Skip to main content

AgentBuilder

Struct AgentBuilder 

Source
pub struct AgentBuilder { /* private fields */ }
Expand description

Agent Builder — fluent API to create a FunctionCallingAgent

Uses the Builder pattern so users can create and run an Agent in just 3 lines.

§Basic usage

let agent = AgentBuilder::new()
    .llm(OpenAIChat::new(OpenAIConfig::new("sk-...")))
    .system("You are a helpful assistant.")
    .tool(Calculator::new())
    .build()?;

§Using Arc<dyn BaseChatModel>

let llm = wrap_chat_model(OpenAIChat::new(config));
let agent = AgentBuilder::new()
    .llm_from_arc(llm)
    .system("You are a helpful assistant.")
    .build()?;

Implementations§

Source§

impl AgentBuilder

Source

pub fn new() -> Self

Creates a new AgentBuilder

Source

pub fn llm<L>(self, llm: L) -> Self
where L: BaseChatModel + Send + Sync + 'static, L::Error: Into<ProviderError>,

Sets the LLM (any type implementing BaseChatModel)

Automatically wraps it as Arc<dyn BaseChatModel<Error = ProviderError>>.

Source

pub fn llm_from_arc( self, llm: Arc<dyn BaseChatModel<Error = ProviderError> + Send + Sync>, ) -> Self

Sets the LLM (from an already-wrapped Arc<dyn BaseChatModel>)

For LLM instances already created via wrap_chat_model() or LLMClient.

Source

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

Sets the system prompt

Source

pub fn tool<T: BaseTool + 'static>(self, tool: T) -> Self

Adds a single tool

Source

pub fn tools(self, tools: Vec<Arc<dyn BaseTool>>) -> Self

Adds multiple tools

Source

pub fn max_iterations(self, n: usize) -> Self

Sets max iterations (clamped to [1, 100] to prevent 0 or runaway limits)

Source

pub fn build(self) -> Result<FunctionCallingAgent, AgentError>

Builds a FunctionCallingAgent

§Errors

Returns AgentError::Other if no LLM was set.

Source

pub fn build_as_agent(self) -> Result<Arc<dyn BaseAgent>, AgentError>

Builds and wraps as Arc<dyn BaseAgent> for direct use with AgentExecutor

§Errors

Returns AgentError::Other if no LLM was set.

Source

pub fn get_max_iterations(&self) -> usize

Returns the max iterations

Trait Implementations§

Source§

impl Default for AgentBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more