Skip to main content

AgentConfig

Struct AgentConfig 

Source
pub struct AgentConfig {
    pub system_prompt: String,
    pub model: ModelSpec,
    pub tool_names: Vec<String>,
    pub retry: RetryConfig,
    pub stream_options: StreamOptionsConfig,
    pub steering_mode: SteeringModeConfig,
    pub follow_up_mode: FollowUpModeConfig,
    pub structured_output_max_retries: usize,
    pub approval_mode: ApprovalModeConfig,
    pub plan_mode_addendum: Option<String>,
    pub cache_config: Option<CacheConfigData>,
    pub extra: Value,
}
Expand description

A fully serializable snapshot of agent configuration.

Captures the subset of AgentOptions fields that can survive a serde round-trip. Trait objects (tools, stream functions, transformers, policies, callbacks) cannot be serialized and must be re-registered by the consumer after deserialization.

§What round-trips faithfully

system_prompt, model, retry, stream_options, steering_mode, follow_up_mode, structured_output_max_retries, approval_mode, plan_mode_addendum, and cache_config are all restored by into_agent_options().

§What does NOT round-trip

  • tool_names — stored for informational use only (e.g., re-registering tools by name). The consumer must supply the actual tool implementations.
  • extra — application-level metadata that has no corresponding AgentOptions field. Survives serde but is not fed back into the agent.
  • Trait objectsstream_fn, convert_to_llm, transform_context, approve_tool, policies, event forwarders, etc. must be re-attached.

§Example

// Save
let config = agent.options().to_config();
let json = serde_json::to_string(&config)?;

// Restore
let config: AgentConfig = serde_json::from_str(&json)?;
let opts = AgentOptions::from_config(config, stream_fn, convert_to_llm)
    .with_tools(re_register_tools(&config.tool_names));

Fields§

§system_prompt: String

System prompt sent to the LLM.

§model: ModelSpec

Model specification (provider, model ID, thinking level, etc.).

§tool_names: Vec<String>

Names of registered tools (routing keys from AgentTool::name()).

§retry: RetryConfig

Retry strategy parameters.

§stream_options: StreamOptionsConfig

Per-call stream options (temperature, max tokens, transport).

§steering_mode: SteeringModeConfig

Steering queue drain mode.

§follow_up_mode: FollowUpModeConfig

Follow-up queue drain mode.

§structured_output_max_retries: usize

Max retries for structured output validation.

§approval_mode: ApprovalModeConfig

Approval mode for the tool gate.

§plan_mode_addendum: Option<String>

Optional plan mode addendum appended to the system prompt.

§cache_config: Option<CacheConfigData>

Optional context caching configuration.

§extra: Value

Arbitrary extension data for application-specific config.

This field survives serialization but is not restored into AgentOptions — it has no corresponding field there. Use it to store application-level metadata alongside the config.

Implementations§

Source§

impl AgentConfig

Source

pub fn into_agent_options( self, stream_fn: Arc<dyn StreamFn>, convert_to_llm: impl Fn(&AgentMessage) -> Option<LlmMessage> + Send + Sync + 'static, ) -> AgentOptions

Restore an AgentOptions builder from this config.

The caller must supply the required non-serializable arguments (stream_fn and convert_to_llm) and then re-attach any trait objects (tools, transformers, policies) via the builder methods.

Trait Implementations§

Source§

impl Clone for AgentConfig

Source§

fn clone(&self) -> AgentConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AgentConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for AgentConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,