Language

VoiceAgentAudioOutputConfig Class

Definition

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.
public class VoiceAgentAudioOutputConfig : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.VoiceAgentAudioOutputConfig>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.VoiceAgentAudioOutputConfig>
type VoiceAgentAudioOutputConfig = class
    interface IJsonModel<VoiceAgentAudioOutputConfig>
    interface IPersistableModel<VoiceAgentAudioOutputConfig>
Public Class VoiceAgentAudioOutputConfig
Implements IJsonModel(Of VoiceAgentAudioOutputConfig), IPersistableModel(Of VoiceAgentAudioOutputConfig)
Inheritance
VoiceAgentAudioOutputConfig
Implements

Constructors

Name Description
VoiceAgentAudioOutputConfig()

Initializes a new instance of VoiceAgentAudioOutputConfig.

Properties

Name Description
CustomLexiconUrl

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

CustomTextNormalizationUrl

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

CustomVoiceEndpointId

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.

OutputAudioTimestampTypes

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

PersonalVoiceModel

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.

PreferLocales

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.

VoiceLocale

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

VoiceTemperature

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

VoiceType

The voice implementation.

Volume

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

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<VoiceAgentAudioOutputConfig>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<VoiceAgentAudioOutputConfig>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<VoiceAgentAudioOutputConfig>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<VoiceAgentAudioOutputConfig>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<VoiceAgentAudioOutputConfig>.Write(ModelReaderWriterOptions)

Applies to