Struct Response 

pub struct Response {

    pub id: ResponseId,
    pub object: String,
    pub created_at: u64,
    pub completed_at: Option<u64>,
    pub status: ResponseStatus,
    pub incomplete_details: Option<IncompleteDetails>,
    pub model: String,
    pub previous_response_id: Option<String>,
    pub instructions: Option<String>,
    pub output: Vec<OutputItem>,
    pub error: Option<Box<OpenResponseError>>,
    pub tools: Option<Vec<ToolDefinition>>,
    pub usage: Option<Box<OpenUsage>>,
    pub parallel_tool_calls: Option<bool>,
    pub max_output_tokens: Option<u64>,
    pub max_tool_calls: Option<u64>,
    pub temperature: Option<f64>,
    pub top_p: Option<f64>,
    pub store: Option<bool>,
    pub background: Option<bool>,
    pub service_tier: Option<String>,
    pub metadata: Option<Value>,
}

The main response object per the Open Responses specification.

This is the top-level object returned by the API, containing all output items, usage statistics, and metadata about the response.

Fields

id: ResponseId

Unique ID of the response.

object: String

Object type, always “response”.

created_at: u64

Unix timestamp (seconds) when the response was created.

completed_at: Option<u64>

Unix timestamp (seconds) when the response was completed, if applicable.

status: ResponseStatus

Current status of the response.

incomplete_details: Option<IncompleteDetails>

Details about why the response was incomplete, if applicable.

model: String

The model that generated this response.

previous_response_id: Option<String>

ID of the previous response in the chain, if any.

instructions: Option<String>

Additional instructions used to guide the model.

output: Vec<OutputItem>

Output items generated by the model.

error: Option<Box<OpenResponseError>>

Error that occurred, if the response failed.

tools: Option<Vec<ToolDefinition>>

Tools that were available to the model.

usage: Option<Box<OpenUsage>>

Token usage statistics.

parallel_tool_calls: Option<bool>

Whether parallel tool calls were allowed.

max_output_tokens: Option<u64>

Maximum output tokens allowed.

max_tool_calls: Option<u64>

Maximum tool calls allowed.

temperature: Option<f64>

Sampling temperature used.

top_p: Option<f64>

Nucleus sampling parameter used.

store: Option<bool>

Whether this response was stored.

background: Option<bool>

Whether this request ran in the background.

service_tier: Option<String>

Service tier used for this response.

metadata: Option<Value>

Developer-defined metadata.

Implementations

impl Response

pub fn new(id: impl Into<String>, model: impl Into<String>) -> Self

Creates a new response with the given ID and model.

pub fn add_output(&mut self, item: OutputItem)

Adds an output item to the response.

pub fn complete(&mut self)

Marks the response as completed.

pub fn fail(&mut self, error: OpenResponseError)

Marks the response as failed with the given error.

pub fn incomplete(&mut self, reason: IncompleteReason)

Marks the response as incomplete with the given reason.

pub fn with_usage(self, usage: OpenUsage) -> Self

Sets the usage statistics.

pub fn with_tools(self, tools: Vec<ToolDefinition>) -> Self

Sets the available tools.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

impl Default for Response

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Response

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Response

fn eq(&self, other: &Response) -> 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 Response

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 Response