Struct Agent 

pub struct Agent { /* private fields */ }

One configured model-tool agent.

Implementations

impl Agent

pub fn run<'a>( &'a self, input: impl Into<String> + Send + 'a, run: &'a RunContext, ) -> AgentFuture<'a, Result<AgentOutcome, AgentError>>

Runs a user text turn inside an existing runtime context.

pub fn stream<'a>( &'a self, input: impl Into<String> + Send + 'a, run: &'a RunContext, ) -> AgentEventStream<'a>

Streams real-time events while driving the canonical Agent loop.

pub fn run_checkpointed<'a>( &'a self, input: impl Into<String> + Send + 'a, run: &'a RunContext, checkpoint: &'a AgentCheckpoint, ) -> AgentFuture<'a, Result<AgentOutcome, AgentError>>

Runs with write-ahead checkpoint persistence.

pub fn resume<'a>( &'a self, checkpoint: &'a AgentCheckpoint, run: &'a RunContext, policy: ResumePolicy, ) -> AgentFuture<'a, Result<AgentOutcome, AgentError>>

Resumes a persisted Agent execution.

impl Agent

pub fn builder( name: impl Into<String>, model: Arc<dyn Model>, model_ref: ModelRef, ) -> AgentBuilder

Starts a fluent builder for an Agent.

pub fn new( name: impl Into<String>, model: Arc<dyn Model>, model_ref: ModelRef, ) -> Self

Creates an agent without instructions or tools.

pub fn system(self, instruction: impl Into<String>) -> Self

Appends a system instruction.

pub fn tools(self, tools: ToolRegistry) -> Self

Installs the registry whose tools are exposed and executable.

pub fn agents(self, agents: AgentGateway) -> Self

Installs the gateway whose child agents are exposed and callable.

pub fn effect_executor(self, effects: EffectExecutor) -> Self

Replaces the write-ahead effect coordinator shared by callables.

pub const fn effect_recovery_policy(self, policy: EffectRecoveryPolicy) -> Self

Sets recovery behavior for ambiguous callable effects.

pub const fn with_config(self, config: AgentConfig) -> Self

Replaces local execution configuration.

pub fn output_format(self, output_format: OutputFormat) -> Self

Sets the desired format for the terminal model response.

pub fn structured_output<T>(self, name: impl Into<String>) -> Self

where T: JsonSchema,

Requests strict structured output described by the Rust type T.

pub fn into_structured<T>(self, name: impl Into<String>) -> StructuredAgent<T>

where T: JsonSchema,

Binds provider schema generation and local decoding to the same type.

pub fn name(&self) -> &str

Returns the stable local agent name.

pub const fn model_ref(&self) -> &ModelRef

Returns the provider and model identity used by this Agent.

pub fn callable_capabilities(&self) -> CapabilitySet

Returns capabilities for every Tool and child Agent exposed by this Agent.

The returned set is not granted automatically. Applications explicitly decide whether to install it on a root or delegated Run.

Trait Implementations

impl Clone for Agent

fn clone(&self) -> Agent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Agent

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

Formats the value using the given formatter.