Skip to main content

Agent

Struct Agent 

Source
pub struct Agent {
    pub name: String,
    pub instructions: Option<Instructions>,
    pub model: String,
    pub tools: Vec<Arc<dyn Tool>>,
    pub handoffs: Vec<Agent>,
    pub model_settings: ModelSettings,
    pub handoff_description: Option<String>,
}
Expand description

An AI agent configured with instructions, tools, and settings

Agents are the core abstraction for building AI applications. They encapsulate a model, system prompt (instructions), tools, and other configuration.

Fields§

§name: String

The name of the agent

§instructions: Option<Instructions>

Instructions (system prompt) for the agent

§model: String

The model to use (e.g., “gpt-4”, “claude-3-5-sonnet”)

§tools: Vec<Arc<dyn Tool>>

Tools available to the agent

§handoffs: Vec<Agent>

Handoff agents (sub-agents the agent can delegate to)

§model_settings: ModelSettings

Model settings (temperature, max_tokens, etc.)

§handoff_description: Option<String>

Description for when this agent is used as a handoff

Implementations§

Source§

impl Agent

Source

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

Create a new agent with the given name

Source

pub fn builder(name: impl Into<String>) -> AgentBuilder

Create a builder for the agent

Source

pub fn clone_with(&self) -> AgentBuilder

Clone the agent with modifications

Source

pub fn system_prompt(&self) -> Option<&str>

Get the system prompt for the agent

Source

pub async fn run( &self, input: impl Into<String>, config: &RunConfig, ) -> Result<RunResult>

Run the agent with the given input

This is a convenience method that creates a default RunConfig. For more control, use Runner::run directly.

Source

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

Add a tool to the agent

Source

pub fn with_handoff(self, agent: Agent) -> Self

Add a handoff agent

Trait Implementations§

Source§

impl Clone for Agent

Source§

fn clone(&self) -> Agent

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Agent

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Agent

§

impl !UnwindSafe for Agent

§

impl Freeze for Agent

§

impl Send for Agent

§

impl Sync for Agent

§

impl Unpin for Agent

§

impl UnsafeUnpin for Agent

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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> 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