Class RealtimeServerEvent.ConversationItemRetrieved
-
- All Implemented Interfaces:
public final class RealtimeServerEvent.ConversationItemRetrievedReturned when a conversation item is retrieved with
conversation.item.retrieve. This is provided as a way to fetch the server's representation of an item, for example to get access to the post-processed audio data after noise cancellation and VAD. It includes the full content of the Item, including audio data.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRealtimeServerEvent.ConversationItemRetrieved.BuilderA builder for ConversationItemRetrieved.
-
Method Summary
Modifier and Type Method Description final StringeventId()The unique ID of the server event. final ConversationItemitem()A single item within a Realtime conversation. final JsonValue_type()The event type, must be conversation.item.retrieved.final JsonField<String>_eventId()Returns the raw JSON value of eventId. final JsonField<ConversationItem>_item()Returns the raw JSON value of item. final Map<String, JsonValue>_additionalProperties()final RealtimeServerEvent.ConversationItemRetrieved.BuildertoBuilder()final RealtimeServerEvent.ConversationItemRetrievedvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static RealtimeServerEvent.ConversationItemRetrieved.Builderbuilder()Returns a mutable builder for constructing an instance of ConversationItemRetrieved. -
-
Method Detail
-
item
final ConversationItem item()
A single item within a Realtime conversation.
-
_type
final JsonValue _type()
The event type, must be
conversation.item.retrieved.Expected to always return the following:
JsonValue.from("conversation.item.retrieved")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.
-
_item
final JsonField<ConversationItem> _item()
Returns the raw JSON value of item.
Unlike item, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final RealtimeServerEvent.ConversationItemRetrieved.Builder toBuilder()
-
validate
final RealtimeServerEvent.ConversationItemRetrieved 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 RealtimeServerEvent.ConversationItemRetrieved.Builder builder()
Returns a mutable builder for constructing an instance of ConversationItemRetrieved.
The following fields are required:
.eventId() .item()
-
-
-
-