Skip to main content

CreateResponse

Type Alias CreateResponse 

Source
pub type CreateResponse = ResponseCreateRequest;
Expand description

Aliased Type§

pub struct CreateResponse {
Show 22 fields pub model: String, pub input: Option<ResponseInput>, pub instructions: Option<String>, pub tools: Option<Vec<ResponseTool>>, pub tool_choice: Option<ResponseToolChoice>, pub parallel_tool_calls: Option<bool>, pub previous_response_id: Option<String>, pub temperature: Option<f64>, pub top_p: Option<f64>, pub max_output_tokens: Option<i64>, pub truncation: Option<String>, pub reasoning: Option<Reasoning>, pub store: Option<bool>, pub metadata: Option<HashMap<String, String>>, pub include: Option<Vec<String>>, pub stream: Option<bool>, pub service_tier: Option<String>, pub user: Option<String>, pub text: Option<ResponseTextConfig>, pub prompt_cache_key: Option<String>, pub prompt_cache_retention: Option<String>, pub background: Option<bool>,
}

Fields§

§model: String

Model to use.

§input: Option<ResponseInput>

Input text or messages.

§instructions: Option<String>

System instructions.

§tools: Option<Vec<ResponseTool>>

Tools available to the model.

§tool_choice: Option<ResponseToolChoice>

How the model selects tools.

§parallel_tool_calls: Option<bool>

Whether to enable parallel tool calls.

§previous_response_id: Option<String>

Previous response ID for multi-turn.

§temperature: Option<f64>

Temperature (0-2).

§top_p: Option<f64>

Nucleus sampling parameter.

§max_output_tokens: Option<i64>

Max output tokens.

§truncation: Option<String>

Truncation strategy: “auto” or “disabled”.

§reasoning: Option<Reasoning>

Reasoning configuration for o-series models.

§store: Option<bool>

Store for evals/distillation.

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

Metadata key-value pairs.

§include: Option<Vec<String>>

Additional data to include in response.

§stream: Option<bool>

Whether to stream.

§service_tier: Option<String>

Service tier.

§user: Option<String>

End user identifier.

§text: Option<ResponseTextConfig>

Text output configuration.

§prompt_cache_key: Option<String>

Prompt cache key — caches system prompt prefix server-side for faster repeat calls.

§prompt_cache_retention: Option<String>

Prompt cache retention: “in-memory” or “24h” for extended caching.

§background: Option<bool>

Whether to run in background mode.