Package com.openai.models.responses
Class ResponseTextAnnotationDeltaEvent
-
- All Implemented Interfaces:
public final class ResponseTextAnnotationDeltaEvent
Emitted when a text annotation is added.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseTextAnnotationDeltaEvent.Builder
A builder for ResponseTextAnnotationDeltaEvent.
public final class
ResponseTextAnnotationDeltaEvent.Annotation
A citation to a file.
-
Method Summary
Modifier and Type Method Description final ResponseTextAnnotationDeltaEvent.Annotation
annotation()
A citation to a file. final Long
annotationIndex()
The index of the annotation that was added. final Long
contentIndex()
The index of the content part that the text annotation was added to. final String
itemId()
The ID of the output item that the text annotation was added to. final Long
outputIndex()
The index of the output item that the text annotation was added to. final JsonValue
_type()
The type of the event. final JsonField<ResponseTextAnnotationDeltaEvent.Annotation>
_annotation()
A citation to a file. final JsonField<Long>
_annotationIndex()
The index of the annotation that was added. final JsonField<Long>
_contentIndex()
The index of the content part that the text annotation was added to. final JsonField<String>
_itemId()
The ID of the output item that the text annotation was added to. final JsonField<Long>
_outputIndex()
The index of the output item that the text annotation was added to. final Map<String, JsonValue>
_additionalProperties()
final ResponseTextAnnotationDeltaEvent
validate()
final ResponseTextAnnotationDeltaEvent.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseTextAnnotationDeltaEvent.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseTextAnnotationDeltaEvent. -
-
Method Detail
-
annotation
final ResponseTextAnnotationDeltaEvent.Annotation annotation()
A citation to a file.
-
annotationIndex
final Long annotationIndex()
The index of the annotation that was added.
-
contentIndex
final Long contentIndex()
The index of the content part that the text annotation was added to.
-
outputIndex
final Long outputIndex()
The index of the output item that the text annotation was added to.
-
_annotation
final JsonField<ResponseTextAnnotationDeltaEvent.Annotation> _annotation()
A citation to a file.
-
_annotationIndex
final JsonField<Long> _annotationIndex()
The index of the annotation that was added.
-
_contentIndex
final JsonField<Long> _contentIndex()
The index of the content part that the text annotation was added to.
-
_itemId
final JsonField<String> _itemId()
The ID of the output item that the text annotation was added to.
-
_outputIndex
final JsonField<Long> _outputIndex()
The index of the output item that the text annotation was added to.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final ResponseTextAnnotationDeltaEvent validate()
-
toBuilder
final ResponseTextAnnotationDeltaEvent.Builder toBuilder()
-
builder
final static ResponseTextAnnotationDeltaEvent.Builder builder()
Returns a mutable builder for constructing an instance of ResponseTextAnnotationDeltaEvent.
The following fields are required:
.annotation() .annotationIndex() .contentIndex() .itemId() .outputIndex()
-
-
-
-