Struct SearchRequest 

#[non_exhaustive]
pub struct SearchRequest {

    pub placement: String,
    pub branch: String,
    pub query: String,
    pub visitor_id: String,
    pub user_info: Option<UserInfo>,
    pub page_size: i32,
    pub page_token: String,
    pub offset: i32,
    pub filter: String,
    pub canonical_filter: String,
    pub order_by: String,
    pub facet_specs: Vec<FacetSpec>,
    pub dynamic_facet_spec: Option<DynamicFacetSpec>,
    pub boost_spec: Option<BoostSpec>,
    pub query_expansion_spec: Option<QueryExpansionSpec>,
    pub variant_rollup_keys: Vec<String>,
    pub page_categories: Vec<String>,
    pub search_mode: SearchMode,
    pub personalization_spec: Option<PersonalizationSpec>,
    pub labels: HashMap<String, String>,
    pub spell_correction_spec: Option<SpellCorrectionSpec>,
    pub entity: String,
    pub conversational_search_spec: Option<ConversationalSearchSpec>,
    pub tile_navigation_spec: Option<TileNavigationSpec>,
    pub language_code: String,
    pub region_code: String,
    pub place_id: String,
    pub user_attributes: HashMap<String, StringList>,
    /* private fields */
}

Request message for SearchService.Search method.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

placement: String

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: String

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: String

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: String

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: Option<UserInfo>

User information.

page_size: i32

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: String

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: i32

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: String

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: String

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: String

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: Vec<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: Option<DynamicFacetSpec>

👎Deprecated

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: Option<BoostSpec>

Boost specification to boost certain products. For more information, see Boost results.

Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.

query_expansion_spec: Option<QueryExpansionSpec>

The query expansion specification that specifies the conditions under which query expansion occurs. For more information, see Query expansion.

variant_rollup_keys: Vec<String>

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: Vec<String>

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: SearchMode

The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.

personalization_spec: Option<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: HashMap<String, String>

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 in the Resource Manager documentation.

spell_correction_spec: Option<SpellCorrectionSpec>

The spell correction specification that specifies the mode under which spell correction will take effect.

entity: String

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: Option<ConversationalSearchSpec>

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

tile_navigation_spec: Option<TileNavigationSpec>

Optional. This field specifies tile navigation related parameters.

language_code: String

Optional. The BCP-47 language code, such as “en-US” or “sr-Latn” list. For more information, see Standardized codes. This field helps to better interpret the query. If a value isn’t specified, the query language code is automatically detected, which may not be accurate.

region_code: String

Optional. The Unicode country/region code (CLDR) of a location, such as “US” and “419” list. For more information, see Standardized codes. If set, then results will be boosted based on the region_code provided.

place_id: String

Optional. An id corresponding to a place, such as a store id or region id. When specified, we use the price from the local inventory with the matching product’s LocalInventory.place_id for revenue optimization.

user_attributes: HashMap<String, StringList>

Optional. The user attributes that could be used for personalization of search results.

• Populate at most 100 key-value pairs per query.
• Only supports string keys and repeated string values.
• Duplicate keys are not allowed within a single query.

Example: user_attributes: [ { key: “pets” value { values: “dog” values: “cat” } }, { key: “state” value { values: “CA” } } ]

Implementations

impl SearchRequest

pub fn new() -> Self

pub fn set_placement<T: Into<String>>(self, v: T) -> Self

Sets the value of placement.

Example

let x = SearchRequest::new().set_placement("example");

pub fn set_branch<T: Into<String>>(self, v: T) -> Self

Sets the value of branch.

Example

let x = SearchRequest::new().set_branch("example");

pub fn set_query<T: Into<String>>(self, v: T) -> Self

Sets the value of query.

Example

let x = SearchRequest::new().set_query("example");

pub fn set_visitor_id<T: Into<String>>(self, v: T) -> Self

Sets the value of visitor_id.

Example

let x = SearchRequest::new().set_visitor_id("example");

pub fn set_user_info<T>(self, v: T) -> Self

where T: Into<UserInfo>,

Sets the value of user_info.

Example

use google_cloud_retail_v2::model::UserInfo;
let x = SearchRequest::new().set_user_info(UserInfo::default()/* use setters */);

pub fn set_or_clear_user_info<T>(self, v: Option<T>) -> Self

where T: Into<UserInfo>,

Sets or clears the value of user_info.

Example

use google_cloud_retail_v2::model::UserInfo;
let x = SearchRequest::new().set_or_clear_user_info(Some(UserInfo::default()/* use setters */));
let x = SearchRequest::new().set_or_clear_user_info(None::<UserInfo>);

