Struct AgentConfig 

pub struct AgentConfig {

    pub name: String,
    pub description: Option<String>,
    pub model_id: String,
    pub system_prompt: Option<String>,
    pub timeout_seconds: u64,
    pub temperature: Option<f64>,
    pub max_tokens: Option<usize>,
    pub compaction_strategy: CompactionStrategy,
    pub compaction_instruction: Option<String>,
    pub context_window: usize,
    pub api_key: Option<String>,
    pub workspace_dir: Option<PathBuf>,
    pub output_mode: Option<String>,
    pub session_id: Option<String>,
    pub provider_options: Option<ProviderOptions>,
    pub ttsr_engine: Option<Arc<TtsrEngine>>,
    pub memory: Option<Arc<dyn MemoryBackend>>,
    pub todo: Option<Arc<dyn TodoStateProvider>>,
    pub agent_pool: Option<Arc<dyn AgentPoolProvider>>,
}

Agent runtime configuration

Fields

name: String

Agent name

description: Option<String>

Agent description

model_id: String

Model ID to use

system_prompt: Option<String>

System prompt

timeout_seconds: u64

Timeout in seconds for the entire agent run

temperature: Option<f64>

Temperature for generation (0.0 to 1.0)

max_tokens: Option<usize>

Maximum tokens to generate

compaction_strategy: CompactionStrategy

Compaction strategy for long conversations

compaction_instruction: Option<String>

Custom instruction passed to the compactor

context_window: usize

Model context window size (used for threshold-based compaction)

api_key: Option<String>

API key override for the provider.

When set, this is injected into oxi_ai::StreamOptions so the provider uses it instead of an environment variable.

workspace_dir: Option<PathBuf>

Working directory for file tools. Defaults to current directory if None.

output_mode: Option<String>

Output mode for agent responses.

When set, the agent extracts structured output from the final response. See OutputMode for available modes.

session_id: Option<String>

Session identity used by tools that gate behavior on liveness (e.g. the issue tool’s start/close ownership checks). When Some, this value is threaded through to crate::tools::ToolContext::session_id. None means the tool receives session_id == None and ownership-gated operations will reject the call (defensive default).

provider_options: Option<ProviderOptions>

Per-provider options for fine-grained control.

When set, these are passed through to oxi_ai::StreamOptions::provider_options so the provider can read provider-specific settings (e.g. Anthropic adaptive thinking, OpenAI reasoning_effort, Google thinkingConfig).

ttsr_engine: Option<Arc<TtsrEngine>>

TTSR engine for stream rule checking. When set, streaming output is checked against registered rules and violations trigger crate::agent_loop::StreamOutcome::RuleInterrupt.

memory: Option<Arc<dyn MemoryBackend>>

Memory backend for memory_* tools.

todo: Option<Arc<dyn TodoStateProvider>>

Todo state provider for the todo tool.

agent_pool: Option<Arc<dyn AgentPoolProvider>>

Agent pool for Hub display and sub-agent matching.

Implementations

impl AgentConfig

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

Create a new config with the given model ID.

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

Set the agent name.

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

Set the system prompt.

pub fn with_timeout(self, seconds: u64) -> Self

Set the timeout in seconds for the entire agent run.

pub fn with_compaction_strategy(self, strategy: CompactionStrategy) -> Self

Set the compaction strategy for long conversations.

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

Set a custom instruction passed to the compactor.

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

Set the session identity threaded into crate::tools::ToolContext::session_id.

Tools that gate behavior on liveness (e.g. an issue tool’s start/close ownership checks) use this to identify the caller. Leaving it None causes those tools to see an empty caller id and reject ownership-gated operations (defensive default).

Trait Implementations

impl Clone for AgentConfig

fn clone(&self) -> AgentConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentConfig

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

Formats the value using the given formatter.

impl Default for AgentConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AgentConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AgentConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.