Struct google_api_proto::google::cloud::retail::v2alpha::CompleteQueryRequest

pub struct CompleteQueryRequest {
    pub catalog: String,
    pub query: String,
    pub visitor_id: String,
    pub language_codes: Vec<String>,
    pub device_type: String,
    pub dataset: String,
    pub max_suggestions: i32,
    pub enable_attribute_suggestions: bool,
    pub entity: String,
}

Autocomplete parameters.

Fields

catalog: String

Required. Catalog for which the completion is performed.

Full resource name of catalog, such as projects/*/locations/global/catalogs/default_catalog.

query: String

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

visitor_id: String

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

language_codes: Vec<String>

Note that this field applies for user-data dataset only. For requests with cloud-retail dataset, setting this field has no effect.

The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as “en-US” or “sr-Latn”. For more information, see Tags for Identifying Languages. The maximum number of language codes is 3.

device_type: String

The device type context for completion suggestions. We recommend that you leave this field empty.

It can apply different suggestions on different device types, e.g. DESKTOP, MOBILE. If it is empty, the suggestions are across all device types.

Supported formats:

• UNKNOWN_DEVICE_TYPE

• DESKTOP

• MOBILE

• A customized string starts with OTHER_, e.g. OTHER_IPHONE.

dataset: String

Determines which dataset to use for fetching completion. “user-data” will use the imported dataset through [CompletionService.ImportCompletionData][google.cloud.retail.v2alpha.CompletionService.ImportCompletionData]. “cloud-retail” will use the dataset generated by cloud retail based on user events. If leave empty, it will use the “user-data”.

Current supported values:

• user-data

• cloud-retail: This option requires enabling auto-learning function first. See guidelines.

max_suggestions: i32

Completion max suggestions. If left unset or set to 0, then will fallback to the configured value [CompletionConfig.max_suggestions][google.cloud.retail.v2alpha.CompletionConfig.max_suggestions].

The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.

enable_attribute_suggestions: bool

If true, attribute suggestions are enabled and provided in response.

This field is only available for “cloud-retail” dataset.

entity: String

The entity for customers who run multiple entities, domains, sites, or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc. If this is set, it must be an exact match with [UserEvent.entity][google.cloud.retail.v2alpha.UserEvent.entity] to get per-entity autocomplete results.

Trait Implementations

impl Clone for CompleteQueryRequest

fn clone(&self) -> CompleteQueryRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompleteQueryRequest

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

Formats the value using the given formatter.

impl Default for CompleteQueryRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for CompleteQueryRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CompleteQueryRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CompleteQueryRequest