openai_struct/models/response.rs
1/*
2 * OpenAI API
3 *
4 * The OpenAI REST API. Please see pub https://platform.openai.com/docs/api-reference for more details.
5 *
6 * OpenAPI spec pub version: 2.3.0
7 *
8 * Generated pub by: https://github.com/swagger-api/swagger-codegen.git
9 */
10
11#[allow(unused_imports)]
12use serde_json::Value;
13
14#[derive(Debug, Serialize, Deserialize)]
15pub struct Response {
16 /// 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.
17 #[serde(rename = "instructions")]
18 pub instructions: Option<String>,
19 /// An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).
20 #[serde(rename = "max_output_tokens")]
21 pub max_output_tokens: Option<i32>,
22 /// 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](/docs/models) to browse and compare available models.
23 #[serde(rename = "model")]
24 pub model: Option<crate::models::ModelIdsResponses>,
25 /// The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](/docs/guides/conversation-state).
26 #[serde(rename = "previous_response_id")]
27 pub previous_response_id: Option<String>,
28 #[serde(rename = "reasoning")]
29 pub reasoning: Option<crate::models::Reasoning>,
30 #[serde(rename = "text")]
31 pub text: Option<crate::models::ResponsePropertiesText>,
32 /// 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.
33 #[serde(rename = "tool_choice")]
34 pub tool_choice: Option<Value>,
35 /// 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](/docs/guides/tools-web-search) or [file search](/docs/guides/tools-file-search). Learn more about [built-in tools](/docs/guides/tools). - **Function calls (custom tools)**: Functions that are defined by you, enabling the model to call your own code. Learn more about [function calling](/docs/guides/function-calling).
36 #[serde(rename = "tools")]
37 pub tools: Option<Vec<crate::models::Tool>>,
38 /// 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.
39 #[serde(rename = "truncation")]
40 pub truncation: Option<String>,
41 #[serde(rename = "metadata")]
42 pub metadata: Option<crate::models::Metadata>,
43 #[serde(rename = "service_tier")]
44 pub service_tier: Option<crate::models::ServiceTier>,
45 /// 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.
46 #[serde(rename = "temperature")]
47 pub temperature: Option<f32>,
48 /// 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.
49 #[serde(rename = "top_p")]
50 pub top_p: Option<f32>,
51 /// A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).
52 #[serde(rename = "user")]
53 pub user: Option<String>,
54 /// Unix timestamp (in seconds) of when this Response was created.
55 #[serde(rename = "created_at")]
56 pub created_at: f32,
57 #[serde(rename = "error")]
58 pub error: crate::models::ResponseError,
59 /// Unique identifier for this Response.
60 #[serde(rename = "id")]
61 pub id: String,
62 #[serde(rename = "incomplete_details")]
63 pub incomplete_details: crate::models::ResponseIncompleteDetails,
64 /// The object type of this resource - always set to `response`.
65 #[serde(rename = "object")]
66 pub object: String,
67 /// An array of content items generated by the model. - The length and order of items in the `output` array is dependent on the model's response. - Rather than accessing the first item in the `output` array and assuming it's an `assistant` message with the content generated by the model, you might consider using the `output_text` property where supported in SDKs.
68 #[serde(rename = "output")]
69 pub output: Vec<crate::models::OutputItem>,
70 /// SDK-only convenience property that contains the aggregated text output from all `output_text` items in the `output` array, if any are present. Supported in the Python and JavaScript SDKs.
71 #[serde(rename = "output_text")]
72 pub output_text: Option<String>,
73 /// Whether to allow the model to run tool calls in parallel.
74 #[serde(rename = "parallel_tool_calls")]
75 pub parallel_tool_calls: bool,
76 /// The status of the response generation. One of `completed`, `failed`, `in_progress`, or `incomplete`.
77 #[serde(rename = "status")]
78 pub status: Option<String>,
79 #[serde(rename = "usage")]
80 pub usage: Option<crate::models::ResponseUsage>,
81}