Class: OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning

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

Defined Under Namespace

Modules: Context, Effort, GenerateSummary, Mode, Summary

Instance Attribute Summary collapse

Class Method 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(context: nil, effort: nil, generate_summary: nil, mode: nil, summary: nil) ⇒ Object

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

gpt-5 and o-series models only Configuration options for reasoning models.

Parameters:




# File 'lib/openai/models/beta/responses/input_token_count_params.rb', line 274

Instance Attribute Details

#context ⇒ Symbol, ...

Controls which reasoning items are rendered back to the model on later turns. When returned on a response, this is the effective reasoning context mode used for the response.

Parameters:

  • value (OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::context, nil)

Returns:



222
223
224
 
# File 'lib/openai/models/beta/responses/input_token_count_params.rb', line 222

optional :context,
enum: -> { OpenAI::Beta::Responses::InputTokenCountParams::Reasoning::Context },
nil?: true

#effort ⇒ Symbol, ...

Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, xhigh, and max. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the reasoning guide for model-specific support.

Parameters:

  • value (OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::effort, nil)

Returns:



235
236
237
 
# File 'lib/openai/models/beta/responses/input_token_count_params.rb', line 235

optional :effort,
enum: -> { OpenAI::Beta::Responses::InputTokenCountParams::Reasoning::Effort },
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.

Parameters:

  • value (OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::generate_summary, nil)

Returns:



249
250
251
 
# File 'lib/openai/models/beta/responses/input_token_count_params.rb', line 249

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

#mode ⇒ String, ...

Controls the reasoning execution mode for the request.

When returned on a response, this is the effective execution mode.

Returns:



259
 
# File 'lib/openai/models/beta/responses/input_token_count_params.rb', line 259

optional :mode, union: -> { OpenAI::Beta::Responses::InputTokenCountParams::Reasoning::Mode }

#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.

concise is supported for computer-use-preview models and all reasoning models after gpt-5.

Parameters:

  • value (OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::summary, nil)

Returns:



270
271
272
 
# File 'lib/openai/models/beta/responses/input_token_count_params.rb', line 270

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/beta/responses/input_token_count_params.rb', line 304

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


162
 
# File 'sig/openai/models/beta/responses/input_token_count_params.rbs', line 162

def to_hash: -> {