Struct ToolBudget 

#[non_exhaustive]
pub struct ToolBudget {
    pub max_steps: u32,
    pub max_total_tokens: Option<u64>,
}

How far a tool loop may run (issue #665): a hard cap on model calls, and an optional cap on the tokens those calls may spend.

#[non_exhaustive]: build one with ToolBudget::steps and the builder method rather than a struct literal, so another limit (wall clock, tool calls per step) is not a breaking change.

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.

max_steps: u32

The most model calls the loop may make. A budget of N means at most N calls: the loop makes no N+1th, even when the Nth still asks for a tool, and a budget of 0 makes none at all.

max_total_tokens: Option<u64>

The most input + output tokens the loop may spend in total, where a caller names one. None is unbounded.

Implementations

impl ToolBudget

pub fn steps(max_steps: u32) -> Self

A budget of max_steps model calls and no token ceiling.

pub fn max_total_tokens(self, max_total_tokens: u64) -> Self

Caps the total input + output tokens the loop may spend.

Trait Implementations

impl Clone for ToolBudget

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 ToolBudget

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

Formats the value using the given formatter.

impl Eq for ToolBudget

impl PartialEq for ToolBudget

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ToolBudget