FormatPlan

interface FormatPlan : FormatPlanProperties(source)

This is the format plan for the voice output. It controls how text is reformatted before being sent to the voice provider. Many things are reformatted including phone numbers, emails and addresses to improve their enunciation.
Default true because voice generation sounds better with reformatting.
To disable chunk reformatting, set enabled to false.

Properties

Link copied to clipboard
abstract var enabled: Boolean?

This determines whether the chunk is reformatted before being sent to the voice provider. Many things are reformatted including phone numbers, emails and addresses to improve their enunciation.
Default true because voice generation sounds better with reformatting.
To disable chunk reformatting, set this to false.

Link copied to clipboard
abstract var numberToDigitsCutoff: Int

This is the cutoff after which a number is converted to individual digits instead of being spoken as a whole number.
Example: if set to 2025, the number 2024 will be spoken as "twenty twenty-four" but 2026 will be spoken as "two zero two six".
Set to 0 to always convert to digits. Set to a very large number to never convert to digits.
Defaults to -1 (unset, uses Vapi default behavior).