Struct CostPreview 

#[non_exhaustive]
pub struct CostPreview {
    pub model: ModelId,
    pub input_tokens: u32,
    pub max_output_tokens: u32,
    pub input_cost_usd: f64,
    pub max_output_cost_usd: f64,
    pub max_total_usd: f64,
}

Available on crate features async and pricing only.

Pre-flight cost estimate for a request.

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.

model: ModelId

Model the estimate was computed for.

input_tokens: u32

Server-counted input tokens (from /v1/messages/count_tokens).

max_output_tokens: u32

Output upper bound, taken from request.max_tokens.

input_cost_usd: f64

USD cost of the input tokens alone.

max_output_cost_usd: f64

USD cost if the model emits exactly max_output_tokens output tokens.

max_total_usd: f64

input_cost_usd + max_output_cost_usd. The largest amount this request could cost in vanilla usage (excludes cache/server-tool charges since those are runtime-determined).

Implementations

impl CostPreview

pub fn cost_for(&self, output_tokens: u32, pricing: &PricingTable) -> f64

USD cost if the model produces exactly output_tokens tokens. Useful for plotting expected cost against an empirical output-size estimate.

Trait Implementations

impl Clone for CostPreview

fn clone(&self) -> CostPreview

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CostPreview

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

Formats the value using the given formatter.

impl PartialEq for CostPreview

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