Class ResponseOutputTextAnnotationAddedEvent
-
- All Implemented Interfaces:
public final class ResponseOutputTextAnnotationAddedEvent
Emitted when an annotation is added to output text content.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseOutputTextAnnotationAddedEvent.Builder
A builder for ResponseOutputTextAnnotationAddedEvent.
-
Method Summary
Modifier and Type Method Description final JsonValue
_annotation()
The annotation object being added. final Long
annotationIndex()
The index of the annotation within the content part. final Long
contentIndex()
The index of the content part within the output item. final String
itemId()
The unique identifier of the item to which the annotation is being added. final Long
outputIndex()
The index of the output item in the response's output array. final Long
sequenceNumber()
The sequence number of this event. final JsonValue
_type()
The type of the event. final JsonField<Long>
_annotationIndex()
Returns the raw JSON value of annotationIndex. final JsonField<Long>
_contentIndex()
Returns the raw JSON value of contentIndex. final JsonField<String>
_itemId()
Returns the raw JSON value of itemId. final JsonField<Long>
_outputIndex()
Returns the raw JSON value of outputIndex. final JsonField<Long>
_sequenceNumber()
Returns the raw JSON value of sequenceNumber. final Map<String, JsonValue>
_additionalProperties()
final ResponseOutputTextAnnotationAddedEvent.Builder
toBuilder()
final ResponseOutputTextAnnotationAddedEvent
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseOutputTextAnnotationAddedEvent.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseOutputTextAnnotationAddedEvent. -
-
Method Detail
-
_annotation
final JsonValue _annotation()
The annotation object being added. (See annotation schema for details.)
-
annotationIndex
final Long annotationIndex()
The index of the annotation within the content part.
-
contentIndex
final Long contentIndex()
The index of the content part within the output item.
-
itemId
final String itemId()
The unique identifier of the item to which the annotation is being added.
-
outputIndex
final Long outputIndex()
The index of the output item in the response's output array.
-
sequenceNumber
final Long sequenceNumber()
The sequence number of this event.
-
_type
final JsonValue _type()
The type of the event. Always 'response.output_text_annotation.added'.
Expected to always return the following:
JsonValue.from("response.output_text_annotation.added")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_annotationIndex
final JsonField<Long> _annotationIndex()
Returns the raw JSON value of annotationIndex.
Unlike annotationIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_contentIndex
final JsonField<Long> _contentIndex()
Returns the raw JSON value of contentIndex.
Unlike contentIndex, 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.
-
_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.
-
_sequenceNumber
final JsonField<Long> _sequenceNumber()
Returns the raw JSON value of sequenceNumber.
Unlike sequenceNumber, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseOutputTextAnnotationAddedEvent.Builder toBuilder()
-
validate
final ResponseOutputTextAnnotationAddedEvent validate()
-
builder
final static ResponseOutputTextAnnotationAddedEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseOutputTextAnnotationAddedEvent.
The following fields are required:
.annotation() .annotationIndex() .contentIndex() .itemId() .outputIndex() .sequenceNumber()
-
-
-
-