VoiceAgentSessionUpdateConfig interface

Package:

@azure/ai-projects

The stable realtime session settings accepted in a session.update client event.

Properties

animation	Animation settings for the session.
audio	The input- and output-audio settings for the session.
avatar	The avatar settings for the session.
greeting	A proactive assistant greeting started after session configuration.
include	Additional fields to include in service outputs.
instructions	Instructions applied throughout the session.
interim_response	Interim-response settings for latency and tool execution.
max_output_tokens	The maximum output-token count for one response.
metadata	Up to 16 string key-value pairs attached to the session.
output_modalities	The output modalities enabled for the session.
parallel_tool_calls	Whether the model may call multiple tools in parallel.
reasoning	Reasoning settings for compatible realtime models.
temperature	The sampling temperature for compatible cascaded pipelines.
tools	Tools available to the session.
tool_choice	Tool-selection behavior for the session.
type	The session type. Always realtime.

Property Details

animation

Animation settings for the session.

animation?: VoiceAgentAnimationConfig

Property Value

VoiceAgentAnimationConfig

audio

The input- and output-audio settings for the session.

audio?: VoiceAgentAudioConfig

Property Value

VoiceAgentAudioConfig

avatar

The avatar settings for the session.

avatar?: VoiceAgentSessionAvatarConfig

Property Value

VoiceAgentSessionAvatarConfig

greeting

A proactive assistant greeting started after session configuration.

greeting?: VoiceAgentGreetingConfigUnion

Property Value

VoiceAgentGreetingConfigUnion

include

Additional fields to include in service outputs.

include?: VoiceAgentSessionIncludeOption[]

Property Value

VoiceAgentSessionIncludeOption[]

instructions

Instructions applied throughout the session.

instructions?: string

Property Value

string

interim_response

Interim-response settings for latency and tool execution.

interim_response?: VoiceAgentInterimResponseConfigUnion

Property Value

VoiceAgentInterimResponseConfigUnion

max_output_tokens

The maximum output-token count for one response.

max_output_tokens?: VoiceAgentMaxOutputTokens

Property Value

VoiceAgentMaxOutputTokens

metadata

Up to 16 string key-value pairs attached to the session.

metadata?: Record<string, string>

Property Value

Record<string, string>

output_modalities

The output modalities enabled for the session.

output_modalities?: VoiceOutputModality[]

Property Value

VoiceOutputModality[]

parallel_tool_calls

Whether the model may call multiple tools in parallel.

parallel_tool_calls?: boolean

Property Value

boolean

reasoning

Reasoning settings for compatible realtime models.

reasoning?: RealtimeReasoning

Property Value

RealtimeReasoning

temperature

The sampling temperature for compatible cascaded pipelines.

temperature?: number

Property Value

number

tools

Tools available to the session.

tools?: VoiceAgentToolUnion[]

Property Value

VoiceAgentToolUnion[]

tool_choice

Tool-selection behavior for the session.

tool_choice?: VoiceAgentToolChoice

Property Value

VoiceAgentToolChoice

type

The session type. Always realtime.

type: "realtime"

Property Value

"realtime"