Struct google_api_proto::google::cloud::retail::v2::CompletionConfig

pub struct CompletionConfig {
    pub name: String,
    pub matching_order: String,
    pub max_suggestions: i32,
    pub min_prefix_length: i32,
    pub auto_learning: bool,
    pub suggestions_input_config: Option<CompletionDataInputConfig>,
    pub last_suggestions_import_operation: String,
    pub denylist_input_config: Option<CompletionDataInputConfig>,
    pub last_denylist_import_operation: String,
    pub allowlist_input_config: Option<CompletionDataInputConfig>,
    pub last_allowlist_import_operation: String,
}

Catalog level autocomplete config for customers to customize autocomplete feature’s settings.

Fields

name: String

Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig

matching_order: String

Specifies the matching order for autocomplete suggestions, e.g., a query consisting of ‘sh’ with ‘out-of-order’ specified would suggest “women’s shoes”, whereas a query of ‘red s’ with ‘exact-prefix’ specified would suggest “red shoes”. Currently supported values:

• ‘out-of-order’
• ‘exact-prefix’

Default value: ‘exact-prefix’.

max_suggestions: i32

The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value.

Value range is 1 to 20.

min_prefix_length: i32

The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value.

Value range is 1 to 20.

auto_learning: bool

If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use cloud-retail data in [CompleteQueryRequest][google.cloud.retail.v2.CompleteQueryRequest].

suggestions_input_config: Option<CompletionDataInputConfig>

Output only. The source data for the latest import of the autocomplete suggestion phrases.

last_suggestions_import_operation: String

Output only. Name of the LRO corresponding to the latest suggestion terms list import.

Can use [GetOperation][google.longrunning.Operations.GetOperation] API method to retrieve the latest state of the Long Running Operation.

denylist_input_config: Option<CompletionDataInputConfig>

Output only. The source data for the latest import of the autocomplete denylist phrases.

last_denylist_import_operation: String

Output only. Name of the LRO corresponding to the latest denylist import.

Can use [GetOperation][google.longrunning.Operations.GetOperation] API to retrieve the latest state of the Long Running Operation.

allowlist_input_config: Option<CompletionDataInputConfig>

Output only. The source data for the latest import of the autocomplete allowlist phrases.

last_allowlist_import_operation: String

Output only. Name of the LRO corresponding to the latest allowlist import.

Can use [GetOperation][google.longrunning.Operations.GetOperation] API to retrieve the latest state of the Long Running Operation.

Trait Implementations

impl Clone for CompletionConfig

fn clone(&self) -> CompletionConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionConfig

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

Formats the value using the given formatter.

impl Default for CompletionConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for CompletionConfig

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 CompletionConfig

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