Struct TokenUsage 

pub struct TokenUsage {
    pub input: u64,
    pub output: u64,
    pub cache_write: u64,
    pub cache_read: u64,
}

What a call actually consumed, split by how each token was billed.

The four counts are disjoint: a prompt token is billed exactly once, as uncached input, as a cache write, or as a cache read.

Fields

input: u64

Prompt tokens charged at the full input rate.

output: u64

Completion tokens.

cache_write: u64

Prompt tokens written to the cache this call.

cache_read: u64

Prompt tokens served from the cache this call.

Implementations

impl TokenUsage

pub const NONE: Self

Nothing consumed.

pub fn prompt_tokens(&self) -> u64

Every prompt token, however it was billed.

pub fn total_tokens(&self) -> u64

Prompt plus completion.

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

What fraction of the prompt was served from cache, as a percentage.

The number to watch when a cache is supposed to be working: a prefix that should be hitting and reads zero means something upstream is changing bytes that were meant to be stable.

pub fn plus(self, other: Self) -> Self

Add another call’s usage to this one.

Trait Implementations

impl Clone for TokenUsage

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TokenUsage

impl Debug for TokenUsage

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

Formats the value using the given formatter.

impl Default for TokenUsage

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TokenUsage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TokenUsage

impl PartialEq for TokenUsage

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TokenUsage

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 TokenUsage