Class InputAudioBufferCommitEvent
-
- All Implemented Interfaces:
public final class InputAudioBufferCommitEvent
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.
Committing 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
InputAudioBufferCommitEvent.Builder
A builder for InputAudioBufferCommitEvent.
-
Method Summary
Modifier and Type Method Description final JsonValue
_type()
The event type, must be input_audio_buffer.commit
.final Optional<String>
eventId()
Optional client-generated ID used to identify this event. final JsonField<String>
_eventId()
Returns the raw JSON value of eventId. final Map<String, JsonValue>
_additionalProperties()
final InputAudioBufferCommitEvent.Builder
toBuilder()
final InputAudioBufferCommitEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static InputAudioBufferCommitEvent.Builder
builder()
Returns a mutable builder for constructing an instance of InputAudioBufferCommitEvent. -
-
Method Detail
-
_type
final JsonValue _type()
The event type, must be
input_audio_buffer.commit
.Expected to always return the following:
JsonValue.from("input_audio_buffer.commit")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_eventId
final JsonField<String> _eventId()
Returns the raw JSON value of eventId.
Unlike eventId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final InputAudioBufferCommitEvent.Builder toBuilder()
-
validate
final InputAudioBufferCommitEvent validate()
-
builder
final static InputAudioBufferCommitEvent.Builder builder()
Returns a mutable builder for constructing an instance of InputAudioBufferCommitEvent.
-
-
-
-