Class: OpenAI::Models::Responses::ResponseReasoningItem

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

Defined Under Namespace

Modules: Status Classes: 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, 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: :summary_text) ⇒ Object

Some parameter documentations has been truncated, see Summary for more details.

Parameters:

  • text (String) (defaults to: ) —

    A short summary of the reasoning used by the model when generating

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

    The type of the object. Always ‘summary_text`.




# File 'lib/openai/models/responses/response_reasoning_item.rb', line 72

Instance Attribute Details

#encrypted_content ⇒ String?

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

Returns:

  • (String, nil) 


31
 
# File 'lib/openai/models/responses/response_reasoning_item.rb', line 31

optional :encrypted_content, String, nil?: true

#id ⇒ String

The unique identifier of the reasoning content.

Returns:

  • (String) 


11
 
# File 'lib/openai/models/responses/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:



38
 
# File 'lib/openai/models/responses/response_reasoning_item.rb', line 38

optional :status, enum: -> { OpenAI::Responses::ResponseReasoningItem::Status }

#summary ⇒ Array<OpenAI::Models::Responses::ResponseReasoningItem::Summary>

Reasoning text contents.

Returns:



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

required :summary,
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseReasoningItem::Summary] }

#type ⇒ Symbol, :reasoning

The type of the object. Always ‘reasoning`.

Returns:

  • (Symbol, :reasoning) 


24
 
# File 'lib/openai/models/responses/response_reasoning_item.rb', line 24

required :type, const: :reasoning