Struct ResponseRequest

pub struct ResponseRequest {
    model: String,
    instructions: Option<String>,
    input: Vec<InputItem>,
    tools: Option<Vec<Tool>>,
    include: Option<Vec<String>>,
    max_output_tokens: Option<u64>,
    previous_response_id: Option<String>,
    temperature: Option<f32>,
    top_p: Option<f32>,
    user: Option<String>,
}

OpenAI API JSON 定義。 Response API リクエスト。

Fields

model: String

Model ID used to generate the response, like gpt-4o or o1. 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.

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.

input: Vec<InputItem>

Text, image, or file inputs to the model, used to generate a response. (string or Array)

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.

include: Option<Vec<String>>

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.

max_output_tokens: Option<u64>

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

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.

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. (Defaults to 1)

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. (Defaults to 1)

user: Option<String>

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

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 Default for ResponseRequest

fn default() -> ResponseRequest

Returns the “default value” for a type.

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.