Class: OpenAI::Models::Beta::BetaResponseOutputText

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/beta_response_output_text.rb,
sig/openai/models/beta/beta_response_output_text.rbs

Defined Under Namespace

Modules: Annotation Classes: Logprob

Instance Attribute Summary collapse

Class Method 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, meta_info, new_coerce_state, 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(file_id:, index:, type: :file_path) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Beta::BetaResponseOutputText::Annotation::FilePath for more details.

A path to a file.

Parameters:

  • file_id (String) —

    The ID of the file.

  • index (Integer) —

    The index of the file in the list of files.

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

    The type of the file path. Always file_path.




# File 'lib/openai/models/beta/beta_response_output_text.rb', line 31

Instance Attribute Details

#annotations ⇒ Array<OpenAI::Models::Beta::BetaResponseOutputText::Annotation::FileCitation, OpenAI::Models::Beta::BetaResponseOutputText::Annotation::URLCitation, OpenAI::Models::Beta::BetaResponseOutputText::Annotation::ContainerFileCitation, OpenAI::Models::Beta::BetaResponseOutputText::Annotation::FilePath>

The annotations of the text output.

Parameters:

  • value (::Array[OpenAI::Models::Beta::BetaResponseOutputText::annotation])

Returns:



11
12
 
# File 'lib/openai/models/beta/beta_response_output_text.rb', line 11

required :annotations,
-> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaResponseOutputText::Annotation] }

#logprobs ⇒ Array<OpenAI::Models::Beta::BetaResponseOutputText::Logprob>?

Returns:



29
 
# File 'lib/openai/models/beta/beta_response_output_text.rb', line 29

optional :logprobs, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::BetaResponseOutputText::Logprob] }

#text ⇒ String

The text output from the model.

Parameters:

  • value (String)

Returns:

  • (String) 


18
 
# File 'lib/openai/models/beta/beta_response_output_text.rb', line 18

required :text, String

#type ⇒ Symbol, :output_text

The type of the output text. Always output_text.

Parameters:

  • value (:output_text)

Returns:

  • (Symbol, :output_text) 


24
 
# File 'lib/openai/models/beta/beta_response_output_text.rb', line 24

required :type, const: :output_text

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


34
 
# File 'sig/openai/models/beta/beta_response_output_text.rbs', line 34

def to_hash: -> {