Struct CreateResponseArgs 

pub struct CreateResponseArgs { /* private fields */ }

Builder for CreateResponse.

Implementations

impl CreateResponseArgs

pub fn background<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Whether to run the model response in the background. Learn more.

pub fn conversation<VALUE: Into<ConversationParam>>( &mut self, value: VALUE, ) -> &mut Self

The conversation that this response belongs to. Items from this conversation are prepended to input_items for this response request.

Input items and output items from this response are automatically added to this conversation after this response completes.

pub fn include<VALUE: Into<Vec<IncludeEnum>>>( &mut self, value: VALUE, ) -> &mut Self

Specify additional output data to include in the model response. Currently supported values are:

• web_search_call.action.sources: Include the sources of the web search tool call.

• code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool call items.

• computer_call_output.output.image_url: Include image urls from the computer call output.

• 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.

• message.output_text.logprobs: Include logprobs with assistant messages.

• reasoning.encrypted_content: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the store parameter is set to false, or when an organization is enrolled in the zero data retention program).

pub fn input<VALUE: Into<InputParam>>(&mut self, value: VALUE) -> &mut Self

Text, 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

pub fn instructions<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

A system (or developer) message inserted into 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.

pub fn max_output_tokens<VALUE: Into<u32>>(&mut self, value: VALUE) -> &mut Self

An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens.

pub fn max_tool_calls<VALUE: Into<u32>>(&mut self, value: VALUE) -> &mut Self

The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored.

pub fn metadata<VALUE: Into<HashMap<String, String>>>( &mut self, value: VALUE, ) -> &mut Self

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

pub fn model<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn parallel_tool_calls<VALUE: Into<bool>>( &mut self, value: VALUE, ) -> &mut Self

Whether to allow the model to run tool calls in parallel.

pub fn previous_response_id<VALUE: Into<String>>( &mut self, value: VALUE, ) -> &mut Self

The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about conversation state. Cannot be used in conjunction with conversation.

pub fn prompt<VALUE: Into<Prompt>>(&mut self, value: VALUE) -> &mut Self

Reference to a prompt template and its variables. Learn more.

pub fn prompt_cache_key<VALUE: Into<String>>( &mut self, value: VALUE, ) -> &mut Self

Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.

pub fn reasoning<VALUE: Into<Reasoning>>(&mut self, value: VALUE) -> &mut Self

gpt-5 and o-series models only Configuration options for reasoning models.

pub fn safety_identifier<VALUE: Into<String>>( &mut self, value: VALUE, ) -> &mut Self

A stable identifier used to help detect users of your application that may be violating OpenAI’s usage policies.

The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.

pub fn service_tier<VALUE: Into<ServiceTier>>( &mut self, value: VALUE, ) -> &mut Self

Specifies the processing type used for serving the request.

• If set to ‘auto’, then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use ‘default’.
• If set to ‘default’, then the request will be processed with the standard pricing and performance for the selected model.
• If set to ‘flex’ or ‘priority’, then the request will be processed with the corresponding service tier.
• When not set, the default behavior is ‘auto’.

When the service_tier parameter is set, the response body will include the service_tier value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.

pub fn store<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Whether to store the generated model response for later retrieval via API.

pub fn stream<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn stream_options<VALUE: Into<ResponseStreamOptions>>( &mut self, value: VALUE, ) -> &mut Self

Options for streaming responses. Only set this when you set stream: true.

pub fn temperature<VALUE: Into<f32>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn text<VALUE: Into<ResponseTextParam>>( &mut self, value: VALUE, ) -> &mut Self

Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more:

• Text inputs and outputs
• Structured Outputs

pub fn tool_choice<VALUE: Into<ToolChoiceParam>>( &mut self, value: VALUE, ) -> &mut Self

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.

pub fn tools<VALUE: Into<Vec<Tool>>>(&mut self, value: VALUE) -> &mut Self

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.

We support the following categories of tools:

• 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.
• MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools.
• Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code.

pub fn top_logprobs<VALUE: Into<u8>>(&mut self, value: VALUE) -> &mut Self

An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability.

pub fn top_p<VALUE: Into<f32>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn truncation<VALUE: Into<Truncation>>(&mut self, value: VALUE) -> &mut Self

The truncation strategy to use for the model response.

• auto: If the input to this Response exceeds the model’s context window size, the model will truncate the response to fit the context window by dropping items from the beginning of the conversation.
• disabled (default): If the input size will exceed the context window size for a model, the request will fail with a 400 error.

pub fn build(&self) -> Result<CreateResponse, OpenAIError>

Builds a new CreateResponse.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for CreateResponseArgs

fn clone(&self) -> CreateResponseArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CreateResponseArgs

fn default() -> Self

Returns the “default value” for a type.