pub fn set_page_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_size.

Example

let x = SearchRequest::new().set_page_size(42);

pub fn set_page_token<T: Into<String>>(self, v: T) -> Self

Sets the value of page_token.

Example

let x = SearchRequest::new().set_page_token("example");

pub fn set_offset<T: Into<i32>>(self, v: T) -> Self

Sets the value of offset.

Example

let x = SearchRequest::new().set_offset(42);

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

Example

let x = SearchRequest::new().set_filter("example");

pub fn set_canonical_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of canonical_filter.

Example

let x = SearchRequest::new().set_canonical_filter("example");

pub fn set_order_by<T: Into<String>>(self, v: T) -> Self

Sets the value of order_by.

Example

let x = SearchRequest::new().set_order_by("example");

pub fn set_facet_specs<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<FacetSpec>,

Sets the value of facet_specs.

Example

use google_cloud_retail_v2::model::search_request::FacetSpec;
let x = SearchRequest::new()
    .set_facet_specs([
        FacetSpec::default()/* use setters */,
        FacetSpec::default()/* use (different) setters */,
    ]);

pub fn set_dynamic_facet_spec<T>(self, v: T) -> Self

where T: Into<DynamicFacetSpec>,

👎Deprecated

Sets the value of dynamic_facet_spec.

Example

use google_cloud_retail_v2::model::search_request::DynamicFacetSpec;
let x = SearchRequest::new().set_dynamic_facet_spec(DynamicFacetSpec::default()/* use setters */);

pub fn set_or_clear_dynamic_facet_spec<T>(self, v: Option<T>) -> Self

where T: Into<DynamicFacetSpec>,

👎Deprecated

Sets or clears the value of dynamic_facet_spec.

Example

use google_cloud_retail_v2::model::search_request::DynamicFacetSpec;
let x = SearchRequest::new().set_or_clear_dynamic_facet_spec(Some(DynamicFacetSpec::default()/* use setters */));
let x = SearchRequest::new().set_or_clear_dynamic_facet_spec(None::<DynamicFacetSpec>);

pub fn set_boost_spec<T>(self, v: T) -> Self

where T: Into<BoostSpec>,

Sets the value of boost_spec.

Example

use google_cloud_retail_v2::model::search_request::BoostSpec;
let x = SearchRequest::new().set_boost_spec(BoostSpec::default()/* use setters */);

pub fn set_or_clear_boost_spec<T>(self, v: Option<T>) -> Self

where T: Into<BoostSpec>,

Sets or clears the value of boost_spec.

Example

use google_cloud_retail_v2::model::search_request::BoostSpec;
let x = SearchRequest::new().set_or_clear_boost_spec(Some(BoostSpec::default()/* use setters */));
let x = SearchRequest::new().set_or_clear_boost_spec(None::<BoostSpec>);

pub fn set_query_expansion_spec<T>(self, v: T) -> Self

where T: Into<QueryExpansionSpec>,

Sets the value of query_expansion_spec.

Example

use google_cloud_retail_v2::model::search_request::QueryExpansionSpec;
let x = SearchRequest::new().set_query_expansion_spec(QueryExpansionSpec::default()/* use setters */);

pub fn set_or_clear_query_expansion_spec<T>(self, v: Option<T>) -> Self

where T: Into<QueryExpansionSpec>,

Sets or clears the value of query_expansion_spec.

Example

use google_cloud_retail_v2::model::search_request::QueryExpansionSpec;
let x = SearchRequest::new().set_or_clear_query_expansion_spec(Some(QueryExpansionSpec::default()/* use setters */));
let x = SearchRequest::new().set_or_clear_query_expansion_spec(None::<QueryExpansionSpec>);

pub fn set_variant_rollup_keys<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of variant_rollup_keys.

Example

let x = SearchRequest::new().set_variant_rollup_keys(["a", "b", "c"]);

pub fn set_page_categories<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of page_categories.

Example

let x = SearchRequest::new().set_page_categories(["a", "b", "c"]);

pub fn set_search_mode<T: Into<SearchMode>>(self, v: T) -> Self

Sets the value of search_mode.

Example

use google_cloud_retail_v2::model::search_request::SearchMode;
let x0 = SearchRequest::new().set_search_mode(SearchMode::ProductSearchOnly);
let x1 = SearchRequest::new().set_search_mode(SearchMode::FacetedSearchOnly);

pub fn set_personalization_spec<T>(self, v: T) -> Self

where T: Into<PersonalizationSpec>,

Sets the value of personalization_spec.

Example

