Class InputAudioBufferCommittedEvent
-
- All Implemented Interfaces:
public final class InputAudioBufferCommittedEventReturned when an input audio buffer is committed, either by the client or automatically in server VAD mode. The
item_idproperty is the ID of the user message item that will be created, thus aconversation.item.createdevent will also be sent to the client.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classInputAudioBufferCommittedEvent.BuilderA builder for InputAudioBufferCommittedEvent.
-
Method Summary
Modifier and Type Method Description final StringeventId()The unique ID of the server event. final StringitemId()The ID of the user message item that will be created. final JsonValue_type()The event type, must be input_audio_buffer.committed.final Optional<String>previousItemId()The ID of the preceding item after which the new item will be inserted. 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.BuildertoBuilder()final InputAudioBufferCommittedEventvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static InputAudioBufferCommittedEvent.Builderbuilder()Returns a mutable builder for constructing an instance of InputAudioBufferCommittedEvent. -
-
Method Detail
-
_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).
-
previousItemId
final Optional<String> previousItemId()
The ID of the preceding item after which the new item will be inserted. Can be
nullif the item has no predecessor.
-
_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()
-
-
-
-