View Source ExOpenAI.Components.CompletionUsage (ex_openai.ex v2.0.0-beta2)

Usage statistics for the completion request.

Fields

:completion_tokens - required - integer()
Number of tokens in the generated completion.
Default: 0
:completion_tokens_details - optional - {:%{}, [], [{{:optional, [], [:accepted_prediction_tokens]}, {:integer, [], []}}, {{:optional, [], [:audio_tokens]}, {:integer, [], []}}, {{:optional, [], [:reasoning_tokens]}, {:integer, [], []}}, {{:optional, [], [:rejected_prediction_tokens]}, {:integer, [], []}}]}
Breakdown of tokens used in a completion.
:prompt_tokens - required - integer()
Number of tokens in the prompt.
Default: 0
:prompt_tokens_details - optional - {:%{}, [], [{{:optional, [], [:audio_tokens]}, {:integer, [], []}}, {{:optional, [], [:cached_tokens]}, {:integer, [], []}}]}
Breakdown of tokens used in the prompt.
:total_tokens - required - integer()
Total number of tokens used in the request (prompt + completion).
Default: 0

Summary

Types

t()

Types

t()

@type t() :: %ExOpenAI.Components.CompletionUsage{
  completion_tokens: integer(),
  completion_tokens_details:
    %{
      optional(:accepted_prediction_tokens) => integer(),
      optional(:audio_tokens) => integer(),
      optional(:reasoning_tokens) => integer(),
      optional(:rejected_prediction_tokens) => integer()
    }
    | nil,
  prompt_tokens: integer(),
  prompt_tokens_details:
    %{
      optional(:audio_tokens) => integer(),
      optional(:cached_tokens) => integer()
    }
    | nil,
  total_tokens: integer()
}