Class ResponseOutputItemAddedEvent
-
- All Implemented Interfaces:
public final class ResponseOutputItemAddedEventReturned when a new Item is created during Response generation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseOutputItemAddedEvent.BuilderA builder for ResponseOutputItemAddedEvent.
-
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 LongoutputIndex()The index of the output item in the Response. final StringresponseId()The ID of the Response to which the item belongs. final JsonValue_type()The event type, must be response.output_item.added.final JsonField<String>_eventId()Returns the raw JSON value of eventId. final JsonField<ConversationItem>_item()Returns the raw JSON value of item. final JsonField<Long>_outputIndex()Returns the raw JSON value of outputIndex. final JsonField<String>_responseId()Returns the raw JSON value of responseId. final Map<String, JsonValue>_additionalProperties()final ResponseOutputItemAddedEvent.BuildertoBuilder()final ResponseOutputItemAddedEventvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseOutputItemAddedEvent.Builderbuilder()Returns a mutable builder for constructing an instance of ResponseOutputItemAddedEvent. -
-
Method Detail
-
item
final ConversationItem item()
A single item within a Realtime conversation.
-
outputIndex
final Long outputIndex()
The index of the output item in the Response.
-
responseId
final String responseId()
The ID of the Response to which the item belongs.
-
_type
final JsonValue _type()
The event type, must be
response.output_item.added.Expected to always return the following:
JsonValue.from("response.output_item.added")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.
-
_outputIndex
final JsonField<Long> _outputIndex()
Returns the raw JSON value of outputIndex.
Unlike outputIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_responseId
final JsonField<String> _responseId()
Returns the raw JSON value of responseId.
Unlike responseId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseOutputItemAddedEvent.Builder toBuilder()
-
validate
final ResponseOutputItemAddedEvent validate()
-
builder
final static ResponseOutputItemAddedEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseOutputItemAddedEvent.
The following fields are required:
.eventId() .item() .outputIndex() .responseId()
-
-
-
-