Class: OpenAI::Models::Beta::BetaResponseReasoningItem

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

Defined Under Namespace

Modules: Status Classes: Agent, Content, Summary

Instance Attribute 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(text:, type: :reasoning_text) ⇒ Object

Reasoning text from the model.

Parameters:

  • text (String) —

    The reasoning text from the model.

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

    The type of the reasoning text. Always reasoning_text.




# File 'lib/openai/models/beta/beta_response_reasoning_item.rb', line 89

Instance Attribute Details

#agent ⇒ OpenAI::Models::Beta::BetaResponseReasoningItem::Agent?

The agent that produced this item.

Parameters:

  • value (OpenAI::Beta::BetaResponseReasoningItem::Agent, nil)

Returns:



30
 
# File 'lib/openai/models/beta/beta_response_reasoning_item.rb', line 30

optional :agent, -> { OpenAI::Beta::BetaResponseReasoningItem::Agent }, nil?: true

#content ⇒ Array<OpenAI::Models::Beta::BetaResponseReasoningItem::Content>?

Reasoning text content.

Returns:



36
37
 
# File 'lib/openai/models/beta/beta_response_reasoning_item.rb', line 36

optional :content,
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::BetaResponseReasoningItem::Content] }

#encrypted_content ⇒ String?

The encrypted content of the reasoning item - populated when a response is generated with reasoning.encrypted_content in the include parameter.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


44
 
# File 'lib/openai/models/beta/beta_response_reasoning_item.rb', line 44

optional :encrypted_content, String, nil?: true

#id ⇒ String

The unique identifier of the reasoning content.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#status ⇒ Symbol, ...

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

Returns:



51
 
# File 'lib/openai/models/beta/beta_response_reasoning_item.rb', line 51

optional :status, enum: -> { OpenAI::Beta::BetaResponseReasoningItem::Status }

#summary ⇒ Array<OpenAI::Models::Beta::BetaResponseReasoningItem::Summary>

Reasoning summary content.

Parameters:

  • value (::Array[OpenAI::Beta::BetaResponseReasoningItem::Summary])

Returns:



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

required :summary,
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::BetaResponseReasoningItem::Summary] }

#type ⇒ Symbol, :reasoning

The type of the object. Always reasoning.

Parameters:

  • value (:reasoning)

Returns:

  • (Symbol, :reasoning) 


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

required :type, const: :reasoning

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


50
 
# File 'sig/openai/models/beta/beta_response_reasoning_item.rbs', line 50

def to_hash: -> {