Class: OpenAI::Models::Reasoning

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Reasoning

Defined in:

lib/openai/models/reasoning.rb

Defined Under Namespace

Modules: GenerateSummary, Summary

Instance Attribute Summary

• #effort ⇒ Symbol, ...

  o-series models only.

• #generate_summary ⇒ Symbol, ... deprecated Deprecated.
• #summary ⇒ Symbol, ...

  A summary of the reasoning performed by the model.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(effort: nil, generate_summary: nil, summary: nil) ⇒ void constructor

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

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, 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(effort: nil, generate_summary: nil, summary: nil) ⇒ void

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

o-series models only

Configuration options for reasoning models.

Parameters:

• effort (Symbol, OpenAI::Models::ReasoningEffort, nil) (defaults to: nil) —

  o-series models only

• generate_summary (Symbol, OpenAI::Models::Reasoning::GenerateSummary, nil) (defaults to: nil) —

  Deprecated: use summary instead.

• summary (Symbol, OpenAI::Models::Reasoning::Summary, nil) (defaults to: nil) —

  A summary of the reasoning performed by the model. This can be

# File 'lib/openai/models/reasoning.rb', line 37

Instance Attribute Details

#effort ⇒ Symbol, ...

o-series models only

Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

Returns:

• (Symbol, OpenAI::Models::ReasoningEffort, nil)

# File 'lib/openai/models/reasoning.rb', line 15

optional :effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true

#generate_summary ⇒ Symbol, ...

Deprecated.

Deprecated: use summary instead.

A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.

Returns:

• (Symbol, OpenAI::Models::Reasoning::GenerateSummary, nil)

# File 'lib/openai/models/reasoning.rb', line 27

optional :generate_summary, enum: -> { OpenAI::Reasoning::GenerateSummary }, nil?: true

#summary ⇒ Symbol, ...

A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.

Returns:

• (Symbol, OpenAI::Models::Reasoning::Summary, nil)

# File 'lib/openai/models/reasoning.rb', line 35

optional :summary, enum: -> { OpenAI::Reasoning::Summary }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/openai/models/reasoning.rb', line 68