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, 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(id:, summary:, content: nil, 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:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/openai/models/responses/response_reasoning_item.rb', line 68

class Summary < OpenAI::Internal::Type::BaseModel
  # @!attribute text
  #   A summary of the reasoning output from the model so far.
  #
  #   @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)
  #   A summary text from the model.
  #
  #   @param text [String] A summary of the reasoning output from the model so far.
  #
  #   @param type [Symbol, :summary_text] The type of the object. Always `summary_text`.
end

Instance Attribute Details

#text ⇒ String

A summary of the reasoning output from the model so far.

Returns:

  • (String) 


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

required :text, String

#type ⇒ Symbol, :summary_text

The type of the object. Always ‘summary_text`.

Returns:

  • (Symbol, :summary_text) 


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

required :type, const: :summary_text