Class SearchMode (1.22.0)

SearchMode(value)

The search mode of each search request.

    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.