Struct GoogleCloudRetailV2ConversationalSearchRequest 

pub struct GoogleCloudRetailV2ConversationalSearchRequest {
    pub branch: Option<String>,
    pub conversation_id: Option<String>,
    pub conversational_filtering_spec: Option<GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec>,
    pub page_categories: Option<Vec<String>>,
    pub query: Option<String>,
    pub safety_settings: Option<Vec<GoogleCloudRetailV2SafetySetting>>,
    pub search_params: Option<GoogleCloudRetailV2ConversationalSearchRequestSearchParams>,
    pub user_info: Option<GoogleCloudRetailV2UserInfo>,
    pub user_labels: Option<HashMap<String, String>>,
    pub visitor_id: Option<String>,
}

Request message for ConversationalSearchService.ConversationalSearch method.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• locations catalogs placements conversational search projects (request)
• locations catalogs serving configs conversational search projects (request)

Fields

branch: Option<String>

Required. 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.

conversation_id: Option<String>

Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.

conversational_filtering_spec: Option<GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec>

Optional. This field specifies all conversational filtering related parameters.

page_categories: Option<Vec<String>>

Optional. 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”].

query: Option<String>

Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request.

safety_settings: Option<Vec<GoogleCloudRetailV2SafetySetting>>

Optional. The safety settings to be applied to the generated content.

search_params: Option<GoogleCloudRetailV2ConversationalSearchRequestSearchParams>

Optional. Search parameters.

user_info: Option<GoogleCloudRetailV2UserInfo>

Optional. User information.

user_labels: Option<HashMap<String, String>>

Optional. The user 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. See Google Cloud Document for more details.

visitor_id: Option<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.

Trait Implementations

impl Clone for GoogleCloudRetailV2ConversationalSearchRequest

fn clone(&self) -> GoogleCloudRetailV2ConversationalSearchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GoogleCloudRetailV2ConversationalSearchRequest

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

Formats the value using the given formatter.

impl Default for GoogleCloudRetailV2ConversationalSearchRequest

fn default() -> GoogleCloudRetailV2ConversationalSearchRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GoogleCloudRetailV2ConversationalSearchRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GoogleCloudRetailV2ConversationalSearchRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for GoogleCloudRetailV2ConversationalSearchRequest