Struct ChunkPlan

pub struct ChunkPlan {
    pub enabled: Option<bool>,
    pub min_characters: Option<f64>,
    pub punctuation_boundaries: Option<Vec<PunctuationBoundaries>>,
    pub format_plan: Option<Box<FormatPlan>>,
}

Fields

enabled: Option<bool>

This determines whether the model output is chunked before being sent to the voice provider. Default true. Usage: - To rely on the voice provider’s audio generation logic, set this to false. - If seeing issues with quality, set this to true. If disabled, Vapi-provided audio control tokens like will not work. @default true

min_characters: Option<f64>

This is the minimum number of characters in a chunk. Usage: - To increase quality, set this to a higher value. - To decrease latency, set this to a lower value. @default 30

punctuation_boundaries: Option<Vec<PunctuationBoundaries>>

These are the punctuations that are considered valid boundaries for a chunk to be created. Usage: - To increase quality, constrain to fewer boundaries. - To decrease latency, enable all. Default is automatically set to balance the trade-off between quality and latency based on the provider.

format_plan: Option<Box<FormatPlan>>

This is the plan for formatting the chunk before it is sent to the voice provider.

Implementations

impl ChunkPlan

pub fn new() -> ChunkPlan

Trait Implementations

impl Clone for ChunkPlan

fn clone(&self) -> ChunkPlan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChunkPlan

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

Formats the value using the given formatter.

impl Default for ChunkPlan

fn default() -> ChunkPlan

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChunkPlan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChunkPlan

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

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 ChunkPlan