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

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

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(id: , summary: , encrypted_content: nil, status: nil, type: :reasoning) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::ResponseReasoningItem for more details.

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your ‘input` to the Responses API for subsequent turns of a conversation if you are manually [managing context](platform.openai.com/docs/guides/conversation-state).

Parameters:

  • id (String) (defaults to: ) —

    The unique identifier of the reasoning content.

  • summary (Array<OpenAI::Models::Responses::ResponseReasoningItem::Summary>) (defaults to: ) —

    Reasoning text contents.

  • encrypted_content (String, nil) (defaults to: nil) —

    The encrypted content of the reasoning item - populated when a response is

  • status (Symbol, OpenAI::Models::Responses::ResponseReasoningItem::Status) (defaults to: nil) —

    The status of the item. One of ‘in_progress`, `completed`, or

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

    The type of the object. Always ‘reasoning`.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/openai/models/responses/response_reasoning_item.rb', line 59

class Summary < OpenAI::Internal::Type::BaseModel
  # @!attribute text
  #   A short summary of the reasoning used by the model when generating the response.
  #
  #   @return [String]
  required :text, String

  # @!attribute type
  #   The type of the object. Always `summary_text`.
  #
  #   @return [Symbol, :summary_text]
  required :type, const: :summary_text

  # @!method initialize(text:, type: :summary_text)
  #   Some parameter documentations has been truncated, see
  #   {OpenAI::Models::Responses::ResponseReasoningItem::Summary} for more details.
  #
  #   @param text [String] A short summary of the reasoning used by the model when generating
  #
  #   @param type [Symbol, :summary_text] The type of the object. Always `summary_text`.
end

Instance Attribute Details

#text ⇒ String

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

Returns:

  • (String) 


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

required :text, String

#type ⇒ Symbol, :summary_text

The type of the object. Always ‘summary_text`.

Returns:

  • (Symbol, :summary_text) 


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

required :type, const: :summary_text