Class: OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_output_text_annotation_added_event.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(annotation: , annotation_index: , content_index: , item_id: , output_index: , sequence_number: , type: :"response.output_text_annotation.added") ⇒ Object

Emitted when an annotation is added to output text content.

Parameters:

  • annotation (Object) (defaults to: ) —

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

  • annotation_index (Integer) (defaults to: ) —

    The index of the annotation within the content part.

  • content_index (Integer) (defaults to: ) —

    The index of the content part within the output item.

  • item_id (String) (defaults to: ) —

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

  • output_index (Integer) (defaults to: ) —

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

  • sequence_number (Integer) (defaults to: ) —

    The sequence number of this event.

  • type (Symbol, :"response.output_text_annotation.added") (defaults to: :"response.output_text_annotation.added") —

    The type of the event. Always ‘response.output_text_annotation.added’.




# File 'lib/openai/models/responses/response_output_text_annotation_added_event.rb', line 49

Instance Attribute Details

#annotation ⇒ Object

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

Returns:

  • (Object) 


11
 
# File 'lib/openai/models/responses/response_output_text_annotation_added_event.rb', line 11

required :annotation, OpenAI::Internal::Type::Unknown

#annotation_index ⇒ Integer

The index of the annotation within the content part.

Returns:

  • (Integer) 


17
 
# File 'lib/openai/models/responses/response_output_text_annotation_added_event.rb', line 17

required :annotation_index, Integer

#content_index ⇒ Integer

The index of the content part within the output item.

Returns:

  • (Integer) 


23
 
# File 'lib/openai/models/responses/response_output_text_annotation_added_event.rb', line 23

required :content_index, Integer

#item_id ⇒ String

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

Returns:

  • (String) 


29
 
# File 'lib/openai/models/responses/response_output_text_annotation_added_event.rb', line 29

required :item_id, String

#output_index ⇒ Integer

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

Returns:

  • (Integer) 


35
 
# File 'lib/openai/models/responses/response_output_text_annotation_added_event.rb', line 35

required :output_index, Integer

#sequence_number ⇒ Integer

The sequence number of this event.

Returns:

  • (Integer) 


41
 
# File 'lib/openai/models/responses/response_output_text_annotation_added_event.rb', line 41

required :sequence_number, Integer

#type ⇒ Symbol, :"response.output_text_annotation.added"

The type of the event. Always ‘response.output_text_annotation.added’.

Returns:

  • (Symbol, :"response.output_text_annotation.added") 


47
 
# File 'lib/openai/models/responses/response_output_text_annotation_added_event.rb', line 47

required :type, const: :"response.output_text_annotation.added"