Class: OpenAI::Models::Responses::ResponseOutputText

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

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::Responses::ResponseOutputText::Annotation::FilePath for more details.

A path to a file.




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

Instance Attribute Details

#annotations ⇒ Array<OpenAI::Models::Responses::ResponseOutputText::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::ContainerFileCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::FilePath>

The annotations of the text output.



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

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

#logprobs ⇒ Array<OpenAI::Models::Responses::ResponseOutputText::Logprob>? 



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

optional :logprobs, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseOutputText::Logprob] }

#text ⇒ String

The text output from the model.



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

required :text, String

#type ⇒ Symbol, :output_text

The type of the output text. Always ‘output_text`.



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

required :type, const: :output_text

Class Method Details

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




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