Struct Agent

pub struct Agent { /* private fields */ }

Agents are the main interface for building agentic systems.

Construct agents by calling the builder, setting an llm, configure hooks, tools and other customizations.

Important defaults

• The default context is the DefaultContext, executing tools locally with the LocalExecutor.
• A default stop tool is provided for agents to explicitly stop if needed
• The default SystemPrompt instructs the agent with chain of thought and some common safeguards, but is otherwise quite bare. In a lot of cases this can be sufficient.

Implementations

impl Agent

pub fn builder() -> AgentBuilder

Build a new agent

impl Agent

pub async fn query(&mut self, query: impl Into<String> + Debug) -> Result<()>

Run the agent with a user message. The agent will loop completions, make tool calls, until no new messages are available.

pub async fn query_once( &mut self, query: impl Into<String> + Debug, ) -> Result<()>

Run the agent with a user message once.

pub async fn run(&mut self) -> Result<()>

Run the agent with without user message. The agent will loop completions, make tool calls, until no new messages are available.

pub async fn run_once(&mut self) -> Result<()>

Run the agent with without user message. The agent will loop completions, make tool calls, until

pub async fn history(&self) -> Vec<ChatMessage>

Retrieve the message history of the agent

pub fn stop(&mut self)

Tell the agent to stop. It will finish it’s current loop and then stop.

pub fn context(&self) -> &dyn AgentContext

Access the agent’s context

pub fn is_running(&self) -> bool

The agent is still running

pub fn is_stopped(&self) -> bool

The agent stopped

pub fn is_pending(&self) -> bool

The agent has not (ever) started

Trait Implementations

impl Clone for Agent

fn clone(&self) -> Agent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Agent

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

Formats the value using the given formatter.