Class: OpenAI::Models::CompletionUsage

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

Defined Under Namespace

Classes: CompletionTokensDetails, PromptTokensDetails

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, 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(accepted_prediction_tokens: nil, audio_tokens: nil, reasoning_tokens: nil, rejected_prediction_tokens: nil) ⇒ Object

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

Breakdown of tokens used in a completion.

Parameters:

  • accepted_prediction_tokens (Integer) (defaults to: nil) —

    When using Predicted Outputs, the number of tokens in the

  • audio_tokens (Integer) (defaults to: nil) —

    Audio input tokens generated by the model.

  • reasoning_tokens (Integer) (defaults to: nil) —

    Tokens generated by the model for reasoning.

  • rejected_prediction_tokens (Integer) (defaults to: nil) —

    When using Predicted Outputs, the number of tokens in the




# File 'lib/openai/models/completion_usage.rb', line 36

Instance Attribute Details

#completion_tokens ⇒ Integer

Number of tokens in the generated completion.

Returns:

  • (Integer) 


10
 
# File 'lib/openai/models/completion_usage.rb', line 10

required :completion_tokens, Integer

#completion_tokens_details ⇒ OpenAI::Models::CompletionUsage::CompletionTokensDetails?

Breakdown of tokens used in a completion.

Returns:



28
 
# File 'lib/openai/models/completion_usage.rb', line 28

optional :completion_tokens_details, -> { OpenAI::CompletionUsage::CompletionTokensDetails }

#prompt_tokens ⇒ Integer

Number of tokens in the prompt.

Returns:

  • (Integer) 


16
 
# File 'lib/openai/models/completion_usage.rb', line 16

required :prompt_tokens, Integer

#prompt_tokens_details ⇒ OpenAI::Models::CompletionUsage::PromptTokensDetails?

Breakdown of tokens used in the prompt.

Returns:



34
 
# File 'lib/openai/models/completion_usage.rb', line 34

optional :prompt_tokens_details, -> { OpenAI::CompletionUsage::PromptTokensDetails }

#total_tokens ⇒ Integer

Total number of tokens used in the request (prompt + completion).

Returns:

  • (Integer) 


22
 
# File 'lib/openai/models/completion_usage.rb', line 22

required :total_tokens, Integer