pub struct CreateResponse {Show 19 fields
pub instructions: Option<String>,
pub max_output_tokens: Option<i32>,
pub model: Option<ModelIdsResponses>,
pub previous_response_id: Option<String>,
pub reasoning: Option<Reasoning>,
pub text: Option<ResponsePropertiesText>,
pub tool_choice: Option<Value>,
pub tools: Option<Vec<Tool>>,
pub truncation: Option<String>,
pub metadata: Option<Metadata>,
pub service_tier: Option<ServiceTier>,
pub temperature: Option<f32>,
pub top_p: Option<f32>,
pub user: Option<String>,
pub include: Option<Vec<Includable>>,
pub input: Value,
pub parallel_tool_calls: Option<bool>,
pub store: Option<bool>,
pub stream: Option<bool>,
}Fields§
§instructions: Option<String>Inserts a system (or developer) message as the first item in the model’s context. When using along with previous_response_id, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.
max_output_tokens: Option<i32>An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens.
model: Option<ModelIdsResponses>Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.
previous_response_id: Option<String>The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about conversation state.
reasoning: Option<Reasoning>§text: Option<ResponsePropertiesText>§tool_choice: Option<Value>How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.
tools: Option<Vec<Tool>>An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. The two categories of tools you can provide the model are: - Built-in tools: Tools that are provided by OpenAI that extend the model’s capabilities, like web search or file search. Learn more about built-in tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code. Learn more about function calling.
truncation: Option<String>The truncation strategy to use for the model response. - auto: If the context of this response and previous ones exceeds the model’s context window size, the model will truncate the response to fit the context window by dropping input items in the middle of the conversation. - disabled (default): If a model response will exceed the context window size for a model, the request will fail with a 400 error.
metadata: Option<Metadata>§service_tier: Option<ServiceTier>§temperature: Option<f32>What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.
top_p: Option<f32>An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.
user: Option<String>A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
include: Option<Vec<Includable>>Specify additional output data to include in the model response. Currently supported values are: - file_search_call.results: Include the search results of the file search tool call. - message.input_image.image_url: Include image urls from the input message. - computer_call_output.output.image_url: Include image urls from the computer call output.
input: ValueText, image, or file inputs to the model, used to generate a response. Learn more: - Text inputs and outputs - Image inputs - File inputs - Conversation state - Function calling
parallel_tool_calls: Option<bool>Whether to allow the model to run tool calls in parallel.
store: Option<bool>Whether to store the generated model response for later retrieval via API.
stream: Option<bool>If set to true, the model response data will be streamed to the client as it is generated using server-sent events. See the Streaming section below for more information.