Response Class

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

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

Keyword-Only Parameters

Returns

Remove all items from D.

clear() -> None

copy() -> Model

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: D[k] if k in D, else d. :rtype: any

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

Parameters

items() -> ItemsView[str, Any]

Returns

keys() -> KeysView[str]

Returns

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

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

popitem() -> tuple[str, Any]

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

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

Parameters

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

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

values() -> ValuesView[Any]

Returns

Which conversation the response is added to, determined by the conversation field in the response.create event. If auto, the response will be added to the default conversation and the value of conversation_id will be an id like conv_1234. If none, the response will not be added to any conversation and the value of conversation_id will be null. If responses are being triggered by server VAD, the response will be added to the default conversation, thus the conversation_id will be an id like conv_1234.

conversation_id: str | None

The unique ID of the response.

id: str | None

Maximum number of output tokens for a single assistant response, inclusive of tool calls, that was used in this response. Is either a int type or a Literal["inf"] type.

max_output_tokens: int | Literal['inf'] | None

The set of modalities the model used to respond. If there are multiple modalities, the model will pick one, for example if modalities is ["text", "audio"], the model could be responding in either text or audio.

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

The object type, must be realtime.response. Default value is "realtime.response".

object: Literal['realtime.response'] | None

The list of output items generated by the response.

output: list['_models.ResponseItem'] | None

The format of output audio. Options are pcm16, g711_ulaw, or g711_alaw. Known values are: "pcm16", "pcm16-8000hz", "pcm16-16000hz", "g711_ulaw", and "g711_alaw".

output_audio_format: str | _models.OutputAudioFormat | None

The final status of the response. One of: completed, cancelled, failed, incomplete, or in_progress. Known values are: "completed", "cancelled", "failed", "incomplete", and "in_progress".

status: str | _models.ResponseStatus | None

Additional details about the status.

status_details: _models.ResponseStatusDetails | None

Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.

temperature: float | None

Usage statistics for the Response, this will correspond to billing. A VoiceLive API session will maintain a conversation context and append new Items to the Conversation, thus output from previous turns (text and audio tokens) will become the input for later turns.

usage: _models.TokenUsage | None

Union[str, "_models.OpenAIVoiceName"], OpenAIVoice, AzureVoice

voice: _types.Voice | None