Struct Usage 

pub struct Usage {
    pub input_tokens: u64,
    pub cached_input_tokens: u64,
    pub cache_creation_tokens: u64,
    pub output_tokens: u64,
}

Fields

input_tokens: u64

Number of prompt tokens processed during the turn.

cached_input_tokens: u64

Number of cached prompt tokens reused from previous turns.

cache_creation_tokens: u64

Number of cache-creation tokens charged during the turn.

output_tokens: u64

Number of completion tokens generated by the model.

Implementations

impl Usage

pub fn uncached_input_tokens(&self) -> u64

Number of input tokens billed at the full input rate: neither served from cache nor written to it. input_tokens is the total prompt token count (uncached + cached + cache-creation), so both cached and cache-creation tokens are subtracted out here.

pub fn cache_hit_rate(&self) -> Option<f64>

Cache hit rate as a fraction (0.0 to 1.0): cached input over total input. Returns None when no input tokens were recorded.

pub fn cache_summary(&self) -> String

Human-readable summary of prompt cache efficiency.

pub fn add(&mut self, other: &Usage)

Accumulate another usage sample into this one.

Trait Implementations

impl Clone for Usage

fn clone(&self) -> Usage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Usage

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

Formats the value using the given formatter.

impl Default for Usage

fn default() -> Usage

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Usage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Usage

impl JsonSchema for Usage

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Usage

fn eq(&self, other: &Usage) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Usage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Usage