Module: OpenAI::Models::Responses::ResponseOutputText::Annotation

Extended by:

Internal::Type::Union

Defined in:

lib/openai/models/responses/response_output_text.rb

Overview

A citation to a file.

Defined Under Namespace

Classes: FileCitation, FilePath, URLCitation

Class Method Summary

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

Instance Method Summary

• #initialize(end_index: , start_index: , title: , url: , type: :url_citation) ⇒ Object

  A citation for a web resource used to generate a model response.

Methods included from Internal::Type::Union

==, ===, coerce, 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, type_info

Class Method Details

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

Returns:

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

# File 'lib/openai/models/responses/response_output_text.rb', line 159

Instance Method Details

#initialize(end_index: , start_index: , title: , url: , type: :url_citation) ⇒ Object

A citation for a web resource used to generate a model response.

Parameters:

• end_index (Integer) (defaults to: ) —

  The index of the last character of the URL citation in the message.

• start_index (Integer) (defaults to: ) —

  The index of the first character of the URL citation in the message.

• title (String) (defaults to: ) —

  The title of the web resource.

• url (String) (defaults to: ) —

  The URL of the web resource.

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

  The type of the URL citation. Always ‘url_citation`.

# File 'lib/openai/models/responses/response_output_text.rb', line 71