Struct CompletionConfig 

#[non_exhaustive]
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,
    /* private fields */
}

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

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.

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.

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.

Implementations

impl CompletionConfig

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = CompletionConfig::new().set_name(format!("projects/{project_id}/locations/{location_id}/catalogs/{catalog_id}/completionConfig"));

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

Sets the value of matching_order.

Example

let x = CompletionConfig::new().set_matching_order("example");

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

Sets the value of max_suggestions.

Example

let x = CompletionConfig::new().set_max_suggestions(42);

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

Sets the value of min_prefix_length.

Example

let x = CompletionConfig::new().set_min_prefix_length(42);

pub fn set_auto_learning<T: Into<bool>>(self, v: T) -> Self

Sets the value of auto_learning.

Example

let x = CompletionConfig::new().set_auto_learning(true);

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

where T: Into<CompletionDataInputConfig>,

Sets the value of suggestions_input_config.

Example

use google_cloud_retail_v2::model::CompletionDataInputConfig;
let x = CompletionConfig::new().set_suggestions_input_config(CompletionDataInputConfig::default()/* use setters */);

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

where T: Into<CompletionDataInputConfig>,

Sets or clears the value of suggestions_input_config.

Example

use google_cloud_retail_v2::model::CompletionDataInputConfig;
let x = CompletionConfig::new().set_or_clear_suggestions_input_config(Some(CompletionDataInputConfig::default()/* use setters */));
let x = CompletionConfig::new().set_or_clear_suggestions_input_config(None::<CompletionDataInputConfig>);

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

Sets the value of last_suggestions_import_operation.

Example

let x = CompletionConfig::new().set_last_suggestions_import_operation("example");

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

where T: Into<CompletionDataInputConfig>,

Sets the value of denylist_input_config.

Example

use google_cloud_retail_v2::model::CompletionDataInputConfig;
let x = CompletionConfig::new().set_denylist_input_config(CompletionDataInputConfig::default()/* use setters */);

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

where T: Into<CompletionDataInputConfig>,

Sets or clears the value of denylist_input_config.

Example

use google_cloud_retail_v2::model::CompletionDataInputConfig;
let x = CompletionConfig::new().set_or_clear_denylist_input_config(Some(CompletionDataInputConfig::default()/* use setters */));
let x = CompletionConfig::new().set_or_clear_denylist_input_config(None::<CompletionDataInputConfig>);

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

Sets the value of last_denylist_import_operation.

Example

let x = CompletionConfig::new().set_last_denylist_import_operation("example");

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

where T: Into<CompletionDataInputConfig>,

Sets the value of allowlist_input_config.

Example

use google_cloud_retail_v2::model::CompletionDataInputConfig;
let x = CompletionConfig::new().set_allowlist_input_config(CompletionDataInputConfig::default()/* use setters */);

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

where T: Into<CompletionDataInputConfig>,

Sets or clears the value of allowlist_input_config.

Example

use google_cloud_retail_v2::model::CompletionDataInputConfig;
let x = CompletionConfig::new().set_or_clear_allowlist_input_config(Some(CompletionDataInputConfig::default()/* use setters */));
let x = CompletionConfig::new().set_or_clear_allowlist_input_config(None::<CompletionDataInputConfig>);

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

Sets the value of last_allowlist_import_operation.

Example

let x = CompletionConfig::new().set_last_allowlist_import_operation("example");

Trait Implementations

impl Clone for CompletionConfig

fn clone(&self) -> CompletionConfig

Returns a duplicate 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() -> CompletionConfig

Returns the “default value” for a type.

impl Message for CompletionConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CompletionConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CompletionConfig