Class SearchRequest (1.23.0)

Version 1.23.0

• 1.23.1 (latest)
• 1.23.0
• 1.22.0
• 1.21.2
• 1.20.1
• 1.19.1
• 1.18.0
• 1.17.0
• 1.16.3
• 1.15.1
• 1.14.1
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.1
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.1
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.2
• 0.4.2
• 0.3.1
• 0.2.0
• 0.1.0

SearchRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for SearchService.Search method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
placement	str Required. The resource name of the Retail Search serving config, such as projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config or the name of the legacy placement resource, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search. This field is used to identify the serving config name and the set of models that are used to make the search.
branch	str The branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0. Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.
query	str Raw search query. If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories.
visitor_id	str Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
user_info	google.cloud.retail_v2.types.UserInfo User information.
page_size	int Maximum number of Products to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 120. Values above 120 will be coerced to 120. If this field is negative, an INVALID_ARGUMENT is returned.
page_token	str A page token SearchResponse.next_page_token, received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
offset	int A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Products deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an INVALID_ARGUMENT is returned.
filter	str The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. For more information, see Filter __. If this field is unrecognizable, an INVALID_ARGUMENT is returned.
canonical_filter	str The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
order_by	str The order in which products are returned. Products can be ordered by a field in an Product object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. For more information, see Order __. If this field is unrecognizable, an INVALID_ARGUMENT is returned.
facet_specs	MutableSequence[google.cloud.retail_v2.types.SearchRequest.FacetSpec] Facet specifications for faceted search. If empty, no facets are returned. A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
dynamic_facet_spec	google.cloud.retail_v2.types.SearchRequest.DynamicFacetSpec Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field. The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.
boost_spec	google.cloud.retail_v2.types.SearchRequest.BoostSpec Boost specification to boost certain products. For more information, see `Boost results
query_expansion_spec	google.cloud.retail_v2.types.SearchRequest.QueryExpansionSpec The query expansion specification that specifies the conditions under which query expansion occurs. For more information, see `Query expansion
variant_rollup_keys	MutableSequence[str] The keys to fetch and rollup the matching variant Products attributes, FulfillmentInfo or LocalInventorys attributes. The attributes from all the matching variant Products or LocalInventorys are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30. For FulfillmentInfo, a fulfillment type and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID. Supported keys are: - colorFamilies - price - originalPrice - discount - variantId - inventory(place_id,price) - inventory(place_id,original_price) - inventory(place_id,attributes.key), where key is any key in the Product.local_inventories.attributes map. - attributes.key, where key is any key in the Product.attributes map. - pickupInStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". - shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store". - sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "same-day-delivery". - nextDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery". - customFulfillment1.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-1". - customFulfillment2.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". - customFulfillment3.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-3". - customFulfillment4.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". - customFulfillment5.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-5". If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.
page_categories	MutableSequence[str] The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
search_mode	google.cloud.retail_v2.types.SearchRequest.SearchMode The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.
personalization_spec	google.cloud.retail_v2.types.SearchRequest.PersonalizationSpec The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec.
labels	MutableMapping[str, str] The labels applied to a resource must meet the following requirements: - Each resource can have multiple labels, up to a maximum of 64. - Each label must be a key-value pair. - Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. - Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. - The key portion of a label must be unique. However, you can use the same key with multiple resources. - Keys must start with a lowercase letter or international character. For more information, see `Requirements for labels
spell_correction_spec	google.cloud.retail_v2.types.SearchRequest.SpellCorrectionSpec The spell correction specification that specifies the mode under which spell correction will take effect. This field is a member of oneof_ _spell_correction_spec.
entity	str The entity for customers that may run multiple different entities, domains, sites or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.
conversational_search_spec	google.cloud.retail_v2.types.SearchRequest.ConversationalSearchSpec Optional. This field specifies all conversational related parameters addition to traditional retail search.
tile_navigation_spec	google.cloud.retail_v2.types.SearchRequest.TileNavigationSpec Optional. This field specifies tile navigation related parameters.

Classes

BoostSpec

BoostSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Boost specification to boost certain items.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ConversationalSearchSpec

ConversationalSearchSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

This field specifies all conversational related parameters addition to traditional retail search.

DynamicFacetSpec

DynamicFacetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The specifications of dynamically generated facets.

FacetSpec

FacetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A facet specification to perform faceted search.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

PersonalizationSpec

PersonalizationSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The specification for personalization.

QueryExpansionSpec

QueryExpansionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Specification to determine under which conditions query expansion should occur.

SearchMode

SearchMode(value)

The search mode of each search request.

    Only
    <xref uid="google.cloud.retail.v2.SearchResponse.SearchResult">SearchResponse.SearchResult</xref>
    will be returned.
    <xref uid="google.cloud.retail.v2.SearchResponse.Facet">SearchResponse.Facet</xref>
    will not be returned, even if
    <xref uid="google.cloud.retail.v2.SearchRequest.facet_specs">SearchRequest.facet_specs</xref>
    or
    <xref uid="google.cloud.retail.v2.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.v2.SearchRequest.facet_specs">SearchRequest.facet_specs</xref>
    and
    <xref uid="google.cloud.retail.v2.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.v2.SearchResponse.Facet">SearchResponse.Facet</xref>
    will be returned.
    <xref uid="google.cloud.retail.v2.SearchResponse.SearchResult">SearchResponse.SearchResult</xref>
    will not be returned.

SpellCorrectionSpec

SpellCorrectionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The specification for query spell correction.

TileNavigationSpec

TileNavigationSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

This field specifies tile navigation related parameters.