Struct Usage 

pub struct Usage {
    pub completion_tokens: usize,
    pub prompt_tokens: usize,
    pub total_tokens: usize,
    pub prompt_audio_seconds: Option<u64>,
    pub num_cached_tokens: Option<u64>,
    pub prompt_tokens_details: Option<PromptTokensDetails>,
}

Token usage returned by Mistral’s chat completions and embeddings endpoints.

See https://docs.mistral.ai/api/ (UsageInfo schema). The three counts are always present; the remaining fields are populated by Mistral on a best-effort basis (e.g. cached-token information appears once a prompt is large enough to be cached).

Fields

completion_tokens: usize

prompt_tokens: usize

total_tokens: usize

prompt_audio_seconds: Option<u64>

Duration in seconds of audio tokens in the prompt (audio-input models only).

num_cached_tokens: Option<u64>

Total cached prompt tokens reported at the top level. Some Mistral responses populate this in addition to (or instead of) prompt_tokens_details.cached_tokens.

prompt_tokens_details: Option<PromptTokensDetails>

In-depth breakdown of prompt token usage (currently only cached tokens).

Implementations

impl Usage

pub fn cached_tokens(&self) -> u64

Returns the number of cached prompt tokens, preferring the structured prompt_tokens_details.cached_tokens field and falling back to the top-level num_cached_tokens. Returns 0 when neither is present.

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<(), Error>

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<Usage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Usage

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

Formats the value using the given formatter.

impl GetTokenUsage for Usage

fn token_usage(&self) -> Usage

Returns token usage for this response. Zero-valued usage is Usage’s documented sentinel for missing provider usage metrics; response types that carry no usage return Usage::new.

impl Serialize for Usage

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.