Struct UsageTotals 

pub struct UsageTotals {
    pub tokens: Usage,
    pub cost: f64,
    pub unpriced: u64,
    pub calls: u64,
}

Many calls’ Usage summed for a running account: the token counters, the known cost, and how many calls the sum holds and how many of them were not fully priced.

use rig_core::completion::{Usage, UsageTotals};

let mut totals = UsageTotals::default();
totals.record(&Usage::new().input_tokens(100).output_tokens(20).total_tokens(120));
assert_eq!((totals.calls, totals.unpriced, totals.uncached_input()), (1, 1, 100));

Fields

tokens: Usage

The token counters summed, with no cost: a call that did not report a counter adds nothing to it.

cost: f64

The known costs summed, in USD.

unpriced: u64

The calls whose cost is not known, or known only in part, so Self::cost is a lower bound when any.

calls: u64

The calls summed.

Implementations

impl UsageTotals

pub fn record(&mut self, usage: &Usage)

Adds a finished call’s usage.

pub fn add(&mut self, other: &UsageTotals)

Adds what other summed.

pub fn uncached_input(&self) -> u64

Input tokens neither read from nor written to a cache.

pub fn total_tokens(&self) -> u64

The tokens read and written, cached input included.

pub fn cost_label(&self) -> Option<String>

The cost as $0.123, ending in + when some calls were not priced, or None when no call was.

pub fn cost_or_tokens(&self) -> String

The cost, or as 1.2M tokens when no call was priced, such as a local or subscription model’s.

Trait Implementations

impl Clone for UsageTotals

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for UsageTotals

impl Debug for UsageTotals

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

Formats the value using the given formatter.

impl Default for UsageTotals

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UsageTotals

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UsageTotals

One line for a person or a log: the calls, the tokens by kind and the cost.

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

Formats the value using the given formatter.

impl PartialEq for UsageTotals

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for UsageTotals

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 UsageTotals