openai 7.12.1 → 7.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/package.json +1 -1
- package/resources/admin/organization/audit-logs.d.mts +1 -1
- package/resources/admin/organization/audit-logs.d.ts +1 -1
- package/resources/admin/organization/projects/api-keys.d.mts +5 -0
- package/resources/admin/organization/projects/api-keys.d.mts.map +1 -1
- package/resources/admin/organization/projects/api-keys.d.ts +5 -0
- package/resources/admin/organization/projects/api-keys.d.ts.map +1 -1
- package/resources/admin/organization/projects/projects.d.mts +2 -2
- package/resources/admin/organization/projects/projects.d.ts +2 -2
- package/resources/admin/organization/projects/service-accounts/service-accounts.d.mts +13 -0
- package/resources/admin/organization/projects/service-accounts/service-accounts.d.mts.map +1 -1
- package/resources/admin/organization/projects/service-accounts/service-accounts.d.ts +13 -0
- package/resources/admin/organization/projects/service-accounts/service-accounts.d.ts.map +1 -1
- package/resources/admin/organization/projects/service-accounts/service-accounts.js.map +1 -1
- package/resources/admin/organization/projects/service-accounts/service-accounts.mjs.map +1 -1
- package/resources/audio/speech.d.mts +3 -2
- package/resources/audio/speech.d.mts.map +1 -1
- package/resources/audio/speech.d.ts +3 -2
- package/resources/audio/speech.d.ts.map +1 -1
- package/resources/audio/transcriptions.d.mts +10 -10
- package/resources/audio/transcriptions.d.ts +10 -10
- package/resources/audio/translations.d.mts +1 -1
- package/resources/audio/translations.d.ts +1 -1
- package/resources/batches.d.mts +6 -5
- package/resources/batches.d.mts.map +1 -1
- package/resources/batches.d.ts +6 -5
- package/resources/batches.d.ts.map +1 -1
- package/resources/beta/assistants.d.mts +143 -147
- package/resources/beta/assistants.d.mts.map +1 -1
- package/resources/beta/assistants.d.ts +143 -147
- package/resources/beta/assistants.d.ts.map +1 -1
- package/resources/beta/responses/input-tokens.d.mts +11 -11
- package/resources/beta/responses/input-tokens.d.ts +11 -11
- package/resources/beta/responses/responses.d.mts +181 -170
- package/resources/beta/responses/responses.d.mts.map +1 -1
- package/resources/beta/responses/responses.d.ts +181 -170
- package/resources/beta/responses/responses.d.ts.map +1 -1
- package/resources/beta/responses/responses.js +3 -3
- package/resources/beta/responses/responses.js.map +1 -1
- package/resources/beta/responses/responses.mjs +3 -3
- package/resources/beta/responses/responses.mjs.map +1 -1
- package/resources/beta/threads/messages.d.mts +29 -23
- package/resources/beta/threads/messages.d.mts.map +1 -1
- package/resources/beta/threads/messages.d.ts +29 -23
- package/resources/beta/threads/messages.d.ts.map +1 -1
- package/resources/beta/threads/runs/runs.d.mts +39 -35
- package/resources/beta/threads/runs/runs.d.mts.map +1 -1
- package/resources/beta/threads/runs/runs.d.ts +39 -35
- package/resources/beta/threads/runs/runs.d.ts.map +1 -1
- package/resources/beta/threads/runs/runs.js.map +1 -1
- package/resources/beta/threads/runs/runs.mjs.map +1 -1
- package/resources/beta/threads/runs/steps.d.mts +14 -15
- package/resources/beta/threads/runs/steps.d.mts.map +1 -1
- package/resources/beta/threads/runs/steps.d.ts +14 -15
- package/resources/beta/threads/runs/steps.d.ts.map +1 -1
- package/resources/beta/threads/threads.d.mts +53 -50
- package/resources/beta/threads/threads.d.mts.map +1 -1
- package/resources/beta/threads/threads.d.ts +53 -50
- package/resources/beta/threads/threads.d.ts.map +1 -1
- package/resources/beta/threads/threads.js.map +1 -1
- package/resources/beta/threads/threads.mjs.map +1 -1
- package/resources/chat/completions/completions.d.mts +89 -81
- package/resources/chat/completions/completions.d.mts.map +1 -1
- package/resources/chat/completions/completions.d.ts +89 -81
- package/resources/chat/completions/completions.d.ts.map +1 -1
- package/resources/chat/completions/completions.js.map +1 -1
- package/resources/chat/completions/completions.mjs.map +1 -1
- package/resources/completions.d.mts +15 -14
- package/resources/completions.d.mts.map +1 -1
- package/resources/completions.d.ts +15 -14
- package/resources/completions.d.ts.map +1 -1
- package/resources/content-provenance-checks.d.mts +1 -1
- package/resources/content-provenance-checks.d.ts +1 -1
- package/resources/content-provenance-checks.js +1 -1
- package/resources/content-provenance-checks.mjs +1 -1
- package/resources/conversations/items.d.mts +3 -3
- package/resources/conversations/items.d.ts +3 -3
- package/resources/embeddings.d.mts +6 -6
- package/resources/embeddings.d.ts +6 -6
- package/resources/evals/evals.d.mts +1 -1
- package/resources/evals/evals.d.ts +1 -1
- package/resources/evals/evals.js +1 -1
- package/resources/evals/evals.mjs +1 -1
- package/resources/evals/runs/runs.d.mts +62 -57
- package/resources/evals/runs/runs.d.mts.map +1 -1
- package/resources/evals/runs/runs.d.ts +62 -57
- package/resources/evals/runs/runs.d.ts.map +1 -1
- package/resources/evals/runs/runs.js.map +1 -1
- package/resources/evals/runs/runs.mjs.map +1 -1
- package/resources/files.d.mts +5 -5
- package/resources/files.d.ts +5 -5
- package/resources/files.js +5 -5
- package/resources/files.mjs +5 -5
- package/resources/fine-tuning/alpha/graders.d.mts +5 -4
- package/resources/fine-tuning/alpha/graders.d.mts.map +1 -1
- package/resources/fine-tuning/alpha/graders.d.ts +5 -4
- package/resources/fine-tuning/alpha/graders.d.ts.map +1 -1
- package/resources/fine-tuning/checkpoints/permissions.d.mts +8 -4
- package/resources/fine-tuning/checkpoints/permissions.d.mts.map +1 -1
- package/resources/fine-tuning/checkpoints/permissions.d.ts +8 -4
- package/resources/fine-tuning/checkpoints/permissions.d.ts.map +1 -1
- package/resources/fine-tuning/checkpoints/permissions.js +8 -4
- package/resources/fine-tuning/checkpoints/permissions.js.map +1 -1
- package/resources/fine-tuning/checkpoints/permissions.mjs +8 -4
- package/resources/fine-tuning/checkpoints/permissions.mjs.map +1 -1
- package/resources/fine-tuning/jobs/jobs.d.mts +13 -12
- package/resources/fine-tuning/jobs/jobs.d.mts.map +1 -1
- package/resources/fine-tuning/jobs/jobs.d.ts +13 -12
- package/resources/fine-tuning/jobs/jobs.d.ts.map +1 -1
- package/resources/fine-tuning/jobs/jobs.js +2 -2
- package/resources/fine-tuning/jobs/jobs.js.map +1 -1
- package/resources/fine-tuning/jobs/jobs.mjs +2 -2
- package/resources/fine-tuning/jobs/jobs.mjs.map +1 -1
- package/resources/graders/grader-models.d.mts +1 -1
- package/resources/graders/grader-models.d.ts +1 -1
- package/resources/images.d.mts +10 -10
- package/resources/images.d.ts +10 -10
- package/resources/moderations.d.mts +5 -4
- package/resources/moderations.d.mts.map +1 -1
- package/resources/moderations.d.ts +5 -4
- package/resources/moderations.d.ts.map +1 -1
- package/resources/moderations.js +2 -1
- package/resources/moderations.js.map +1 -1
- package/resources/moderations.mjs +2 -1
- package/resources/moderations.mjs.map +1 -1
- package/resources/realtime/calls.d.mts +1 -1
- package/resources/realtime/calls.d.ts +1 -1
- package/resources/realtime/client-secrets.d.mts +4 -4
- package/resources/realtime/client-secrets.d.ts +4 -4
- package/resources/realtime/client-secrets.js +1 -1
- package/resources/realtime/client-secrets.mjs +1 -1
- package/resources/realtime/realtime.d.mts +16 -16
- package/resources/realtime/realtime.d.ts +16 -16
- package/resources/responses/input-tokens.d.mts +9 -9
- package/resources/responses/input-tokens.d.ts +9 -9
- package/resources/responses/responses.d.mts +175 -164
- package/resources/responses/responses.d.mts.map +1 -1
- package/resources/responses/responses.d.ts +175 -164
- package/resources/responses/responses.d.ts.map +1 -1
- package/resources/responses/responses.js +3 -3
- package/resources/responses/responses.js.map +1 -1
- package/resources/responses/responses.mjs +3 -3
- package/resources/responses/responses.mjs.map +1 -1
- package/resources/shared.d.mts +12 -12
- package/resources/shared.d.ts +12 -12
- package/resources/uploads/parts.d.mts +5 -4
- package/resources/uploads/parts.d.mts.map +1 -1
- package/resources/uploads/parts.d.ts +5 -4
- package/resources/uploads/parts.d.ts.map +1 -1
- package/resources/uploads/parts.js +5 -4
- package/resources/uploads/parts.js.map +1 -1
- package/resources/uploads/parts.mjs +5 -4
- package/resources/uploads/parts.mjs.map +1 -1
- package/resources/uploads/uploads.d.mts +11 -11
- package/resources/uploads/uploads.d.ts +11 -11
- package/resources/uploads/uploads.js +9 -9
- package/resources/uploads/uploads.mjs +9 -9
- package/resources/vector-stores/file-batches.d.mts +11 -11
- package/resources/vector-stores/file-batches.d.ts +11 -11
- package/resources/vector-stores/files.d.mts +8 -8
- package/resources/vector-stores/files.d.ts +8 -8
- package/resources/vector-stores/files.js +3 -3
- package/resources/vector-stores/files.mjs +3 -3
- package/resources/vector-stores/vector-stores.d.mts +3 -3
- package/resources/vector-stores/vector-stores.d.ts +3 -3
- package/resources/webhooks/webhooks.d.mts +6 -2
- package/resources/webhooks/webhooks.d.mts.map +1 -1
- package/resources/webhooks/webhooks.d.ts +6 -2
- package/resources/webhooks/webhooks.d.ts.map +1 -1
- package/src/resources/admin/organization/audit-logs.ts +1 -1
- package/src/resources/admin/organization/projects/api-keys.ts +6 -0
- package/src/resources/admin/organization/projects/projects.ts +2 -2
- package/src/resources/admin/organization/projects/service-accounts/service-accounts.ts +15 -0
- package/src/resources/audio/speech.ts +3 -2
- package/src/resources/audio/transcriptions.ts +10 -10
- package/src/resources/audio/translations.ts +1 -1
- package/src/resources/batches.ts +6 -5
- package/src/resources/beta/assistants.ts +143 -147
- package/src/resources/beta/responses/input-tokens.ts +11 -11
- package/src/resources/beta/responses/responses.ts +181 -170
- package/src/resources/beta/threads/messages.ts +29 -23
- package/src/resources/beta/threads/runs/runs.ts +39 -35
- package/src/resources/beta/threads/runs/steps.ts +14 -15
- package/src/resources/beta/threads/threads.ts +53 -50
- package/src/resources/chat/completions/completions.ts +89 -81
- package/src/resources/completions.ts +15 -14
- package/src/resources/content-provenance-checks.ts +1 -1
- package/src/resources/conversations/items.ts +3 -3
- package/src/resources/embeddings.ts +6 -6
- package/src/resources/evals/evals.ts +1 -1
- package/src/resources/evals/runs/runs.ts +62 -57
- package/src/resources/files.ts +5 -5
- package/src/resources/fine-tuning/alpha/graders.ts +5 -4
- package/src/resources/fine-tuning/checkpoints/permissions.ts +8 -4
- package/src/resources/fine-tuning/jobs/jobs.ts +13 -12
- package/src/resources/graders/grader-models.ts +1 -1
- package/src/resources/images.ts +10 -10
- package/src/resources/moderations.ts +5 -4
- package/src/resources/realtime/calls.ts +1 -1
- package/src/resources/realtime/client-secrets.ts +4 -4
- package/src/resources/realtime/realtime.ts +16 -16
- package/src/resources/responses/input-tokens.ts +9 -9
- package/src/resources/responses/responses.ts +175 -164
- package/src/resources/shared.ts +12 -12
- package/src/resources/uploads/parts.ts +5 -4
- package/src/resources/uploads/uploads.ts +11 -11
- package/src/resources/vector-stores/file-batches.ts +11 -11
- package/src/resources/vector-stores/files.ts +8 -8
- package/src/resources/vector-stores/vector-stores.ts +3 -3
- package/src/resources/webhooks/webhooks.ts +6 -2
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -79,16 +79,16 @@ export class Responses extends APIResource {
|
|
|
79
79
|
|
|
80
80
|
/**
|
|
81
81
|
* Creates a model response. Provide
|
|
82
|
-
* [text](https://
|
|
83
|
-
* [image](https://
|
|
84
|
-
* [text](https://
|
|
85
|
-
* [JSON](https://
|
|
86
|
-
* the model call your own
|
|
87
|
-
* [custom code](https://
|
|
88
|
-
* built-in [tools](https://
|
|
89
|
-
* [web search](https://
|
|
90
|
-
* [file search](https://
|
|
91
|
-
* your own data as input for the model's response.
|
|
82
|
+
* [text](https://developers.openai.com/api/docs/guides/text) or
|
|
83
|
+
* [image](https://developers.openai.com/api/docs/guides/images-vision) inputs to
|
|
84
|
+
* generate [text](https://developers.openai.com/api/docs/guides/text) or
|
|
85
|
+
* [JSON](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
86
|
+
* outputs. Have the model call your own
|
|
87
|
+
* [custom code](https://developers.openai.com/api/docs/guides/function-calling) or
|
|
88
|
+
* use built-in [tools](https://developers.openai.com/api/docs/guides/tools) like
|
|
89
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search) or
|
|
90
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
91
|
+
* to use your own data as input for the model's response.
|
|
92
92
|
*
|
|
93
93
|
* @example
|
|
94
94
|
* ```ts
|
|
@@ -210,7 +210,7 @@ export class Responses extends APIResource {
|
|
|
210
210
|
/**
|
|
211
211
|
* Cancels a model response with the given ID. Only responses created with the
|
|
212
212
|
* `background` parameter set to `true` can be cancelled.
|
|
213
|
-
* [Learn more](https://
|
|
213
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
214
214
|
*
|
|
215
215
|
* @example
|
|
216
216
|
* ```ts
|
|
@@ -230,9 +230,9 @@ export class Responses extends APIResource {
|
|
|
230
230
|
* Compact a conversation. Returns a compacted response object.
|
|
231
231
|
*
|
|
232
232
|
* Learn when and how to compact long-running conversations in the
|
|
233
|
-
* [conversation state guide](https://
|
|
233
|
+
* [conversation state guide](https://developers.openai.com/api/docs/guides/conversation-state#managing-the-context-window).
|
|
234
234
|
* For ZDR-compatible compaction details, see
|
|
235
|
-
* [Compaction (advanced)](https://
|
|
235
|
+
* [Compaction (advanced)](https://developers.openai.com/api/docs/guides/conversation-state#compaction-advanced).
|
|
236
236
|
*
|
|
237
237
|
* @example
|
|
238
238
|
* ```ts
|
|
@@ -536,7 +536,7 @@ export type ComputerActionList = Array<ComputerAction>;
|
|
|
536
536
|
|
|
537
537
|
/**
|
|
538
538
|
* A tool that controls a virtual computer. Learn more about the
|
|
539
|
-
* [computer tool](https://
|
|
539
|
+
* [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).
|
|
540
540
|
*/
|
|
541
541
|
export interface ComputerTool {
|
|
542
542
|
/**
|
|
@@ -547,7 +547,7 @@ export interface ComputerTool {
|
|
|
547
547
|
|
|
548
548
|
/**
|
|
549
549
|
* A tool that controls a virtual computer. Learn more about the
|
|
550
|
-
* [computer tool](https://
|
|
550
|
+
* [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).
|
|
551
551
|
*/
|
|
552
552
|
export interface ComputerUsePreviewTool {
|
|
553
553
|
/**
|
|
@@ -653,7 +653,7 @@ export interface ContainerReference {
|
|
|
653
653
|
|
|
654
654
|
/**
|
|
655
655
|
* A custom tool that processes input using a specified format. Learn more about
|
|
656
|
-
* [custom tools](https://
|
|
656
|
+
* [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools)
|
|
657
657
|
*/
|
|
658
658
|
export interface CustomTool {
|
|
659
659
|
/**
|
|
@@ -730,7 +730,7 @@ export interface EasyInputMessage {
|
|
|
730
730
|
/**
|
|
731
731
|
* A tool that searches for relevant content from uploaded files. Learn more about
|
|
732
732
|
* the
|
|
733
|
-
* [file search tool](https://
|
|
733
|
+
* [file search tool](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
734
734
|
*/
|
|
735
735
|
export interface FileSearchTool {
|
|
736
736
|
/**
|
|
@@ -823,7 +823,7 @@ export interface FunctionShellTool {
|
|
|
823
823
|
/**
|
|
824
824
|
* Defines a function in your own code the model can choose to call. Learn more
|
|
825
825
|
* about
|
|
826
|
-
* [function calling](https://
|
|
826
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
827
827
|
*/
|
|
828
828
|
export interface FunctionTool {
|
|
829
829
|
/**
|
|
@@ -1085,8 +1085,8 @@ export interface Response {
|
|
|
1085
1085
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
1086
1086
|
* range of models with different capabilities, performance characteristics, and
|
|
1087
1087
|
* price points. Refer to the
|
|
1088
|
-
* [model guide](https://
|
|
1089
|
-
* available models.
|
|
1088
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
1089
|
+
* compare available models.
|
|
1090
1090
|
*/
|
|
1091
1091
|
model: Shared.ResponsesModel;
|
|
1092
1092
|
|
|
@@ -1143,17 +1143,18 @@ export interface Response {
|
|
|
1143
1143
|
*
|
|
1144
1144
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
1145
1145
|
* capabilities, like
|
|
1146
|
-
* [web search](https://
|
|
1147
|
-
*
|
|
1146
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
1147
|
+
* or
|
|
1148
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
1148
1149
|
* Learn more about
|
|
1149
|
-
* [built-in tools](https://
|
|
1150
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
1150
1151
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
1151
1152
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
1152
|
-
* [MCP Tools](https://
|
|
1153
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
1153
1154
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
1154
1155
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
1155
1156
|
* Learn more about
|
|
1156
|
-
* [function calling](https://
|
|
1157
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
1157
1158
|
* You can also use custom tools to call your own code.
|
|
1158
1159
|
*/
|
|
1159
1160
|
tools: Array<Tool>;
|
|
@@ -1169,7 +1170,7 @@ export interface Response {
|
|
|
1169
1170
|
|
|
1170
1171
|
/**
|
|
1171
1172
|
* Whether to run the model response in the background.
|
|
1172
|
-
* [Learn more](https://
|
|
1173
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
1173
1174
|
*/
|
|
1174
1175
|
background?: boolean | null;
|
|
1175
1176
|
|
|
@@ -1188,7 +1189,7 @@ export interface Response {
|
|
|
1188
1189
|
/**
|
|
1189
1190
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
1190
1191
|
* including visible output tokens and
|
|
1191
|
-
* [reasoning tokens](https://
|
|
1192
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
1192
1193
|
*/
|
|
1193
1194
|
max_output_tokens?: number | null;
|
|
1194
1195
|
|
|
@@ -1201,14 +1202,14 @@ export interface Response {
|
|
|
1201
1202
|
/**
|
|
1202
1203
|
* The unique ID of the previous response to the model. Use this to create
|
|
1203
1204
|
* multi-turn conversations. Learn more about
|
|
1204
|
-
* [conversation state](https://
|
|
1205
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
1205
1206
|
* Cannot be used in conjunction with `conversation`.
|
|
1206
1207
|
*/
|
|
1207
1208
|
previous_response_id?: string | null;
|
|
1208
1209
|
|
|
1209
1210
|
/**
|
|
1210
1211
|
* Reference to a prompt template and its variables.
|
|
1211
|
-
* [Learn more](https://
|
|
1212
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
1212
1213
|
*/
|
|
1213
1214
|
prompt?: ResponsePrompt | null;
|
|
1214
1215
|
|
|
@@ -1224,7 +1225,7 @@ export interface Response {
|
|
|
1224
1225
|
/**
|
|
1225
1226
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
1226
1227
|
* hit rates. Replaces the `user` field.
|
|
1227
|
-
* [Learn more](https://
|
|
1228
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
1228
1229
|
*/
|
|
1229
1230
|
prompt_cache_key?: string | null;
|
|
1230
1231
|
|
|
@@ -1240,7 +1241,7 @@ export interface Response {
|
|
|
1240
1241
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
1241
1242
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
1242
1243
|
* of 24 hours.
|
|
1243
|
-
* [Learn more](https://
|
|
1244
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
1244
1245
|
* This field expresses a maximum retention policy, while
|
|
1245
1246
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
1246
1247
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -1257,7 +1258,7 @@ export interface Response {
|
|
|
1257
1258
|
|
|
1258
1259
|
/**
|
|
1259
1260
|
* Configuration options for
|
|
1260
|
-
* [reasoning models](https://
|
|
1261
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
1261
1262
|
*/
|
|
1262
1263
|
reasoning?: Shared.Reasoning | null;
|
|
1263
1264
|
|
|
@@ -1267,7 +1268,7 @@ export interface Response {
|
|
|
1267
1268
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
1268
1269
|
* hashing their username or email address, in order to avoid sending us any
|
|
1269
1270
|
* identifying information.
|
|
1270
|
-
* [Learn more](https://
|
|
1271
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
1271
1272
|
*/
|
|
1272
1273
|
safety_identifier?: string | null;
|
|
1273
1274
|
|
|
@@ -1280,13 +1281,15 @@ export interface Response {
|
|
|
1280
1281
|
* will use 'default'.
|
|
1281
1282
|
* - If set to 'default', then the request will be processed with the standard
|
|
1282
1283
|
* pricing and performance for the selected model.
|
|
1283
|
-
* - If set to
|
|
1284
|
-
* then
|
|
1285
|
-
*
|
|
1286
|
-
*
|
|
1287
|
-
*
|
|
1288
|
-
*
|
|
1289
|
-
*
|
|
1284
|
+
* - If set to
|
|
1285
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
1286
|
+
* the request will be processed with the Flex Processing service tier.
|
|
1287
|
+
* - To opt-in to
|
|
1288
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
1289
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
1290
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
1291
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
1292
|
+
* `priority` in your request.
|
|
1290
1293
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
1291
1294
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
1292
1295
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -1308,8 +1311,8 @@ export interface Response {
|
|
|
1308
1311
|
* Configuration options for a text response from the model. Can be plain text or
|
|
1309
1312
|
* structured JSON data. Learn more:
|
|
1310
1313
|
*
|
|
1311
|
-
* - [Text inputs and outputs](https://
|
|
1312
|
-
* - [Structured Outputs](https://
|
|
1314
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
1315
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
1313
1316
|
*/
|
|
1314
1317
|
text?: ResponseTextConfig;
|
|
1315
1318
|
|
|
@@ -1343,7 +1346,7 @@ export interface Response {
|
|
|
1343
1346
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
1344
1347
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
1345
1348
|
* abuse.
|
|
1346
|
-
* [Learn more](https://
|
|
1349
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
1347
1350
|
*/
|
|
1348
1351
|
user?: string;
|
|
1349
1352
|
}
|
|
@@ -2025,7 +2028,7 @@ export namespace ResponseCodeInterpreterToolCall {
|
|
|
2025
2028
|
|
|
2026
2029
|
/**
|
|
2027
2030
|
* A compaction item generated by the
|
|
2028
|
-
* [`v1/responses/compact` API](https://
|
|
2031
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
2029
2032
|
*/
|
|
2030
2033
|
export interface ResponseCompactionItem {
|
|
2031
2034
|
/**
|
|
@@ -2051,7 +2054,7 @@ export interface ResponseCompactionItem {
|
|
|
2051
2054
|
|
|
2052
2055
|
/**
|
|
2053
2056
|
* A compaction item generated by the
|
|
2054
|
-
* [`v1/responses/compact` API](https://
|
|
2057
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
2055
2058
|
*/
|
|
2056
2059
|
export interface ResponseCompactionItemParam {
|
|
2057
2060
|
/**
|
|
@@ -2092,7 +2095,7 @@ export interface ResponseCompletedEvent {
|
|
|
2092
2095
|
|
|
2093
2096
|
/**
|
|
2094
2097
|
* A tool call to a computer use tool. See the
|
|
2095
|
-
* [computer use guide](https://
|
|
2098
|
+
* [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use)
|
|
2096
2099
|
* for more information.
|
|
2097
2100
|
*/
|
|
2098
2101
|
export interface ResponseComputerToolCall {
|
|
@@ -3125,7 +3128,7 @@ export interface ResponseFileSearchCallSearchingEvent {
|
|
|
3125
3128
|
|
|
3126
3129
|
/**
|
|
3127
3130
|
* The results of a file search tool call. See the
|
|
3128
|
-
* [file search guide](https://
|
|
3131
|
+
* [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
3129
3132
|
* for more information.
|
|
3130
3133
|
*/
|
|
3131
3134
|
export interface ResponseFileSearchToolCall {
|
|
@@ -3194,7 +3197,7 @@ export namespace ResponseFileSearchToolCall {
|
|
|
3194
3197
|
*
|
|
3195
3198
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
3196
3199
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
3197
|
-
* [Structured Outputs guide](https://
|
|
3200
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
3198
3201
|
*
|
|
3199
3202
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
3200
3203
|
*
|
|
@@ -3212,7 +3215,7 @@ export type ResponseFormatTextConfig =
|
|
|
3212
3215
|
/**
|
|
3213
3216
|
* JSON Schema response format. Used to generate structured JSON responses. Learn
|
|
3214
3217
|
* more about
|
|
3215
|
-
* [Structured Outputs](https://
|
|
3218
|
+
* [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
3216
3219
|
*/
|
|
3217
3220
|
export interface ResponseFormatTextJSONSchemaConfig {
|
|
3218
3221
|
/**
|
|
@@ -3243,7 +3246,7 @@ export interface ResponseFormatTextJSONSchemaConfig {
|
|
|
3243
3246
|
* true, the model will always follow the exact schema defined in the `schema`
|
|
3244
3247
|
* field. Only a subset of JSON Schema is supported when `strict` is `true`. To
|
|
3245
3248
|
* learn more, read the
|
|
3246
|
-
* [Structured Outputs guide](https://
|
|
3249
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
3247
3250
|
*/
|
|
3248
3251
|
strict?: boolean | null;
|
|
3249
3252
|
}
|
|
@@ -3562,7 +3565,7 @@ export namespace ResponseFunctionShellToolCallOutput {
|
|
|
3562
3565
|
|
|
3563
3566
|
/**
|
|
3564
3567
|
* A tool call to run a function. See the
|
|
3565
|
-
* [function calling guide](https://
|
|
3568
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
3566
3569
|
* for more information.
|
|
3567
3570
|
*/
|
|
3568
3571
|
export interface ResponseFunctionToolCall {
|
|
@@ -3630,7 +3633,7 @@ export namespace ResponseFunctionToolCall {
|
|
|
3630
3633
|
|
|
3631
3634
|
/**
|
|
3632
3635
|
* A tool call to run a function. See the
|
|
3633
|
-
* [function calling guide](https://
|
|
3636
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
3634
3637
|
* for more information.
|
|
3635
3638
|
*/
|
|
3636
3639
|
export interface ResponseFunctionToolCallItem extends ResponseFunctionToolCall {
|
|
@@ -3723,8 +3726,8 @@ export namespace ResponseFunctionToolCallOutputItem {
|
|
|
3723
3726
|
|
|
3724
3727
|
/**
|
|
3725
3728
|
* The results of a web search tool call. See the
|
|
3726
|
-
* [web search guide](https://
|
|
3727
|
-
* more information.
|
|
3729
|
+
* [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
3730
|
+
* for more information.
|
|
3728
3731
|
*/
|
|
3729
3732
|
export interface ResponseFunctionWebSearch {
|
|
3730
3733
|
/**
|
|
@@ -4202,7 +4205,7 @@ export namespace ResponseInputFileContent {
|
|
|
4202
4205
|
|
|
4203
4206
|
/**
|
|
4204
4207
|
* An image input to the model. Learn about
|
|
4205
|
-
* [image inputs](https://
|
|
4208
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision).
|
|
4206
4209
|
*/
|
|
4207
4210
|
export interface ResponseInputImage {
|
|
4208
4211
|
/**
|
|
@@ -4251,7 +4254,7 @@ export namespace ResponseInputImage {
|
|
|
4251
4254
|
|
|
4252
4255
|
/**
|
|
4253
4256
|
* An image input to the model. Learn about
|
|
4254
|
-
* [image inputs](https://
|
|
4257
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
4255
4258
|
*/
|
|
4256
4259
|
export interface ResponseInputImageContent {
|
|
4257
4260
|
/**
|
|
@@ -6850,7 +6853,7 @@ export namespace ResponseOutputTextAnnotationAddedEvent {
|
|
|
6850
6853
|
|
|
6851
6854
|
/**
|
|
6852
6855
|
* Reference to a prompt template and its variables.
|
|
6853
|
-
* [Learn more](https://
|
|
6856
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
6854
6857
|
*/
|
|
6855
6858
|
export interface ResponsePrompt {
|
|
6856
6859
|
/**
|
|
@@ -6895,7 +6898,7 @@ export interface ResponseQueuedEvent {
|
|
|
6895
6898
|
* A description of the chain of thought used by a reasoning model while generating
|
|
6896
6899
|
* a response. Be sure to include these items in your `input` to the Responses API
|
|
6897
6900
|
* for subsequent turns of a conversation if you are manually
|
|
6898
|
-
* [managing context](https://
|
|
6901
|
+
* [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
6899
6902
|
*/
|
|
6900
6903
|
export interface ResponseReasoningItem {
|
|
6901
6904
|
/**
|
|
@@ -8127,8 +8130,8 @@ export type ResponseStreamEvent =
|
|
|
8127
8130
|
* Configuration options for a text response from the model. Can be plain text or
|
|
8128
8131
|
* structured JSON data. Learn more:
|
|
8129
8132
|
*
|
|
8130
|
-
* - [Text inputs and outputs](https://
|
|
8131
|
-
* - [Structured Outputs](https://
|
|
8133
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
8134
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
8132
8135
|
*/
|
|
8133
8136
|
export interface ResponseTextConfig {
|
|
8134
8137
|
/**
|
|
@@ -8136,7 +8139,7 @@ export interface ResponseTextConfig {
|
|
|
8136
8139
|
*
|
|
8137
8140
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
8138
8141
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
8139
|
-
* [Structured Outputs guide](https://
|
|
8142
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
8140
8143
|
*
|
|
8141
8144
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
8142
8145
|
*
|
|
@@ -8462,7 +8465,7 @@ export namespace ResponseUsage {
|
|
|
8462
8465
|
|
|
8463
8466
|
/**
|
|
8464
8467
|
* The number of tokens that were retrieved from the cache.
|
|
8465
|
-
* [More on prompt caching](https://
|
|
8468
|
+
* [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
8466
8469
|
*/
|
|
8467
8470
|
cached_tokens: number;
|
|
8468
8471
|
}
|
|
@@ -8597,7 +8600,7 @@ export namespace ResponsesClientEvent {
|
|
|
8597
8600
|
|
|
8598
8601
|
/**
|
|
8599
8602
|
* Whether to run the model response in the background.
|
|
8600
|
-
* [Learn more](https://
|
|
8603
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
8601
8604
|
*/
|
|
8602
8605
|
background?: boolean | null;
|
|
8603
8606
|
|
|
@@ -8641,11 +8644,11 @@ export namespace ResponsesClientEvent {
|
|
|
8641
8644
|
*
|
|
8642
8645
|
* Learn more:
|
|
8643
8646
|
*
|
|
8644
|
-
* - [Text inputs and outputs](https://
|
|
8645
|
-
* - [Image inputs](https://
|
|
8646
|
-
* - [File inputs](https://
|
|
8647
|
-
* - [Conversation state](https://
|
|
8648
|
-
* - [Function calling](https://
|
|
8647
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
8648
|
+
* - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
8649
|
+
* - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
8650
|
+
* - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
8651
|
+
* - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
8649
8652
|
*/
|
|
8650
8653
|
input?: string | ResponsesAPI.ResponseInput;
|
|
8651
8654
|
|
|
@@ -8661,7 +8664,7 @@ export namespace ResponsesClientEvent {
|
|
|
8661
8664
|
/**
|
|
8662
8665
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
8663
8666
|
* including visible output tokens and
|
|
8664
|
-
* [reasoning tokens](https://
|
|
8667
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
8665
8668
|
*/
|
|
8666
8669
|
max_output_tokens?: number | null;
|
|
8667
8670
|
|
|
@@ -8687,8 +8690,8 @@ export namespace ResponsesClientEvent {
|
|
|
8687
8690
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
8688
8691
|
* range of models with different capabilities, performance characteristics, and
|
|
8689
8692
|
* price points. Refer to the
|
|
8690
|
-
* [model guide](https://
|
|
8691
|
-
* available models.
|
|
8693
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
8694
|
+
* compare available models.
|
|
8692
8695
|
*/
|
|
8693
8696
|
model?: Shared.ResponsesModel;
|
|
8694
8697
|
|
|
@@ -8705,21 +8708,21 @@ export namespace ResponsesClientEvent {
|
|
|
8705
8708
|
/**
|
|
8706
8709
|
* The unique ID of the previous response to the model. Use this to create
|
|
8707
8710
|
* multi-turn conversations. Learn more about
|
|
8708
|
-
* [conversation state](https://
|
|
8711
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
8709
8712
|
* Cannot be used in conjunction with `conversation`.
|
|
8710
8713
|
*/
|
|
8711
8714
|
previous_response_id?: string | null;
|
|
8712
8715
|
|
|
8713
8716
|
/**
|
|
8714
8717
|
* Reference to a prompt template and its variables.
|
|
8715
|
-
* [Learn more](https://
|
|
8718
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
8716
8719
|
*/
|
|
8717
8720
|
prompt?: ResponsesAPI.ResponsePrompt | null;
|
|
8718
8721
|
|
|
8719
8722
|
/**
|
|
8720
8723
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
8721
8724
|
* hit rates. Replaces the `user` field.
|
|
8722
|
-
* [Learn more](https://
|
|
8725
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
8723
8726
|
*/
|
|
8724
8727
|
prompt_cache_key?: string | null;
|
|
8725
8728
|
|
|
@@ -8731,7 +8734,7 @@ export namespace ResponsesClientEvent {
|
|
|
8731
8734
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
8732
8735
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
8733
8736
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
8734
|
-
* [prompt caching guide](https://
|
|
8737
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
8735
8738
|
* for current details.
|
|
8736
8739
|
*/
|
|
8737
8740
|
prompt_cache_options?: ResponseCreate.PromptCacheOptions;
|
|
@@ -8742,7 +8745,7 @@ export namespace ResponsesClientEvent {
|
|
|
8742
8745
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
8743
8746
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
8744
8747
|
* of 24 hours.
|
|
8745
|
-
* [Learn more](https://
|
|
8748
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
8746
8749
|
* This field expresses a maximum retention policy, while
|
|
8747
8750
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
8748
8751
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -8759,7 +8762,7 @@ export namespace ResponsesClientEvent {
|
|
|
8759
8762
|
|
|
8760
8763
|
/**
|
|
8761
8764
|
* Configuration options for
|
|
8762
|
-
* [reasoning models](https://
|
|
8765
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
8763
8766
|
*/
|
|
8764
8767
|
reasoning?: Shared.Reasoning | null;
|
|
8765
8768
|
|
|
@@ -8769,7 +8772,7 @@ export namespace ResponsesClientEvent {
|
|
|
8769
8772
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
8770
8773
|
* hashing their username or email address, in order to avoid sending us any
|
|
8771
8774
|
* identifying information.
|
|
8772
|
-
* [Learn more](https://
|
|
8775
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
8773
8776
|
*/
|
|
8774
8777
|
safety_identifier?: string | null;
|
|
8775
8778
|
|
|
@@ -8781,13 +8784,15 @@ export namespace ResponsesClientEvent {
|
|
|
8781
8784
|
* will use 'default'.
|
|
8782
8785
|
* - If set to 'default', then the request will be processed with the standard
|
|
8783
8786
|
* pricing and performance for the selected model.
|
|
8784
|
-
* - If set to
|
|
8785
|
-
* then
|
|
8786
|
-
*
|
|
8787
|
-
*
|
|
8788
|
-
*
|
|
8789
|
-
*
|
|
8790
|
-
*
|
|
8787
|
+
* - If set to
|
|
8788
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
8789
|
+
* the request will be processed with the Flex Processing service tier.
|
|
8790
|
+
* - To opt-in to
|
|
8791
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
8792
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
8793
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
8794
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
8795
|
+
* `priority` in your request.
|
|
8791
8796
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
8792
8797
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
8793
8798
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -8805,7 +8810,7 @@ export namespace ResponsesClientEvent {
|
|
|
8805
8810
|
* Whether to store the generated model response for later retrieval via API.
|
|
8806
8811
|
* Defaults to true when omitted. If set to true, response data will be stored for
|
|
8807
8812
|
* at least 30 days, subject to the
|
|
8808
|
-
* [data retention exceptions](/api/docs/guides/your-data#v1responses).
|
|
8813
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
8809
8814
|
*/
|
|
8810
8815
|
store?: boolean | null;
|
|
8811
8816
|
|
|
@@ -8814,7 +8819,7 @@ export namespace ResponsesClientEvent {
|
|
|
8814
8819
|
* generated using
|
|
8815
8820
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
8816
8821
|
* See the
|
|
8817
|
-
* [Streaming section below](https://
|
|
8822
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
8818
8823
|
* for more information.
|
|
8819
8824
|
*/
|
|
8820
8825
|
stream?: boolean | null;
|
|
@@ -8845,8 +8850,8 @@ export namespace ResponsesClientEvent {
|
|
|
8845
8850
|
* Configuration options for a text response from the model. Can be plain text or
|
|
8846
8851
|
* structured JSON data. Learn more:
|
|
8847
8852
|
*
|
|
8848
|
-
* - [Text inputs and outputs](https://
|
|
8849
|
-
* - [Structured Outputs](https://
|
|
8853
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
8854
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
8850
8855
|
*/
|
|
8851
8856
|
text?: ResponsesAPI.ResponseTextConfig;
|
|
8852
8857
|
|
|
@@ -8874,17 +8879,18 @@ export namespace ResponsesClientEvent {
|
|
|
8874
8879
|
*
|
|
8875
8880
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
8876
8881
|
* capabilities, like
|
|
8877
|
-
* [web search](https://
|
|
8878
|
-
*
|
|
8882
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
8883
|
+
* or
|
|
8884
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
8879
8885
|
* Learn more about
|
|
8880
|
-
* [built-in tools](https://
|
|
8886
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
8881
8887
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
8882
8888
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
8883
|
-
* [MCP Tools](https://
|
|
8889
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
8884
8890
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
8885
8891
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
8886
8892
|
* Learn more about
|
|
8887
|
-
* [function calling](https://
|
|
8893
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
8888
8894
|
* You can also use custom tools to call your own code.
|
|
8889
8895
|
*/
|
|
8890
8896
|
tools?: Array<ResponsesAPI.Tool>;
|
|
@@ -8922,7 +8928,7 @@ export namespace ResponsesClientEvent {
|
|
|
8922
8928
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
8923
8929
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
8924
8930
|
* abuse.
|
|
8925
|
-
* [Learn more](https://
|
|
8931
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
8926
8932
|
*/
|
|
8927
8933
|
user?: string;
|
|
8928
8934
|
}
|
|
@@ -8997,7 +9003,7 @@ export namespace ResponsesClientEvent {
|
|
|
8997
9003
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
8998
9004
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
8999
9005
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
9000
|
-
* [prompt caching guide](https://
|
|
9006
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
9001
9007
|
* for current details.
|
|
9002
9008
|
*/
|
|
9003
9009
|
export interface PromptCacheOptions {
|
|
@@ -9873,13 +9879,15 @@ export namespace ResponsesServerEvent {
|
|
|
9873
9879
|
* will use 'default'.
|
|
9874
9880
|
* - If set to 'default', then the request will be processed with the standard
|
|
9875
9881
|
* pricing and performance for the selected model.
|
|
9876
|
-
* - If set to
|
|
9877
|
-
* then
|
|
9878
|
-
*
|
|
9879
|
-
*
|
|
9880
|
-
*
|
|
9881
|
-
*
|
|
9882
|
-
*
|
|
9882
|
+
* - If set to
|
|
9883
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
9884
|
+
* the request will be processed with the Flex Processing service tier.
|
|
9885
|
+
* - To opt-in to
|
|
9886
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
9887
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
9888
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
9889
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
9890
|
+
* `priority` in your request.
|
|
9883
9891
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
9884
9892
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
9885
9893
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -9935,7 +9943,7 @@ export namespace Tool {
|
|
|
9935
9943
|
/**
|
|
9936
9944
|
* Give the model access to additional tools via remote Model Context Protocol
|
|
9937
9945
|
* (MCP) servers.
|
|
9938
|
-
* [Learn more about MCP](https://
|
|
9946
|
+
* [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
9939
9947
|
*/
|
|
9940
9948
|
export interface Mcp {
|
|
9941
9949
|
/**
|
|
@@ -9969,7 +9977,7 @@ export namespace Tool {
|
|
|
9969
9977
|
* Identifier for service connectors, like those available in ChatGPT. One of
|
|
9970
9978
|
* `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
|
|
9971
9979
|
* service connectors
|
|
9972
|
-
* [here](https://
|
|
9980
|
+
* [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
|
|
9973
9981
|
*
|
|
9974
9982
|
* Currently supported `connector_id` values are:
|
|
9975
9983
|
*
|
|
@@ -10416,12 +10424,12 @@ export interface ToolChoiceShell {
|
|
|
10416
10424
|
|
|
10417
10425
|
/**
|
|
10418
10426
|
* Indicates that the model should use a built-in tool to generate a response.
|
|
10419
|
-
* [Learn more about built-in tools](https://
|
|
10427
|
+
* [Learn more about built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
10420
10428
|
*/
|
|
10421
10429
|
export interface ToolChoiceTypes {
|
|
10422
10430
|
/**
|
|
10423
10431
|
* The type of hosted tool the model should to use. Learn more about
|
|
10424
|
-
* [built-in tools](https://
|
|
10432
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
10425
10433
|
*
|
|
10426
10434
|
* Allowed values are:
|
|
10427
10435
|
*
|
|
@@ -10474,7 +10482,7 @@ export interface ToolSearchTool {
|
|
|
10474
10482
|
/**
|
|
10475
10483
|
* This tool searches the web for relevant results to use in a response. Learn more
|
|
10476
10484
|
* about the
|
|
10477
|
-
* [web search tool](https://
|
|
10485
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
10478
10486
|
*/
|
|
10479
10487
|
export interface WebSearchPreviewTool {
|
|
10480
10488
|
/**
|
|
@@ -10533,7 +10541,7 @@ export namespace WebSearchPreviewTool {
|
|
|
10533
10541
|
|
|
10534
10542
|
/**
|
|
10535
10543
|
* Search the Internet for sources related to the prompt. Learn more about the
|
|
10536
|
-
* [web search tool](https://
|
|
10544
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
10537
10545
|
*/
|
|
10538
10546
|
export interface WebSearchTool {
|
|
10539
10547
|
/**
|
|
@@ -10617,7 +10625,7 @@ export type ResponseCreateParams = ResponseCreateParamsNonStreaming | ResponseCr
|
|
|
10617
10625
|
export interface ResponseCreateParamsBase {
|
|
10618
10626
|
/**
|
|
10619
10627
|
* Whether to run the model response in the background.
|
|
10620
|
-
* [Learn more](https://
|
|
10628
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
10621
10629
|
*/
|
|
10622
10630
|
background?: boolean | null;
|
|
10623
10631
|
|
|
@@ -10664,11 +10672,11 @@ export interface ResponseCreateParamsBase {
|
|
|
10664
10672
|
*
|
|
10665
10673
|
* Learn more:
|
|
10666
10674
|
*
|
|
10667
|
-
* - [Text inputs and outputs](https://
|
|
10668
|
-
* - [Image inputs](https://
|
|
10669
|
-
* - [File inputs](https://
|
|
10670
|
-
* - [Conversation state](https://
|
|
10671
|
-
* - [Function calling](https://
|
|
10675
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
10676
|
+
* - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
10677
|
+
* - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
10678
|
+
* - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
10679
|
+
* - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
10672
10680
|
*/
|
|
10673
10681
|
input?: string | ResponseInput;
|
|
10674
10682
|
|
|
@@ -10684,7 +10692,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10684
10692
|
/**
|
|
10685
10693
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
10686
10694
|
* including visible output tokens and
|
|
10687
|
-
* [reasoning tokens](https://
|
|
10695
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
10688
10696
|
*/
|
|
10689
10697
|
max_output_tokens?: number | null;
|
|
10690
10698
|
|
|
@@ -10702,8 +10710,8 @@ export interface ResponseCreateParamsBase {
|
|
|
10702
10710
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
10703
10711
|
* range of models with different capabilities, performance characteristics, and
|
|
10704
10712
|
* price points. Refer to the
|
|
10705
|
-
* [model guide](https://
|
|
10706
|
-
* available models.
|
|
10713
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
10714
|
+
* compare available models.
|
|
10707
10715
|
*/
|
|
10708
10716
|
model?: Shared.ResponsesModel;
|
|
10709
10717
|
|
|
@@ -10720,21 +10728,21 @@ export interface ResponseCreateParamsBase {
|
|
|
10720
10728
|
/**
|
|
10721
10729
|
* The unique ID of the previous response to the model. Use this to create
|
|
10722
10730
|
* multi-turn conversations. Learn more about
|
|
10723
|
-
* [conversation state](https://
|
|
10731
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
10724
10732
|
* Cannot be used in conjunction with `conversation`.
|
|
10725
10733
|
*/
|
|
10726
10734
|
previous_response_id?: string | null;
|
|
10727
10735
|
|
|
10728
10736
|
/**
|
|
10729
10737
|
* Reference to a prompt template and its variables.
|
|
10730
|
-
* [Learn more](https://
|
|
10738
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
10731
10739
|
*/
|
|
10732
10740
|
prompt?: ResponsePrompt | null;
|
|
10733
10741
|
|
|
10734
10742
|
/**
|
|
10735
10743
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
10736
10744
|
* hit rates. Replaces the `user` field.
|
|
10737
|
-
* [Learn more](https://
|
|
10745
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
10738
10746
|
*/
|
|
10739
10747
|
prompt_cache_key?: string | null;
|
|
10740
10748
|
|
|
@@ -10746,7 +10754,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10746
10754
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
10747
10755
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
10748
10756
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
10749
|
-
* [prompt caching guide](https://
|
|
10757
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
10750
10758
|
* for current details.
|
|
10751
10759
|
*/
|
|
10752
10760
|
prompt_cache_options?: ResponseCreateParams.PromptCacheOptions;
|
|
@@ -10757,7 +10765,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10757
10765
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
10758
10766
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
10759
10767
|
* of 24 hours.
|
|
10760
|
-
* [Learn more](https://
|
|
10768
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
10761
10769
|
* This field expresses a maximum retention policy, while
|
|
10762
10770
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
10763
10771
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -10774,7 +10782,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10774
10782
|
|
|
10775
10783
|
/**
|
|
10776
10784
|
* Configuration options for
|
|
10777
|
-
* [reasoning models](https://
|
|
10785
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
10778
10786
|
*/
|
|
10779
10787
|
reasoning?: Shared.Reasoning | null;
|
|
10780
10788
|
|
|
@@ -10784,7 +10792,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10784
10792
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
10785
10793
|
* hashing their username or email address, in order to avoid sending us any
|
|
10786
10794
|
* identifying information.
|
|
10787
|
-
* [Learn more](https://
|
|
10795
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
10788
10796
|
*/
|
|
10789
10797
|
safety_identifier?: string | null;
|
|
10790
10798
|
|
|
@@ -10797,13 +10805,15 @@ export interface ResponseCreateParamsBase {
|
|
|
10797
10805
|
* will use 'default'.
|
|
10798
10806
|
* - If set to 'default', then the request will be processed with the standard
|
|
10799
10807
|
* pricing and performance for the selected model.
|
|
10800
|
-
* - If set to
|
|
10801
|
-
* then
|
|
10802
|
-
*
|
|
10803
|
-
*
|
|
10804
|
-
*
|
|
10805
|
-
*
|
|
10806
|
-
*
|
|
10808
|
+
* - If set to
|
|
10809
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
10810
|
+
* the request will be processed with the Flex Processing service tier.
|
|
10811
|
+
* - To opt-in to
|
|
10812
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
10813
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
10814
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
10815
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
10816
|
+
* `priority` in your request.
|
|
10807
10817
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
10808
10818
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
10809
10819
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -10819,7 +10829,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10819
10829
|
* Whether to store the generated model response for later retrieval via API.
|
|
10820
10830
|
* Defaults to true when omitted. If set to true, response data will be stored for
|
|
10821
10831
|
* at least 30 days, subject to the
|
|
10822
|
-
* [data retention exceptions](/api/docs/guides/your-data#v1responses).
|
|
10832
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
10823
10833
|
*/
|
|
10824
10834
|
store?: boolean | null;
|
|
10825
10835
|
|
|
@@ -10828,7 +10838,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10828
10838
|
* generated using
|
|
10829
10839
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
10830
10840
|
* See the
|
|
10831
|
-
* [Streaming section below](https://
|
|
10841
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
10832
10842
|
* for more information.
|
|
10833
10843
|
*/
|
|
10834
10844
|
stream?: boolean | null;
|
|
@@ -10850,8 +10860,8 @@ export interface ResponseCreateParamsBase {
|
|
|
10850
10860
|
* Configuration options for a text response from the model. Can be plain text or
|
|
10851
10861
|
* structured JSON data. Learn more:
|
|
10852
10862
|
*
|
|
10853
|
-
* - [Text inputs and outputs](https://
|
|
10854
|
-
* - [Structured Outputs](https://
|
|
10863
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
10864
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
10855
10865
|
*/
|
|
10856
10866
|
text?: ResponseTextConfig;
|
|
10857
10867
|
|
|
@@ -10879,17 +10889,18 @@ export interface ResponseCreateParamsBase {
|
|
|
10879
10889
|
*
|
|
10880
10890
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
10881
10891
|
* capabilities, like
|
|
10882
|
-
* [web search](https://
|
|
10883
|
-
*
|
|
10892
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
10893
|
+
* or
|
|
10894
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
10884
10895
|
* Learn more about
|
|
10885
|
-
* [built-in tools](https://
|
|
10896
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
10886
10897
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
10887
10898
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
10888
|
-
* [MCP Tools](https://
|
|
10899
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
10889
10900
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
10890
10901
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
10891
10902
|
* Learn more about
|
|
10892
|
-
* [function calling](https://
|
|
10903
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
10893
10904
|
* You can also use custom tools to call your own code.
|
|
10894
10905
|
*/
|
|
10895
10906
|
tools?: Array<Tool>;
|
|
@@ -10927,7 +10938,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10927
10938
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
10928
10939
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
10929
10940
|
* abuse.
|
|
10930
|
-
* [Learn more](https://
|
|
10941
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
10931
10942
|
*/
|
|
10932
10943
|
user?: string;
|
|
10933
10944
|
}
|
|
@@ -11002,7 +11013,7 @@ export namespace ResponseCreateParams {
|
|
|
11002
11013
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
11003
11014
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
11004
11015
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
11005
|
-
* [prompt caching guide](https://
|
|
11016
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11006
11017
|
* for current details.
|
|
11007
11018
|
*/
|
|
11008
11019
|
export interface PromptCacheOptions {
|
|
@@ -11062,7 +11073,7 @@ export interface ResponseCreateParamsNonStreaming extends ResponseCreateParamsBa
|
|
|
11062
11073
|
* generated using
|
|
11063
11074
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11064
11075
|
* See the
|
|
11065
|
-
* [Streaming section below](https://
|
|
11076
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11066
11077
|
* for more information.
|
|
11067
11078
|
*/
|
|
11068
11079
|
stream?: false | null;
|
|
@@ -11074,7 +11085,7 @@ export interface ResponseCreateParamsStreaming extends ResponseCreateParamsBase
|
|
|
11074
11085
|
* generated using
|
|
11075
11086
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11076
11087
|
* See the
|
|
11077
|
-
* [Streaming section below](https://
|
|
11088
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11078
11089
|
* for more information.
|
|
11079
11090
|
*/
|
|
11080
11091
|
stream: true;
|
|
@@ -11109,7 +11120,7 @@ export interface ResponseRetrieveParamsBase {
|
|
|
11109
11120
|
* generated using
|
|
11110
11121
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11111
11122
|
* See the
|
|
11112
|
-
* [Streaming section below](https://
|
|
11123
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11113
11124
|
* for more information.
|
|
11114
11125
|
*/
|
|
11115
11126
|
stream?: boolean;
|
|
@@ -11126,7 +11137,7 @@ export interface ResponseRetrieveParamsNonStreaming extends ResponseRetrievePara
|
|
|
11126
11137
|
* generated using
|
|
11127
11138
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11128
11139
|
* See the
|
|
11129
|
-
* [Streaming section below](https://
|
|
11140
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11130
11141
|
* for more information.
|
|
11131
11142
|
*/
|
|
11132
11143
|
stream?: false;
|
|
@@ -11138,7 +11149,7 @@ export interface ResponseRetrieveParamsStreaming extends ResponseRetrieveParamsB
|
|
|
11138
11149
|
* generated using
|
|
11139
11150
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11140
11151
|
* See the
|
|
11141
|
-
* [Streaming section below](https://
|
|
11152
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11142
11153
|
* for more information.
|
|
11143
11154
|
*/
|
|
11144
11155
|
stream: true;
|
|
@@ -11149,8 +11160,8 @@ export interface ResponseCompactParams {
|
|
|
11149
11160
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
11150
11161
|
* range of models with different capabilities, performance characteristics, and
|
|
11151
11162
|
* price points. Refer to the
|
|
11152
|
-
* [model guide](https://
|
|
11153
|
-
* available models.
|
|
11163
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
11164
|
+
* compare available models.
|
|
11154
11165
|
*/
|
|
11155
11166
|
model:
|
|
11156
11167
|
| 'gpt-6-astra'
|
|
@@ -11275,7 +11286,7 @@ export interface ResponseCompactParams {
|
|
|
11275
11286
|
/**
|
|
11276
11287
|
* The unique ID of the previous response to the model. Use this to create
|
|
11277
11288
|
* multi-turn conversations. Learn more about
|
|
11278
|
-
* [conversation state](https://
|
|
11289
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
11279
11290
|
* Cannot be used in conjunction with `conversation`.
|
|
11280
11291
|
*/
|
|
11281
11292
|
previous_response_id?: string | null;
|
|
@@ -11293,7 +11304,7 @@ export interface ResponseCompactParams {
|
|
|
11293
11304
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
11294
11305
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
11295
11306
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
11296
|
-
* [prompt caching guide](https://
|
|
11307
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11297
11308
|
* for current details.
|
|
11298
11309
|
*/
|
|
11299
11310
|
prompt_cache_options?: ResponseCompactParams.PromptCacheOptions | null;
|
|
@@ -11309,17 +11320,17 @@ export interface ResponseCompactParams {
|
|
|
11309
11320
|
* Project settings. Unless otherwise configured, the Project will use 'default'. -
|
|
11310
11321
|
* If set to 'default', then the request will be processed with the standard
|
|
11311
11322
|
* pricing and performance for the selected model. - If set to
|
|
11312
|
-
* '[flex](https://
|
|
11313
|
-
* request will be processed with the Flex Processing service tier. - To opt-in
|
|
11314
|
-
* [Fast mode](/api/docs/guides/fast-mode) at the
|
|
11315
|
-
* `service_tier=fast` or `service_tier=priority`
|
|
11316
|
-
* Completions. For models with a dedicated Fast
|
|
11317
|
-
* `service_tier=fast`; for other models, either
|
|
11318
|
-
* `service_tier=priority`. - When not set, the default behavior
|
|
11319
|
-
* the `service_tier` parameter is set, the response body will
|
|
11320
|
-
* `service_tier` value based on the processing mode actually used to
|
|
11321
|
-
* request. This response value may be different from the value set in
|
|
11322
|
-
* parameter.
|
|
11323
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
11324
|
+
* the request will be processed with the Flex Processing service tier. - To opt-in
|
|
11325
|
+
* to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
11326
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
11327
|
+
* parameter for Responses or Chat Completions. For models with a dedicated Fast
|
|
11328
|
+
* tier, either value resolves to `service_tier=fast`; for other models, either
|
|
11329
|
+
* value resolves to `service_tier=priority`. - When not set, the default behavior
|
|
11330
|
+
* is 'auto'. When the `service_tier` parameter is set, the response body will
|
|
11331
|
+
* include the `service_tier` value based on the processing mode actually used to
|
|
11332
|
+
* serve the request. This response value may be different from the value set in
|
|
11333
|
+
* the parameter.
|
|
11323
11334
|
*/
|
|
11324
11335
|
service_tier?: 'auto' | 'default' | 'fast' | 'flex' | 'priority' | null;
|
|
11325
11336
|
}
|
|
@@ -11333,7 +11344,7 @@ export namespace ResponseCompactParams {
|
|
|
11333
11344
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
11334
11345
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
11335
11346
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
11336
|
-
* [prompt caching guide](https://
|
|
11347
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11337
11348
|
* for current details.
|
|
11338
11349
|
*/
|
|
11339
11350
|
export interface PromptCacheOptions {
|