Struct SessionOptions 

pub struct SessionOptions {

    pub provider: Option<String>,
    pub model: Option<String>,
    pub api_key: Option<String>,
    pub thinking: Option<ThinkingLevel>,
    pub system_prompt: Option<String>,
    pub append_system_prompt: Option<String>,
    pub enabled_tools: Option<Vec<String>>,
    pub working_directory: Option<PathBuf>,
    pub no_session: bool,
    pub session_path: Option<PathBuf>,
    pub session_dir: Option<PathBuf>,
    pub extension_paths: Vec<PathBuf>,
    pub extension_policy: Option<String>,
    pub repair_policy: Option<String>,
    pub include_cwd_in_prompt: bool,
    pub max_tool_iterations: usize,
    pub tool_factory: Option<Arc<dyn ToolFactory>>,
    pub on_event: Option<Arc<dyn Fn(AgentEvent) + Send + Sync>>,
    pub on_tool_start: Option<OnToolStart>,
    pub on_tool_end: Option<OnToolEnd>,
    pub on_stream_event: Option<OnStreamEvent>,
}

SDK session construction options.

These options provide the programmatic equivalent of the core CLI startup path used in src/main.rs.

Fields

provider: Option<String>

model: Option<String>

api_key: Option<String>

thinking: Option<ThinkingLevel>

system_prompt: Option<String>

append_system_prompt: Option<String>

enabled_tools: Option<Vec<String>>

working_directory: Option<PathBuf>

no_session: bool

session_path: Option<PathBuf>

session_dir: Option<PathBuf>

extension_paths: Vec<PathBuf>

extension_policy: Option<String>

repair_policy: Option<String>

include_cwd_in_prompt: bool

max_tool_iterations: usize

tool_factory: Option<Arc<dyn ToolFactory>>

Optional factory for the session’s ToolRegistry.

When None (the default), create_agent_session builds the built-in tool set from SessionOptions::enabled_tools exactly as it always has — existing callers are unaffected.

Setting this lets a downstream embedder layer custom tools onto the registry: approval-gated wrappers around the built-ins, a read-only “plan mode” subset, a Task tool that spawns nested sandboxed sessions, etc. Implement ToolFactory on your own Send + Sync type and call default_tool_registry from inside it to inherit the current built-in resolution rules.

Wrapped in Arc because SessionOptions is cloned through the session-handle pipeline and the factory may need to outlive the options struct.

on_event: Option<Arc<dyn Fn(AgentEvent) + Send + Sync>>

Session-level event listener invoked for every AgentEvent.

Unlike the per-prompt callback passed to AgentSessionHandle::prompt, this fires for all prompts throughout the session lifetime.

on_tool_start: Option<OnToolStart>

Typed callback invoked when tool execution starts.

on_tool_end: Option<OnToolEnd>

Typed callback invoked when tool execution ends.

on_stream_event: Option<OnStreamEvent>

Callback for raw provider StreamEvents.

Trait Implementations

impl Clone for SessionOptions

fn clone(&self) -> SessionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for SessionOptions

fn default() -> Self

Returns the “default value” for a type.