Class ConversationItemRetrieveEvent
-
- All Implemented Interfaces:
public final class ConversationItemRetrieveEventSend this event when you want to retrieve the server's representation of a specific item in the conversation history. This is useful, for example, to inspect user audio after noise cancellation and VAD. The server will respond with a
conversation.item.retrievedevent, unless the item does not exist in the conversation history, in which case the server will respond with an error.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classConversationItemRetrieveEvent.BuilderA builder for ConversationItemRetrieveEvent.
-
Method Summary
Modifier and Type Method Description final StringitemId()The ID of the item to retrieve. final JsonValue_type()The event type, must be conversation.item.retrieve.final Optional<String>eventId()Optional client-generated ID used to identify this event. final JsonField<String>_itemId()Returns the raw JSON value of itemId. final JsonField<String>_eventId()Returns the raw JSON value of eventId. final Map<String, JsonValue>_additionalProperties()final ConversationItemRetrieveEvent.BuildertoBuilder()final ConversationItemRetrieveEventvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ConversationItemRetrieveEvent.Builderbuilder()Returns a mutable builder for constructing an instance of ConversationItemRetrieveEvent. -
-
Method Detail
-
_type
final JsonValue _type()
The event type, must be
conversation.item.retrieve.Expected to always return the following:
JsonValue.from("conversation.item.retrieve")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_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.
-
_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 ConversationItemRetrieveEvent.Builder toBuilder()
-
validate
final ConversationItemRetrieveEvent validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static ConversationItemRetrieveEvent.Builder builder()
Returns a mutable builder for constructing an instance of ConversationItemRetrieveEvent.
The following fields are required:
.itemId()
-
-
-
-