Struct TavusVoice

pub struct TavusVoice {
    pub provider: Provider,
    pub voice_id: TavusVoiceVoiceId,
    pub chunk_plan: Option<ChunkPlan>,
    pub persona_id: Option<String>,
    pub callback_url: Option<String>,
    pub conversation_name: Option<String>,
    pub conversational_context: Option<String>,
    pub custom_greeting: Option<String>,
    pub properties: Option<TavusConversationProperties>,
    pub fallback_plan: Option<FallbackPlan>,
}

Fields

provider: Provider

This is the voice provider that will be used.

voice_id: TavusVoiceVoiceId

chunk_plan: Option<ChunkPlan>

This is the plan for chunking the model output before it is sent to the voice provider.

persona_id: Option<String>

This is the unique identifier for the persona that the replica will use in the conversation.

callback_url: Option<String>

This is the url that will receive webhooks with updates regarding the conversation state.

conversation_name: Option<String>

This is the name for the conversation.

conversational_context: Option<String>

This is the context that will be appended to any context provided in the persona, if one is provided.

custom_greeting: Option<String>

This is the custom greeting that the replica will give once a participant joines the conversation.

properties: Option<TavusConversationProperties>

These are optional properties used to customize the conversation.

fallback_plan: Option<FallbackPlan>

This is the plan for voice provider fallbacks in the event that the primary voice provider fails.

Implementations

impl TavusVoice

pub fn new(provider: Provider, voice_id: TavusVoiceVoiceId) -> TavusVoice

Trait Implementations

impl Clone for TavusVoice

fn clone(&self) -> TavusVoice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TavusVoice

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

Formats the value using the given formatter.

impl Default for TavusVoice

fn default() -> TavusVoice

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TavusVoice

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TavusVoice

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

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 TavusVoice