Schema
Schema name: RealtimeServerEventResponseAudioDone
json
{
"(resource) realtime > (model) response_audio_done_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone",
"docstring": "Returned when the model-generated audio is done. Also emitted when a Response\nis interrupted, incomplete, or cancelled.\n",
"ident": "ResponseAudioDoneEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "content_index"
},
{
"ident": "event_id"
},
{
"ident": "item_id"
},
{
"ident": "output_index"
},
{
"ident": "response_id"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) response_audio_done_event > (schema) > (property) content_index",
"(resource) realtime > (model) response_audio_done_event > (schema) > (property) event_id",
"(resource) realtime > (model) response_audio_done_event > (schema) > (property) item_id",
"(resource) realtime > (model) response_audio_done_event > (schema) > (property) output_index",
"(resource) realtime > (model) response_audio_done_event > (schema) > (property) response_id",
"(resource) realtime > (model) response_audio_done_event > (schema) > (property) type"
]
},
"(resource) realtime > (model) response_audio_done_event > (schema) > (property) content_index": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/content_index",
"deprecated": false,
"key": "content_index",
"docstring": "The index of the content part in the item's content array.",
"type": {
"kind": "HttpTypeNumber"
},
"optional": false,
"nullable": false,
"schemaType": "integer",
"children": []
},
"(resource) realtime > (model) response_audio_done_event > (schema) > (property) event_id": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/event_id",
"deprecated": false,
"key": "event_id",
"docstring": "The unique ID of the server event.",
"type": {
"kind": "HttpTypeString"
},
"optional": false,
"nullable": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) response_audio_done_event > (schema) > (property) item_id": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/item_id",
"deprecated": false,
"key": "item_id",
"docstring": "The ID of the item.",
"type": {
"kind": "HttpTypeString"
},
"optional": false,
"nullable": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) response_audio_done_event > (schema) > (property) output_index": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/output_index",
"deprecated": false,
"key": "output_index",
"docstring": "The index of the output item in the response.",
"type": {
"kind": "HttpTypeNumber"
},
"optional": false,
"nullable": false,
"schemaType": "integer",
"children": []
},
"(resource) realtime > (model) response_audio_done_event > (schema) > (property) response_id": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/response_id",
"deprecated": false,
"key": "response_id",
"docstring": "The ID of the response.",
"type": {
"kind": "HttpTypeString"
},
"optional": false,
"nullable": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) response_audio_done_event > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/type",
"deprecated": false,
"key": "type",
"docstring": "The event type, must be `response.output_audio.done`.",
"type": {
"kind": "HttpTypeUnion",
"oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/type",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "response.output_audio.done"
}
]
},
"optional": false,
"nullable": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) response_audio_done_event > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) response_audio_done_event > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "response.output_audio.done"
}
}
}