VoiceAgentAvatarConfig interface

Package:

@azure/ai-projects

Avatar configuration for a voice agent. These values are session defaults and may be overridden when connecting.

Properties

character	The avatar character identifier, e.g. 'lisa'.
customized	Whether the avatar is a customer-customized avatar. Defaults to false.
model	The avatar model identifier.
output_audit_audio	Whether audit audio is emitted with avatar output. Defaults to false.
output_protocol	The transport used to deliver the avatar video stream.
scene	Avatar placement and motion settings.
style	The avatar style, e.g. 'casual-sitting'.
type	The avatar type.
video	Avatar video encoder and presentation settings.

Property Details

character

The avatar character identifier, e.g. 'lisa'.

character: string

Property Value

string

customized

Whether the avatar is a customer-customized avatar. Defaults to false.

customized?: boolean

Property Value

boolean

model

The avatar model identifier.

model?: string

Property Value

string

output_audit_audio

Whether audit audio is emitted with avatar output. Defaults to false.

output_audit_audio?: boolean

Property Value

boolean

output_protocol

The transport used to deliver the avatar video stream.

output_protocol?: VoiceAgentAvatarOutputProtocol

Property Value

VoiceAgentAvatarOutputProtocol

scene

Avatar placement and motion settings.

scene?: VoiceAgentAvatarScene

Property Value

VoiceAgentAvatarScene

style

The avatar style, e.g. 'casual-sitting'.

style?: string

Property Value

string

type

The avatar type.

type: VoiceAgentAvatarType

Property Value

VoiceAgentAvatarType

video

Avatar video encoder and presentation settings.

video?: VoiceAgentAvatarVideoParams

Property Value

VoiceAgentAvatarVideoParams