Skip to main content

AgentBuilder

Struct AgentBuilder 

Source
pub struct AgentBuilder<'a> { /* private fields */ }
Expand description

Builder for creating an Agent on an AgyBridge.

Obtained from AgyBridge::agent(). Implements IntoFuture so you can .await it directly, or chain optional .tools() / .hooks() calls before awaiting.

Implementations§

Source§

impl AgentBuilder<'_>

Source

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

Attach a ToolRegistry containing custom Rust tools for the agent.

The registry’s tool definitions are automatically merged into the agent configuration.

§Errors (at build time)

Returns error::Error::InvalidConfig if config.tools is already non-empty — pass tools via the registry or via config.tools, not both.

Source

pub fn hooks(self, hooks: Hooks) -> Self

Attach Hooks for lifecycle event callbacks (pre/post turn, tool-call gating, etc.).

Source

pub fn policy_handler(self, handler: impl AskUserHandler + 'static) -> Self

Attach a custom AskUserHandler to manage interactive tool-call confirmations.

Source

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

Set a pre-existing conversation ID to resume.

Source

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

Set the model backend (e.g. "gemini-3.5-flash").

Source

pub fn system_instructions( self, instructions: impl Into<SystemInstructions>, ) -> Self

Set system instructions for the agent.

Source

pub fn workspaces( self, workspaces: impl IntoIterator<Item = impl Into<PathBuf>>, ) -> Self

Append workspace directories the agent is allowed to access and modify.

Source

pub fn policies( self, policies: impl IntoIterator<Item = impl Into<PolicyRule>>, ) -> Self

Append policy rules to govern tool execution.

Source

pub fn triggers( self, triggers: impl IntoIterator<Item = impl Into<TriggerEntry>>, ) -> Self

Append triggers that autonomously wake the agent.

Source

pub fn mcp_servers( self, servers: impl IntoIterator<Item = impl Into<McpServer>>, ) -> Self

Append MCP servers for the agent.

Source

pub fn skills( self, skills: impl IntoIterator<Item = impl Into<PathBuf>>, ) -> Self

Append paths for agent skills.

Source

pub fn max_quota_retries(self, retries: u32) -> Self

Set the maximum number of quota retry attempts before giving up.

Source

pub async fn build(self) -> Result<Agent, Error>

Validate configuration and create the agent.

Prefer using .await directly on the builder (via IntoFuture) instead of calling this method explicitly.

§Errors

Returns error::Error::InvalidConfig if:

  • config.tools is non-empty and a ToolRegistry was provided.
  • The capabilities configuration is self-contradictory (e.g. both enabled_tools and disabled_tools specified).

Returns other error::Error variants if agent creation fails.

Trait Implementations§

Source§

impl<'a> IntoFuture for AgentBuilder<'a>

Source§

type Output = Result<AgentHandle<PythonRuntime>, Error>

The output that the future will produce on completion.
Source§

type IntoFuture = Pin<Box<dyn Future<Output = <AgentBuilder<'a> as IntoFuture>::Output> + Send + 'a>>

Which kind of future are we turning this into?
Source§

fn into_future(self) -> Self::IntoFuture

Creates a future from a value. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for AgentBuilder<'a>

§

impl<'a> !UnwindSafe for AgentBuilder<'a>

§

impl<'a> Freeze for AgentBuilder<'a>

§

impl<'a> Send for AgentBuilder<'a>

§

impl<'a> Sync for AgentBuilder<'a>

§

impl<'a> Unpin for AgentBuilder<'a>

§

impl<'a> UnsafeUnpin for AgentBuilder<'a>

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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> Ungil for T
where T: Send,

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