VoiceResponseBase interface
Properties shared by persisted voice responses.
Properties
| max_output_tokens | Maximum number of output tokens for a single assistant response, inclusive of tool calls, that was used in this response. |
| object | The object type, must be |
| output_modalities | The set of modalities the model used to respond, currently the only possible values are
|
| status | The final status of the response ( |
| status_details | Additional details about the status. |
| usage | Usage statistics for the Response, this will correspond to billing. A Realtime 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. |
Property Details
max_output_tokens
Maximum number of output tokens for a single assistant response, inclusive of tool calls, that was used in this response.
max_output_tokens?: number | "inf"Property Value
number | "inf"
object
The object type, must be realtime.response.
object?: "realtime.response"Property Value
"realtime.response"
output_modalities
The set of modalities the model used to respond, currently the only possible values are
[\"audio\"], [\"text\"]. Audio output always include a text transcript. Setting the
output to mode text will disable audio output from the model.
output_modalities?: ("text" | "audio")[]Property Value
("text" | "audio")[]
status
The final status of the response (completed, cancelled, failed, or
incomplete, in_progress).
status?: "failed" | "in_progress" | "cancelled" | "completed" | "incomplete"Property Value
"failed" | "in_progress" | "cancelled" | "completed" | "incomplete"
status_details
Additional details about the status.
status_details?: RealtimeResponseStatusDetailsProperty Value
usage
Usage statistics for the Response, this will correspond to billing. A Realtime 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?: RealtimeResponseUsage