Struct AgentBuilder 

pub struct AgentBuilder<M>
where
    M: CompletionModel,
{ /* private fields */ }

A builder for creating an agent

Example

use rig::{providers::openai, agent::AgentBuilder};

let openai = openai::Client::from_env();

let gpt4o = openai.completion_model("gpt-4o");

// Configure the agent
let agent = AgentBuilder::new(model)
    .preamble("System prompt")
    .context("Context document 1")
    .context("Context document 2")
    .tool(tool1)
    .tool(tool2)
    .temperature(0.8)
    .additional_params(json!({"foo": "bar"}))
    .build();

Implementations

impl<M> AgentBuilder<M>

where M: CompletionModel,

pub fn new(model: M) -> Self

pub fn name(self, name: &str) -> Self

Set the name of the agent

pub fn preamble(self, preamble: &str) -> Self

Set the system prompt

pub fn without_preamble(self) -> Self

Remove the system prompt

pub fn append_preamble(self, doc: &str) -> Self

Append to the preamble of the agent

pub fn context(self, doc: &str) -> Self

Add a static context document to the agent

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

Add a static tool to the agent

pub fn rmcp_tool(self, tool: Tool, client: ServerSink) -> Self

Available on crate feature rmcp only.

pub fn dynamic_context( self, sample: usize, dynamic_context: impl VectorStoreIndexDyn + 'static, ) -> Self

Add some dynamic context to the agent. On each prompt, sample documents from the dynamic context will be inserted in the request.

pub fn dynamic_tools( self, sample: usize, dynamic_tools: impl VectorStoreIndexDyn + 'static, toolset: ToolSet, ) -> Self

Add some dynamic tools to the agent. On each prompt, sample tools from the dynamic toolset will be inserted in the request.

pub fn temperature(self, temperature: f64) -> Self

Set the temperature of the model

pub fn max_tokens(self, max_tokens: u64) -> Self

Set the maximum number of tokens for the completion

pub fn additional_params(self, params: Value) -> Self

Set additional parameters to be passed to the model

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

Build the agent