Struct ModelResponse 

pub struct ModelResponse {
    pub id: Option<String>,
    pub model: ModelRef,
    pub content: Vec<ContentPart>,
    pub finish_reason: FinishReason,
    pub usage: ModelUsage,
    pub warnings: Vec<ModelWarning>,
    pub provider_metadata: BTreeMap<String, Value>,
    pub provider_events: Vec<ProviderData>,
}

A complete canonical model response.

Fields

id: Option<String>

Provider response identity.

model: ModelRef

Actual model that produced the response.

content: Vec<ContentPart>

Ordered output content.

finish_reason: FinishReason

Normalized terminal reason.

usage: ModelUsage

Detailed model usage.

warnings: Vec<ModelWarning>

Explicit degradation and compatibility warnings.

provider_metadata: BTreeMap<String, Value>

Namespaced response metadata.

provider_events: Vec<ProviderData>

Provider stream events retained without normalization.

Implementations

impl ModelResponse

pub fn text(&self) -> String

Collects model-visible text in canonical content order.

Reasoning, refusals, Tool calls, citations, and provider-specific payloads remain available through Self::content and are not mixed into the returned text.

pub fn into_text(self) -> String

Consumes the response and collects model-visible text in canonical content order.

Use this when the remaining response metadata and provider events are no longer needed.

impl ModelResponse

pub fn structured<T>(&self) -> Result<T, StructuredOutputError>

where T: DeserializeOwned,

Decodes ordered textual output into a Rust type.

Reasoning, citations, and opaque provider metadata are deliberately not mixed into the JSON body. An explicit refusal fails closed.

Errors

Returns StructuredOutputError when text is absent, the model refused, or the assembled JSON does not deserialize as T.

Trait Implementations

impl Clone for ModelResponse

fn clone(&self) -> ModelResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelResponse

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ModelResponse

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ModelResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModelResponse