Struct UsageMetadata 

pub struct UsageMetadata {
    pub prompt_token_count: i32,
    pub candidates_token_count: i32,
    pub total_token_count: i32,
    pub cache_read_input_token_count: Option<i32>,
    pub cache_creation_input_token_count: Option<i32>,
    pub thinking_token_count: Option<i32>,
    pub audio_input_token_count: Option<i32>,
    pub audio_output_token_count: Option<i32>,
    pub cost: Option<f64>,
    pub is_byok: Option<bool>,
    pub provider_usage: Option<Value>,
}

Token usage statistics from an LLM response.

Fields

prompt_token_count: i32

Number of tokens in the prompt.

candidates_token_count: i32

Number of tokens in the generated response.

total_token_count: i32

Total tokens (prompt + response).

cache_read_input_token_count: Option<i32>

Tokens read from cache (Gemini/Anthropic).

cache_creation_input_token_count: Option<i32>

Tokens written to cache during this request.

thinking_token_count: Option<i32>

Tokens used for thinking/reasoning (thinking models).

audio_input_token_count: Option<i32>

Audio input tokens (multimodal models).

audio_output_token_count: Option<i32>

Audio output tokens (multimodal models).

cost: Option<f64>

Estimated cost in USD for this request.

is_byok: Option<bool>

Whether this request used a bring-your-own-key provider.

provider_usage: Option<Value>

Provider-specific usage details (e.g., server tool use, video tokens).

Trait Implementations

impl Clone for UsageMetadata

fn clone(&self) -> UsageMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UsageMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UsageMetadata

fn default() -> UsageMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UsageMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UsageMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.