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.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

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()`	Returns the raw JSON value of annotation.
`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 Map<String, JsonValue>`	`_additionalProperties()`
`final ResponseTextAnnotationDeltaEvent.Builder`	`toBuilder()`
`final ResponseTextAnnotationDeltaEvent`	`validate()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ResponseTextAnnotationDeltaEvent.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ResponseTextAnnotationDeltaEvent.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- 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.
  - itemId
```
 final String itemId()
```
    The ID of the output item that the text annotation was added to.
  - outputIndex
```
 final Long outputIndex()
```
    The index of the output item that the text annotation was added to.
  - _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).
  - _annotation
```
 final JsonField<ResponseTextAnnotationDeltaEvent.Annotation> _annotation()
```
    Returns the raw JSON value of annotation.
    Unlike annotation, this method doesn't throw if the JSON field has an unexpected type.
  - _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.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final ResponseTextAnnotationDeltaEvent.Builder toBuilder()
```
  - validate
```
 final ResponseTextAnnotationDeltaEvent validate()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - 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()

Class ResponseTextAnnotationDeltaEvent

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

annotation

annotationIndex

contentIndex

itemId

outputIndex

_type

_annotation

_annotationIndex

_contentIndex

_itemId

_outputIndex

_additionalProperties

toBuilder

validate

equals

hashCode

toString

builder