Struct ResponsesRequest 

pub struct ResponsesRequest {
    pub model: String,
    pub input: Option<ResponsesInput>,
    pub stream: Option<bool>,
    pub max_output_tokens: Option<u32>,
    pub temperature: Option<f64>,
    pub top_p: Option<f64>,
    pub reasoning: Option<ResponsesReasoning>,
    pub tools: Vec<ResponsesTool>,
    pub tool_choice: Option<Value>,
    pub plugins: Vec<Plugin>,
}

Request body for the Responses API.

Fields

model: String

Model id.

input: Option<ResponsesInput>

Input — either a single string or structured items.

stream: Option<bool>

Stream-mode flag. The SDK forces Some(true) for streaming calls and Some(false) for blocking ones.

max_output_tokens: Option<u32>

Max output tokens.

temperature: Option<f64>

Sampling temperature.

top_p: Option<f64>

Nucleus sampling probability.

reasoning: Option<ResponsesReasoning>

Reasoning configuration.

tools: Vec<ResponsesTool>

Tools available to the model.

tool_choice: Option<Value>

"auto", "none", or {"type":"function","function":{"name":...}}.

plugins: Vec<Plugin>

Plugin configuration.

Implementations

impl ResponsesRequest

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

Start a builder with the given model.

pub fn input(self, input: impl Into<ResponsesInput>) -> Self

Set the input (string or structured items).

pub fn max_output_tokens(self, n: u32) -> Self

Cap the output length in tokens.

pub fn temperature(self, t: f64) -> Self

Set sampling temperature.

pub fn top_p(self, p: f64) -> Self

Set nucleus sampling probability.

pub fn reasoning_effort(self, effort: impl Into<String>) -> Self

Set reasoning effort (minimal, low, medium, high).

pub fn tools(self, tools: impl IntoIterator<Item = ResponsesTool>) -> Self

Replace the tool list.

pub fn tool_choice(self, choice: Value) -> Self

Set tool-selection strategy.

pub fn plugins(self, plugins: impl IntoIterator<Item = Plugin>) -> Self

Append plugins (does not overwrite existing ones).

pub fn web_search(self, max_results: u32) -> Self

Convenience: enable the web plugin with max_results.

Trait Implementations

impl Clone for ResponsesRequest

fn clone(&self) -> ResponsesRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponsesRequest

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

Formats the value using the given formatter.

impl Default for ResponsesRequest

fn default() -> ResponsesRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ResponsesRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResponsesRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ResponsesRequest

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 ResponsesRequest