Only
<xref uid="google.cloud.retail.v2alpha.SearchResponse.SearchResult">SearchResponse.SearchResult</xref>
will be returned.
<xref uid="google.cloud.retail.v2alpha.SearchResponse.Facet">SearchResponse.Facet</xref>
will not be returned, even if
<xref uid="google.cloud.retail.v2alpha.SearchRequest.facet_specs">SearchRequest.facet_specs</xref>
or
<xref uid="google.cloud.retail.v2alpha.SearchRequest.dynamic_facet_spec">SearchRequest.dynamic_facet_spec</xref>
is set.
FACETED_SEARCH_ONLY (2):
Only faceted search will be performed. The product search
will be disabled.
When in this mode, one or both of
<xref uid="google.cloud.retail.v2alpha.SearchRequest.facet_specs">SearchRequest.facet_specs</xref>
and
<xref uid="google.cloud.retail.v2alpha.SearchRequest.dynamic_facet_spec">SearchRequest.dynamic_facet_spec</xref>
should be set. Otherwise, an INVALID_ARGUMENT error is
returned. Only
<xref uid="google.cloud.retail.v2alpha.SearchResponse.Facet">SearchResponse.Facet</xref>
will be returned.
<xref uid="google.cloud.retail.v2alpha.SearchResponse.SearchResult">SearchResponse.SearchResult</xref>
will not be returned.
Enums
Name
Description
SEARCH_MODE_UNSPECIFIED
Default value. In this case both product search and faceted search will be performed. Both SearchResponse.SearchResult and SearchResponse.Facet will be returned.
PRODUCT_SEARCH_ONLY
Only product search will be performed. The faceted search will be disabled.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class SearchMode (2.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.5.0 (latest)](/python/docs/reference/retail/latest/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [2.4.0](/python/docs/reference/retail/2.4.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [2.3.0](/python/docs/reference/retail/2.3.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [2.2.0](/python/docs/reference/retail/2.2.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [2.1.0](/python/docs/reference/retail/2.1.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [2.0.0](/python/docs/reference/retail/2.0.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.25.0](/python/docs/reference/retail/1.25.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.24.0](/python/docs/reference/retail/1.24.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.23.1](/python/docs/reference/retail/1.23.1/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.22.0](/python/docs/reference/retail/1.22.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.21.2](/python/docs/reference/retail/1.21.2/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.20.1](/python/docs/reference/retail/1.20.1/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.19.1](/python/docs/reference/retail/1.19.1/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.18.0](/python/docs/reference/retail/1.18.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.17.0](/python/docs/reference/retail/1.17.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.16.3](/python/docs/reference/retail/1.16.3/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.15.1](/python/docs/reference/retail/1.15.1/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.14.1](/python/docs/reference/retail/1.14.1/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.13.0](/python/docs/reference/retail/1.13.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.12.0](/python/docs/reference/retail/1.12.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.11.0](/python/docs/reference/retail/1.11.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.10.2](/python/docs/reference/retail/1.10.2/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.9.0](/python/docs/reference/retail/1.9.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.8.1](/python/docs/reference/retail/1.8.1/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.7.0](/python/docs/reference/retail/1.7.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.6.1](/python/docs/reference/retail/1.6.1/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.5.0](/python/docs/reference/retail/1.5.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.4.1](/python/docs/reference/retail/1.4.1/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.3.0](/python/docs/reference/retail/1.3.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.2.1](/python/docs/reference/retail/1.2.1/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.1.0](/python/docs/reference/retail/1.1.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [1.0.2](/python/docs/reference/retail/1.0.2/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [0.4.2](/python/docs/reference/retail/0.4.2/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [0.3.1](/python/docs/reference/retail/0.3.1/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [0.2.0](/python/docs/reference/retail/0.2.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode)\n- [0.1.0](/python/docs/reference/retail/0.1.0/google.cloud.retail_v2alpha.types.SearchRequest.SearchMode) \n\n SearchMode(value)\n\nThe search mode of each search request. \n\n Only\n \u003cxref uid=\"google.cloud.retail.v2alpha.SearchResponse.SearchResult\"\u003eSearchResponse.SearchResult\u003c/xref\u003e\n will be returned.\n \u003cxref uid=\"google.cloud.retail.v2alpha.SearchResponse.Facet\"\u003eSearchResponse.Facet\u003c/xref\u003e\n will not be returned, even if\n \u003cxref uid=\"google.cloud.retail.v2alpha.SearchRequest.facet_specs\"\u003eSearchRequest.facet_specs\u003c/xref\u003e\n or\n \u003cxref uid=\"google.cloud.retail.v2alpha.SearchRequest.dynamic_facet_spec\"\u003eSearchRequest.dynamic_facet_spec\u003c/xref\u003e\n is set.\n FACETED_SEARCH_ONLY (2):\n Only faceted search will be performed. The product search\n will be disabled.\n\n When in this mode, one or both of\n \u003cxref uid=\"google.cloud.retail.v2alpha.SearchRequest.facet_specs\"\u003eSearchRequest.facet_specs\u003c/xref\u003e\n and\n \u003cxref uid=\"google.cloud.retail.v2alpha.SearchRequest.dynamic_facet_spec\"\u003eSearchRequest.dynamic_facet_spec\u003c/xref\u003e\n should be set. Otherwise, an INVALID_ARGUMENT error is\n returned. Only\n \u003cxref uid=\"google.cloud.retail.v2alpha.SearchResponse.Facet\"\u003eSearchResponse.Facet\u003c/xref\u003e\n will be returned.\n \u003cxref uid=\"google.cloud.retail.v2alpha.SearchResponse.SearchResult\"\u003eSearchResponse.SearchResult\u003c/xref\u003e\n will not be returned."]]