Struct FormatPlan

pub struct FormatPlan {
    pub enabled: Option<bool>,
    pub number_to_digits_cutoff: Option<f64>,
    pub replacements: Option<Vec<FormatPlanReplacementsInner>>,
    pub formatters_enabled: Option<Vec<FormattersEnabledTrue>>,
}

Fields

enabled: Option<bool>

This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default true. Usage: - To rely on the voice provider’s formatting logic, set this to false. If voice.chunkPlan.enabled is false, this is automatically false since there’s no chunk to format. @default true

number_to_digits_cutoff: Option<f64>

This is the cutoff after which a number is converted to individual digits instead of being spoken as words. Example: - If cutoff 2025, "12345" is converted to "1 2 3 4 5" while "1200" is converted to "twelve hundred". Usage: - If your use case doesn’t involve IDs like zip codes, set this to a high value. - If your use case involves IDs that are shorter than 5 digits, set this to a lower value. @default 2025

replacements: Option<Vec<FormatPlanReplacementsInner>>

These are the custom replacements you can make to the chunk before it is sent to the voice provider. Usage: - To replace a specific word or phrase with a different word or phrase, use the ExactReplacement type. Eg. { type: 'exact', key: 'hello', value: 'hi' } - To replace a word or phrase that matches a pattern, use the RegexReplacement type. Eg. { type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' } @default []

formatters_enabled: Option<Vec<FormattersEnabledTrue>>

List of formatters to apply. If not provided, all default formatters will be applied. If provided, only the specified formatters will be applied. Note: Some essential formatters like angle bracket removal will always be applied. @default undefined

Implementations

impl FormatPlan

pub fn new() -> FormatPlan

Trait Implementations

impl Clone for FormatPlan

fn clone(&self) -> FormatPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormatPlan

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

Formats the value using the given formatter.

impl Default for FormatPlan

fn default() -> FormatPlan

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FormatPlan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FormatPlan

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

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 FormatPlan