VoiceAgentSessionResponseConfig Class

The effective stable realtime session settings returned by the voice-agent service.

Constructor

VoiceAgentSessionResponseConfig(*args: Any, **kwargs: Any)

Variables

Name	Description
type	str The session type. Always `realtime`. Required. Default value is "realtime".
instructions	str Instructions applied throughout the session.
temperature	float The sampling temperature for compatible cascaded pipelines.
max_output_tokens	int or str The maximum output-token count for one response. Is either a int type or a Literal["inf"] type.
output_modalities	list[str or VoiceOutputModality] The output modalities enabled for the session.
audio	VoiceAgentAudioConfig The input- and output-audio settings for the session.
avatar	VoiceAgentSessionAvatarConfig The avatar settings for the session.
animation	VoiceAgentAnimationConfig Animation settings for the session.
tools	list[VoiceAgentTool] Tools available to the session.
tool_choice	str or str or str or ToolChoiceFunction or ToolChoiceMCP Tool-selection behavior for the session. Is one of the following types: Literal["none"], Literal["auto"], Literal["required"], ToolChoiceFunction, ToolChoiceMCP
reasoning	RealtimeReasoning Reasoning settings for compatible realtime models.
parallel_tool_calls	bool Whether the model may call multiple tools in parallel.
include	list[str or VoiceAgentSessionIncludeOption] Additional fields to include in service outputs.
metadata	dict[str, str] Up to 16 string key-value pairs attached to the session.
interim_response	VoiceAgentInterimResponseConfig Interim-response settings for latency and tool execution.
greeting	VoiceAgentGreetingConfig A proactive assistant greeting started after session configuration.
object	str The object type. Always `realtime.session`. Required. Default value is "realtime.session".
id	str The session identifier. Required.
model	str The selected model. Required.
expires_at	datetime The session expiration time as a Unix timestamp in seconds.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from the dictionary.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.
setdefault	Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any
update	Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from the dictionary.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on the mapping's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

popitem() -> tuple[str, Any]

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on the mapping's values

Attributes

animation

Animation settings for the session.

animation: _models.VoiceAgentAnimationConfig | None

audio

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

audio: _models.VoiceAgentAudioConfig | None

avatar

The avatar settings for the session.

avatar: _models.VoiceAgentSessionAvatarConfig | None

expires_at

The session expiration time as a Unix timestamp in seconds.

expires_at: datetime | None

greeting

A proactive assistant greeting started after session configuration.

greeting: _models.VoiceAgentGreetingConfig | None

id

The session identifier. Required.

id: str

include

Additional fields to include in service outputs.

include: list[typing.Union[str, ForwardRef('_models.VoiceAgentSessionIncludeOption')]] | None

instructions

Instructions applied throughout the session.

instructions: str | None

interim_response

Interim-response settings for latency and tool execution.

interim_response: _models.VoiceAgentInterimResponseConfig | None

max_output_tokens

The maximum output-token count for one response. Is either a int type or a Literal["inf"] type.

max_output_tokens: _unions.VoiceAgentMaxOutputTokens | None

metadata

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

metadata: dict[str, str] | None

model

The selected model. Required.

model: str

object

The object type. Always realtime.session. Required. Default value is "realtime.session".

object: Literal['realtime.session']

output_modalities

The output modalities enabled for the session.

output_modalities: list[typing.Union[str, ForwardRef('_models.VoiceOutputModality')]] | None

parallel_tool_calls

Whether the model may call multiple tools in parallel.

parallel_tool_calls: bool | None

reasoning

Reasoning settings for compatible realtime models.

reasoning: _models.RealtimeReasoning | None

temperature

The sampling temperature for compatible cascaded pipelines.

temperature: float | None

tool_choice

Literal["none"], Literal["auto"], Literal["required"], ToolChoiceFunction, ToolChoiceMCP

tool_choice: _unions.VoiceAgentToolChoice | None

tools

Tools available to the session.

tools: list['_models.VoiceAgentTool'] | None

type

The session type. Always realtime. Required. Default value is "realtime".

type: Literal['realtime']

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?