Skip to main content

Response

Struct Response 

Source
pub struct Response {
Show 27 fields pub id: String, pub object: String, pub created_at: f64, pub model: String, pub output: Vec<ResponseOutputItem>, pub status: Option<String>, pub error: Option<ResponseError>, pub incomplete_details: Option<IncompleteDetails>, pub instructions: Option<String>, pub metadata: Option<HashMap<String, String>>, pub temperature: Option<f64>, pub top_p: Option<f64>, pub max_output_tokens: Option<i64>, pub previous_response_id: Option<String>, pub usage: Option<ResponseUsage>, pub tools: Option<Vec<ResponseTool>>, pub tool_choice: Option<ResponseToolChoice>, pub parallel_tool_calls: Option<bool>, pub truncation: Option<String>, pub reasoning: Option<Reasoning>, pub service_tier: Option<String>, pub text: Option<ResponseTextConfig>, pub completed_at: Option<f64>, pub background: Option<bool>, pub user: Option<String>, pub top_logprobs: Option<i64>, pub max_tool_calls: Option<i64>,
}
Expand description

Response from POST /responses.

Fields§

§id: String

Unique response identifier.

§object: String

Object type — always “response”.

§created_at: f64

Unix timestamp when the response was created.

§model: String

Model used for generation.

§output: Vec<ResponseOutputItem>

Output items (messages, function calls, reasoning, etc.).

§status: Option<String>

Response status: “in_progress”, “completed”, “failed”, “incomplete”.

§error: Option<ResponseError>

Error details if the response failed.

§incomplete_details: Option<IncompleteDetails>

Details about why the response is incomplete.

§instructions: Option<String>

System instructions used.

§metadata: Option<HashMap<String, String>>

Metadata key-value pairs.

§temperature: Option<f64>

Temperature used.

§top_p: Option<f64>

Top-p (nucleus sampling) used.

§max_output_tokens: Option<i64>

Max output tokens limit.

§previous_response_id: Option<String>

Previous response ID for multi-turn.

§usage: Option<ResponseUsage>

Token usage information.

§tools: Option<Vec<ResponseTool>>

Tools used in the response.

§tool_choice: Option<ResponseToolChoice>

Tool choice setting.

§parallel_tool_calls: Option<bool>

Whether parallel tool calls were enabled.

§truncation: Option<String>

Truncation strategy.

§reasoning: Option<Reasoning>

Reasoning configuration.

§service_tier: Option<String>

Service tier used.

§text: Option<ResponseTextConfig>

Text output configuration.

§completed_at: Option<f64>

Unix timestamp when the response completed.

§background: Option<bool>

Whether the response ran in background mode.

§user: Option<String>

End user identifier.

§top_logprobs: Option<i64>

Top log probabilities count.

§max_tool_calls: Option<i64>

Maximum number of tool calls.

Implementations§

Source§

impl Response

Source

pub fn output_text(&self) -> String

Get the text output, concatenating all text content blocks.

Source

pub fn function_calls(&self) -> Vec<FunctionCall>

Extract all function calls from the response output.

Source

pub fn has_function_calls(&self) -> bool

Check if the response has any function calls.

Trait Implementations§

Source§

impl Clone for Response

Source§

fn clone(&self) -> Response

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Response

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Response

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,