Struct ItemCostInput 

#[non_exhaustive]
pub struct ItemCostInput {
    pub state: Tokens,
    pub schema: Tokens,
    pub images: u64,
    pub image_tokens_each: u64,
    pub overhead_tokens: u64,
    pub max_passes: u64,
    pub pass_tokens: Option<u64>,
}

What one item’s provider call is estimated from.

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.

state: Tokens

The item’s state, billed on every pass.

schema: Tokens

The schema sent with every item (fields or questions), billed once across all passes.

images: u64

How many images the item carries.

image_tokens_each: u64

The module’s bound on the tokens one image costs. Required; a module that does not know it states a bound, never zero.

overhead_tokens: u64

The module’s bound on its per-request overhead (prompt template, system text). Required; never defaulted to zero.

max_passes: u64

The module’s upper bound on how many passes the provider makes for the item, at least 1. 1 for a provider that answers in one pass.

pass_tokens: Option<u64>

The provider’s per-pass token budget, when it states one. Used only to check that an exactly counted state fits in a pass; it does not decide how many passes are billed.

Implementations

impl ItemCostInput

pub fn new( state: Tokens, schema: Tokens, image_tokens_each: u64, overhead_tokens: u64, ) -> Self

pub fn with_images(self, images: u64) -> Self

pub fn with_max_passes(self, max_passes: u64) -> Self

The module’s upper bound on the passes the provider makes. Zero is refused when the item is estimated (EstimateError::NoPasses).

pub fn with_pass_tokens(self, pass_tokens: u64) -> Self

Trait Implementations

impl Clone for ItemCostInput

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 ItemCostInput

impl Debug for ItemCostInput

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

Formats the value using the given formatter.

impl Eq for ItemCostInput

impl PartialEq for ItemCostInput

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ItemCostInput