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>,
    pub service_tier: Option<String>,
}

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>

service_tier: Option<String>

Service tier the provider reports it actually served this step with (OpenAI response.service_tier). A request for a faster tier may be downgraded under load and reported here as "default", which is what the step is billed at. None when the provider did not report one. When usage is aggregated with add_assign, the most recently reported tier wins; consumers needing per-step precision read per-step usage.

Implementations

impl TokenUsage

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

pub fn with_service_tier(self, service_tier: Option<String>) -> Self

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

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

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

pub fn is_empty(&self) -> bool

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 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 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