Struct CompletionSuggestion 

#[non_exhaustive]
pub struct CompletionSuggestion {
    pub suggestion: String,
    pub language_code: String,
    pub group_id: String,
    pub group_score: f64,
    pub alternative_phrases: Vec<String>,
    pub ranking_info: Option<RankingInfo>,
    /* private fields */
}

Available on crate feature completion-service only.

Autocomplete suggestions that are imported from Customer.

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.

suggestion: String

Required. The suggestion text.

language_code: String

BCP-47 language code of this suggestion.

group_id: String

If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions.

group_score: f64

The score of this suggestion within its group.

alternative_phrases: Vec<String>

Alternative matching phrases for this suggestion.

ranking_info: Option<RankingInfo>

Ranking metrics of this suggestion.

Implementations

impl CompletionSuggestion

pub fn new() -> Self

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

Sets the value of suggestion.

Example

let x = CompletionSuggestion::new().set_suggestion("example");

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

Sets the value of language_code.

Example

let x = CompletionSuggestion::new().set_language_code("example");

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

Sets the value of group_id.

Example

let x = CompletionSuggestion::new().set_group_id("example");

pub fn set_group_score<T: Into<f64>>(self, v: T) -> Self

Sets the value of group_score.

Example

let x = CompletionSuggestion::new().set_group_score(42.0);

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

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of alternative_phrases.

Example

let x = CompletionSuggestion::new().set_alternative_phrases(["a", "b", "c"]);

pub fn set_ranking_info<T: Into<Option<RankingInfo>>>(self, v: T) -> Self

Sets the value of ranking_info.

Note that all the setters affecting ranking_info are mutually exclusive.

Example

use google_cloud_discoveryengine_v1::model::completion_suggestion::RankingInfo;
let x = CompletionSuggestion::new().set_ranking_info(Some(RankingInfo::GlobalScore(42.0)));

pub fn global_score(&self) -> Option<&f64>

The value of ranking_info if it holds a GlobalScore, None if the field is not set or holds a different branch.

pub fn set_global_score<T: Into<f64>>(self, v: T) -> Self

Sets the value of ranking_info to hold a GlobalScore.

Note that all the setters affecting ranking_info are mutually exclusive.

Example

let x = CompletionSuggestion::new().set_global_score(42.0);
assert!(x.global_score().is_some());
assert!(x.frequency().is_none());

pub fn frequency(&self) -> Option<&i64>

The value of ranking_info if it holds a Frequency, None if the field is not set or holds a different branch.

pub fn set_frequency<T: Into<i64>>(self, v: T) -> Self

Sets the value of ranking_info to hold a Frequency.

Note that all the setters affecting ranking_info are mutually exclusive.

Example

let x = CompletionSuggestion::new().set_frequency(42);
assert!(x.frequency().is_some());
assert!(x.global_score().is_none());

Trait Implementations

impl Clone for CompletionSuggestion

fn clone(&self) -> CompletionSuggestion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionSuggestion

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

Formats the value using the given formatter.

impl Default for CompletionSuggestion

fn default() -> CompletionSuggestion

Returns the “default value” for a type.

impl Message for CompletionSuggestion

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CompletionSuggestion

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CompletionSuggestion