Struct google_api_proto::google::cloud::retail::v2alpha::CompleteQueryResponse

pub struct CompleteQueryResponse {
    pub completion_results: Vec<CompletionResult>,
    pub attribution_token: String,
    pub recent_search_results: Vec<RecentSearchResult>,
    pub attribute_results: BTreeMap<String, AttributeResult>,
}

Response of the autocomplete query.

Fields

completion_results: Vec<CompletionResult>

Results of the matching suggestions. The result list is ordered and the first result is top suggestion.

attribution_token: String

A unique complete token. This should be included in the [UserEvent.completion_detail][google.cloud.retail.v2alpha.UserEvent.completion_detail] for search events resulting from this completion, which enables accurate attribution of complete model performance.

recent_search_results: Vec<RecentSearchResult>

👎Deprecated

Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support.

This feature is only available when [CompleteQueryRequest.visitor_id][google.cloud.retail.v2alpha.CompleteQueryRequest.visitor_id] field is set and [UserEvent][google.cloud.retail.v2alpha.UserEvent] is imported. The recent searches satisfy the follow rules:

• They are ordered from latest to oldest.

• They are matched with [CompleteQueryRequest.query][google.cloud.retail.v2alpha.CompleteQueryRequest.query] case insensitively.

• They are transformed to lower case.

• They are UTF-8 safe.

Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

attribute_results: BTreeMap<String, AttributeResult>

A map of matched attribute suggestions. This field is only available for “cloud-retail” dataset.

Current supported keys:

• brands

• categories

Trait Implementations

impl Clone for CompleteQueryResponse

fn clone(&self) -> CompleteQueryResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompleteQueryResponse

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

Formats the value using the given formatter.

impl Default for CompleteQueryResponse

fn default() -> Self

Returns the “default value” for a type.

impl Message for CompleteQueryResponse

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 CompleteQueryResponse

fn eq(&self, other: &CompleteQueryResponse) -> 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 CompleteQueryResponse