use google_cloud_retail_v2::model::search_request::PersonalizationSpec;
let x = SearchRequest::new().set_personalization_spec(PersonalizationSpec::default()/* use setters */);

pub fn set_or_clear_personalization_spec<T>(self, v: Option<T>) -> Self

where T: Into<PersonalizationSpec>,

Sets or clears the value of personalization_spec.

Example

use google_cloud_retail_v2::model::search_request::PersonalizationSpec;
let x = SearchRequest::new().set_or_clear_personalization_spec(Some(PersonalizationSpec::default()/* use setters */));
let x = SearchRequest::new().set_or_clear_personalization_spec(None::<PersonalizationSpec>);

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Example

let x = SearchRequest::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_spell_correction_spec<T>(self, v: T) -> Self

where T: Into<SpellCorrectionSpec>,

Sets the value of spell_correction_spec.

Example

use google_cloud_retail_v2::model::search_request::SpellCorrectionSpec;
let x = SearchRequest::new().set_spell_correction_spec(SpellCorrectionSpec::default()/* use setters */);

pub fn set_or_clear_spell_correction_spec<T>(self, v: Option<T>) -> Self

where T: Into<SpellCorrectionSpec>,

Sets or clears the value of spell_correction_spec.

Example

use google_cloud_retail_v2::model::search_request::SpellCorrectionSpec;
let x = SearchRequest::new().set_or_clear_spell_correction_spec(Some(SpellCorrectionSpec::default()/* use setters */));
let x = SearchRequest::new().set_or_clear_spell_correction_spec(None::<SpellCorrectionSpec>);

pub fn set_entity<T: Into<String>>(self, v: T) -> Self

Sets the value of entity.

Example

let x = SearchRequest::new().set_entity("example");

pub fn set_conversational_search_spec<T>(self, v: T) -> Self

where T: Into<ConversationalSearchSpec>,

Sets the value of conversational_search_spec.

Example

use google_cloud_retail_v2::model::search_request::ConversationalSearchSpec;
let x = SearchRequest::new().set_conversational_search_spec(ConversationalSearchSpec::default()/* use setters */);

pub fn set_or_clear_conversational_search_spec<T>(self, v: Option<T>) -> Self

where T: Into<ConversationalSearchSpec>,

Sets or clears the value of conversational_search_spec.

Example

use google_cloud_retail_v2::model::search_request::ConversationalSearchSpec;
let x = SearchRequest::new().set_or_clear_conversational_search_spec(Some(ConversationalSearchSpec::default()/* use setters */));
let x = SearchRequest::new().set_or_clear_conversational_search_spec(None::<ConversationalSearchSpec>);

pub fn set_tile_navigation_spec<T>(self, v: T) -> Self

where T: Into<TileNavigationSpec>,

Sets the value of tile_navigation_spec.

Example

use google_cloud_retail_v2::model::search_request::TileNavigationSpec;
let x = SearchRequest::new().set_tile_navigation_spec(TileNavigationSpec::default()/* use setters */);

pub fn set_or_clear_tile_navigation_spec<T>(self, v: Option<T>) -> Self

where T: Into<TileNavigationSpec>,

Sets or clears the value of tile_navigation_spec.

Example

use google_cloud_retail_v2::model::search_request::TileNavigationSpec;
let x = SearchRequest::new().set_or_clear_tile_navigation_spec(Some(TileNavigationSpec::default()/* use setters */));
let x = SearchRequest::new().set_or_clear_tile_navigation_spec(None::<TileNavigationSpec>);

pub fn set_language_code<T: Into<String>>(self, v: T) -> Self

Sets the value of language_code.

Example

let x = SearchRequest::new().set_language_code("example");

pub fn set_region_code<T: Into<String>>(self, v: T) -> Self

Sets the value of region_code.

Example

let x = SearchRequest::new().set_region_code("example");

pub fn set_place_id<T: Into<String>>(self, v: T) -> Self

Sets the value of place_id.

Example

let x = SearchRequest::new().set_place_id("example");

pub fn set_user_attributes<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<StringList>,

Sets the value of user_attributes.

Example

use google_cloud_retail_v2::model::StringList;
let x = SearchRequest::new().set_user_attributes([
    ("key0", StringList::default()/* use setters */),
    ("key1", StringList::default()/* use (different) setters */),
]);

Trait Implementations

impl Clone for SearchRequest

fn clone(&self) -> SearchRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchRequest

fn default() -> SearchRequest

Returns the “default value” for a type.

impl Message for SearchRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SearchRequest

fn eq(&self, other: &SearchRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SearchRequest