Class: OpenAI::Models::Audio::Transcription::Usage::Tokens

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/audio/transcription.rb

Defined Under Namespace

Classes: InputTokenDetails

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, 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(input_tokens: , output_tokens: , total_tokens: , input_token_details: nil, type: :tokens) ⇒ void

Usage statistics for models billed by token usage.

Parameters:

  • input_tokens (Integer) (defaults to: ) —

    Number of input tokens billed for this request.

  • output_tokens (Integer) (defaults to: ) —

    Number of output tokens generated.

  • total_tokens (Integer) (defaults to: ) —

    Total number of tokens used (input + output).

  • input_token_details (OpenAI::Models::Audio::Transcription::Usage::Tokens::InputTokenDetails) (defaults to: nil) —

    Details about the input tokens billed for this request.

  • type (Symbol, :tokens) (defaults to: :tokens) —

    The type of the usage object. Always tokens for this variant.




# File 'lib/openai/models/audio/transcription.rb', line 115

Instance Attribute Details

#input_token_details ⇒ OpenAI::Models::Audio::Transcription::Usage::Tokens::InputTokenDetails?

Details about the input tokens billed for this request.

Returns:



110
111
112
113
 
# File 'lib/openai/models/audio/transcription.rb', line 110

optional :input_token_details,
-> {
  OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails
}

#input_tokens ⇒ Integer

Number of input tokens billed for this request.

Returns:

  • (Integer) 


86
 
# File 'lib/openai/models/audio/transcription.rb', line 86

required :input_tokens, Integer

#output_tokens ⇒ Integer

Number of output tokens generated.

Returns:

  • (Integer) 


92
 
# File 'lib/openai/models/audio/transcription.rb', line 92

required :output_tokens, Integer

#total_tokens ⇒ Integer

Total number of tokens used (input + output).

Returns:

  • (Integer) 


98
 
# File 'lib/openai/models/audio/transcription.rb', line 98

required :total_tokens, Integer

#type ⇒ Symbol, :tokens

The type of the usage object. Always tokens for this variant.

Returns:

  • (Symbol, :tokens) 


104
 
# File 'lib/openai/models/audio/transcription.rb', line 104

required :type, const: :tokens