Struct ResponseObject 

#[non_exhaustive]
pub struct ResponseObject {

    pub created_at: i64,
    pub error: Option<ResponseError>,
    pub id: String,
    pub incomplete_details: Option<ResponseIncompleteDetails>,
    pub instructions: Option<String>,
    pub max_output_tokens: Option<i32>,
    pub metadata: Option<Metadata>,
    pub model: String,
    pub object: String,
    pub output: Vec<OutputItem>,
    pub parallel_tool_calls: bool,
    pub previous_response_id: Option<String>,
    pub reasoning: Option<Reasoning>,
    pub status: String,
    pub stream: Option<bool>,
    pub temperature: Option<f32>,
    pub text: Option<TextResponseFormatConfigurationOptions>,
    pub tool_choice: Option<ToolChoice>,
    pub tools: Option<Vec<Tool>>,
    pub top_p: Option<f32>,
    pub truncation: Option<String>,
    pub usage: Option<ResponseUsage>,
    pub user: Option<String>,
}

Represents a response generated by the model via the Responses API. Corresponds to the Response schema in the OpenAPI spec.

Used By

• /responses (POST response)
• /responses/{response_id} (GET response)
• RealtimeServerEventResponseCreated (within realtime_shared.rs)
• RealtimeServerEventResponseDone (within realtime_shared.rs)
• RealtimeServerEventResponseFailed (within realtime_shared.rs)
• RealtimeServerEventResponseIncomplete (within realtime_shared.rs)
• RealtimeServerEventResponseInProgress (within realtime_shared.rs)

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

created_at: i64

Unix timestamp (in seconds) of when this Response was created.

error: Option<ResponseError>

The error object if the response status is failed. Null otherwise.

id: String

Unique identifier for this Response.

incomplete_details: Option<ResponseIncompleteDetails>

Details about why the response is incomplete, if applicable. Null otherwise.

instructions: Option<String>

System instructions provided.

max_output_tokens: Option<i32>

Maximum output tokens allowed.

metadata: Option<Metadata>

Metadata associated with the response.

model: String

Model ID used for the response. *** CHANGED TO String ***

object: String

The object type, always “response”.

output: Vec<OutputItem>

An array of content items generated by the model.

parallel_tool_calls: bool

Whether parallel tool calls were enabled.

previous_response_id: Option<String>

ID of the previous response in the conversation.

reasoning: Option<Reasoning>

Reasoning configuration used.

status: String

The status of the response generation (completed, failed, in_progress, incomplete).

stream: Option<bool>

Whether to stream the response. Defaults to false.

temperature: Option<f32>

Sampling temperature.

text: Option<TextResponseFormatConfigurationOptions>

Text response format configuration.

tool_choice: Option<ToolChoice>

Tool choice strategy used.

tools: Option<Vec<Tool>>

Tools available to the model.

top_p: Option<f32>

Nucleus sampling probability.

truncation: Option<String>

Truncation strategy (“auto” or “disabled”).

usage: Option<ResponseUsage>

Usage statistics for the request. Null if status is not completed.

user: Option<String>

End-user identifier.

Implementations

impl ResponseObject

pub fn former() -> ResponseObjectFormer<ResponseObjectFormerDefinition<(), ResponseObject, ReturnPreformed>>

Provides a mechanism to initiate the formation process with a default completion behavior.

Trait Implementations

impl Clone for ResponseObject

fn clone(&self) -> ResponseObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseObject

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseObject

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__Context, __Formed, __End> EntityToDefinition<__Context, __Formed, __End> for ResponseObject

where __End: FormingEnd<ResponseObjectFormerDefinitionTypes<__Context, __Formed>>,

type Definition = ResponseObjectFormerDefinition<__Context, __Formed, __End>

The specific FormerDefinition associated with this entity.

type Types = ResponseObjectFormerDefinitionTypes<__Context, __Formed>

The specific FormerDefinitionTypes associated with this entity.

impl<__Context, __Formed> EntityToDefinitionTypes<__Context, __Formed> for ResponseObject

type Types = ResponseObjectFormerDefinitionTypes<__Context, __Formed>

Specifies the FormerDefinitionTypes that define the storage, formed entity, and context types used during formation.

impl<Definition> EntityToFormer<Definition> for ResponseObject

where Definition: FormerDefinition<Storage = ResponseObjectFormerStorage>,

type Former = ResponseObjectFormer<Definition>

The type of the former (builder) used for constructing the entity.

fn __f(_: &Definition)

A placeholder function to reference the definition without operational logic.

impl EntityToStorage for ResponseObject

type Storage = ResponseObjectFormerStorage

The storage type used for forming the entity.

impl PartialEq for ResponseObject

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ResponseObject

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 ResponseObject