Struct MessagePlan

pub struct MessagePlan {
    pub idle_messages: Option<Vec<String>>,
    pub idle_message_max_spoken_count: Option<f64>,
    pub idle_message_reset_count_on_user_speech_enabled: Option<bool>,
    pub idle_timeout_seconds: Option<f64>,
    pub silence_timeout_message: Option<String>,
}

Fields

idle_messages: Option<Vec<String>>

This are the messages that the assistant will speak when the user hasn’t responded for idleTimeoutSeconds. Each time the timeout is triggered, a random message will be chosen from this array. Usage: - If user gets distracted and doesn’t respond for a while, this can be used to grab their attention. - If the transcriber doesn’t pick up what the user said, this can be used to ask the user to repeat themselves. (From the perspective of the assistant, the conversation is idle since it didn’t "hear" any user messages.) @default null (no idle message is spoken)

idle_message_max_spoken_count: Option<f64>

This determines the maximum number of times idleMessages can be spoken during the call. @default 3

idle_message_reset_count_on_user_speech_enabled: Option<bool>

This determines whether the idle message count is reset whenever the user speaks. @default false

idle_timeout_seconds: Option<f64>

This is the timeout in seconds before a message from idleMessages is spoken. The clock starts when the assistant finishes speaking and remains active until the user speaks. @default 10

silence_timeout_message: Option<String>

This is the message that the assistant will say if the call ends due to silence. If unspecified, it will hang up without saying anything.

Implementations

impl MessagePlan

pub fn new() -> MessagePlan

Trait Implementations

impl Clone for MessagePlan

fn clone(&self) -> MessagePlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessagePlan

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

Formats the value using the given formatter.

impl Default for MessagePlan

fn default() -> MessagePlan

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MessagePlan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MessagePlan

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

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 MessagePlan