Module: OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation

Extended by:

Internal::Type::Union

Defined in:

lib/openai/models/responses/response_output_text_annotation_added_event.rb,
sig/openai/models/responses/response_output_text_annotation_added_event.rbs

Overview

An annotation that applies to a span of output text.

See Also:

• OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent#annotation

Defined Under Namespace

Classes: ContainerFileCitation, FileCitation, FilePath, URLCitation

Class Method Summary

• .variants ⇒ Array(OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FilePath)

Instance Method Summary

• #initialize(container_id:, end_index:, file_id:, filename:, start_index:, type: :container_file_citation) ⇒ Object

  A citation for a container file used to generate a model response.

• #self?.variants ⇒ ::Array[OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::annotation]

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

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

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.variants ⇒ Array(OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FilePath)

Returns:

• (Array(OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::ContainerFileCitation, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::FilePath))

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

Instance Method Details

#initialize(container_id:, end_index:, file_id:, filename:, start_index:, type: :container_file_citation) ⇒ Object

A citation for a container file used to generate a model response.

Parameters:

• container_id (String) —

  The ID of the container file.

• end_index (Integer) —

  The index of the last character of the container file citation in the message.

• file_id (String) —

  The ID of the file.

• filename (String) —

  The filename of the container file cited.

• start_index (Integer) —

  The index of the first character of the container file citation in the message.

• type (Symbol, :container_file_citation) (defaults to: :container_file_citation) —

  The type of the container file citation. Always container_file_citation.

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

#self?.variants ⇒ ::Array[OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::annotation]

Returns:

• (::Array[OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::annotation])

# File 'sig/openai/models/responses/response_output_text_annotation_added_event.rbs', line 192

def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::annotation]