Struct ModelRequest 

pub struct ModelRequest {

    pub input: ModelInput,
    pub model: Option<String>,
    pub instructions: Option<String>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub max_output_tokens: Option<i32>,
    pub stream: Option<bool>,
    pub logprobs: Option<bool>,
    pub store: Option<bool>,
    pub previous_response_id: Option<String>,
    pub tools: Option<Vec<ModelTool>>,
    pub tool_choice: Option<ModelToolChoice>,
    pub parallel_tool_calls: Option<bool>,
    pub search_parameters: Option<SearchParameters>,
    pub reasoning: Option<ReasoningConfiguration>,
    pub text: Option<ModelResponseConfiguration>,
    pub include: Option<Vec<String>>,
    pub metadata: Option<Value>,
    pub service_tier: Option<String>,
    pub background: Option<bool>,
}

The request body for /v1/responses endpoint.

Fields

input: ModelInput

The input passed to the model. Can be text, image or file.

model: Option<String>

Model name for the model to use.

instructions: Option<String>

An alternate way to specify the system prompt.

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.

stream: Option<bool>

If set, partial message deltas will be sent as server-sent events.

logprobs: Option<bool>

Whether to return log probabilities of the output tokens.

store: Option<bool>

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

previous_response_id: Option<String>

The ID of the previous response from the model.

tools: Option<Vec<ModelTool>>

A list of tools the model may call.

tool_choice: Option<ModelToolChoice>

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

parallel_tool_calls: Option<bool>

Whether to allow the model to run parallel tool calls.

search_parameters: Option<SearchParameters>

Set the parameters to be used for searched data.

reasoning: Option<ReasoningConfiguration>

Reasoning configuration. Only for reasoning models.

text: Option<ModelResponseConfiguration>

Settings for customizing a text response from the model.

include: Option<Vec<String>>

What additional output data to include in the response.

metadata: Option<Value>

Not supported. Only maintained for compatibility reasons.

service_tier: Option<String>

Not supported. Only maintained for compatibility reasons.

background: Option<bool>

(Unsupported) Whether to process the response asynchronously in the background.

Trait Implementations

impl Clone for ModelRequest

fn clone(&self) -> ModelRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelRequest

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

Formats the value using the given formatter.

impl Default for ModelRequest

fn default() -> ModelRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModelRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ModelRequest

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

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 ModelRequest