AgentBuilder

Struct AgentBuilder 

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

Builder for creating Agent instances.

Implementations§

Source§

impl AgentBuilder

Source

pub fn new() -> Self

Source

pub fn model(self, model: impl Model + 'static) -> Self

Sets the model for the agent.

Source

pub fn model_arc(self, model: Arc<dyn Model>) -> Self

Sets the model using an Arc.

Source

pub fn messages(self, messages: Messages) -> Self

Sets the initial messages.

Source

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

Sets the system prompt.

Source

pub fn tool(self, tool: impl AgentTool + 'static) -> Result<Self>

Adds a tool to the agent.

Source

pub fn tools( self, tools: impl IntoIterator<Item = impl AgentTool + 'static>, ) -> Result<Self>

Adds multiple tools to the agent.

Source

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

Sets the tool registry.

Source

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

Sets the agent name.

Source

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

Sets the agent ID.

Source

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

Sets the agent description.

Source

pub fn state(self, state: AgentState) -> Self

Sets the agent state.

Source

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

Sets the hook registry.

Source

pub fn conversation_manager( self, manager: impl ConversationManager + 'static, ) -> Self

Sets the conversation manager.

Source

pub fn record_direct_tool_call(self, record: bool) -> Self

Sets whether to record direct tool calls in message history.

Source

pub fn trace_attribute( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Sets a trace attribute.

Source

pub fn trace_attributes(self, attrs: HashMap<String, String>) -> Self

Sets multiple trace attributes.

Source

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

Sets the maximum number of tool calls per cycle.

Source

pub fn structured_output_model<T: JsonSchema + DeserializeOwned + 'static>( self, ) -> Self

Sets the structured output model type.

This configures the agent to enforce responses matching the schema of type T. The structured output tool will be dynamically registered at invocation time and cleaned up afterward.

§Example
use schemars::JsonSchema;
use serde::Deserialize;

#[derive(JsonSchema, Deserialize)]
struct MyOutput {
    name: String,
    count: i32,
}

let agent = Agent::builder()
    .model(model)
    .structured_output_model::<MyOutput>()
    .build()?;
Source

pub fn structured_output_context(self, context: StructuredOutputContext) -> Self

Sets a custom structured output context.

Source

pub fn build(self) -> Result<Agent>

Builds the agent.

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> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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