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
|
@@ -13,16 +13,16 @@ export declare class Responses extends APIResource {
|
|
|
13
13
|
inputTokens: InputTokensAPI.InputTokens;
|
|
14
14
|
/**
|
|
15
15
|
* Creates a model response. Provide
|
|
16
|
-
* [text](https://
|
|
17
|
-
* [image](https://
|
|
18
|
-
* [text](https://
|
|
19
|
-
* [JSON](https://
|
|
20
|
-
* the model call your own
|
|
21
|
-
* [custom code](https://
|
|
22
|
-
* built-in [tools](https://
|
|
23
|
-
* [web search](https://
|
|
24
|
-
* [file search](https://
|
|
25
|
-
* your own data as input for the model's response.
|
|
16
|
+
* [text](https://developers.openai.com/api/docs/guides/text) or
|
|
17
|
+
* [image](https://developers.openai.com/api/docs/guides/images-vision) inputs to
|
|
18
|
+
* generate [text](https://developers.openai.com/api/docs/guides/text) or
|
|
19
|
+
* [JSON](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
20
|
+
* outputs. Have the model call your own
|
|
21
|
+
* [custom code](https://developers.openai.com/api/docs/guides/function-calling) or
|
|
22
|
+
* use built-in [tools](https://developers.openai.com/api/docs/guides/tools) like
|
|
23
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search) or
|
|
24
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
25
|
+
* to use your own data as input for the model's response.
|
|
26
26
|
*
|
|
27
27
|
* @example
|
|
28
28
|
* ```ts
|
|
@@ -59,7 +59,7 @@ export declare class Responses extends APIResource {
|
|
|
59
59
|
/**
|
|
60
60
|
* Cancels a model response with the given ID. Only responses created with the
|
|
61
61
|
* `background` parameter set to `true` can be cancelled.
|
|
62
|
-
* [Learn more](https://
|
|
62
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
63
63
|
*
|
|
64
64
|
* @example
|
|
65
65
|
* ```ts
|
|
@@ -73,9 +73,9 @@ export declare class Responses extends APIResource {
|
|
|
73
73
|
* Compact a conversation. Returns a compacted response object.
|
|
74
74
|
*
|
|
75
75
|
* Learn when and how to compact long-running conversations in the
|
|
76
|
-
* [conversation state guide](https://
|
|
76
|
+
* [conversation state guide](https://developers.openai.com/api/docs/guides/conversation-state#managing-the-context-window).
|
|
77
77
|
* For ZDR-compatible compaction details, see
|
|
78
|
-
* [Compaction (advanced)](https://
|
|
78
|
+
* [Compaction (advanced)](https://developers.openai.com/api/docs/guides/conversation-state#compaction-advanced).
|
|
79
79
|
*
|
|
80
80
|
* @example
|
|
81
81
|
* ```ts
|
|
@@ -328,7 +328,7 @@ export declare namespace BetaComputerAction {
|
|
|
328
328
|
export type BetaComputerActionList = Array<BetaComputerAction>;
|
|
329
329
|
/**
|
|
330
330
|
* A tool that controls a virtual computer. Learn more about the
|
|
331
|
-
* [computer tool](https://
|
|
331
|
+
* [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).
|
|
332
332
|
*/
|
|
333
333
|
export interface BetaComputerTool {
|
|
334
334
|
/**
|
|
@@ -338,7 +338,7 @@ export interface BetaComputerTool {
|
|
|
338
338
|
}
|
|
339
339
|
/**
|
|
340
340
|
* A tool that controls a virtual computer. Learn more about the
|
|
341
|
-
* [computer tool](https://
|
|
341
|
+
* [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).
|
|
342
342
|
*/
|
|
343
343
|
export interface BetaComputerUsePreviewTool {
|
|
344
344
|
/**
|
|
@@ -426,7 +426,7 @@ export interface BetaContainerReference {
|
|
|
426
426
|
}
|
|
427
427
|
/**
|
|
428
428
|
* A custom tool that processes input using a specified format. Learn more about
|
|
429
|
-
* [custom tools](https://
|
|
429
|
+
* [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools)
|
|
430
430
|
*/
|
|
431
431
|
export interface BetaCustomTool {
|
|
432
432
|
/**
|
|
@@ -520,7 +520,7 @@ export interface BetaEasyInputMessage {
|
|
|
520
520
|
/**
|
|
521
521
|
* A tool that searches for relevant content from uploaded files. Learn more about
|
|
522
522
|
* the
|
|
523
|
-
* [file search tool](https://
|
|
523
|
+
* [file search tool](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
524
524
|
*/
|
|
525
525
|
export interface BetaFileSearchTool {
|
|
526
526
|
/**
|
|
@@ -674,7 +674,7 @@ export interface BetaFunctionShellTool {
|
|
|
674
674
|
/**
|
|
675
675
|
* Defines a function in your own code the model can choose to call. Learn more
|
|
676
676
|
* about
|
|
677
|
-
* [function calling](https://
|
|
677
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
678
678
|
*/
|
|
679
679
|
export interface BetaFunctionTool {
|
|
680
680
|
/**
|
|
@@ -889,8 +889,8 @@ export interface BetaResponse {
|
|
|
889
889
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
890
890
|
* range of models with different capabilities, performance characteristics, and
|
|
891
891
|
* price points. Refer to the
|
|
892
|
-
* [model guide](https://
|
|
893
|
-
* available models.
|
|
892
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
893
|
+
* compare available models.
|
|
894
894
|
*/
|
|
895
895
|
model: 'gpt-6-astra' | 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-5.5' | 'gpt-5.5-2026-04-23' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.4-mini-2026-03-17' | 'gpt-5.4-nano-2026-03-17' | 'gpt-5.3-chat-latest' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-codex' | 'gpt-5.1-mini' | 'gpt-5.1-chat-latest' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5-2025-08-07' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano-2025-04-14' | 'o4-mini' | 'o4-mini-2025-04-16' | 'o3' | 'o3-2025-04-16' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o1' | 'o1-2024-12-17' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o1-mini' | 'o1-mini-2024-09-12' | 'gpt-4o' | 'gpt-4o-2024-11-20' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-05-13' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-audio-preview-2025-06-03' | 'gpt-4o-mini-audio-preview' | 'gpt-4o-mini-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-mini-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview-2025-03-11' | 'chatgpt-4o-latest' | 'codex-mini-latest' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-0125-preview' | 'gpt-4-turbo-preview' | 'gpt-4-1106-preview' | 'gpt-4-vision-preview' | 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-16k-0613' | 'o1-pro' | 'o1-pro-2025-03-19' | 'o3-pro' | 'o3-pro-2025-06-10' | 'o3-deep-research' | 'o3-deep-research-2025-06-26' | 'o4-mini-deep-research' | 'o4-mini-deep-research-2025-06-26' | 'computer-use-preview' | 'computer-use-preview-2025-03-11' | 'gpt-5.5-pro' | 'gpt-5.5-pro-2026-04-23' | 'gpt-5-codex' | 'gpt-5-pro' | 'gpt-5-pro-2025-10-06' | 'gpt-5.1-codex-max' | 'gpt-daybreak-blue-latest' | 'gpt-daybreak-red-latest' | 'gpt-5.6-cyber' | (string & {});
|
|
896
896
|
/**
|
|
@@ -932,17 +932,18 @@ export interface BetaResponse {
|
|
|
932
932
|
*
|
|
933
933
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
934
934
|
* capabilities, like
|
|
935
|
-
* [web search](https://
|
|
936
|
-
*
|
|
935
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
936
|
+
* or
|
|
937
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
937
938
|
* Learn more about
|
|
938
|
-
* [built-in tools](https://
|
|
939
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
939
940
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
940
941
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
941
|
-
* [MCP Tools](https://
|
|
942
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
942
943
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
943
944
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
944
945
|
* Learn more about
|
|
945
|
-
* [function calling](https://
|
|
946
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
946
947
|
* You can also use custom tools to call your own code.
|
|
947
948
|
*/
|
|
948
949
|
tools: Array<BetaTool>;
|
|
@@ -956,7 +957,7 @@ export interface BetaResponse {
|
|
|
956
957
|
top_p: number | null;
|
|
957
958
|
/**
|
|
958
959
|
* Whether to run the model response in the background.
|
|
959
|
-
* [Learn more](https://
|
|
960
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
960
961
|
*/
|
|
961
962
|
background?: boolean | null;
|
|
962
963
|
/**
|
|
@@ -972,7 +973,7 @@ export interface BetaResponse {
|
|
|
972
973
|
/**
|
|
973
974
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
974
975
|
* including visible output tokens and
|
|
975
|
-
* [reasoning tokens](https://
|
|
976
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
976
977
|
*/
|
|
977
978
|
max_output_tokens?: number | null;
|
|
978
979
|
/**
|
|
@@ -990,13 +991,13 @@ export interface BetaResponse {
|
|
|
990
991
|
/**
|
|
991
992
|
* The unique ID of the previous response to the model. Use this to create
|
|
992
993
|
* multi-turn conversations. Learn more about
|
|
993
|
-
* [conversation state](https://
|
|
994
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
994
995
|
* Cannot be used in conjunction with `conversation`.
|
|
995
996
|
*/
|
|
996
997
|
previous_response_id?: string | null;
|
|
997
998
|
/**
|
|
998
999
|
* Reference to a prompt template and its variables.
|
|
999
|
-
* [Learn more](https://
|
|
1000
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
1000
1001
|
*/
|
|
1001
1002
|
prompt?: BetaResponsePrompt | null;
|
|
1002
1003
|
/**
|
|
@@ -1006,7 +1007,7 @@ export interface BetaResponse {
|
|
|
1006
1007
|
/**
|
|
1007
1008
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
1008
1009
|
* hit rates. Replaces the `user` field.
|
|
1009
|
-
* [Learn more](https://
|
|
1010
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
1010
1011
|
*/
|
|
1011
1012
|
prompt_cache_key?: string | null;
|
|
1012
1013
|
/**
|
|
@@ -1020,7 +1021,7 @@ export interface BetaResponse {
|
|
|
1020
1021
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
1021
1022
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
1022
1023
|
* of 24 hours.
|
|
1023
|
-
* [Learn more](https://
|
|
1024
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
1024
1025
|
* This field expresses a maximum retention policy, while
|
|
1025
1026
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
1026
1027
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -1036,7 +1037,7 @@ export interface BetaResponse {
|
|
|
1036
1037
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
1037
1038
|
/**
|
|
1038
1039
|
* Configuration options for
|
|
1039
|
-
* [reasoning models](https://
|
|
1040
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
1040
1041
|
*/
|
|
1041
1042
|
reasoning?: BetaResponse.Reasoning | null;
|
|
1042
1043
|
/**
|
|
@@ -1045,7 +1046,7 @@ export interface BetaResponse {
|
|
|
1045
1046
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
1046
1047
|
* hashing their username or email address, in order to avoid sending us any
|
|
1047
1048
|
* identifying information.
|
|
1048
|
-
* [Learn more](https://
|
|
1049
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
1049
1050
|
*/
|
|
1050
1051
|
safety_identifier?: string | null;
|
|
1051
1052
|
/**
|
|
@@ -1056,13 +1057,15 @@ export interface BetaResponse {
|
|
|
1056
1057
|
* will use 'default'.
|
|
1057
1058
|
* - If set to 'default', then the request will be processed with the standard
|
|
1058
1059
|
* pricing and performance for the selected model.
|
|
1059
|
-
* - If set to
|
|
1060
|
-
* then
|
|
1061
|
-
*
|
|
1062
|
-
*
|
|
1063
|
-
*
|
|
1064
|
-
*
|
|
1065
|
-
*
|
|
1060
|
+
* - If set to
|
|
1061
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
1062
|
+
* the request will be processed with the Flex Processing service tier.
|
|
1063
|
+
* - To opt-in to
|
|
1064
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
1065
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
1066
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
1067
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
1068
|
+
* `priority` in your request.
|
|
1066
1069
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
1067
1070
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
1068
1071
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -1084,8 +1087,8 @@ export interface BetaResponse {
|
|
|
1084
1087
|
* Configuration options for a text response from the model. Can be plain text or
|
|
1085
1088
|
* structured JSON data. Learn more:
|
|
1086
1089
|
*
|
|
1087
|
-
* - [Text inputs and outputs](https://
|
|
1088
|
-
* - [Structured Outputs](https://
|
|
1090
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
1091
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
1089
1092
|
*/
|
|
1090
1093
|
text?: BetaResponseTextConfig;
|
|
1091
1094
|
/**
|
|
@@ -1115,7 +1118,7 @@ export interface BetaResponse {
|
|
|
1115
1118
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
1116
1119
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
1117
1120
|
* abuse.
|
|
1118
|
-
* [Learn more](https://
|
|
1121
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
1119
1122
|
*/
|
|
1120
1123
|
user?: string;
|
|
1121
1124
|
}
|
|
@@ -1316,7 +1319,7 @@ export declare namespace BetaResponse {
|
|
|
1316
1319
|
}
|
|
1317
1320
|
/**
|
|
1318
1321
|
* Configuration options for
|
|
1319
|
-
* [reasoning models](https://
|
|
1322
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
1320
1323
|
*/
|
|
1321
1324
|
interface Reasoning {
|
|
1322
1325
|
/**
|
|
@@ -1333,7 +1336,7 @@ export declare namespace BetaResponse {
|
|
|
1333
1336
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
1334
1337
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
1335
1338
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
1336
|
-
* [reasoning guide](https://
|
|
1339
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
1337
1340
|
* model-specific support.
|
|
1338
1341
|
*/
|
|
1339
1342
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
|
|
@@ -1914,7 +1917,7 @@ export declare namespace BetaResponseCodeInterpreterToolCall {
|
|
|
1914
1917
|
}
|
|
1915
1918
|
/**
|
|
1916
1919
|
* A compaction item generated by the
|
|
1917
|
-
* [`v1/responses/compact` API](https://
|
|
1920
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
1918
1921
|
*/
|
|
1919
1922
|
export interface BetaResponseCompactionItem {
|
|
1920
1923
|
/**
|
|
@@ -1951,7 +1954,7 @@ export declare namespace BetaResponseCompactionItem {
|
|
|
1951
1954
|
}
|
|
1952
1955
|
/**
|
|
1953
1956
|
* A compaction item generated by the
|
|
1954
|
-
* [`v1/responses/compact` API](https://
|
|
1957
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
1955
1958
|
*/
|
|
1956
1959
|
export interface BetaResponseCompactionItemParam {
|
|
1957
1960
|
/**
|
|
@@ -2016,7 +2019,7 @@ export declare namespace BetaResponseCompletedEvent {
|
|
|
2016
2019
|
}
|
|
2017
2020
|
/**
|
|
2018
2021
|
* A tool call to a computer use tool. See the
|
|
2019
|
-
* [computer use guide](https://
|
|
2022
|
+
* [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use)
|
|
2020
2023
|
* for more information.
|
|
2021
2024
|
*/
|
|
2022
2025
|
export interface BetaResponseComputerToolCall {
|
|
@@ -2894,7 +2897,7 @@ export declare namespace BetaResponseFileSearchCallSearchingEvent {
|
|
|
2894
2897
|
}
|
|
2895
2898
|
/**
|
|
2896
2899
|
* The results of a file search tool call. See the
|
|
2897
|
-
* [file search guide](https://
|
|
2900
|
+
* [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
2898
2901
|
* for more information.
|
|
2899
2902
|
*/
|
|
2900
2903
|
export interface BetaResponseFileSearchToolCall {
|
|
@@ -2968,7 +2971,7 @@ export declare namespace BetaResponseFileSearchToolCall {
|
|
|
2968
2971
|
*
|
|
2969
2972
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
2970
2973
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
2971
|
-
* [Structured Outputs guide](https://
|
|
2974
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
2972
2975
|
*
|
|
2973
2976
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
2974
2977
|
*
|
|
@@ -3004,7 +3007,7 @@ export declare namespace BetaResponseFormatTextConfig {
|
|
|
3004
3007
|
/**
|
|
3005
3008
|
* JSON Schema response format. Used to generate structured JSON responses. Learn
|
|
3006
3009
|
* more about
|
|
3007
|
-
* [Structured Outputs](https://
|
|
3010
|
+
* [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
3008
3011
|
*/
|
|
3009
3012
|
export interface BetaResponseFormatTextJSONSchemaConfig {
|
|
3010
3013
|
/**
|
|
@@ -3033,7 +3036,7 @@ export interface BetaResponseFormatTextJSONSchemaConfig {
|
|
|
3033
3036
|
* true, the model will always follow the exact schema defined in the `schema`
|
|
3034
3037
|
* field. Only a subset of JSON Schema is supported when `strict` is `true`. To
|
|
3035
3038
|
* learn more, read the
|
|
3036
|
-
* [Structured Outputs guide](https://
|
|
3039
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
3037
3040
|
*/
|
|
3038
3041
|
strict?: boolean | null;
|
|
3039
3042
|
}
|
|
@@ -3354,7 +3357,7 @@ export declare namespace BetaResponseFunctionShellToolCallOutput {
|
|
|
3354
3357
|
}
|
|
3355
3358
|
/**
|
|
3356
3359
|
* A tool call to run a function. See the
|
|
3357
|
-
* [function calling guide](https://
|
|
3360
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
3358
3361
|
* for more information.
|
|
3359
3362
|
*/
|
|
3360
3363
|
export interface BetaResponseFunctionToolCall {
|
|
@@ -3423,7 +3426,7 @@ export declare namespace BetaResponseFunctionToolCall {
|
|
|
3423
3426
|
}
|
|
3424
3427
|
/**
|
|
3425
3428
|
* A tool call to run a function. See the
|
|
3426
|
-
* [function calling guide](https://
|
|
3429
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
3427
3430
|
* for more information.
|
|
3428
3431
|
*/
|
|
3429
3432
|
export interface BetaResponseFunctionToolCallItem extends BetaResponseFunctionToolCall {
|
|
@@ -3514,8 +3517,8 @@ export declare namespace BetaResponseFunctionToolCallOutputItem {
|
|
|
3514
3517
|
}
|
|
3515
3518
|
/**
|
|
3516
3519
|
* The results of a web search tool call. See the
|
|
3517
|
-
* [web search guide](https://
|
|
3518
|
-
* more information.
|
|
3520
|
+
* [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
3521
|
+
* for more information.
|
|
3519
3522
|
*/
|
|
3520
3523
|
export interface BetaResponseFunctionWebSearch {
|
|
3521
3524
|
/**
|
|
@@ -4105,7 +4108,7 @@ export declare namespace BetaResponseInputFileContent {
|
|
|
4105
4108
|
}
|
|
4106
4109
|
/**
|
|
4107
4110
|
* An image input to the model. Learn about
|
|
4108
|
-
* [image inputs](https://
|
|
4111
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision).
|
|
4109
4112
|
*/
|
|
4110
4113
|
export interface BetaResponseInputImage {
|
|
4111
4114
|
/**
|
|
@@ -4148,7 +4151,7 @@ export declare namespace BetaResponseInputImage {
|
|
|
4148
4151
|
}
|
|
4149
4152
|
/**
|
|
4150
4153
|
* An image input to the model. Learn about
|
|
4151
|
-
* [image inputs](https://
|
|
4154
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
4152
4155
|
*/
|
|
4153
4156
|
export interface BetaResponseInputImageContent {
|
|
4154
4157
|
/**
|
|
@@ -7629,7 +7632,7 @@ export declare namespace BetaResponseOutputTextAnnotationAddedEvent {
|
|
|
7629
7632
|
}
|
|
7630
7633
|
/**
|
|
7631
7634
|
* Reference to a prompt template and its variables.
|
|
7632
|
-
* [Learn more](https://
|
|
7635
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
7633
7636
|
*/
|
|
7634
7637
|
export interface BetaResponsePrompt {
|
|
7635
7638
|
/**
|
|
@@ -7685,7 +7688,7 @@ export declare namespace BetaResponseQueuedEvent {
|
|
|
7685
7688
|
* A description of the chain of thought used by a reasoning model while generating
|
|
7686
7689
|
* a response. Be sure to include these items in your `input` to the Responses API
|
|
7687
7690
|
* for subsequent turns of a conversation if you are manually
|
|
7688
|
-
* [managing context](https://
|
|
7691
|
+
* [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
7689
7692
|
*/
|
|
7690
7693
|
export interface BetaResponseReasoningItem {
|
|
7691
7694
|
/**
|
|
@@ -8900,8 +8903,8 @@ export type BetaResponseStreamEvent = BetaResponseAudioDeltaEvent | BetaResponse
|
|
|
8900
8903
|
* Configuration options for a text response from the model. Can be plain text or
|
|
8901
8904
|
* structured JSON data. Learn more:
|
|
8902
8905
|
*
|
|
8903
|
-
* - [Text inputs and outputs](https://
|
|
8904
|
-
* - [Structured Outputs](https://
|
|
8906
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
8907
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
8905
8908
|
*/
|
|
8906
8909
|
export interface BetaResponseTextConfig {
|
|
8907
8910
|
/**
|
|
@@ -8909,7 +8912,7 @@ export interface BetaResponseTextConfig {
|
|
|
8909
8912
|
*
|
|
8910
8913
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
8911
8914
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
8912
|
-
* [Structured Outputs guide](https://
|
|
8915
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
8913
8916
|
*
|
|
8914
8917
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
8915
8918
|
*
|
|
@@ -9254,7 +9257,7 @@ export declare namespace BetaResponseUsage {
|
|
|
9254
9257
|
cache_write_tokens: number;
|
|
9255
9258
|
/**
|
|
9256
9259
|
* The number of tokens that were retrieved from the cache.
|
|
9257
|
-
* [More on prompt caching](https://
|
|
9260
|
+
* [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
9258
9261
|
*/
|
|
9259
9262
|
cached_tokens: number;
|
|
9260
9263
|
}
|
|
@@ -9399,7 +9402,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9399
9402
|
type: 'response.create';
|
|
9400
9403
|
/**
|
|
9401
9404
|
* Whether to run the model response in the background.
|
|
9402
|
-
* [Learn more](https://
|
|
9405
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
9403
9406
|
*/
|
|
9404
9407
|
background?: boolean | null;
|
|
9405
9408
|
/**
|
|
@@ -9439,11 +9442,11 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9439
9442
|
*
|
|
9440
9443
|
* Learn more:
|
|
9441
9444
|
*
|
|
9442
|
-
* - [Text inputs and outputs](https://
|
|
9443
|
-
* - [Image inputs](https://
|
|
9444
|
-
* - [File inputs](https://
|
|
9445
|
-
* - [Conversation state](https://
|
|
9446
|
-
* - [Function calling](https://
|
|
9445
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
9446
|
+
* - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
9447
|
+
* - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
9448
|
+
* - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
9449
|
+
* - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
9447
9450
|
*/
|
|
9448
9451
|
input?: string | ResponsesAPI.BetaResponseInput;
|
|
9449
9452
|
/**
|
|
@@ -9457,7 +9460,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9457
9460
|
/**
|
|
9458
9461
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
9459
9462
|
* including visible output tokens and
|
|
9460
|
-
* [reasoning tokens](https://
|
|
9463
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
9461
9464
|
*/
|
|
9462
9465
|
max_output_tokens?: number | null;
|
|
9463
9466
|
/**
|
|
@@ -9482,8 +9485,8 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9482
9485
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
9483
9486
|
* range of models with different capabilities, performance characteristics, and
|
|
9484
9487
|
* price points. Refer to the
|
|
9485
|
-
* [model guide](https://
|
|
9486
|
-
* available models.
|
|
9488
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
9489
|
+
* compare available models.
|
|
9487
9490
|
*/
|
|
9488
9491
|
model?: 'gpt-6-astra' | 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-5.5' | 'gpt-5.5-2026-04-23' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.4-mini-2026-03-17' | 'gpt-5.4-nano-2026-03-17' | 'gpt-5.3-chat-latest' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-codex' | 'gpt-5.1-mini' | 'gpt-5.1-chat-latest' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5-2025-08-07' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano-2025-04-14' | 'o4-mini' | 'o4-mini-2025-04-16' | 'o3' | 'o3-2025-04-16' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o1' | 'o1-2024-12-17' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o1-mini' | 'o1-mini-2024-09-12' | 'gpt-4o' | 'gpt-4o-2024-11-20' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-05-13' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-audio-preview-2025-06-03' | 'gpt-4o-mini-audio-preview' | 'gpt-4o-mini-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-mini-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview-2025-03-11' | 'chatgpt-4o-latest' | 'codex-mini-latest' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-0125-preview' | 'gpt-4-turbo-preview' | 'gpt-4-1106-preview' | 'gpt-4-vision-preview' | 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-16k-0613' | 'o1-pro' | 'o1-pro-2025-03-19' | 'o3-pro' | 'o3-pro-2025-06-10' | 'o3-deep-research' | 'o3-deep-research-2025-06-26' | 'o4-mini-deep-research' | 'o4-mini-deep-research-2025-06-26' | 'computer-use-preview' | 'computer-use-preview-2025-03-11' | 'gpt-5.5-pro' | 'gpt-5.5-pro-2026-04-23' | 'gpt-5-codex' | 'gpt-5-pro' | 'gpt-5-pro-2025-10-06' | 'gpt-5.1-codex-max' | 'gpt-daybreak-blue-latest' | 'gpt-daybreak-red-latest' | 'gpt-5.6-cyber' | (string & {});
|
|
9489
9492
|
/**
|
|
@@ -9501,19 +9504,19 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9501
9504
|
/**
|
|
9502
9505
|
* The unique ID of the previous response to the model. Use this to create
|
|
9503
9506
|
* multi-turn conversations. Learn more about
|
|
9504
|
-
* [conversation state](https://
|
|
9507
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
9505
9508
|
* Cannot be used in conjunction with `conversation`.
|
|
9506
9509
|
*/
|
|
9507
9510
|
previous_response_id?: string | null;
|
|
9508
9511
|
/**
|
|
9509
9512
|
* Reference to a prompt template and its variables.
|
|
9510
|
-
* [Learn more](https://
|
|
9513
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
9511
9514
|
*/
|
|
9512
9515
|
prompt?: ResponsesAPI.BetaResponsePrompt | null;
|
|
9513
9516
|
/**
|
|
9514
9517
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
9515
9518
|
* hit rates. Replaces the `user` field.
|
|
9516
|
-
* [Learn more](https://
|
|
9519
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
9517
9520
|
*/
|
|
9518
9521
|
prompt_cache_key?: string | null;
|
|
9519
9522
|
/**
|
|
@@ -9524,7 +9527,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9524
9527
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
9525
9528
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
9526
9529
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
9527
|
-
* [prompt caching guide](https://
|
|
9530
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
9528
9531
|
* for current details.
|
|
9529
9532
|
*/
|
|
9530
9533
|
prompt_cache_options?: ResponseCreate.PromptCacheOptions;
|
|
@@ -9534,7 +9537,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9534
9537
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
9535
9538
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
9536
9539
|
* of 24 hours.
|
|
9537
|
-
* [Learn more](https://
|
|
9540
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
9538
9541
|
* This field expresses a maximum retention policy, while
|
|
9539
9542
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
9540
9543
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -9550,7 +9553,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9550
9553
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
9551
9554
|
/**
|
|
9552
9555
|
* Configuration options for
|
|
9553
|
-
* [reasoning models](https://
|
|
9556
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
9554
9557
|
*/
|
|
9555
9558
|
reasoning?: ResponseCreate.Reasoning | null;
|
|
9556
9559
|
/**
|
|
@@ -9559,7 +9562,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9559
9562
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
9560
9563
|
* hashing their username or email address, in order to avoid sending us any
|
|
9561
9564
|
* identifying information.
|
|
9562
|
-
* [Learn more](https://
|
|
9565
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
9563
9566
|
*/
|
|
9564
9567
|
safety_identifier?: string | null;
|
|
9565
9568
|
/**
|
|
@@ -9570,13 +9573,15 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9570
9573
|
* will use 'default'.
|
|
9571
9574
|
* - If set to 'default', then the request will be processed with the standard
|
|
9572
9575
|
* pricing and performance for the selected model.
|
|
9573
|
-
* - If set to
|
|
9574
|
-
* then
|
|
9575
|
-
*
|
|
9576
|
-
*
|
|
9577
|
-
*
|
|
9578
|
-
*
|
|
9579
|
-
*
|
|
9576
|
+
* - If set to
|
|
9577
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
9578
|
+
* the request will be processed with the Flex Processing service tier.
|
|
9579
|
+
* - To opt-in to
|
|
9580
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
9581
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
9582
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
9583
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
9584
|
+
* `priority` in your request.
|
|
9580
9585
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
9581
9586
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
9582
9587
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -9593,7 +9598,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9593
9598
|
* Whether to store the generated model response for later retrieval via API.
|
|
9594
9599
|
* Defaults to true when omitted. If set to true, response data will be stored for
|
|
9595
9600
|
* at least 30 days, subject to the
|
|
9596
|
-
* [data retention exceptions](/api/docs/guides/your-data#v1responses).
|
|
9601
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
9597
9602
|
*/
|
|
9598
9603
|
store?: boolean | null;
|
|
9599
9604
|
/**
|
|
@@ -9601,7 +9606,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9601
9606
|
* generated using
|
|
9602
9607
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
9603
9608
|
* See the
|
|
9604
|
-
* [Streaming section below](https://
|
|
9609
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
9605
9610
|
* for more information.
|
|
9606
9611
|
*/
|
|
9607
9612
|
stream?: boolean | null;
|
|
@@ -9628,8 +9633,8 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9628
9633
|
* Configuration options for a text response from the model. Can be plain text or
|
|
9629
9634
|
* structured JSON data. Learn more:
|
|
9630
9635
|
*
|
|
9631
|
-
* - [Text inputs and outputs](https://
|
|
9632
|
-
* - [Structured Outputs](https://
|
|
9636
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
9637
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
9633
9638
|
*/
|
|
9634
9639
|
text?: ResponsesAPI.BetaResponseTextConfig;
|
|
9635
9640
|
/**
|
|
@@ -9646,17 +9651,18 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9646
9651
|
*
|
|
9647
9652
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
9648
9653
|
* capabilities, like
|
|
9649
|
-
* [web search](https://
|
|
9650
|
-
*
|
|
9654
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
9655
|
+
* or
|
|
9656
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
9651
9657
|
* Learn more about
|
|
9652
|
-
* [built-in tools](https://
|
|
9658
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
9653
9659
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
9654
9660
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
9655
|
-
* [MCP Tools](https://
|
|
9661
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
9656
9662
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
9657
9663
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
9658
9664
|
* Learn more about
|
|
9659
|
-
* [function calling](https://
|
|
9665
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
9660
9666
|
* You can also use custom tools to call your own code.
|
|
9661
9667
|
*/
|
|
9662
9668
|
tools?: Array<ResponsesAPI.BetaTool>;
|
|
@@ -9690,7 +9696,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9690
9696
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
9691
9697
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
9692
9698
|
* abuse.
|
|
9693
|
-
* [Learn more](https://
|
|
9699
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
9694
9700
|
*/
|
|
9695
9701
|
user?: string;
|
|
9696
9702
|
}
|
|
@@ -9774,7 +9780,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9774
9780
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
9775
9781
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
9776
9782
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
9777
|
-
* [prompt caching guide](https://
|
|
9783
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
9778
9784
|
* for current details.
|
|
9779
9785
|
*/
|
|
9780
9786
|
interface PromptCacheOptions {
|
|
@@ -9801,7 +9807,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9801
9807
|
}
|
|
9802
9808
|
/**
|
|
9803
9809
|
* Configuration options for
|
|
9804
|
-
* [reasoning models](https://
|
|
9810
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
9805
9811
|
*/
|
|
9806
9812
|
interface Reasoning {
|
|
9807
9813
|
/**
|
|
@@ -9818,7 +9824,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9818
9824
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
9819
9825
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
9820
9826
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
9821
|
-
* [reasoning guide](https://
|
|
9827
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
9822
9828
|
* model-specific support.
|
|
9823
9829
|
*/
|
|
9824
9830
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
|
|
@@ -10566,13 +10572,15 @@ export declare namespace BetaResponsesServerEvent {
|
|
|
10566
10572
|
* will use 'default'.
|
|
10567
10573
|
* - If set to 'default', then the request will be processed with the standard
|
|
10568
10574
|
* pricing and performance for the selected model.
|
|
10569
|
-
* - If set to
|
|
10570
|
-
* then
|
|
10571
|
-
*
|
|
10572
|
-
*
|
|
10573
|
-
*
|
|
10574
|
-
*
|
|
10575
|
-
*
|
|
10575
|
+
* - If set to
|
|
10576
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
10577
|
+
* the request will be processed with the Flex Processing service tier.
|
|
10578
|
+
* - To opt-in to
|
|
10579
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
10580
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
10581
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
10582
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
10583
|
+
* `priority` in your request.
|
|
10576
10584
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
10577
10585
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
10578
10586
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -10607,7 +10615,7 @@ export declare namespace BetaTool {
|
|
|
10607
10615
|
/**
|
|
10608
10616
|
* Give the model access to additional tools via remote Model Context Protocol
|
|
10609
10617
|
* (MCP) servers.
|
|
10610
|
-
* [Learn more about MCP](https://
|
|
10618
|
+
* [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
10611
10619
|
*/
|
|
10612
10620
|
interface Mcp {
|
|
10613
10621
|
/**
|
|
@@ -10636,7 +10644,7 @@ export declare namespace BetaTool {
|
|
|
10636
10644
|
* Identifier for service connectors, like those available in ChatGPT. One of
|
|
10637
10645
|
* `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
|
|
10638
10646
|
* service connectors
|
|
10639
|
-
* [here](https://
|
|
10647
|
+
* [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
|
|
10640
10648
|
*
|
|
10641
10649
|
* Currently supported `connector_id` values are:
|
|
10642
10650
|
*
|
|
@@ -11015,12 +11023,12 @@ export interface BetaToolChoiceShell {
|
|
|
11015
11023
|
}
|
|
11016
11024
|
/**
|
|
11017
11025
|
* Indicates that the model should use a built-in tool to generate a response.
|
|
11018
|
-
* [Learn more about built-in tools](https://
|
|
11026
|
+
* [Learn more about built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
11019
11027
|
*/
|
|
11020
11028
|
export interface BetaToolChoiceTypes {
|
|
11021
11029
|
/**
|
|
11022
11030
|
* The type of hosted tool the model should to use. Learn more about
|
|
11023
|
-
* [built-in tools](https://
|
|
11031
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
11024
11032
|
*
|
|
11025
11033
|
* Allowed values are:
|
|
11026
11034
|
*
|
|
@@ -11058,7 +11066,7 @@ export interface BetaToolSearchTool {
|
|
|
11058
11066
|
/**
|
|
11059
11067
|
* This tool searches the web for relevant results to use in a response. Learn more
|
|
11060
11068
|
* about the
|
|
11061
|
-
* [web search tool](https://
|
|
11069
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
11062
11070
|
*/
|
|
11063
11071
|
export interface BetaWebSearchPreviewTool {
|
|
11064
11072
|
/**
|
|
@@ -11108,7 +11116,7 @@ export declare namespace BetaWebSearchPreviewTool {
|
|
|
11108
11116
|
}
|
|
11109
11117
|
/**
|
|
11110
11118
|
* Search the Internet for sources related to the prompt. Learn more about the
|
|
11111
|
-
* [web search tool](https://
|
|
11119
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
11112
11120
|
*/
|
|
11113
11121
|
export interface BetaWebSearchTool {
|
|
11114
11122
|
/**
|
|
@@ -11180,7 +11188,7 @@ export type ResponseCreateParams = ResponseCreateParamsNonStreaming | ResponseCr
|
|
|
11180
11188
|
export interface ResponseCreateParamsBase {
|
|
11181
11189
|
/**
|
|
11182
11190
|
* Body param: Whether to run the model response in the background.
|
|
11183
|
-
* [Learn more](https://
|
|
11191
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
11184
11192
|
*/
|
|
11185
11193
|
background?: boolean | null;
|
|
11186
11194
|
/**
|
|
@@ -11221,11 +11229,11 @@ export interface ResponseCreateParamsBase {
|
|
|
11221
11229
|
*
|
|
11222
11230
|
* Learn more:
|
|
11223
11231
|
*
|
|
11224
|
-
* - [Text inputs and outputs](https://
|
|
11225
|
-
* - [Image inputs](https://
|
|
11226
|
-
* - [File inputs](https://
|
|
11227
|
-
* - [Conversation state](https://
|
|
11228
|
-
* - [Function calling](https://
|
|
11232
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
11233
|
+
* - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
11234
|
+
* - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
11235
|
+
* - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
11236
|
+
* - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
11229
11237
|
*/
|
|
11230
11238
|
input?: string | BetaResponseInput;
|
|
11231
11239
|
/**
|
|
@@ -11239,7 +11247,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11239
11247
|
/**
|
|
11240
11248
|
* Body param: An upper bound for the number of tokens that can be generated for a
|
|
11241
11249
|
* response, including visible output tokens and
|
|
11242
|
-
* [reasoning tokens](https://
|
|
11250
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
11243
11251
|
*/
|
|
11244
11252
|
max_output_tokens?: number | null;
|
|
11245
11253
|
/**
|
|
@@ -11264,8 +11272,8 @@ export interface ResponseCreateParamsBase {
|
|
|
11264
11272
|
* Body param: Model ID used to generate the response, like `gpt-6-astra`. OpenAI
|
|
11265
11273
|
* offers a wide range of models with different capabilities, performance
|
|
11266
11274
|
* characteristics, and price points. Refer to the
|
|
11267
|
-
* [model guide](https://
|
|
11268
|
-
* available models.
|
|
11275
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
11276
|
+
* compare available models.
|
|
11269
11277
|
*/
|
|
11270
11278
|
model?: 'gpt-6-astra' | 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-5.5' | 'gpt-5.5-2026-04-23' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.4-mini-2026-03-17' | 'gpt-5.4-nano-2026-03-17' | 'gpt-5.3-chat-latest' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-codex' | 'gpt-5.1-mini' | 'gpt-5.1-chat-latest' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5-2025-08-07' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano-2025-04-14' | 'o4-mini' | 'o4-mini-2025-04-16' | 'o3' | 'o3-2025-04-16' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o1' | 'o1-2024-12-17' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o1-mini' | 'o1-mini-2024-09-12' | 'gpt-4o' | 'gpt-4o-2024-11-20' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-05-13' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-audio-preview-2025-06-03' | 'gpt-4o-mini-audio-preview' | 'gpt-4o-mini-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-mini-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview-2025-03-11' | 'chatgpt-4o-latest' | 'codex-mini-latest' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-0125-preview' | 'gpt-4-turbo-preview' | 'gpt-4-1106-preview' | 'gpt-4-vision-preview' | 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-16k-0613' | 'o1-pro' | 'o1-pro-2025-03-19' | 'o3-pro' | 'o3-pro-2025-06-10' | 'o3-deep-research' | 'o3-deep-research-2025-06-26' | 'o4-mini-deep-research' | 'o4-mini-deep-research-2025-06-26' | 'computer-use-preview' | 'computer-use-preview-2025-03-11' | 'gpt-5.5-pro' | 'gpt-5.5-pro-2026-04-23' | 'gpt-5-codex' | 'gpt-5-pro' | 'gpt-5-pro-2025-10-06' | 'gpt-5.1-codex-max' | 'gpt-daybreak-blue-latest' | 'gpt-daybreak-red-latest' | 'gpt-5.6-cyber' | (string & {});
|
|
11271
11279
|
/**
|
|
@@ -11284,19 +11292,19 @@ export interface ResponseCreateParamsBase {
|
|
|
11284
11292
|
/**
|
|
11285
11293
|
* Body param: The unique ID of the previous response to the model. Use this to
|
|
11286
11294
|
* create multi-turn conversations. Learn more about
|
|
11287
|
-
* [conversation state](https://
|
|
11295
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
11288
11296
|
* Cannot be used in conjunction with `conversation`.
|
|
11289
11297
|
*/
|
|
11290
11298
|
previous_response_id?: string | null;
|
|
11291
11299
|
/**
|
|
11292
11300
|
* Body param: Reference to a prompt template and its variables.
|
|
11293
|
-
* [Learn more](https://
|
|
11301
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
11294
11302
|
*/
|
|
11295
11303
|
prompt?: BetaResponsePrompt | null;
|
|
11296
11304
|
/**
|
|
11297
11305
|
* Body param: Used by OpenAI to cache responses for similar requests to optimize
|
|
11298
11306
|
* your cache hit rates. Replaces the `user` field.
|
|
11299
|
-
* [Learn more](https://
|
|
11307
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
11300
11308
|
*/
|
|
11301
11309
|
prompt_cache_key?: string | null;
|
|
11302
11310
|
/**
|
|
@@ -11308,7 +11316,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11308
11316
|
* conversation, without a content-block lookback limit. Set `mode` to `explicit`
|
|
11309
11317
|
* to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is
|
|
11310
11318
|
* currently the only supported value. See the
|
|
11311
|
-
* [prompt caching guide](https://
|
|
11319
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11312
11320
|
* for current details.
|
|
11313
11321
|
*/
|
|
11314
11322
|
prompt_cache_options?: ResponseCreateParams.PromptCacheOptions;
|
|
@@ -11318,7 +11326,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11318
11326
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
11319
11327
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
11320
11328
|
* of 24 hours.
|
|
11321
|
-
* [Learn more](https://
|
|
11329
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
11322
11330
|
* This field expresses a maximum retention policy, while
|
|
11323
11331
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
11324
11332
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -11334,7 +11342,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11334
11342
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
11335
11343
|
/**
|
|
11336
11344
|
* Body param: Configuration options for
|
|
11337
|
-
* [reasoning models](https://
|
|
11345
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
11338
11346
|
*/
|
|
11339
11347
|
reasoning?: ResponseCreateParams.Reasoning | null;
|
|
11340
11348
|
/**
|
|
@@ -11343,7 +11351,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11343
11351
|
* uniquely identifies each user, with a maximum length of 64 characters. We
|
|
11344
11352
|
* recommend hashing their username or email address, in order to avoid sending us
|
|
11345
11353
|
* any identifying information.
|
|
11346
|
-
* [Learn more](https://
|
|
11354
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
11347
11355
|
*/
|
|
11348
11356
|
safety_identifier?: string | null;
|
|
11349
11357
|
/**
|
|
@@ -11354,13 +11362,15 @@ export interface ResponseCreateParamsBase {
|
|
|
11354
11362
|
* will use 'default'.
|
|
11355
11363
|
* - If set to 'default', then the request will be processed with the standard
|
|
11356
11364
|
* pricing and performance for the selected model.
|
|
11357
|
-
* - If set to
|
|
11358
|
-
* then
|
|
11359
|
-
*
|
|
11360
|
-
*
|
|
11361
|
-
*
|
|
11362
|
-
*
|
|
11363
|
-
*
|
|
11365
|
+
* - If set to
|
|
11366
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
11367
|
+
* the request will be processed with the Flex Processing service tier.
|
|
11368
|
+
* - To opt-in to
|
|
11369
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
11370
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
11371
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
11372
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
11373
|
+
* `priority` in your request.
|
|
11364
11374
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
11365
11375
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
11366
11376
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -11377,7 +11387,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11377
11387
|
* Body param: Whether to store the generated model response for later retrieval
|
|
11378
11388
|
* via API. Defaults to true when omitted. If set to true, response data will be
|
|
11379
11389
|
* stored for at least 30 days, subject to the
|
|
11380
|
-
* [data retention exceptions](/api/docs/guides/your-data#v1responses).
|
|
11390
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
11381
11391
|
*/
|
|
11382
11392
|
store?: boolean | null;
|
|
11383
11393
|
/**
|
|
@@ -11385,7 +11395,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11385
11395
|
* client as it is generated using
|
|
11386
11396
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11387
11397
|
* See the
|
|
11388
|
-
* [Streaming section below](https://
|
|
11398
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11389
11399
|
* for more information.
|
|
11390
11400
|
*/
|
|
11391
11401
|
stream?: boolean | null;
|
|
@@ -11405,8 +11415,8 @@ export interface ResponseCreateParamsBase {
|
|
|
11405
11415
|
* Body param: Configuration options for a text response from the model. Can be
|
|
11406
11416
|
* plain text or structured JSON data. Learn more:
|
|
11407
11417
|
*
|
|
11408
|
-
* - [Text inputs and outputs](https://
|
|
11409
|
-
* - [Structured Outputs](https://
|
|
11418
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
11419
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
11410
11420
|
*/
|
|
11411
11421
|
text?: BetaResponseTextConfig;
|
|
11412
11422
|
/**
|
|
@@ -11423,17 +11433,18 @@ export interface ResponseCreateParamsBase {
|
|
|
11423
11433
|
*
|
|
11424
11434
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
11425
11435
|
* capabilities, like
|
|
11426
|
-
* [web search](https://
|
|
11427
|
-
*
|
|
11436
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
11437
|
+
* or
|
|
11438
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
11428
11439
|
* Learn more about
|
|
11429
|
-
* [built-in tools](https://
|
|
11440
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
11430
11441
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
11431
11442
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
11432
|
-
* [MCP Tools](https://
|
|
11443
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
11433
11444
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
11434
11445
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
11435
11446
|
* Learn more about
|
|
11436
|
-
* [function calling](https://
|
|
11447
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
11437
11448
|
* You can also use custom tools to call your own code.
|
|
11438
11449
|
*/
|
|
11439
11450
|
tools?: Array<BetaTool>;
|
|
@@ -11469,7 +11480,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11469
11480
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
11470
11481
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
11471
11482
|
* abuse.
|
|
11472
|
-
* [Learn more](https://
|
|
11483
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
11473
11484
|
*/
|
|
11474
11485
|
user?: string;
|
|
11475
11486
|
/**
|
|
@@ -11557,7 +11568,7 @@ export declare namespace ResponseCreateParams {
|
|
|
11557
11568
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
11558
11569
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
11559
11570
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
11560
|
-
* [prompt caching guide](https://
|
|
11571
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11561
11572
|
* for current details.
|
|
11562
11573
|
*/
|
|
11563
11574
|
interface PromptCacheOptions {
|
|
@@ -11584,7 +11595,7 @@ export declare namespace ResponseCreateParams {
|
|
|
11584
11595
|
}
|
|
11585
11596
|
/**
|
|
11586
11597
|
* Configuration options for
|
|
11587
|
-
* [reasoning models](https://
|
|
11598
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
11588
11599
|
*/
|
|
11589
11600
|
interface Reasoning {
|
|
11590
11601
|
/**
|
|
@@ -11601,7 +11612,7 @@ export declare namespace ResponseCreateParams {
|
|
|
11601
11612
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
11602
11613
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
11603
11614
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
11604
|
-
* [reasoning guide](https://
|
|
11615
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
11605
11616
|
* model-specific support.
|
|
11606
11617
|
*/
|
|
11607
11618
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
|
|
@@ -11658,7 +11669,7 @@ export interface ResponseCreateParamsNonStreaming extends ResponseCreateParamsBa
|
|
|
11658
11669
|
* client as it is generated using
|
|
11659
11670
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11660
11671
|
* See the
|
|
11661
|
-
* [Streaming section below](https://
|
|
11672
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11662
11673
|
* for more information.
|
|
11663
11674
|
*/
|
|
11664
11675
|
stream?: false | null;
|
|
@@ -11669,7 +11680,7 @@ export interface ResponseCreateParamsStreaming extends ResponseCreateParamsBase
|
|
|
11669
11680
|
* client as it is generated using
|
|
11670
11681
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11671
11682
|
* See the
|
|
11672
|
-
* [Streaming section below](https://
|
|
11683
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11673
11684
|
* for more information.
|
|
11674
11685
|
*/
|
|
11675
11686
|
stream: true;
|
|
@@ -11700,7 +11711,7 @@ export interface ResponseRetrieveParamsBase {
|
|
|
11700
11711
|
* client as it is generated using
|
|
11701
11712
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11702
11713
|
* See the
|
|
11703
|
-
* [Streaming section below](https://
|
|
11714
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11704
11715
|
* for more information.
|
|
11705
11716
|
*/
|
|
11706
11717
|
stream?: boolean;
|
|
@@ -11719,7 +11730,7 @@ export interface ResponseRetrieveParamsNonStreaming extends ResponseRetrievePara
|
|
|
11719
11730
|
* client as it is generated using
|
|
11720
11731
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11721
11732
|
* See the
|
|
11722
|
-
* [Streaming section below](https://
|
|
11733
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11723
11734
|
* for more information.
|
|
11724
11735
|
*/
|
|
11725
11736
|
stream?: false;
|
|
@@ -11730,7 +11741,7 @@ export interface ResponseRetrieveParamsStreaming extends ResponseRetrieveParamsB
|
|
|
11730
11741
|
* client as it is generated using
|
|
11731
11742
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11732
11743
|
* See the
|
|
11733
|
-
* [Streaming section below](https://
|
|
11744
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11734
11745
|
* for more information.
|
|
11735
11746
|
*/
|
|
11736
11747
|
stream: true;
|
|
@@ -11752,8 +11763,8 @@ export interface ResponseCompactParams {
|
|
|
11752
11763
|
* Body param: Model ID used to generate the response, like `gpt-6-astra`. OpenAI
|
|
11753
11764
|
* offers a wide range of models with different capabilities, performance
|
|
11754
11765
|
* characteristics, and price points. Refer to the
|
|
11755
|
-
* [model guide](https://
|
|
11756
|
-
* available models.
|
|
11766
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
11767
|
+
* compare available models.
|
|
11757
11768
|
*/
|
|
11758
11769
|
model: 'gpt-6-astra' | 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-5.5' | 'gpt-5.5-2026-04-23' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.4-mini-2026-03-17' | 'gpt-5.4-nano-2026-03-17' | 'gpt-5.3-chat-latest' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-codex' | 'gpt-5.1-mini' | 'gpt-5.1-chat-latest' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5-2025-08-07' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano-2025-04-14' | 'o4-mini' | 'o4-mini-2025-04-16' | 'o3' | 'o3-2025-04-16' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o1' | 'o1-2024-12-17' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o1-mini' | 'o1-mini-2024-09-12' | 'gpt-4o' | 'gpt-4o-2024-11-20' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-05-13' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-audio-preview-2025-06-03' | 'gpt-4o-mini-audio-preview' | 'gpt-4o-mini-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-mini-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview-2025-03-11' | 'chatgpt-4o-latest' | 'codex-mini-latest' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-0125-preview' | 'gpt-4-turbo-preview' | 'gpt-4-1106-preview' | 'gpt-4-vision-preview' | 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-16k-0613' | 'o1-pro' | 'o1-pro-2025-03-19' | 'o3-pro' | 'o3-pro-2025-06-10' | 'o3-deep-research' | 'o3-deep-research-2025-06-26' | 'o4-mini-deep-research' | 'o4-mini-deep-research-2025-06-26' | 'computer-use-preview' | 'computer-use-preview-2025-03-11' | 'gpt-5.5-pro' | 'gpt-5.5-pro-2026-04-23' | 'gpt-5-codex' | 'gpt-5-pro' | 'gpt-5-pro-2025-10-06' | 'gpt-5.1-codex-max' | 'gpt-daybreak-blue-latest' | 'gpt-daybreak-red-latest' | 'gpt-5.6-cyber' | (string & {}) | null;
|
|
11759
11770
|
/**
|
|
@@ -11771,7 +11782,7 @@ export interface ResponseCompactParams {
|
|
|
11771
11782
|
/**
|
|
11772
11783
|
* Body param: The unique ID of the previous response to the model. Use this to
|
|
11773
11784
|
* create multi-turn conversations. Learn more about
|
|
11774
|
-
* [conversation state](https://
|
|
11785
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
11775
11786
|
* Cannot be used in conjunction with `conversation`.
|
|
11776
11787
|
*/
|
|
11777
11788
|
previous_response_id?: string | null;
|
|
@@ -11788,7 +11799,7 @@ export interface ResponseCompactParams {
|
|
|
11788
11799
|
* conversation, without a content-block lookback limit. Set `mode` to `explicit`
|
|
11789
11800
|
* to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is
|
|
11790
11801
|
* currently the only supported value. See the
|
|
11791
|
-
* [prompt caching guide](https://
|
|
11802
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11792
11803
|
* for current details.
|
|
11793
11804
|
*/
|
|
11794
11805
|
prompt_cache_options?: ResponseCompactParams.PromptCacheOptions | null;
|
|
@@ -11803,17 +11814,17 @@ export interface ResponseCompactParams {
|
|
|
11803
11814
|
* in the Project settings. Unless otherwise configured, the Project will use
|
|
11804
11815
|
* 'default'. - If set to 'default', then the request will be processed with the
|
|
11805
11816
|
* standard pricing and performance for the selected model. - If set to
|
|
11806
|
-
* '[flex](https://
|
|
11807
|
-
* request will be processed with the Flex Processing service tier. - To opt-in
|
|
11808
|
-
* [Fast mode](/api/docs/guides/fast-mode) at the
|
|
11809
|
-
* `service_tier=fast` or `service_tier=priority`
|
|
11810
|
-
* Completions. For models with a dedicated Fast
|
|
11811
|
-
* `service_tier=fast`; for other models, either
|
|
11812
|
-
* `service_tier=priority`. - When not set, the default behavior
|
|
11813
|
-
* the `service_tier` parameter is set, the response body will
|
|
11814
|
-
* `service_tier` value based on the processing mode actually used to
|
|
11815
|
-
* request. This response value may be different from the value set in
|
|
11816
|
-
* parameter.
|
|
11817
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
11818
|
+
* the request will be processed with the Flex Processing service tier. - To opt-in
|
|
11819
|
+
* to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
11820
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
11821
|
+
* parameter for Responses or Chat Completions. For models with a dedicated Fast
|
|
11822
|
+
* tier, either value resolves to `service_tier=fast`; for other models, either
|
|
11823
|
+
* value resolves to `service_tier=priority`. - When not set, the default behavior
|
|
11824
|
+
* is 'auto'. When the `service_tier` parameter is set, the response body will
|
|
11825
|
+
* include the `service_tier` value based on the processing mode actually used to
|
|
11826
|
+
* serve the request. This response value may be different from the value set in
|
|
11827
|
+
* the parameter.
|
|
11817
11828
|
*/
|
|
11818
11829
|
service_tier?: 'auto' | 'default' | 'fast' | 'flex' | 'priority' | null;
|
|
11819
11830
|
/**
|
|
@@ -11830,7 +11841,7 @@ export declare namespace ResponseCompactParams {
|
|
|
11830
11841
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
11831
11842
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
11832
11843
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
11833
|
-
* [prompt caching guide](https://
|
|
11844
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11834
11845
|
* for current details.
|
|
11835
11846
|
*/
|
|
11836
11847
|
interface PromptCacheOptions {
|