Skip to main content

AgentRunOptions

Struct AgentRunOptions 

Source
pub struct AgentRunOptions {
    pub chat_options: Option<ChatOptions>,
    pub additional_tools: Vec<ToolDefinition>,
    pub background: Option<bool>,
    pub continuation_token: Option<ContinuationToken>,
}
Expand description

Per-run option overrides for a single SupportsAgentRun::run_with_options / SupportsAgentRun::run_stream call, merged over the agent’s build-time defaults.

Mirrors upstream run/run_stream per-call keyword arguments and .NET AgentRunOptions: the per-run ChatOptions take precedence over the agent’s defaults (via ChatOptions::merge, matching Python’s run_chat_options & ChatOptions(...)), and additional_tools are appended to the tool list for that call only.

Fields§

§chat_options: Option<ChatOptions>

Chat-option overrides merged over the agent’s defaults (per-run wins).

§additional_tools: Vec<ToolDefinition>

Extra tools available only for this run, appended to the agent’s tools.

Declaration-only tools (no executor) surface their calls back to the caller instead of being executed locally — this is how a hosting frontend injects client-side tools (see the AG-UI router).

§background: Option<bool>

Run as a background (long-running) operation, overriding ChatOptions::background for this run.

Mirrors .NET AgentRunOptions.AllowBackgroundResponses (Python passes background in the run options). When the service accepts the request without finishing it, the response carries a continuation_token to poll or resume with. A background run needs a session, so that the follow-up runs share its conversation.

§continuation_token: Option<ContinuationToken>

Poll or resume the background run that issued this token, overriding ChatOptions::continuation_token for this run.

Mirrors .NET AgentRunOptions.ContinuationToken. A run that carries one continues an existing operation, so it takes no new messages, and neither history nor context providers are consulted for the request.

Implementations§

Source§

impl AgentRunOptions

Source

pub fn new() -> AgentRunOptions

Empty options (no overrides).

Source

pub fn with_chat_options(self, options: ChatOptions) -> AgentRunOptions

Set the per-run chat-option overrides (merged over the agent defaults, per-run winning).

Source

pub fn with_tool(self, tool: ToolDefinition) -> AgentRunOptions

Append a tool available only for this run.

Source

pub fn with_tools( self, tools: impl IntoIterator<Item = ToolDefinition>, ) -> AgentRunOptions

Append multiple tools available only for this run.

Source

pub fn with_background(self, background: bool) -> AgentRunOptions

Ask for a background (long-running) run. See Self::background.

Source

pub fn with_continuation_token( self, token: ContinuationToken, ) -> AgentRunOptions

Poll or resume a background run. See Self::continuation_token.

Source

pub fn is_empty(&self) -> bool

Whether these options carry no overrides at all. Used by the default SupportsAgentRun::run_with_options to decide whether to warn about ignoring options it cannot honor.

Trait Implementations§

Source§

impl Clone for AgentRunOptions

Source§

fn clone(&self) -> AgentRunOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AgentRunOptions

Source§

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

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

impl Default for AgentRunOptions

Source§

fn default() -> AgentRunOptions

Returns the “default value” for a type. 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: Sized + 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: Sized + 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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