Class: OpenAI::Models::Beta::Responses::InputTokenCountParams::Text

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: Verbosity

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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(format_: nil, verbosity: nil) ⇒ Object

Parameters:

  • format_ (defaults to: nil) —

    An object specifying the format that the model must output.

    Configuring { "type": "json_schema" } enables Structured Outputs, which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

    The default format is { "type": "text" } with no additional options.

    Not recommended for gpt-4o and newer models:

    Setting to { "type": "json_object" } enables the older JSON mode, which ensures the message the model generates is valid JSON. Using json_schema is preferred for models that support it.

  • verbosity (defaults to: nil) —

    Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are low, medium, and high. The default is medium.




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

Instance Attribute Details

#format_ ⇒ OpenAI::Models::Beta::beta_response_format_text_config?

An object specifying the format that the model must output.

Configuring { "type": "json_schema" } enables Structured Outputs, which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

The default format is { "type": "text" } with no additional options.

Not recommended for gpt-4o and newer models:

Setting to { "type": "json_object" } enables the older JSON mode, which ensures the message the model generates is valid JSON. Using json_schema is preferred for models that support it.

Returns:

  • (OpenAI::Models::Beta::beta_response_format_text_config, nil) 


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

optional :format_, union: -> { OpenAI::Beta::BetaResponseFormatTextConfig }, api_name: :format

#verbosity ⇒ OpenAI::Models::Beta::Responses::InputTokenCountParams::Text::verbosity?

Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are low, medium, and high. The default is medium.

Returns:

  • (OpenAI::Models::Beta::Responses::InputTokenCountParams::Text::verbosity, nil) 


505
506
507
508
509
 
# File 'lib/openai/models/beta/responses/input_token_count_params.rb', line 505

optional(
  :verbosity,
  enum: -> { OpenAI::Beta::Responses::InputTokenCountParams::Text::Verbosity },
  nil?: true
)

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {