ClaudeCode.Model.Usage (ClaudeCode v0.36.3)

Per-model token usage statistics from the Claude CLI.

Used by ClaudeCode.Message.ResultMessage to provide a breakdown of token usage per model (e.g., when fallback models are involved).

Fields

:input_tokens - Number of input tokens consumed
:output_tokens - Number of output tokens generated
:cache_creation_input_tokens - Tokens used to create cache entries
:cache_read_input_tokens - Tokens read from cache
:web_search_requests - Number of web search requests made
:cost_usd - Cost in USD for this model's usage
:context_window - Context window size for this model
:max_output_tokens - Maximum output tokens for this model

Summary

Types

t()

Functions

parse(model_usage)

Parses a model usage map from CLI JSON.

parse_single(usage_data)

Parses a single model's usage data from CLI JSON.

Types

t()

@type t() :: %{
  input_tokens: non_neg_integer(),
  output_tokens: non_neg_integer(),
  cache_creation_input_tokens: non_neg_integer() | nil,
  cache_read_input_tokens: non_neg_integer() | nil,
  web_search_requests: non_neg_integer(),
  cost_usd: float() | nil,
  context_window: non_neg_integer() | nil,
  max_output_tokens: non_neg_integer() | nil
}

Functions

parse(model_usage)

@spec parse(map() | nil) :: %{required(String.t()) => t()}

Parses a model usage map from CLI JSON.

Accepts a map keyed by model name with usage data values. Returns a map with the same keys and parsed t/0 values.

Returns an empty map for nil or non-map input.

Examples

iex> ClaudeCode.Model.Usage.parse(%{"claude-sonnet" => %{"input_tokens" => 100, "output_tokens" => 50}})
%{"claude-sonnet" => %{input_tokens: 100, output_tokens: 50, cache_creation_input_tokens: nil, cache_read_input_tokens: nil, web_search_requests: 0, cost_usd: nil, context_window: nil, max_output_tokens: nil}}

iex> ClaudeCode.Model.Usage.parse(nil)
%{}

parse_single(usage_data)

@spec parse_single(map() | nil) :: t() | nil

Parses a single model's usage data from CLI JSON.

Returns nil for nil or non-map input.

Examples

iex> ClaudeCode.Model.Usage.parse_single(%{"input_tokens" => 100, "output_tokens" => 50})
%{input_tokens: 100, output_tokens: 50, cache_creation_input_tokens: nil, cache_read_input_tokens: nil, web_search_requests: 0, cost_usd: nil, context_window: nil, max_output_tokens: nil}

iex> ClaudeCode.Model.Usage.parse_single(nil)
nil