Skip to main content

AgentResponse

Struct AgentResponse 

Source
pub struct AgentResponse {
    pub messages: Vec<Message>,
    pub response_id: Option<String>,
    pub conversation_id: Option<String>,
    pub created_at: Option<String>,
    pub usage_details: Option<UsageDetails>,
    pub value: Option<Value>,
    pub continuation_token: Option<ContinuationToken>,
    pub additional_properties: HashMap<String, Value>,
}
Expand description

A full response from an agent run.

Fields§

§messages: Vec<Message>§response_id: Option<String>§conversation_id: Option<String>

Service-side conversation id, when the backing service manages the conversation (e.g. Responses API previous_response_id, Azure AI thread id). Agent persists it onto the AgentThread.

§created_at: Option<String>§usage_details: Option<UsageDetails>§value: Option<Value>§continuation_token: Option<ContinuationToken>

Opaque token to resume this run when it is a background/long-running request that has not yet completed. None for ordinary complete runs.

§additional_properties: HashMap<String, Value>

Implementations§

Source§

impl AgentResponse

Source

pub fn text(&self) -> String

The concatenated text of all messages (no separator), matching Python.

Source

pub fn user_input_requests(&self) -> Vec<&FunctionApprovalRequestContent>

All pending user-input (function-approval) requests across the messages.

Mirrors Python AgentResponse.user_input_requests; use this to detect when a run paused awaiting human approval of a tool call.

Source

pub fn parse_json<T>(&self) -> Result<T, Error>

Parse the run’s concatenated text into a structured value.

Mirrors Python’s response.value: the message text is treated as JSON and deserialized into T.

Source

pub fn from_chat_response(resp: ChatResponse) -> AgentResponse

Build from a chat response, mapping fields across.

Source

pub fn from_updates(updates: Vec<AgentResponseUpdate>) -> AgentResponse

Aggregate a stream of agent updates into a full response.

Source

pub fn from_updates_with_format( updates: Vec<AgentResponseUpdate>, response_format: Option<&ResponseFormat>, ) -> AgentResponse

Aggregate a stream of agent updates into a full response, auto-populating AgentResponse::value from the aggregated text when a structured response_format was requested (mirrors Python’s output_format_type argument to from_agent_run_response_updates).

Source

pub fn from_agent_run_response_updates( updates: Vec<AgentResponseUpdate>, ) -> AgentResponse

Alias for AgentResponse::from_updates, matching Python’s AgentResponse.from_agent_run_response_updates.

Trait Implementations§

Source§

impl Clone for AgentResponse

Source§

fn clone(&self) -> AgentResponse

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 AgentResponse

Source§

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

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

impl Default for AgentResponse

Source§

fn default() -> AgentResponse

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AgentResponse

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for AgentResponse

Source§

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. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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