Struct Usage 

pub struct Usage {
    pub input: InputTokens,
    pub output: OutputTokens,
    pub raw: Option<JsonObject>,
}

Token usage of a single language model call or of several added calls.

Every counter is optional because providers report different subsets. Standard fields that cannot be mapped are None; the provider’s original usage object is available in raw.

Fields

input: InputTokens

Input (prompt) token counts.

output: OutputTokens

Output (completion) token counts.

raw: Option<JsonObject>

Provider-specific usage object as returned by the API.

Implementations

impl Usage

pub fn totals(input: u64, output: u64) -> Self

Creates a usage with only the total input and output counts set.

pub fn add(&self, other: &Usage) -> Usage

Adds two usages counter by counter.

None + None = None; Some(a) + None = Some(a). The raw object is dropped because provider payloads cannot be combined generically.

pub fn total_tokens(&self) -> Option<u64>

Total tokens: input total plus output total (None when both unknown).

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