Struct AgentOptions 

pub struct AgentOptions { /* private fields */ }

Configuration options for an AI agent instance.

AgentOptions controls all aspects of agent behavior including model selection, conversation management, tool usage, and lifecycle hooks. This struct should be constructed using AgentOptions::builder() rather than direct instantiation to ensure required fields are validated.

Architecture

The options are organized into several functional areas:

• Model Configuration: model, base_url, api_key, temperature, max_tokens
• Conversation Control: system_prompt, max_turns, timeout
• Tool Management: tools, auto_execute_tools, max_tool_iterations
• Lifecycle Hooks: hooks for monitoring and interception

Thread Safety

Tools are wrapped in Arc<Tool> to allow efficient cloning and sharing across threads, as agents may need to be cloned for parallel processing.

Examples

use open_agent::AgentOptions;

let options = AgentOptions::builder()
    .model("qwen2.5-32b-instruct")
    .base_url("http://localhost:1234/v1")
    .system_prompt("You are a helpful coding assistant")
    .max_turns(5)
    .temperature(0.7)
    .build()
    .expect("Valid configuration");

Implementations

impl AgentOptions

pub fn builder() -> AgentOptionsBuilder

Creates a new builder for constructing AgentOptions.

The builder pattern is used because:

1. Some fields are required (model, base_url) and need validation
2. Many fields have sensible defaults that can be overridden
3. The API is more discoverable and readable than struct initialization

Example

use open_agent::AgentOptions;

let options = AgentOptions::builder()
    .model("qwen2.5-32b-instruct")
    .base_url("http://localhost:1234/v1")
    .build()
    .expect("Valid configuration");

pub fn system_prompt(&self) -> &str

Returns the system prompt.

pub fn model(&self) -> &str

Returns the model identifier.

pub fn base_url(&self) -> &str

Returns the base URL.

pub fn api_key(&self) -> &str

Returns the API key.

pub fn max_turns(&self) -> u32

Returns the maximum number of conversation turns.

pub fn max_tokens(&self) -> Option<u32>

Returns the maximum tokens setting.

pub fn temperature(&self) -> f32

Returns the sampling temperature.

pub fn timeout(&self) -> u64

Returns the HTTP timeout in seconds.

pub fn tools(&self) -> &[Arc<Tool>]

Returns a reference to the tools vector.

pub fn auto_execute_tools(&self) -> bool

Returns whether automatic tool execution is enabled.

pub fn max_tool_iterations(&self) -> u32

Returns the maximum tool execution iterations.

pub fn hooks(&self) -> &Hooks

Returns a reference to the hooks configuration.

Trait Implementations

impl Clone for AgentOptions

fn clone(&self) -> AgentOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentOptions

Custom Debug implementation to prevent sensitive data leakage.

We override the default Debug implementation because:

1. The api_key field may contain sensitive credentials that shouldn’t appear in logs or error messages
2. The tools vector contains Arc-wrapped closures that don’t debug nicely, so we show a count instead

This ensures that debug output is safe for logging while remaining useful for troubleshooting.

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

Formats the value using the given formatter.

impl Default for AgentOptions

Default values optimized for common single-turn use cases.

These defaults are chosen to:

• Require explicit configuration of critical fields (model, base_url)
• Provide safe, sensible defaults for optional fields
• Work with local inference servers that don’t need authentication

fn default() -> Self

Returns the “default value” for a type.