Class InputAudioBufferCommittedEvent
-
- All Implemented Interfaces:
public final class InputAudioBufferCommittedEvent
Returned when an input audio buffer is committed, either by the client or automatically in server VAD mode. The
item_id
property is the ID of the user message item that will be created, thus aconversation.item.created
event will also be sent to the client.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
InputAudioBufferCommittedEvent.Builder
A builder for InputAudioBufferCommittedEvent.
-
Method Summary
Modifier and Type Method Description final String
eventId()
The unique ID of the server event. final String
itemId()
The ID of the user message item that will be created. final String
previousItemId()
The ID of the preceding item after which the new item will be inserted. final JsonValue
_type()
The event type, must be input_audio_buffer.committed
.final JsonField<String>
_eventId()
Returns the raw JSON value of eventId. final JsonField<String>
_itemId()
Returns the raw JSON value of itemId. final JsonField<String>
_previousItemId()
Returns the raw JSON value of previousItemId. final Map<String, JsonValue>
_additionalProperties()
final InputAudioBufferCommittedEvent.Builder
toBuilder()
final InputAudioBufferCommittedEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static InputAudioBufferCommittedEvent.Builder
builder()
Returns a mutable builder for constructing an instance of InputAudioBufferCommittedEvent. -
-
Method Detail
-
previousItemId
final String previousItemId()
The ID of the preceding item after which the new item will be inserted.
-
_type
final JsonValue _type()
The event type, must be
input_audio_buffer.committed
.Expected to always return the following:
JsonValue.from("input_audio_buffer.committed")
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.
-
_itemId
final JsonField<String> _itemId()
Returns the raw JSON value of itemId.
Unlike itemId, this method doesn't throw if the JSON field has an unexpected type.
-
_previousItemId
final JsonField<String> _previousItemId()
Returns the raw JSON value of previousItemId.
Unlike previousItemId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final InputAudioBufferCommittedEvent.Builder toBuilder()
-
validate
final InputAudioBufferCommittedEvent validate()
-
builder
final static InputAudioBufferCommittedEvent.Builder builder()
Returns a mutable builder for constructing an instance of InputAudioBufferCommittedEvent.
The following fields are required:
.eventId() .itemId() .previousItemId()
-
-
-
-