Struct StopSpeakingPlan

pub struct StopSpeakingPlan {
    pub num_words: Option<f64>,
    pub voice_seconds: Option<f64>,
    pub backoff_seconds: Option<f64>,
    pub acknowledgement_phrases: Option<Vec<String>>,
    pub interruption_phrases: Option<Vec<String>>,
}

Fields

num_words: Option<f64>

This is the number of words that the customer has to say before the assistant will stop talking. Words like "stop", "actually", "no", etc. will always interrupt immediately regardless of this value. Words like "okay", "yeah", "right" will never interrupt. When set to 0, voiceSeconds is used in addition to the transcriptions to determine the customer has started speaking. Defaults to 0. @default 0

voice_seconds: Option<f64>

This is the seconds customer has to speak before the assistant stops talking. This uses the VAD (Voice Activity Detection) spike to determine if the customer has started speaking. Considerations: - A lower value might be more responsive but could potentially pick up non-speech sounds. - A higher value reduces false positives but might slightly delay the detection of speech onset. This is only used if numWords is set to 0. Defaults to 0.2 @default 0.2

backoff_seconds: Option<f64>

This is the seconds to wait before the assistant will start talking again after being interrupted. Defaults to 1. @default 1

acknowledgement_phrases: Option<Vec<String>>

These are the phrases that will never interrupt the assistant, even if numWords threshold is met. These are typically acknowledgement or backchanneling phrases.

interruption_phrases: Option<Vec<String>>

These are the phrases that will always interrupt the assistant immediately, regardless of numWords. These are typically phrases indicating disagreement or desire to stop.

Implementations

impl StopSpeakingPlan

pub fn new() -> StopSpeakingPlan

Trait Implementations

impl Clone for StopSpeakingPlan

fn clone(&self) -> StopSpeakingPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StopSpeakingPlan

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

Formats the value using the given formatter.

impl Default for StopSpeakingPlan

fn default() -> StopSpeakingPlan

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StopSpeakingPlan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StopSpeakingPlan

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

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 StopSpeakingPlan