Struct AgentRun 

pub struct AgentRun { /* private fields */ }

Available on crate feature agent only.

The sans-IO agent loop state machine. See the module docs for the driving protocol.

Implementations

impl AgentRun

pub fn new(prompt: impl Into<Message>) -> AgentRun

Create a run for one prompt with no input history, a one-model-call budget, and no invalid tool-call retries.

pub fn with_history(self, history: Vec<Message>) -> AgentRun

Set the input chat history preceding the prompt.

pub fn max_turns(self, max_turns: usize) -> AgentRun

Set the total model-call budget, including the initial call and every retry or continuation. A budget of zero emits no model calls. Exceeding the budget makes AgentRun::next_step return PromptError::MaxTurnsError.

pub fn with_output_validation( self, output_schema: Option<Value>, max_output_retries: usize, ) -> AgentRun

Configure Tool output-mode validation (#1928): the JSON schema the output-tool arguments should satisfy, and how many times to re-prompt the model — when it finalizes without calling the output tool, or calls it with arguments missing required fields — before finalizing best-effort.

pub fn max_invalid_tool_call_retries(self, retries: usize) -> AgentRun

Set the retry budget for InvalidToolCallAction::Retry resolutions. Invalid tool-call retries also consume the total model-call budget.

pub fn with_tool_choice(self, tool_choice: ToolChoice) -> AgentRun

Set the tool choice active for this run. Used to reject InvalidToolCallAction::Skip resolutions under ToolChoice::None and reported in invalid tool-call contexts.

pub fn with_output_tool_name(self, name: impl Into<String>) -> AgentRun

Set the synthetic output-tool name for Tool output mode (see #1928). When a model turn calls this tool, the run finalizes with the call’s arguments (serialized JSON) as the response.

pub fn usage(&self) -> Usage

Aggregated token usage across all completed model calls so far.

pub fn turn(&self) -> usize

Number of model calls emitted so far (including retries).

pub fn completion_calls(&self) -> &[CompletionCall]

Details for each completed model call so far.

pub fn messages(&self) -> &[Message]

Messages accumulated by this run (the prompt plus all assistant turns and tool results), excluding the input history.

pub fn retry_model_turn( &mut self, request: RetryRequest, ) -> Result<(), PromptError>

Reject the accepted, tool-free model turn and prepare another model call.

RetryRequest::Repeat discards the rejected assistant response and reuses the same prompt and preceding history with fresh request preparation. RetryRequest::Feedback records the rejected response followed by corrective user feedback. Canonical empty assistant turns are omitted from history, matching normal turn advancement. Both modes preserve completion-call and usage accounting, and the next call consumes the existing total model-call budget.

Tool-bearing turns cannot be retried through this operation because preserving them without matching tool results would create invalid provider-visible history. Use tool-call hooks to steer those turns.

pub fn full_history(&self) -> Vec<Message>

The full conversation: input history followed by Self::messages.

pub fn is_done(&self) -> bool

Whether the run reached AgentRunStep::Done.

pub fn response(&self) -> Option<&PromptResponse>

The final response once the run is done, without cloning it. AgentRun::next_step in the done state returns an owned clone (including the full accumulated message history); prefer this when only inspecting the result.

pub fn cancel_error(&self, reason: impl Into<String>) -> PromptError

Build the cancellation error a driver should return when one of its hooks terminates the run, carrying the current full history.

pub fn pending_invalid_tool_call(&self) -> Option<InvalidToolCallContext>

The invalid tool call currently awaiting AgentRun::resolve_invalid_tool_call, if any. Useful to re-derive the resolution context after deserializing a suspended run.

pub fn next_step(&mut self) -> Result<AgentRunStep, PromptError>

Advance the machine and return the next action for the driver.

Errors

• PromptError::MaxTurnsError when the total model-call budget is exhausted.
• PromptError::PromptCancelled when the machine is driven out of protocol (for example, calling this while a model response is pending).

pub fn model_response( &mut self, turn: ModelTurn, ) -> Result<ModelTurnOutcome, PromptError>

Feed the model’s response for the pending AgentRunStep::CallModel.

Records the completion call and aggregates usage, then validates the turn’s tool calls against the advertised tool names. See ModelTurnOutcome for what the driver must do next.

pub fn resolve_invalid_tool_call( &mut self, action: InvalidToolCallAction, ) -> Result<ModelTurnOutcome, PromptError>

Answer a pending ModelTurnOutcome::NeedsResolution.

Applies the agent loop’s recovery semantics:

• InvalidToolCallAction::Fail fails the run with PromptError::UnknownToolCall.
• InvalidToolCallAction::Retry rolls the turn back with corrective feedback while budget remains, consuming the total model-call budget.
• InvalidToolCallAction::Repair renames the tool call; the repaired name is revalidated against the allowed tools.
• InvalidToolCallAction::Stop cancels the run with PromptError::prompt_cancelled and the supplied reason.
• InvalidToolCallAction::Skip records a synthetic tool result and suppresses execution of every tool call in the turn. Rejected under ToolChoice::None.

pub fn tool_results( &mut self, results: Vec<UserContent>, ) -> Result<(), PromptError>

Feed the tool results for the pending AgentRunStep::CallTools.

Results may be in any order; they are appended as a single user message, matching what providers expect for parallel tool calls. Each result must be a tool result answering one of the pending calls, and every pending call must be answered — exactly what providers require to accept the next request.

pub fn record_streamed_completion_call( &mut self, usage: Usage, ) -> Result<CompletionCall, PromptError>

Record one provider completion call for a streamed turn.

Streamed turns learn usage from the provider’s final stream event — including for turns abandoned by invalid tool-call recovery, where the stream is drained for usage after the rollback — so recording is decoupled from turn ingestion. Valid while a model response is pending or between a turn rollback and the next AgentRunStep::CallModel; aggregates usage into the run total. Zero-valued usage means the provider reported no usage metrics.

pub fn streamed_invalid_tool_call_context( &self, partial: &PartialStreamedTurn, invalid: &StreamedInvalidToolCall, ) -> InvalidToolCallContext

The recovery-hook context for an invalid tool call surfaced mid-stream by a streamed::StreamedTurnAssembler.

pub fn resolve_streamed_invalid_tool_call( &mut self, partial: &PartialStreamedTurn, invalid: &StreamedInvalidToolCall, action: InvalidToolCallAction, ) -> Result<StreamedResolution, PromptError>

Resolve an invalid tool call surfaced mid-stream.

Applies the same recovery semantics as AgentRun::resolve_invalid_tool_call, but rollback messages are assembled from the partial streamed turn — exactly what the model has produced so far — and a successful retry or skip abandons the turn (see StreamedResolution) instead of finishing it.

pub fn streamed_turn(&mut self, turn: StreamedTurn) -> Result<(), PromptError>

Feed the assembled streamed turn for the pending AgentRunStep::CallModel.

Remaining tool calls are validated fail-fast — mid-stream resolution already had recovery-hook access — and the turn then advances through AgentRun::next_step exactly like a non-streamed one.

Trait Implementations

impl Clone for AgentRun

fn clone(&self) -> AgentRun

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentRun

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentRun

fn deserialize<__D>( __deserializer: __D, ) -> Result<AgentRun, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AgentRun

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.