Struct UsageMetadata 

pub struct UsageMetadata {
    pub input_tokens: i64,
    pub output_tokens: i64,
    pub total_tokens: i64,
    pub input_token_details: Option<InputTokenDetails>,
    pub output_token_details: Option<OutputTokenDetails>,
}

Usage metadata for a message, such as token counts.

This is a standard representation of token usage that is consistent across models.

Fields

input_tokens: i64

Count of input (or prompt) tokens. Sum of all input token types.

output_tokens: i64

Count of output (or completion) tokens. Sum of all output token types.

total_tokens: i64

Total token count. Sum of input_tokens + output_tokens.

input_token_details: Option<InputTokenDetails>

Breakdown of input token counts.

output_token_details: Option<OutputTokenDetails>

Breakdown of output token counts.

Implementations

impl UsageMetadata

pub fn new(input_tokens: i64, output_tokens: i64) -> Self

Create a new usage metadata with the given token counts.

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

Add another UsageMetadata to this one.

Trait Implementations

impl Clone for UsageMetadata

fn clone(&self) -> UsageMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UsageMetadata

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

Formats the value using the given formatter.

impl Default for UsageMetadata

fn default() -> UsageMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UsageMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UsageMetadata

fn eq(&self, other: &UsageMetadata) -> 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 UsageMetadata

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 UsageMetadata