VoiceAgentAudioOutputConfig interface

Package:

@azure/ai-projects

Output audio configuration for a voice agent. Provider-specific fields are selected by voice_type:

• openai: voice and speed.
• azure-standard: voice, voice_locale, speed, voice_temperature, custom_lexicon_url, custom_text_normalization_url, prefer_locales, style, pitch, and volume.
• azure-custom: all azure-standard fields except style, plus custom_voice_endpoint_id.
• azure-personal: all azure-standard fields except style, plus personal_voice_model.
• avatar-voice-sync: all azure-standard fields except voice and style, plus personal_voice_model; the voice name is derived from the avatar.
• azure-realtime-native: voice and speed. format and output_audio_timestamp_types apply to every voice type.

Properties

custom_lexicon_url	The URL of a custom pronunciation lexicon. Applies to azure-standard, azure-custom, azure-personal, and avatar-voice-sync.
custom_text_normalization_url	The URL of a custom text-normalization configuration. Applies to azure-standard, azure-custom, azure-personal, and avatar-voice-sync.
custom_voice_endpoint_id	The Azure custom-voice deployment endpoint identifier. Applies only when voice_type is azure-custom.
format	The output audio format. Applies to every voice_type and defaults to 24 kHz PCM.
output_audio_timestamp_types	Timestamp kinds to include with output audio. Applies to every voice_type.
personal_voice_model	The Azure personal or avatar voice model. Applies only when voice_type is azure-personal or avatar-voice-sync.
pitch	The voice pitch adjustment. Applies to azure-standard, azure-custom, azure-personal, and avatar-voice-sync.
prefer_locales	Preferred BCP-47 locales for multilingual synthesis. Applies to azure-standard, azure-custom, azure-personal, and avatar-voice-sync.
speed	The numeric output speed multiplier. Applies to all known voice_type values and defaults to 1.
style	The voice speaking style. Applies only when voice_type is azure-standard.
voice	The voice name or identifier. Applies to openai, azure-standard, azure-custom, azure-personal, and azure-realtime-native. It does not apply to avatar-voice-sync, which derives the voice name from the avatar.
voice_locale	The enforced BCP-47 output locale. Applies to azure-standard, azure-custom, azure-personal, and avatar-voice-sync.
voice_temperature	The voice variation temperature. Applies to azure-standard, azure-custom, azure-personal, and avatar-voice-sync.
voice_type	The voice implementation.
volume	The voice volume adjustment. Applies to azure-standard, azure-custom, azure-personal, and avatar-voice-sync.

Property Details

custom_lexicon_url

The URL of a custom pronunciation lexicon. Applies to azure-standard, azure-custom, azure-personal, and avatar-voice-sync.

custom_lexicon_url?: string

Property Value

string

custom_text_normalization_url

The URL of a custom text-normalization configuration. Applies to azure-standard, azure-custom, azure-personal, and avatar-voice-sync.

custom_text_normalization_url?: string

Property Value

string

custom_voice_endpoint_id

The Azure custom-voice deployment endpoint identifier. Applies only when voice_type is azure-custom.

custom_voice_endpoint_id?: string

Property Value

string

format

The output audio format. Applies to every voice_type and defaults to 24 kHz PCM.

format?: RealtimeAudioFormatsUnion

Property Value

RealtimeAudioFormatsUnion

output_audio_timestamp_types

Timestamp kinds to include with output audio. Applies to every voice_type.

output_audio_timestamp_types?: "word"[]

Property Value

"word"[]

personal_voice_model

The Azure personal or avatar voice model. Applies only when voice_type is azure-personal or avatar-voice-sync.

personal_voice_model?: string

Property Value

string

pitch

The voice pitch adjustment. Applies to azure-standard, azure-custom, azure-personal, and avatar-voice-sync.

pitch?: string

Property Value

string

prefer_locales

Preferred BCP-47 locales for multilingual synthesis. Applies to azure-standard, azure-custom, azure-personal, and avatar-voice-sync.

prefer_locales?: string[]

Property Value

string[]

speed

The numeric output speed multiplier. Applies to all known voice_type values and defaults to 1.

speed?: number

Property Value

number

style

The voice speaking style. Applies only when voice_type is azure-standard.

style?: string

Property Value

string

voice

The voice name or identifier. Applies to openai, azure-standard, azure-custom, azure-personal, and azure-realtime-native. It does not apply to avatar-voice-sync, which derives the voice name from the avatar.

voice?: string

Property Value

string

voice_locale

The enforced BCP-47 output locale. Applies to azure-standard, azure-custom, azure-personal, and avatar-voice-sync.

voice_locale?: string

Property Value

string

voice_temperature

The voice variation temperature. Applies to azure-standard, azure-custom, azure-personal, and avatar-voice-sync.

voice_temperature?: number

Property Value

number

voice_type

The voice implementation.

voice_type?: VoiceType

Property Value

VoiceType

volume

The voice volume adjustment. Applies to azure-standard, azure-custom, azure-personal, and avatar-voice-sync.

volume?: string

Property Value

string