Struct Phrase 

#[non_exhaustive]
pub struct Phrase {
    pub value: String,
    pub boost: f32,
    /* private fields */
}

A Phrase contains words and phrase “hints” so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer.

List items can also include CustomClass references containing groups of words that represent common concepts that occur in natural language.

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.

value: String

The phrase itself.

boost: f32

Hint Boost. Overrides the boost set at the phrase set level. 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. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost values will return an error. Boost values must be between 0 and 20. Any values outside that range will return an error. 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.

Implementations

impl Phrase

pub fn new() -> Self

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

Sets the value of value.

Example

let x = Phrase::new().set_value("example");

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

Sets the value of boost.

Example

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

Trait Implementations

impl Clone for Phrase

fn clone(&self) -> Phrase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Phrase

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

Formats the value using the given formatter.

impl Default for Phrase

fn default() -> Phrase

Returns the “default value” for a type.

impl Message for Phrase

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Phrase

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