Struct Response

pub struct Response {
    pub model_response_properties: ModelResponseProperties,
    pub response_properties: ResponseProperties,
    pub id: String,
    pub status: Option<ResponseStatus>,
    pub created_at: u64,
    pub error: Option<ResponseError>,
    pub incomplete_details: Option<ResponseIncompleteDetails>,
    pub output: Vec<OutputItem>,
    pub output_text: Option<String>,
    pub usage: Option<ResponseUsage>,
    pub parallel_tool_calls: bool,
}

Fields

model_response_properties: ModelResponseProperties

response_properties: ResponseProperties

id: String

Unique identifier for this Response.

status: Option<ResponseStatus>

The status of the response generation. One of completed, failed, in_progress, cancelled, queued, or incomplete.

created_at: u64

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

error: Option<ResponseError>

incomplete_details: Option<ResponseIncompleteDetails>

Details about why the response is incomplete.

output: Vec<OutputItem>

An array of content items generated by the model.

• The length and order of items in the output array is dependent on the model’s response.
• Rather than accessing the first item in the output array and assuming it’s an assistant message with the content generated by the model, you might consider using the output_text property where supported in SDKs.

output_text: Option<String>

SDK-only convenience property that contains the aggregated text output from all output_text items in the output array, if any are present. Supported in the Python and JavaScript SDKs.

usage: Option<ResponseUsage>

parallel_tool_calls: bool

Whether to allow the model to run tool calls in parallel.

Implementations

impl Response

pub fn builder() -> ResponseBuilder<((), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building Response. On the builder, call .model_response_properties(...)(optional), .response_properties(...)(optional), .id(...), .status(...)(optional), .created_at(...), .error(...)(optional), .incomplete_details(...)(optional), .output(...), .output_text(...)(optional), .usage(...)(optional), .parallel_tool_calls(...) to set the values of the fields. Finally, call .build() to create the instance of Response.

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<'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