Struct PhraseSet 

#[non_exhaustive]
pub struct PhraseSet {

    pub name: String,
    pub uid: String,
    pub phrases: Vec<Phrase>,
    pub boost: f32,
    pub display_name: String,
    pub state: State,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub delete_time: Option<Timestamp>,
    pub expire_time: Option<Timestamp>,
    pub annotations: HashMap<String, String>,
    pub etag: String,
    pub reconciling: bool,
    pub kms_key_name: String,
    pub kms_key_version_name: String,
    /* private fields */
}

PhraseSet for biasing in speech recognition. A PhraseSet is used to provide “hints” to the speech recognizer to favor specific words and phrases in the results.

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

Output only. Identifier. The resource name of the PhraseSet. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.

uid: String

Output only. System-assigned unique identifier for the PhraseSet.

phrases: Vec<Phrase>

A list of word and phrases.

boost: f32

Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Valid boost values are between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.

display_name: String

User-settable, human-readable name for the PhraseSet. Must be 63 characters or less.

state: State

Output only. The PhraseSet lifecycle state.

create_time: Option<Timestamp>

Output only. Creation time.

update_time: Option<Timestamp>

Output only. The most recent time this resource was modified.

delete_time: Option<Timestamp>

Output only. The time at which this resource was requested for deletion.

expire_time: Option<Timestamp>

Output only. The time at which this resource will be purged.

annotations: HashMap<String, String>

Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations.

etag: String

Output only. This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.

reconciling: bool

Output only. Whether or not this PhraseSet is in the process of being updated.

kms_key_name: String

Output only. The KMS key name with which the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

kms_key_version_name: String

Output only. The KMS key version name with which the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.

Implementations

impl PhraseSet

pub fn new() -> Self

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

Sets the value of name.

Example

let x = PhraseSet::new().set_name("example");

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

Sets the value of uid.

Example

let x = PhraseSet::new().set_uid("example");

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

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

Sets the value of phrases.

Example

use google_cloud_speech_v2::model::phrase_set::Phrase;
let x = PhraseSet::new()
    .set_phrases([
        Phrase::default()/* use setters */,
        Phrase::default()/* use (different) setters */,
    ]);

pub fn set_boost<T: Into<f32>>(self, v: T) -> Self

Sets the value of boost.

Example

let x = PhraseSet::new().set_boost(42.0);

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

Sets the value of display_name.

Example

let x = PhraseSet::new().set_display_name("example");

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_speech_v2::model::phrase_set::State;
let x0 = PhraseSet::new().set_state(State::Active);
let x1 = PhraseSet::new().set_state(State::Deleted);

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

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = PhraseSet::new().set_create_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = PhraseSet::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = PhraseSet::new().set_or_clear_create_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of update_time.

Example

use wkt::Timestamp;
let x = PhraseSet::new().set_update_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

use wkt::Timestamp;
let x = PhraseSet::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = PhraseSet::new().set_or_clear_update_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of delete_time.

Example

use wkt::Timestamp;
let x = PhraseSet::new().set_delete_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of delete_time.

Example

use wkt::Timestamp;
let x = PhraseSet::new().set_or_clear_delete_time(Some(Timestamp::default()/* use setters */));
let x = PhraseSet::new().set_or_clear_delete_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of expire_time.

Example

use wkt::Timestamp;
let x = PhraseSet::new().set_expire_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of expire_time.

Example

use wkt::Timestamp;
let x = PhraseSet::new().set_or_clear_expire_time(Some(Timestamp::default()/* use setters */));
let x = PhraseSet::new().set_or_clear_expire_time(None::<Timestamp>);

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

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

Sets the value of annotations.

Example

let x = PhraseSet::new().set_annotations([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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

Sets the value of etag.

Example

let x = PhraseSet::new().set_etag("example");

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

Sets the value of reconciling.

Example

let x = PhraseSet::new().set_reconciling(true);

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

Sets the value of kms_key_name.

Example

let x = PhraseSet::new().set_kms_key_name("example");

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

Sets the value of kms_key_version_name.

Example

let x = PhraseSet::new().set_kms_key_version_name("example");

Trait Implementations

impl Clone for PhraseSet

fn clone(&self) -> PhraseSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PhraseSet

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

Formats the value using the given formatter.

impl Default for PhraseSet

fn default() -> PhraseSet

Returns the “default value” for a type.

impl Message for PhraseSet

fn typename() -> &'static str

The typename of this message.

impl PartialEq for PhraseSet

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