Struct WordInfo 

#[non_exhaustive]
pub struct WordInfo {
    pub start_offset: Option<Duration>,
    pub end_offset: Option<Duration>,
    pub word: String,
    pub confidence: f32,
    pub speaker_label: String,
    /* private fields */
}

Word-specific information for recognized words.

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.

start_offset: Option<Duration>

Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if enable_word_time_offsets is true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

end_offset: Option<Duration>

Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if enable_word_time_offsets is true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

word: String

The word corresponding to this set of information.

confidence: f32

The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where is_final is set to true. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating confidence was not set.

speaker_label: String

A distinct label is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. speaker_label is set if SpeakerDiarizationConfig is given and only in the top alternative.

Implementations

impl WordInfo

pub fn new() -> Self

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

where T: Into<Duration>,

Sets the value of start_offset.

Example

use wkt::Duration;
let x = WordInfo::new().set_start_offset(Duration::default()/* use setters */);

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

where T: Into<Duration>,

Sets or clears the value of start_offset.

Example

use wkt::Duration;
let x = WordInfo::new().set_or_clear_start_offset(Some(Duration::default()/* use setters */));
let x = WordInfo::new().set_or_clear_start_offset(None::<Duration>);

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

where T: Into<Duration>,

Sets the value of end_offset.

Example

use wkt::Duration;
let x = WordInfo::new().set_end_offset(Duration::default()/* use setters */);

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

where T: Into<Duration>,

Sets or clears the value of end_offset.

Example

use wkt::Duration;
let x = WordInfo::new().set_or_clear_end_offset(Some(Duration::default()/* use setters */));
let x = WordInfo::new().set_or_clear_end_offset(None::<Duration>);

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

Sets the value of word.

Example

let x = WordInfo::new().set_word("example");

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

Sets the value of confidence.

Example

let x = WordInfo::new().set_confidence(42.0);

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

Sets the value of speaker_label.

Example

let x = WordInfo::new().set_speaker_label("example");

Trait Implementations

impl Clone for WordInfo

fn clone(&self) -> WordInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WordInfo

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

Formats the value using the given formatter.

impl Default for WordInfo

fn default() -> WordInfo

Returns the “default value” for a type.

impl Message for WordInfo

fn typename() -> &'static str

The typename of this message.

impl PartialEq for WordInfo

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