Class: OpenAI::Models::Conversations::OutputTextContent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/conversations/output_text_content.rb

Defined Under Namespace

Modules: Annotation

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from OpenAI::Internal::Type::BaseModel

Instance Attribute Details

#annotations ⇒ Array<OpenAI::Models::Conversations::FileCitationBody, OpenAI::Models::Conversations::URLCitationBody, OpenAI::Models::Conversations::ContainerFileCitationBody>

The annotations of the text output.

Returns:



11
12
 
# File 'lib/openai/models/conversations/output_text_content.rb', line 11

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

#logprobs ⇒ Array<OpenAI::Models::Conversations::LobProb>?

Returns:



29
 
# File 'lib/openai/models/conversations/output_text_content.rb', line 29

optional :logprobs, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Conversations::LobProb] }

#text ⇒ String

The text output from the model.

Returns:

  • (String) 


18
 
# File 'lib/openai/models/conversations/output_text_content.rb', line 18

required :text, String

#type ⇒ Symbol, :output_text

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

Returns:

  • (Symbol, :output_text) 


24
 
# File 'lib/openai/models/conversations/output_text_content.rb', line 24

required :type, const: :output_text