Struct RunAgentInput 

pub struct RunAgentInput {
    pub thread_id: ThreadId,
    pub run_id: RunId,
    pub parent_run_id: Option<RunId>,
    pub state: Value,
    pub messages: Vec<Message>,
    pub tools: Vec<Tool>,
    pub context: Vec<Context>,
    pub forwarded_props: Value,
}

Input for running an agent.

This is the primary request type sent by clients to start or continue an agent run. It contains the thread and run identifiers, conversation messages, available tools, context, and any custom state.

Example

use ag_ui_core::{RunAgentInput, Context, Message, ThreadId, RunId};

let input = RunAgentInput::new(ThreadId::random(), RunId::random())
    .with_messages(vec![Message::new_user("Hello!")])
    .with_context(vec![
        Context::new("timezone".to_string(), "UTC".to_string()),
    ]);

assert!(input.messages.len() == 1);
assert!(input.context.len() == 1);

Fields

thread_id: ThreadId

The thread identifier for this conversation.

run_id: RunId

The run identifier for this specific agent invocation.

parent_run_id: Option<RunId>

Optional parent run ID for nested or sub-agent runs.

state: Value

The current state, can be any JSON value.

messages: Vec<Message>

The conversation messages.

tools: Vec<Tool>

The tools available to the agent.

context: Vec<Context>

Additional context provided to the agent.

forwarded_props: Value

Forwarded properties from the client.

Implementations

impl RunAgentInput

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

Creates a new RunAgentInput with the given thread and run IDs.

Initializes with empty messages, tools, context, null state, and null forwarded props.

pub fn with_parent_run_id(self, parent_id: impl Into<RunId>) -> RunAgentInput

Sets the parent run ID for nested runs.

pub fn with_state(self, state: Value) -> RunAgentInput

Sets the state.

pub fn with_messages(self, messages: Vec<Message>) -> RunAgentInput

Sets the messages.

pub fn with_tools(self, tools: Vec<Tool>) -> RunAgentInput

Sets the available tools.

pub fn with_context(self, context: Vec<Context>) -> RunAgentInput

Sets the context items.

pub fn with_forwarded_props(self, props: Value) -> RunAgentInput

Sets the forwarded props.

Trait Implementations

impl Clone for RunAgentInput

fn clone(&self) -> RunAgentInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunAgentInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RunAgentInput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RunAgentInput

fn eq(&self, other: &RunAgentInput) -> 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 Serialize for RunAgentInput

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RunAgentInput