Struct AgentOptions 

pub struct AgentOptions { /* private fields */ }

Configuration for model requests, tool execution, and hooks.

Construct validated options with AgentOptions::builder. Default leaves the model and base URL empty without validation. Clones share tool handlers. max_tokens and temperature remain unset unless explicitly supplied.

Implementations

impl AgentOptions

pub fn builder() -> AgentOptionsBuilder

Creates a builder that requires a model and base URL.

See AgentOptionsBuilder for an example.

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 headers(&self) -> &BTreeMap<String, String>

Returns the caller-supplied HTTP headers.

pub fn max_turns(&self) -> u32

Returns the retained max_turns compatibility value.

The SDK does not enforce it. Use max_tool_iterations for automatic tool rounds and enforce conversation limits in your application.

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

Returns the maximum tokens setting.

pub fn temperature(&self) -> Option<f32>

Returns the sampling temperature, or None when the server should choose.

pub fn protocol(&self) -> ApiProtocol

Returns the wire protocol this endpoint speaks.

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.

pub fn include_reasoning(&self) -> bool

Returns whether the reasoning channel is surfaced to the caller.

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

Omits credentials and shows tool counts instead of handlers.

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

Formats the value using the given formatter.

impl Default for AgentOptions

Defaults with an empty model and base URL. Use the builder for runtime validation.

fn default() -> Self

Returns the “default value” for a type.