ModelResponse

Struct ModelResponse 

Source
pub struct ModelResponse {
Show 22 fields pub id: String, pub object: String, pub created_at: i64, pub model: String, pub output: Vec<ModelOutput>, pub parallel_tool_calls: bool, pub text: ModelResponseConfiguration, pub tool_choice: ModelToolChoice, pub tools: Vec<ModelTool>, pub status: String, pub store: bool, pub metadata: Value, pub usage: Option<ModelUsage>, pub temperature: Option<f32>, pub top_p: Option<f32>, pub max_output_tokens: Option<i32>, pub previous_response_id: Option<String>, pub reasoning: Option<ReasoningConfiguration>, pub user: Option<String>, pub incomplete_details: Option<IncompleteDetails>, pub background: Option<bool>, pub debug_output: Option<DebugOutput>,
}
Expand description

The response body for /v1/responses endpoint.

Fields§

§id: String

Unique ID of the response.

§object: String

The object type of this resource. Always set to response.

§created_at: i64

The Unix timestamp (in seconds) for the response creation time.

§model: String

Model name used to generate the response.

§output: Vec<ModelOutput>

The response generated by the model.

§parallel_tool_calls: bool

Whether to allow the model to run parallel tool calls.

§text: ModelResponseConfiguration

Settings for customizing a text response from the model.

§tool_choice: ModelToolChoice

Controls which (if any) tool is called by the model.

§tools: Vec<ModelTool>

A list of tools the model may call.

§status: String

Status of the response. One of completed, in_progress or incomplete.

§store: bool

Whether to store the input message(s) and model response for later retrieval.

§metadata: Value

Only included for compatibility.

§usage: Option<ModelUsage>

Token usage information.

§temperature: Option<f32>

What sampling temperature to use, between 0 and 2.

§top_p: Option<f32>

An alternative to sampling with temperature, called nucleus sampling.

§max_output_tokens: Option<i32>

Max number of tokens that can be generated in a response.

§previous_response_id: Option<String>

The ID of the previous response from the model.

§reasoning: Option<ReasoningConfiguration>

Reasoning configuration. Only for reasoning models.

§user: Option<String>

A unique identifier representing your end-user.

§incomplete_details: Option<IncompleteDetails>

Details about why the response is incomplete.

§background: Option<bool>

Whether to process the response asynchronously in the background.

§debug_output: Option<DebugOutput>

Debug output. Only available to trusted testers.

Trait Implementations§

Source§

impl Clone for ModelResponse

Source§

fn clone(&self) -> ModelResponse

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 ModelResponse

Source§

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

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

impl Default for ModelResponse

Source§

fn default() -> ModelResponse

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ModelResponse

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 PartialEq for ModelResponse

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for ModelResponse

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
Source§

impl StructuralPartialEq for ModelResponse

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