ResponseSession interface
Base for session configuration in the response.
Properties
| agent | The agent configuration for the session, if applicable. |
| animation | The animation configuration for the session. |
| avatar | Configuration for avatar streaming and behavior during the session. |
| id | The unique identifier for the session. |
| include | List of include options for the session (e.g., logprobs, phrases, file search results). |
| input |
Configuration for echo cancellation during server-side audio processing. |
| input |
Input audio format. Default is 'pcm16'. |
| input |
Configuration for input audio noise reduction. |
| input |
Input audio sampling rate in Hz. Available values:
|
| input |
Configuration for input audio transcription. |
| instructions | Optional instructions to guide the model's behavior throughout the session. |
| interim |
Configuration for interim response generation during latency or tool calls. |
| max |
Maximum number of tokens to generate in the response. Default is unlimited. |
| metadata | Set of up to 16 key-value pairs that can be attached to the session. This is useful for storing additional information about the session in a structured format, such as tracking IDs, user context, or application-specific labels. These key-value pairs are also included in Foundry resource logs for tracing and diagnostics. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. |
| modalities | The modalities to be used in the session. |
| model | The model for the session. |
| output |
Output audio format. Default is 'pcm16'. |
| output |
Types of timestamps to include in audio response content. |
| reasoning |
Constrains effort on reasoning for reasoning models. Check model documentation for supported values for each model. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. |
| temperature | Controls the randomness of the model's output. Range: 0.0 to 1.0. Default is 0.7. |
| tool |
Specifies which tools the model is allowed to call during the session. |
| tools | Configuration for tools to be used during the session, if applicable. |
| turn |
Type of turn detection to use. |
| voice | The voice configuration for the session. |
Property Details
agent
The agent configuration for the session, if applicable.
agent?: AgentConfigProperty Value
animation
avatar
Configuration for avatar streaming and behavior during the session.
avatar?: AvatarConfigProperty Value
id
The unique identifier for the session.
id?: stringProperty Value
string
include
List of include options for the session (e.g., logprobs, phrases, file search results).
include?: string[]Property Value
string[]
inputAudioEchoCancellation
Configuration for echo cancellation during server-side audio processing.
inputAudioEchoCancellation?: AudioEchoCancellationProperty Value
inputAudioFormat
Input audio format. Default is 'pcm16'.
inputAudioFormat?: stringProperty Value
string
inputAudioNoiseReduction
Configuration for input audio noise reduction.
inputAudioNoiseReduction?: AudioNoiseReductionProperty Value
inputAudioSamplingRate
Input audio sampling rate in Hz. Available values:
For pcm16: 8000, 16000, 24000
For g711_alaw/g711_ulaw: 8000
inputAudioSamplingRate?: numberProperty Value
number
inputAudioTranscription
Configuration for input audio transcription.
inputAudioTranscription?: AudioInputTranscriptionOptionsProperty Value
instructions
Optional instructions to guide the model's behavior throughout the session.
instructions?: stringProperty Value
string
interimResponse
Configuration for interim response generation during latency or tool calls.
interimResponse?: InterimResponseConfigProperty Value
maxResponseOutputTokens
Maximum number of tokens to generate in the response. Default is unlimited.
maxResponseOutputTokens?: number | "inf"Property Value
number | "inf"
metadata
Set of up to 16 key-value pairs that can be attached to the session. This is useful for storing additional information about the session in a structured format, such as tracking IDs, user context, or application-specific labels. These key-value pairs are also included in Foundry resource logs for tracing and diagnostics. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.
metadata?: Record<string, string>Property Value
Record<string, string>
modalities
The modalities to be used in the session.
modalities?: string[]Property Value
string[]
model
The model for the session.
model?: stringProperty Value
string
outputAudioFormat
Output audio format. Default is 'pcm16'.
outputAudioFormat?: stringProperty Value
string
outputAudioTimestampTypes
Types of timestamps to include in audio response content.
outputAudioTimestampTypes?: string[]Property Value
string[]
reasoningEffort
Constrains effort on reasoning for reasoning models. Check model documentation for supported values for each model. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
reasoningEffort?: stringProperty Value
string
temperature
Controls the randomness of the model's output. Range: 0.0 to 1.0. Default is 0.7.
temperature?: numberProperty Value
number
toolChoice
Specifies which tools the model is allowed to call during the session.
toolChoice?: ToolChoiceProperty Value
tools
Configuration for tools to be used during the session, if applicable.
tools?: ToolUnion[]