Struct Transcript 

#[non_exhaustive]
pub struct Transcript { /* private fields */ }

One clip’s transcription.

Examples

use cactus_rs::whistle::{Language, Transcript};

let transcript: Transcript = r#"{"text":"Mach das Licht in der Kitche aus.",
    "language":"de","ttft_ms":57.4,"decode_tps":182.4}"#
    .parse()?;

assert_eq!(transcript.language(), Some(Language::De));
assert!(!transcript.is_empty());

Implementations

impl Transcript

pub fn text(&self) -> &str

What was said, as one string. Empty for silence.

Examples

use cactus_rs::whistle::Transcript;

let transcript: Transcript = r#"{"text":"Turn off the kitchen lights."}"#.parse()?;
assert_eq!(transcript.text(), "Turn off the kitchen lights.");

pub fn language(&self) -> Option<Language>

The language the clip was transcribed as: the forced one, or the one detected.

None for silence, which has no language, and for a code this crate does not know; Transcript::language_code still has that code.

Examples

use cactus_rs::whistle::{Language, Transcript};

let spoken: Transcript = r#"{"text":"Hallo.","language":"de"}"#.parse()?;
assert_eq!(spoken.language(), Some(Language::De));

let silence: Transcript = r#"{"text":"","language":""}"#.parse()?;
assert_eq!(silence.language(), None);

pub fn language_code(&self) -> &str

The language code exactly as the engine wrote it, empty for silence.

Examples

use cactus_rs::whistle::Transcript;

let transcript: Transcript = r#"{"text":"Hello.","language":"en"}"#.parse()?;
assert_eq!(transcript.language_code(), "en");

pub fn words(&self) -> &[Word]

Every word with its timing, when word timestamps were asked for; empty otherwise.

Examples

use cactus_rs::whistle::Transcript;

let transcript: Transcript = r#"{"text":"On.","language":"en",
    "words":[{"word":"On.","start":0.16,"end":0.4,"probability":0.85}]}"#
    .parse()?;
assert_eq!(transcript.words()[0].word(), "On.");

pub const fn ttft_ms(&self) -> f32

Milliseconds until the first token was decoded, which is mostly the encoder’s time.

Examples

use cactus_rs::whistle::Transcript;

let transcript: Transcript = r#"{"text":"On.","ttft_ms":23.2}"#.parse()?;
assert_eq!(transcript.ttft_ms(), 23.2);

pub const fn decode_tps(&self) -> f32

Tokens per second while decoding the text.

Examples

use cactus_rs::whistle::Transcript;

let transcript: Transcript = r#"{"text":"On.","decode_tps":274.8}"#.parse()?;
assert_eq!(transcript.decode_tps(), 274.8);

pub fn is_empty(&self) -> bool

Whether nothing was recognised: silence, noise or an empty clip.

Examples

use cactus_rs::whistle::Transcript;

let silence: Transcript = r#"{"text":"","language":""}"#.parse()?;
assert!(silence.is_empty());

Trait Implementations

impl Clone for Transcript

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Transcript

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

Formats the value using the given formatter.

impl Default for Transcript

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Transcript

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for Transcript

Parses a transcription envelope.

fn from_str(s: &str) -> Result<Self>

Errors

Returns Error::Envelope when the text is not the JSON this crate expects.

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for Transcript

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Transcript

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Transcript