SearchRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Request message for SearchService.Search method.
Attributes | |
|---|---|
| Name | Description |
placement |
str
Required. The resource name of the search engine placement, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search.
This field is used to identify the set of models that will
be used to make the search.
We currently support one placement with the following ID:
- default_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. |
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. 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. If this field is unrecognizable, an INVALID_ARGUMENT is returned. |
canonical_filter |
str
The filter applied to every search request when quality improvement such as query expansion is needed. For example, if a query does not have enough results, an expanded query with SearchRequest.canonical_filter will be returned as a supplement of the original query. This field is strongly recommended to achieve high search quality. See SearchRequest.filter for more details about filter syntax. |
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. If this field is unrecognizable, an INVALID_ARGUMENT is returned. |
facet_specs |
Sequence[google.cloud.retail_v2.types.SearchRequest.FacetSpec]
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. |
dynamic_facet_spec |
google.cloud.retail_v2.types.SearchRequest.DynamicFacetSpec
The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated. This feature requires additional allowlisting. Contact Retail Search support team if you are interested in using dynamic facet feature. |
boost_spec |
google.cloud.retail_v2.types.SearchRequest.BoostSpec
Boost specification to boost certain products. |
query_expansion_spec |
google.cloud.retail_v2.types.SearchRequest.QueryExpansionSpec
The query expansion specification that specifies the conditions under which query expansion will occur. |
variant_rollup_keys |
Sequence[str]
The keys to fetch and rollup the matching variant Products attributes. The attributes from all the matching variant Products are merged and de-duplicated. Notice that rollup variant Products attributes will lead to extra query latency. Maximum number of keys is 10. 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 - 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 |
Sequence[str]
The categories associated with a category page. Required 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, please 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"]. |
Classes
BoostSpec
BoostSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)Boost specification to boost certain items.
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.
QueryExpansionSpec
QueryExpansionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)Specification to determine under which conditions query expansion should occur.