Schema
Schema name: RealtimeClientEventInputAudioBufferCommit
json
{
"(resource) realtime > (model) input_audio_buffer_commit_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit",
"docstring": "Send this event to commit the user input audio buffer, which will create a new user message item in the conversation. This event will produce an error if the input audio buffer is empty. When in Server VAD mode, the client does not need to send this event, the server will commit the audio buffer automatically.\n\nCommitting the input audio buffer will trigger input audio transcription (if enabled in session configuration), but it will not create a response from the model. The server will respond with an `input_audio_buffer.committed` event.\n",
"ident": "InputAudioBufferCommitEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "event_id"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) input_audio_buffer_commit_event > (schema) > (property) type",
"(resource) realtime > (model) input_audio_buffer_commit_event > (schema) > (property) event_id"
]
},
"(resource) realtime > (model) input_audio_buffer_commit_event > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit/properties/type",
"deprecated": false,
"key": "type",
"docstring": "The event type, must be `input_audio_buffer.commit`.",
"type": {
"kind": "HttpTypeUnion",
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit/properties/type",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "input_audio_buffer.commit"
}
]
},
"optional": false,
"nullable": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) input_audio_buffer_commit_event > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) input_audio_buffer_commit_event > (schema) > (property) event_id": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit/properties/event_id",
"deprecated": false,
"key": "event_id",
"docstring": "Optional client-generated ID used to identify this event.",
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"maxLength": 512
},
"optional": true,
"nullable": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) input_audio_buffer_commit_event > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_audio_buffer.commit"
}
}
}