Struct HumeVoice

pub struct HumeVoice {
    pub caching_enabled: Option<bool>,
    pub provider: ProviderTrue,
    pub model: Option<ModelTrue>,
    pub voice_id: String,
    pub is_custom_hume_voice: Option<bool>,
    pub chunk_plan: Option<ChunkPlan>,
    pub description: Option<String>,
    pub fallback_plan: Option<FallbackPlan>,
}

Fields

caching_enabled: Option<bool>

This is the flag to toggle voice caching for the assistant.

provider: ProviderTrue

This is the voice provider that will be used.

model: Option<ModelTrue>

This is the model that will be used.

voice_id: String

The ID of the particular voice you want to use.

is_custom_hume_voice: Option<bool>

Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.

chunk_plan: Option<ChunkPlan>

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

description: Option<String>

Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., ‘a soft, gentle voice with a strong British accent’). If a Voice is specified in the request, this description serves as acting instructions. If no Voice is specified, a new voice is generated based on this description.

fallback_plan: Option<FallbackPlan>

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

Implementations

impl HumeVoice

pub fn new(provider: ProviderTrue, voice_id: String) -> HumeVoice

Trait Implementations

impl Clone for HumeVoice

fn clone(&self) -> HumeVoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HumeVoice

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

Formats the value using the given formatter.

impl Default for HumeVoice

fn default() -> HumeVoice

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HumeVoice

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HumeVoice

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

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 HumeVoice