Struct CompletionResponse 

pub struct CompletionResponse {
    pub choice: Vec<AssistantContent>,
    pub usage: Usage,
    pub message_id: Option<String>,
    pub response_id: Option<String>,
    pub provider_request_id: Option<String>,
    pub provider: String,
    pub model: Option<String>,
    pub raw: Value,
    /* private fields */
}

Assistant content and normalized completion metadata. The choice may be empty, including for truncated or filtered turns. Provider-specific data is available through Self::raw without retaining a concrete model type.

A response goes straight back into the conversation as the assistant turn: history.push(response.into()).

Fields

choice: Vec<AssistantContent>

Assistant content returned by the provider, possibly empty.

usage: Usage

Tokens used during prompting and responding

message_id: Option<String>

Provider-issued assistant message ID suitable for replay in Message::Assistant. Response-wide IDs belong in Self::response_id.

response_id: Option<String>

Provider-issued response ID for telemetry and diagnostics. Must not be replayed as an assistant message ID.

provider_request_id: Option<String>

Request identifier from HTTP headers or SDK metadata, not the body’s message or response ID. None when the provider reports none.

provider: String

Stable descriptor name of the provider that produced this response, for example "openai". Always populated, including for responses derived from a stream that ended before its terminal record.

model: Option<String>

Provider-reported model identifier for the response.

This is the model named by the wire response, not the model that was requested; it is None when the provider reports no identifier.

raw: Value

Provider response document for typed inspection through deserialization. Parsed wire types may omit unmodeled fields. This data does not override normalized fields; callers constructing responses must supply it.

Implementations

impl CompletionResponse

pub fn new( choice: Vec<AssistantContent>, usage: Usage, provider: impl Into<String>, raw: Value, ) -> Self

Create a response from its required parts; optional metadata starts unset. raw is the provider’s own document for this response, serialized; see Self::raw.

pub fn finish_reason(&self) -> Option<FinishReason>

Why the model stopped generating, when the provider reported it.

pub fn identity(&self) -> ResponseIdentity

This response’s identity metadata as one ResponseIdentity carrier.

pub fn with_finish_reason(self, finish_reason: FinishReason) -> Self

Attach the normalized finish reason, reconciled against the choice via FinishReason::reconcile_with_output.

pub fn text(&self) -> String

The text parts of Self::choice, concatenated in order.

pub fn reasoning(&self) -> String

The reasoning text of Self::choice (text and summaries), concatenated in order. Encrypted and redacted reasoning has no text.

pub fn message(&self) -> Option<Message>

The assistant turn to append to the conversation: Self::choice in order under the provider’s message id, or None for an empty choice.

pub fn tool_calls(&self) -> impl Iterator<Item = &ToolCall>

The tool calls in Self::choice, in order.

pub fn with_optional_finish_reason( self, finish_reason: Option<FinishReason>, ) -> Self

Sets or clears the finish reason, reconciling a present reason with the choice.

Trait Implementations

impl Clone for CompletionResponse

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompletionResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CompletionResponse

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CompletionResponse

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 CompletionResponse