Skip to main content

TypedRun

Struct TypedRun 

Source
pub struct TypedRun<T> { /* private fields */ }
Expand description

A run that deserializes its accepted output as T.

Configure it with the same setters as AgentRunner, then .await it for a TypedPromptResponse<T>. With a retries budget, a failed attempt (run error, empty output, unparseable output) is retried from scratch; usage accumulates across attempts.

Implementations§

Source§

impl<T> TypedRun<T>

Source

pub fn retries(self, retries: u64) -> Self

Retry a failed attempt up to retries more times. An attempt fails when the run errors, produces no output, or produces output that does not parse as T. Usage accumulates across attempts.

Source

pub fn tool_context(self, context: ToolContext) -> Self

Attach a per-call ToolContext for this run.

Every tool the agent executes during this run can read the caller-provided values (auth tokens, session IDs, conversation state, …) through the tool’s ToolContext, without the model ever seeing them.

Source

pub fn history<H, Item>(self, history: H) -> Self
where H: IntoIterator<Item = Item>, Item: Into<Message>,

Add chat history to the run.

Source

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

Override the agent preamble for this run.

Source

pub fn without_preamble(self) -> Self

Remove the agent’s configured preamble for this run.

Source

pub fn document(self, document: Document) -> Self

Append one static context document for this run.

Source

pub fn documents(self, documents: impl IntoIterator<Item = Document>) -> Self

Append static context documents for this run.

Source

pub fn temperature(self, temperature: f64) -> Self

Override the model temperature for this run.

Source

pub fn without_temperature(self) -> Self

Remove the agent’s configured temperature for this run.

Source

pub fn max_tokens(self, max_tokens: u64) -> Self

Override the maximum completion token count for this run.

Source

pub fn without_max_tokens(self) -> Self

Remove the agent’s configured maximum token count for this run.

Source

pub fn merge_additional_params(self, params: Map<String, Value>) -> Self

Shallow-merge object fields into the provider-specific parameters for this run. Later fields win.

Source

pub fn replace_additional_params(self, params: Value) -> Self

Replace all provider-specific parameters for this run.

Source

pub fn without_additional_params(self) -> Self

Remove the agent’s configured provider-specific parameters for this run.

Source

pub fn tool_choice(self, tool_choice: ToolChoice) -> Self

Override the tool-choice policy for this run.

Source

pub fn without_tool_choice(self) -> Self

Remove the agent’s configured tool-choice policy for this run.

Source

pub fn record_content_telemetry(self, enabled: bool) -> Self

Opt in or out of recording sensitive request, response, and tool content on GenAI telemetry spans for this run.

Defaults to the agent’s setting, which defaults to false. Enabling this can expose prompts, retrieved context, tool results, model responses, and other sensitive or high-cardinality data through OpenTelemetry span attributes. Structural metadata and token usage remain available when disabled.

Source

pub fn conversation(self, id: impl Into<ConversationId>) -> Self

Set the conversation id used to load and persist memory for this run.

Overrides any default conversation id set on the agent. If memory is not configured on the agent, this has no effect.

Source

pub fn without_memory(self) -> Self

Disable conversation memory for this run.

History will neither be loaded from nor saved to the agent’s memory backend.

Source

pub fn max_invalid_tool_call_retries(self, retries: usize) -> Self

Set the retry budget for invalid tool-call recovery.

Invalid tool-call retries also consume the total model-call budget.

Source

pub fn using_model(self, model: impl Into<ModelRef>) -> Self

Set the default model candidate for this run.

This does not suppress registered model-selection hooks, which may replace this candidate before each model call (including retries).

Source

pub fn using_model_value(self, model: impl Into<DynModel<Completion>>) -> Self

Erase and set a typed default model for this run.

Source

pub fn max_turns(self, max_turns: usize) -> Self

Set the total model-call budget, including the initial call and every retry or continuation. Zero emits no model calls; one permits only the initial call. Exceeding the budget returns a StructuredOutputError::PromptError wrapping a MaxTurnsError.

Source

pub fn add_hook<H>(self, hook: H) -> Self
where H: AgentHook + 'static,

Append a hook to this run’s hook stack (on top of any the agent already carries). See the hook module docs.

Source

pub fn tool_concurrency(self, concurrency: usize) -> Self

Execute up to concurrency of a turn’s tool calls at once. See AgentRunner::tool_concurrency for ordering guarantees.

Trait Implementations§

Source§

impl<T> IntoFuture for TypedRun<T>

Source§

type Output = Result<TypedPromptResponse<T>, StructuredOutputError>

The output that the future will produce on completion.
Source§

type IntoFuture = Pin<Box<dyn Future<Output = <TypedRun<T> as IntoFuture>::Output> + Send>>

Which kind of future are we turning this into?
Source§

fn into_future(self) -> Self::IntoFuture

Creates a future from a value. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for TypedRun<T>

§

impl<T> !UnwindSafe for TypedRun<T>

§

impl<T> Freeze for TypedRun<T>
where PhantomData<T>: Freeze,

§

impl<T> Send for TypedRun<T>
where PhantomData<T>: Send,

§

impl<T> Sync for TypedRun<T>
where PhantomData<T>: Sync,

§

impl<T> Unpin for TypedRun<T>
where PhantomData<T>: Unpin,

§

impl<T> UnsafeUnpin for TypedRun<T>

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> 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> 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> Same for T

Source§

type Output = T

Should always be Self
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> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

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> 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