Struct TokenUsage 

pub struct TokenUsage {
    pub prompt_tokens: u32,
    pub completion_tokens: u32,
    pub total_tokens: u32,
    pub cached_prompt_tokens: u32,
    pub cache_creation_prompt_tokens: u32,
    pub cache_hit_rate: Option<f64>,
}

Fields

prompt_tokens: u32

completion_tokens: u32

total_tokens: u32

cached_prompt_tokens: u32

cache_creation_prompt_tokens: u32

Prompt tokens written to the provider’s prompt cache this step. Like cached_prompt_tokens, this is a subset of prompt_tokens, not an additional count; hosts use it to bill cache writes at the provider’s cache-write rate.

cache_hit_rate: Option<f64>

Implementations

impl TokenUsage

pub fn new( prompt_tokens: u32, completion_tokens: u32, total_tokens: u32, ) -> TokenUsage

pub fn with_cached_prompt_tokens(self, cached_prompt_tokens: u32) -> TokenUsage

pub fn with_cache_creation_prompt_tokens( self, cache_creation_prompt_tokens: u32, ) -> TokenUsage

pub fn add_assign(&mut self, usage: &TokenUsage)

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for TokenUsage

fn clone(&self) -> TokenUsage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenUsage

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

Formats the value using the given formatter.

impl Default for TokenUsage

fn default() -> TokenUsage

Returns the “default value” for a type.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<TokenUsage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TokenUsage

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TokenUsage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TokenUsage