Struct RunParams 

pub struct RunParams { /* private fields */ }

What to send when starting a run.

A builder over RunAgentInput: the two ids are required, everything else has a sensible empty default. agent.run(…) takes anything that converts into the input, so a hand-built RunAgentInput works just as well.

Implementations

impl RunParams

pub fn new(thread_id: impl Into<ThreadId>, run_id: impl Into<RunId>) -> Self

A run in thread_id, identified by run_id.

pub fn messages(self, messages: impl Into<Vec<Message>>) -> Self

Sets the conversation history, oldest first.

pub fn message(self, message: impl Into<Message>) -> Self

Appends one message.

pub fn user( self, id: impl Into<MessageId>, content: impl Into<UserContent>, ) -> Self

Appends a user message — the common case, spelled short.

pub fn state(self, state: impl Into<Value>) -> Self

Sets the shared state the agent starts from.

pub fn tools(self, tools: impl Into<Vec<Tool>>) -> Self

Offers tools for this run.

pub fn context(self, context: impl Into<Vec<Context>>) -> Self

Sets the ambient context entries.

pub fn forwarded_props(self, props: impl Into<Value>) -> Self

Sets the passthrough properties, which the protocol never interprets.

pub fn resume(self, entries: impl Into<Vec<ResumeEntry>>) -> Self

Answers the interrupts a previous run paused on. See crate::client::interrupts.

pub fn parent_run_id(self, run_id: impl Into<RunId>) -> Self

Records the run that spawned this one, for nested agents.

pub fn into_input(self) -> RunAgentInput

The request this describes.

Trait Implementations

impl Clone for RunParams

fn clone(&self) -> RunParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunParams

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

Formats the value using the given formatter.

impl Default for RunParams

fn default() -> RunParams

Returns the “default value” for a type.

impl From<RunAgentInput> for RunParams

fn from(input: RunAgentInput) -> Self

Converts to this type from the input type.

impl From<RunParams> for RunAgentInput

fn from(params: RunParams) -> Self

Converts to this type from the input type.

impl PartialEq for RunParams

fn eq(&self, other: &RunParams) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RunParams