Struct ResponseRequest 

pub struct ResponseRequest { /* private fields */ }

Request body for POST /v1/responses.

Implementations

impl ResponseRequest

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

Creates a request. input accepts plain text or a list of InputItems.

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

System-level guidance (replaces the system message of Chat Completions).

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

Upper bound on generated tokens, including invisible reasoning tokens.

pub fn temperature(self, temperature: f32) -> Self

Sampling temperature (0.0-2.0). Not supported by reasoning models.

pub fn top_p(self, top_p: f32) -> Self

Nucleus sampling mass (0.0-1.0). Alternative to temperature.

pub fn reasoning(self, reasoning: ReasoningConfig) -> Self

Full reasoning configuration; see ResponseRequest::reasoning_effort for the common case.

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

Shorthand for setting reasoning.effort. Known values: "none", "minimal", "low", "medium", "high".

pub fn text(self, text: TextConfig) -> Self

Full text output configuration; see ResponseRequest::json_schema and ResponseRequest::verbosity for the common cases.

pub fn json_schema(self, name: impl Into<String>, schema: Value) -> Self

Shorthand for Structured Outputs: sets text.format to a strict JSON schema.

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

Shorthand for setting text.verbosity. Known values: "low", "medium", "high".

pub fn tools(self, tools: Vec<Tool>) -> Self

Tools the model may call: custom functions and OpenAI built-ins.

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

Constrains tool selection: "none", "auto", "required", or a specific-tool object (passed through as raw JSON).

pub fn parallel_tool_calls(self, parallel_tool_calls: bool) -> Self

Whether the model may issue several tool calls in one turn.

pub fn store(self, store: bool) -> Self

Whether the response is persisted server-side (API default: true).

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

Chains onto a stored response to continue a conversation server-side.

pub fn metadata(self, metadata: HashMap<String, String>) -> Self

Up to 16 key-value pairs attached to the stored response.

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

Context overflow handling: "auto" or "disabled".

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

Processing tier: "auto", "default", "flex", "scale", or "priority".

pub fn background(self, background: bool) -> Self

Runs the response in the background; poll with Responses::retrieve.

Trait Implementations

impl Clone for ResponseRequest

fn clone(&self) -> ResponseRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseRequest

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

Formats the value using the given formatter.

impl Serialize for ResponseRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.