Struct Budget 

pub struct Budget {
    pub max_steps: Option<u32>,
    pub max_usd: Option<f64>,
    pub max_tokens: Option<u64>,
    pub min_output_tokens: Option<u32>,
}

Hard limits enforced by the runtime before every model call.

Fields

max_steps: Option<u32>

Maximum number of model calls.

max_usd: Option<f64>

Maximum spend in USD. Every model the agent may call must have pricing, otherwise crate::AgentBuilder::build refuses the agent.

max_tokens: Option<u64>

Maximum input + output tokens.

min_output_tokens: Option<u32>

Stop instead of calling the model when the remaining budget allows fewer output tokens than this. Defaults to 1.

Implementations

impl Budget

pub fn max_steps(self, n: u32) -> Self

pub fn max_usd(self, usd: f64) -> Self

pub fn max_tokens(self, n: u64) -> Self

pub fn min_output_tokens(self, n: u32) -> Self

pub fn output_cap( &self, configured: u32, used_tokens: u64, spent_usd: f64, est_input_tokens: u64, call_cost: impl Fn(u64, u64) -> Option<f64>, ) -> Result<u32, String>

Largest output-token limit for the next call that keeps the run within budget, given an estimate of the call’s input tokens.

call_cost(input, output) is the model’s worst-case USD for a call (see crate::Model::max_call_cost). Returns Err(reason) when the remaining budget cannot pay for min_output_tokens.

pub fn exceeded(&self, steps: u32, tokens: u64, usd: f64) -> Option<String>

Returns why the budget is exhausted, if it is.

Trait Implementations

impl Clone for Budget

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Budget

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

Formats the value using the given formatter.

impl Default for Budget

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Budget

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Budget

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Budget

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 Budget