Struct Usage 

#[non_exhaustive]
pub struct Usage {
    pub total_tokens: u64,
    pub input_tokens: u64,
    pub output_tokens: u64,
    pub thought_tokens: Option<u64>,
    pub cached_read_tokens: Option<u64>,
    pub cached_write_tokens: Option<u64>,
    pub meta: Option<Meta>,
}

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Token usage information for a prompt turn.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

total_tokens: u64

Sum of all token types across session.

input_tokens: u64

Total input tokens across all turns.

output_tokens: u64

Total output tokens across all turns.

thought_tokens: Option<u64>

Total thought/reasoning tokens

cached_read_tokens: Option<u64>

Total cache read tokens.

cached_write_tokens: Option<u64>

Total cache write tokens.

meta: Option<Meta>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Implementations

impl Usage

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

Available on crate feature unstable_end_turn_token_usage only.

pub fn thought_tokens(self, thought_tokens: impl IntoOption<u64>) -> Self

Available on crate feature unstable_end_turn_token_usage only.

Total thought/reasoning tokens

pub fn cached_read_tokens( self, cached_read_tokens: impl IntoOption<u64>, ) -> Self

Available on crate feature unstable_end_turn_token_usage only.

Total cache read tokens.

pub fn cached_write_tokens( self, cached_write_tokens: impl IntoOption<u64>, ) -> Self

Available on crate feature unstable_end_turn_token_usage only.

Total cache write tokens.

pub fn meta(self, meta: impl IntoOption<Meta>) -> Self

Available on crate feature unstable_end_turn_token_usage only.

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

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<'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 IntoV2 for Usage

Available on crate features unstable_end_turn_token_usage and unstable_protocol_v2 only.

type Output = Usage

The corresponding v2 draft type.

fn into_v2(self) -> Result<Self::Output>

Converts this value into the corresponding v2 draft type.

impl JsonSchema for Usage

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Usage

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