RunAgentInput

Struct RunAgentInput 

Source
pub struct RunAgentInput {
    pub thread_id: String,
    pub run_id: String,
    pub messages: Vec<Message>,
    pub tools: Vec<Tool>,
    pub context: Vec<Context>,
    pub state: Option<Value>,
    pub parent_run_id: Option<String>,
    pub parent_thread_id: Option<String>,
    pub model: Option<String>,
    pub system_prompt: Option<String>,
    pub config: Option<Value>,
    pub forwarded_props: Option<Value>,
}
Expand description

Request to run an AG-UI agent.

Fields§

§thread_id: String

Thread identifier.

§run_id: String

Run identifier.

§messages: Vec<Message>

Conversation messages.

§tools: Vec<Tool>

Available tools.

§context: Vec<Context>

Frontend readable context entries.

§state: Option<Value>

Initial state.

§parent_run_id: Option<String>

Parent run ID (for sub-runs).

§parent_thread_id: Option<String>

Parent thread ID (for delegated/sub-agent lineage).

§model: Option<String>

Model to use.

§system_prompt: Option<String>

System prompt.

§config: Option<Value>

Additional configuration.

§forwarded_props: Option<Value>

Additional forwarded properties from AG-UI client runtimes.

Implementations§

Source§

impl RunAgentInput

Source

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

Create a new request with minimal required fields.

Source

pub fn with_message(self, message: Message) -> Self

Add a message.

Source

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

Add messages.

Source

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

Set initial state.

Source

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

Set parent thread ID.

Source

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

Set model.

Source

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

Set system prompt.

Source

pub fn with_forwarded_props(self, forwarded_props: Value) -> Self

Set forwarded props.

Source

pub fn validate(&self) -> Result<(), RequestError>

Validate the request.

Source

pub fn frontend_tools(&self) -> Vec<&Tool>

Get frontend tools from the request.

Source

pub fn has_any_interaction_responses(&self) -> bool

Check if any interaction responses exist in this request.

Source

pub fn has_any_suspension_decisions(&self) -> bool

Check if any suspension decisions exist in this request.

Source

pub fn has_user_input(&self) -> bool

Check if this request contains non-empty user input.

Source

pub fn into_runtime_run_request(self, agent_id: String) -> RunRequest

Convert this AG-UI request to the internal runtime request.

Mapping rules:

  • thread_id, run_id, parent_run_id, state are forwarded directly.
  • messages are converted via convert_agui_messages (assistant/activity/reasoning inbound messages are intentionally skipped at runtime input boundary).
  • resource_id is not provided by AG-UI and remains None.
Source

pub fn interaction_responses(&self) -> Vec<SuspensionResponse>

Extract all interaction responses from tool messages.

Source

pub fn suspension_decisions(&self) -> Vec<ToolCallDecision>

Extract all suspension decisions from tool messages.

Source

pub fn approved_target_ids(&self) -> Vec<String>

Get all approved interaction IDs.

Source

pub fn denied_target_ids(&self) -> Vec<String>

Get all denied interaction IDs.

Trait Implementations§

Source§

impl Clone for RunAgentInput

Source§

fn clone(&self) -> RunAgentInput

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 RunAgentInput

Source§

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

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

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

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 RunAgentInput

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.

§

impl<T> Instrument for T

§

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

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

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.

§

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

§

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
§

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

impl<T> WithSubscriber for T

§

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
§

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