Class: OpenAI::Models::Beta::BetaResponseUsage

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

Defined Under Namespace

Classes: InputTokensDetails, OutputTokensDetails

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(cache_write_tokens:, cached_tokens:) ⇒ Object

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

A detailed breakdown of the input tokens.

Parameters:

  • cache_write_tokens (Integer) —

    The number of input tokens that were written to the cache.

  • cached_tokens (Integer) —

    The number of tokens that were retrieved from the cache.




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

Instance Attribute Details

#input_tokens ⇒ Integer

The number of input tokens.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


11
 
# File 'lib/openai/models/beta/beta_response_usage.rb', line 11

required :input_tokens, Integer

#input_tokens_details ⇒ OpenAI::Models::Beta::BetaResponseUsage::InputTokensDetails

A detailed breakdown of the input tokens.

Parameters:

  • value (OpenAI::Beta::BetaResponseUsage::InputTokensDetails)

Returns:



17
 
# File 'lib/openai/models/beta/beta_response_usage.rb', line 17

required :input_tokens_details, -> { OpenAI::Beta::BetaResponseUsage::InputTokensDetails }

#output_tokens ⇒ Integer

The number of output tokens.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


23
 
# File 'lib/openai/models/beta/beta_response_usage.rb', line 23

required :output_tokens, Integer

#output_tokens_details ⇒ OpenAI::Models::Beta::BetaResponseUsage::OutputTokensDetails

A detailed breakdown of the output tokens.

Parameters:

  • value (OpenAI::Beta::BetaResponseUsage::OutputTokensDetails)

Returns:



29
 
# File 'lib/openai/models/beta/beta_response_usage.rb', line 29

required :output_tokens_details, -> { OpenAI::Beta::BetaResponseUsage::OutputTokensDetails }

#total_tokens ⇒ Integer

The total number of tokens used.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :total_tokens, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


34
 
# File 'sig/openai/models/beta/beta_response_usage.rbs', line 34

def to_hash: -> {