class

OpenAI::ResponseOutputTextAnnotationAddedEvent

Inherits JSON::Serializable < Reference < Object

Emitted when an annotation is added to output text content.

Constructors

new(pull : JSON::PullParser)
Source
new(type_value : ResponseOutputTextAnnotationAddedEventType = ResponseOutputTextAnnotationAddedEventType::ResponseOutputTextAnnotationAdded, item_id : String = "", output_index : Int64 = 0, content_index : Int64 = 0, annotation_index : Int64 = 0, sequence_number : Int64 = 0, annotation : Hash(String, JSON::Any) = Hash(String, JSON::Any).new)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

annotation

The annotation object being added. (See annotation schema for details.)

Source
annotation=(annotation : Hash(String, JSON::Any))

The annotation object being added. (See annotation schema for details.)

Source
annotation_index

The index of the annotation within the content part.

Source
annotation_index=(annotation_index : Int64)

The index of the annotation within the content part.

Source
content_index

The index of the content part within the output item.

Source
content_index=(content_index : Int64)

The index of the content part within the output item.

Source
item_id

The unique identifier of the item to which the annotation is being added.

Source
item_id=(item_id : String)

The unique identifier of the item to which the annotation is being added.

Source
output_index

The index of the output item in the response's output array.

Source
output_index=(output_index : Int64)

The index of the output item in the response's output array.

Source
sequence_number

The sequence number of this event.

Source
sequence_number=(sequence_number : Int64)

The sequence number of this event.

Source
type_value

The type of the event. Always 'response.output_text.annotation.added'.

Source
type_value=(type_value : ResponseOutputTextAnnotationAddedEventType)

The type of the event. Always 'response.output_text.annotation.added'.

Source