Skip to main content

Voice & Language Configuration

Voice and language configurations define supported voices and languages for text-to-speech synthesis and speech-to-text recognition. Referenced by support models and provisioning chains.

Source: src/core/service-configuration/voice-language.schema.ts


Voice​

Synthetic voice options for text-to-speech (TTS) synthesis.

Schema: VoiceSchema

Attributes​

AttributeTypeRequiredDefaultDescription
voiceIdstringYes—Unique identifier for the voice
namestringYes—Human-readable name
descriptionstringYes—Voice characteristics description
genderenumYes—Gender classification. One of male, female, or neutral.
languagestring | nullNo—Optimal language code (e.g., 'en-US')
isDefaultbooleanNofalseWhether this is the default voice

Language​

Language configuration for speech processing.

Schema: LanguageSchema

Attributes​

AttributeTypeRequiredDefaultDescription
languageIdstringYes—Unique identifier (e.g., 'en-us')
namestringYes—Human-readable name with region
codestringYes—ISO 639-1 code with region (e.g., 'en-US')
isDefaultbooleanNofalseWhether this is the platform default
isExperimentalbooleanNofalseWhether in experimental support

Example​

Voice​

{
"voiceId": "adam",
"name": "Adam",
"description": "Deep, authoritative male voice suitable for professional announcements",
"gender": "male",
"language": "en-US",
"isDefault": true
}

Language​

{
"languageId": "en-us",
"name": "English (United States)",
"code": "en-US",
"isDefault": true,
"isExperimental": false
}

Helper Functions​

FunctionDescription
validateSupportedVoices(voices)Validates array of voices
isValidVoice(voice)Type guard for Voice validation