Skip to main content

ModelResponse

Struct ModelResponse 

Source
pub struct ModelResponse {
    pub id: String,
    pub model: String,
    pub stop_reason: StopReason,
    pub content: Vec<ContentPart>,
    pub usage: Usage,
    pub rate_limit: Option<RateLimitSnapshot>,
    pub warnings: Vec<ModelWarning>,
    pub provider_echoes: Vec<ProviderEchoSnapshot>,
}
Expand description

One reply from a model invocation, after decoding.

Fields§

§id: String

Vendor-assigned response ID (used for tracing and replay).

§model: String

Echo of the model that produced this response — useful when the codec resolved an alias (e.g. claude-opusclaude-opus-4-7-20260415).

§stop_reason: StopReason

Why the model stopped producing tokens.

§content: Vec<ContentPart>

Returned content blocks (text, tool calls, etc.).

§usage: Usage

Token / cache accounting from the vendor.

§rate_limit: Option<RateLimitSnapshot>

Provider rate-limit state at response time, when the codec could extract it from response headers (Codec::extract_rate_limit).

§warnings: Vec<ModelWarning>

Codec-emitted warnings (lossy encoding, unknown stop reasons, etc.). Always non-fatal; consumers may surface them in observability.

§provider_echoes: Vec<ProviderEchoSnapshot>

Vendor-keyed opaque round-trip tokens that ride at the response root (rather than on a single content part) — OpenAI Responses Response.id is the canonical example, captured here so the next ModelRequest::continued_from can chain via previous_response_id. Codecs only populate entries matching their own Codec::name.

Implementations§

Source§

impl ModelResponse

Source

pub fn first_text(&self) -> Option<&str>

Borrow the first text block, if any. Convenient when the model is expected to reply with a single text answer (the 5-line-agent path) — saves the manual match &response.content[0] { ContentPart::Text { text, .. } => …, _ => panic!() } dance at every call site.

Returns None when the response has no text block (e.g. the reply is purely a ToolUse block).

Source

pub fn full_text(&self) -> String

Concatenate every text block in order. Useful when the model emits multiple Text blocks interleaved with Thinking or ToolUse blocks and the caller only wants the user-visible answer string.

Source

pub fn tool_uses(&self) -> Vec<ToolUseRef<'_>>

Borrow every ToolUse block in declaration order. Empty when the response carried no tool calls. Used by ReAct-style agents to drive the next dispatch round.

Source

pub fn has_tool_uses(&self) -> bool

True iff the response has at least one ToolUse block — hot path for agent loops that branch on “did the model ask to call a tool?”.

Trait Implementations§

Source§

impl Clone for ModelResponse

Source§

fn clone(&self) -> ModelResponse

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 ModelResponse

Source§

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

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

impl<'de> Deserialize<'de> for ModelResponse

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 PartialEq for ModelResponse

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for ModelResponse

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

impl Eq for ModelResponse

Source§

impl StructuralPartialEq for ModelResponse

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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, 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: 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: 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> Same for T

Source§

type Output = T

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