Skip to main content

AgentBuilder

Struct AgentBuilder 

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

Implementations§

Source§

impl AgentBuilder

Source

pub fn new(provider: Arc<dyn LlmProvider>) -> Self

Create a new builder with an LlmProvider.

Source

pub fn event_bus_capacity(self, capacity: usize) -> Self

Source

pub fn session_id_generator( self, generator: Arc<dyn SessionIdGenerator>, ) -> Self

Source

pub fn convert_to_llm(self, cb: ConvertToLlmFn) -> Self

Set a callback to transform messages before they are sent to the LLM.

The default behavior (when None) is to filter out ChatMessage::Custom variants, which most providers don’t understand. Override this to inject custom serialization logic for application-specific message types.

Source

pub fn guard(self, guard: impl ReactLoopGuard + 'static) -> Self

Source

pub fn guard_dyn(self, guard: Arc<dyn ReactLoopGuard>) -> Self

Set a guard from a pre-built Arc<dyn ReactLoopGuard>.

Use this when you need to share the guard reference (e.g. for inspecting recorded calls in tests).

Source

pub fn context_compactor(self, compactor: Arc<dyn ContextCompaction>) -> Self

Set an inline context compactor for the react loop.

When set, the react loop will check token count after each tool turn and compact the session if it exceeds the configured threshold.

Source

pub fn get_guard(&self) -> Option<&Arc<dyn ReactLoopGuard>>

Check if a guard has been set.

Used by agent-works to inject a default guard if none was set.

Source

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

Source

pub fn enable_thought(self, enable: bool) -> Self

Set whether to include the reasoning content in LLM responses.

Controls whether the reasoning_content field from the LLM is forwarded to consumers (i.e., “show the thinking process”). See AgentConfig::enable_thought for the distinction from enable_thinking().

Source

pub fn reasoning(self, config: ReasoningConfig) -> Self

Source

pub fn enable_thinking(self, enable: bool) -> Self

Set whether to enable the model’s extended thinking / reasoning mode.

Controls whether the model performs deep reasoning (i.e., “enable thinking mode”). See AgentConfig::enable_thought for the distinction from enable_thought().

Source

pub fn thinking_budget(self, budget: u64) -> Self

Source

pub fn tool_timeout(self, timeout_ms: u64) -> Self

Source

pub fn max_tool_output_chars(self, max_chars: usize) -> Self

Source

pub fn register_tool(self, tool: impl Tool + 'static) -> Self

Source

pub fn register_tool_arc(self, tool: Arc<dyn Tool>) -> Self

Source

pub fn approval_handler(self, handler: Arc<dyn ApprovalHandler>) -> Self

Source

pub fn tool_policy(self, policy: Arc<dyn ToolPolicy>) -> Self

Source

pub fn middleware(self, mw: impl Middleware + 'static) -> Self

Source

pub fn context_window(self, max_tokens: usize) -> Self

Source

pub fn context_window_manager(self, manager: ContextWindowManager) -> Self

Source

pub fn response_format(self, format: ResponseFormat) -> Self

Source

pub fn llm_retry(self, retry: RetryConfig) -> Self

Source

pub fn session_store(self, store: Arc<dyn SessionStore>) -> Self

Source

pub fn error_recovery(self, recovery: Arc<dyn ToolErrorRecovery>) -> Self

Source

pub fn max_sessions(self, max: usize) -> Self

Source

pub fn max_turns_per_session(self, max: usize) -> Self

Source

pub fn execution_max_turns(self, max: u32) -> Self

Cap the number of react-loop iterations allowed for a single run (one user input). Distinct from Self::max_turns_per_session, which caps turns across the whole session. When unset, falls back to DEFAULT_MAX_TURNS (50).

Source

pub fn max_message_tokens(self, max: usize) -> Self

Source

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

Source

pub fn language(self, language: Language) -> Self

Source

pub fn apply_if<T>( self, value: Option<T>, f: impl FnOnce(Self, T) -> Self, ) -> Self

Conditionally chain a builder call: apply f only when value is Some.

§Example
let builder = AgentBuilder::new(client)
    .apply_if(config.timeout, |b, t| b.tool_timeout(t))
    .apply_if(config.max_chars, |b, c| b.max_tool_output_chars(c));
Source

pub fn build(self) -> AgentResult<AgentRuntime>

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, 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, <T as TryFrom<U>>::Error>

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