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
|
@@ -32,16 +32,16 @@ export declare class Responses extends APIResource {
|
|
|
32
32
|
inputTokens: InputTokensAPI.InputTokens;
|
|
33
33
|
/**
|
|
34
34
|
* Creates a model response. Provide
|
|
35
|
-
* [text](https://
|
|
36
|
-
* [image](https://
|
|
37
|
-
* [text](https://
|
|
38
|
-
* [JSON](https://
|
|
39
|
-
* the model call your own
|
|
40
|
-
* [custom code](https://
|
|
41
|
-
* built-in [tools](https://
|
|
42
|
-
* [web search](https://
|
|
43
|
-
* [file search](https://
|
|
44
|
-
* your own data as input for the model's response.
|
|
35
|
+
* [text](https://developers.openai.com/api/docs/guides/text) or
|
|
36
|
+
* [image](https://developers.openai.com/api/docs/guides/images-vision) inputs to
|
|
37
|
+
* generate [text](https://developers.openai.com/api/docs/guides/text) or
|
|
38
|
+
* [JSON](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
39
|
+
* outputs. Have the model call your own
|
|
40
|
+
* [custom code](https://developers.openai.com/api/docs/guides/function-calling) or
|
|
41
|
+
* use built-in [tools](https://developers.openai.com/api/docs/guides/tools) like
|
|
42
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search) or
|
|
43
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
44
|
+
* to use your own data as input for the model's response.
|
|
45
45
|
*
|
|
46
46
|
* @example
|
|
47
47
|
* ```ts
|
|
@@ -83,7 +83,7 @@ export declare class Responses extends APIResource {
|
|
|
83
83
|
/**
|
|
84
84
|
* Cancels a model response with the given ID. Only responses created with the
|
|
85
85
|
* `background` parameter set to `true` can be cancelled.
|
|
86
|
-
* [Learn more](https://
|
|
86
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
87
87
|
*
|
|
88
88
|
* @example
|
|
89
89
|
* ```ts
|
|
@@ -97,9 +97,9 @@ export declare class Responses extends APIResource {
|
|
|
97
97
|
* Compact a conversation. Returns a compacted response object.
|
|
98
98
|
*
|
|
99
99
|
* Learn when and how to compact long-running conversations in the
|
|
100
|
-
* [conversation state guide](https://
|
|
100
|
+
* [conversation state guide](https://developers.openai.com/api/docs/guides/conversation-state#managing-the-context-window).
|
|
101
101
|
* For ZDR-compatible compaction details, see
|
|
102
|
-
* [Compaction (advanced)](https://
|
|
102
|
+
* [Compaction (advanced)](https://developers.openai.com/api/docs/guides/conversation-state#compaction-advanced).
|
|
103
103
|
*
|
|
104
104
|
* @example
|
|
105
105
|
* ```ts
|
|
@@ -351,7 +351,7 @@ export declare namespace ComputerAction {
|
|
|
351
351
|
export type ComputerActionList = Array<ComputerAction>;
|
|
352
352
|
/**
|
|
353
353
|
* A tool that controls a virtual computer. Learn more about the
|
|
354
|
-
* [computer tool](https://
|
|
354
|
+
* [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).
|
|
355
355
|
*/
|
|
356
356
|
export interface ComputerTool {
|
|
357
357
|
/**
|
|
@@ -361,7 +361,7 @@ export interface ComputerTool {
|
|
|
361
361
|
}
|
|
362
362
|
/**
|
|
363
363
|
* A tool that controls a virtual computer. Learn more about the
|
|
364
|
-
* [computer tool](https://
|
|
364
|
+
* [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).
|
|
365
365
|
*/
|
|
366
366
|
export interface ComputerUsePreviewTool {
|
|
367
367
|
/**
|
|
@@ -449,7 +449,7 @@ export interface ContainerReference {
|
|
|
449
449
|
}
|
|
450
450
|
/**
|
|
451
451
|
* A custom tool that processes input using a specified format. Learn more about
|
|
452
|
-
* [custom tools](https://
|
|
452
|
+
* [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools)
|
|
453
453
|
*/
|
|
454
454
|
export interface CustomTool {
|
|
455
455
|
/**
|
|
@@ -515,7 +515,7 @@ export interface EasyInputMessage {
|
|
|
515
515
|
/**
|
|
516
516
|
* A tool that searches for relevant content from uploaded files. Learn more about
|
|
517
517
|
* the
|
|
518
|
-
* [file search tool](https://
|
|
518
|
+
* [file search tool](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
519
519
|
*/
|
|
520
520
|
export interface FileSearchTool {
|
|
521
521
|
/**
|
|
@@ -595,7 +595,7 @@ export interface FunctionShellTool {
|
|
|
595
595
|
/**
|
|
596
596
|
* Defines a function in your own code the model can choose to call. Learn more
|
|
597
597
|
* about
|
|
598
|
-
* [function calling](https://
|
|
598
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
599
599
|
*/
|
|
600
600
|
export interface FunctionTool {
|
|
601
601
|
/**
|
|
@@ -809,8 +809,8 @@ export interface Response {
|
|
|
809
809
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
810
810
|
* range of models with different capabilities, performance characteristics, and
|
|
811
811
|
* price points. Refer to the
|
|
812
|
-
* [model guide](https://
|
|
813
|
-
* available models.
|
|
812
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
813
|
+
* compare available models.
|
|
814
814
|
*/
|
|
815
815
|
model: Shared.ResponsesModel;
|
|
816
816
|
/**
|
|
@@ -852,17 +852,18 @@ export interface Response {
|
|
|
852
852
|
*
|
|
853
853
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
854
854
|
* capabilities, like
|
|
855
|
-
* [web search](https://
|
|
856
|
-
*
|
|
855
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
856
|
+
* or
|
|
857
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
857
858
|
* Learn more about
|
|
858
|
-
* [built-in tools](https://
|
|
859
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
859
860
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
860
861
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
861
|
-
* [MCP Tools](https://
|
|
862
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
862
863
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
863
864
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
864
865
|
* Learn more about
|
|
865
|
-
* [function calling](https://
|
|
866
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
866
867
|
* You can also use custom tools to call your own code.
|
|
867
868
|
*/
|
|
868
869
|
tools: Array<Tool>;
|
|
@@ -876,7 +877,7 @@ export interface Response {
|
|
|
876
877
|
top_p: number | null;
|
|
877
878
|
/**
|
|
878
879
|
* Whether to run the model response in the background.
|
|
879
|
-
* [Learn more](https://
|
|
880
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
880
881
|
*/
|
|
881
882
|
background?: boolean | null;
|
|
882
883
|
/**
|
|
@@ -892,7 +893,7 @@ export interface Response {
|
|
|
892
893
|
/**
|
|
893
894
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
894
895
|
* including visible output tokens and
|
|
895
|
-
* [reasoning tokens](https://
|
|
896
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
896
897
|
*/
|
|
897
898
|
max_output_tokens?: number | null;
|
|
898
899
|
/**
|
|
@@ -903,13 +904,13 @@ export interface Response {
|
|
|
903
904
|
/**
|
|
904
905
|
* The unique ID of the previous response to the model. Use this to create
|
|
905
906
|
* multi-turn conversations. Learn more about
|
|
906
|
-
* [conversation state](https://
|
|
907
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
907
908
|
* Cannot be used in conjunction with `conversation`.
|
|
908
909
|
*/
|
|
909
910
|
previous_response_id?: string | null;
|
|
910
911
|
/**
|
|
911
912
|
* Reference to a prompt template and its variables.
|
|
912
|
-
* [Learn more](https://
|
|
913
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
913
914
|
*/
|
|
914
915
|
prompt?: ResponsePrompt | null;
|
|
915
916
|
/**
|
|
@@ -919,7 +920,7 @@ export interface Response {
|
|
|
919
920
|
/**
|
|
920
921
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
921
922
|
* hit rates. Replaces the `user` field.
|
|
922
|
-
* [Learn more](https://
|
|
923
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
923
924
|
*/
|
|
924
925
|
prompt_cache_key?: string | null;
|
|
925
926
|
/**
|
|
@@ -933,7 +934,7 @@ export interface Response {
|
|
|
933
934
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
934
935
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
935
936
|
* of 24 hours.
|
|
936
|
-
* [Learn more](https://
|
|
937
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
937
938
|
* This field expresses a maximum retention policy, while
|
|
938
939
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
939
940
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -949,7 +950,7 @@ export interface Response {
|
|
|
949
950
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
950
951
|
/**
|
|
951
952
|
* Configuration options for
|
|
952
|
-
* [reasoning models](https://
|
|
953
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
953
954
|
*/
|
|
954
955
|
reasoning?: Shared.Reasoning | null;
|
|
955
956
|
/**
|
|
@@ -958,7 +959,7 @@ export interface Response {
|
|
|
958
959
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
959
960
|
* hashing their username or email address, in order to avoid sending us any
|
|
960
961
|
* identifying information.
|
|
961
|
-
* [Learn more](https://
|
|
962
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
962
963
|
*/
|
|
963
964
|
safety_identifier?: string | null;
|
|
964
965
|
/**
|
|
@@ -970,13 +971,15 @@ export interface Response {
|
|
|
970
971
|
* will use 'default'.
|
|
971
972
|
* - If set to 'default', then the request will be processed with the standard
|
|
972
973
|
* pricing and performance for the selected model.
|
|
973
|
-
* - If set to
|
|
974
|
-
* then
|
|
975
|
-
*
|
|
976
|
-
*
|
|
977
|
-
*
|
|
978
|
-
*
|
|
979
|
-
*
|
|
974
|
+
* - If set to
|
|
975
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
976
|
+
* the request will be processed with the Flex Processing service tier.
|
|
977
|
+
* - To opt-in to
|
|
978
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
979
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
980
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
981
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
982
|
+
* `priority` in your request.
|
|
980
983
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
981
984
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
982
985
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -996,8 +999,8 @@ export interface Response {
|
|
|
996
999
|
* Configuration options for a text response from the model. Can be plain text or
|
|
997
1000
|
* structured JSON data. Learn more:
|
|
998
1001
|
*
|
|
999
|
-
* - [Text inputs and outputs](https://
|
|
1000
|
-
* - [Structured Outputs](https://
|
|
1002
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
1003
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
1001
1004
|
*/
|
|
1002
1005
|
text?: ResponseTextConfig;
|
|
1003
1006
|
/**
|
|
@@ -1027,7 +1030,7 @@ export interface Response {
|
|
|
1027
1030
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
1028
1031
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
1029
1032
|
* abuse.
|
|
1030
|
-
* [Learn more](https://
|
|
1033
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
1031
1034
|
*/
|
|
1032
1035
|
user?: string;
|
|
1033
1036
|
}
|
|
@@ -1605,7 +1608,7 @@ export declare namespace ResponseCodeInterpreterToolCall {
|
|
|
1605
1608
|
}
|
|
1606
1609
|
/**
|
|
1607
1610
|
* A compaction item generated by the
|
|
1608
|
-
* [`v1/responses/compact` API](https://
|
|
1611
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
1609
1612
|
*/
|
|
1610
1613
|
export interface ResponseCompactionItem {
|
|
1611
1614
|
/**
|
|
@@ -1627,7 +1630,7 @@ export interface ResponseCompactionItem {
|
|
|
1627
1630
|
}
|
|
1628
1631
|
/**
|
|
1629
1632
|
* A compaction item generated by the
|
|
1630
|
-
* [`v1/responses/compact` API](https://
|
|
1633
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
1631
1634
|
*/
|
|
1632
1635
|
export interface ResponseCompactionItemParam {
|
|
1633
1636
|
/**
|
|
@@ -1662,7 +1665,7 @@ export interface ResponseCompletedEvent {
|
|
|
1662
1665
|
}
|
|
1663
1666
|
/**
|
|
1664
1667
|
* A tool call to a computer use tool. See the
|
|
1665
|
-
* [computer use guide](https://
|
|
1668
|
+
* [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use)
|
|
1666
1669
|
* for more information.
|
|
1667
1670
|
*/
|
|
1668
1671
|
export interface ResponseComputerToolCall {
|
|
@@ -2506,7 +2509,7 @@ export interface ResponseFileSearchCallSearchingEvent {
|
|
|
2506
2509
|
}
|
|
2507
2510
|
/**
|
|
2508
2511
|
* The results of a file search tool call. See the
|
|
2509
|
-
* [file search guide](https://
|
|
2512
|
+
* [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
2510
2513
|
* for more information.
|
|
2511
2514
|
*/
|
|
2512
2515
|
export interface ResponseFileSearchToolCall {
|
|
@@ -2567,7 +2570,7 @@ export declare namespace ResponseFileSearchToolCall {
|
|
|
2567
2570
|
*
|
|
2568
2571
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
2569
2572
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
2570
|
-
* [Structured Outputs guide](https://
|
|
2573
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
2571
2574
|
*
|
|
2572
2575
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
2573
2576
|
*
|
|
@@ -2581,7 +2584,7 @@ export type ResponseFormatTextConfig = Shared.ResponseFormatText | ResponseForma
|
|
|
2581
2584
|
/**
|
|
2582
2585
|
* JSON Schema response format. Used to generate structured JSON responses. Learn
|
|
2583
2586
|
* more about
|
|
2584
|
-
* [Structured Outputs](https://
|
|
2587
|
+
* [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
2585
2588
|
*/
|
|
2586
2589
|
export interface ResponseFormatTextJSONSchemaConfig {
|
|
2587
2590
|
/**
|
|
@@ -2610,7 +2613,7 @@ export interface ResponseFormatTextJSONSchemaConfig {
|
|
|
2610
2613
|
* true, the model will always follow the exact schema defined in the `schema`
|
|
2611
2614
|
* field. Only a subset of JSON Schema is supported when `strict` is `true`. To
|
|
2612
2615
|
* learn more, read the
|
|
2613
|
-
* [Structured Outputs guide](https://
|
|
2616
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
2614
2617
|
*/
|
|
2615
2618
|
strict?: boolean | null;
|
|
2616
2619
|
}
|
|
@@ -2875,7 +2878,7 @@ export declare namespace ResponseFunctionShellToolCallOutput {
|
|
|
2875
2878
|
}
|
|
2876
2879
|
/**
|
|
2877
2880
|
* A tool call to run a function. See the
|
|
2878
|
-
* [function calling guide](https://
|
|
2881
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
2879
2882
|
* for more information.
|
|
2880
2883
|
*/
|
|
2881
2884
|
export interface ResponseFunctionToolCall {
|
|
@@ -2931,7 +2934,7 @@ export declare namespace ResponseFunctionToolCall {
|
|
|
2931
2934
|
}
|
|
2932
2935
|
/**
|
|
2933
2936
|
* A tool call to run a function. See the
|
|
2934
|
-
* [function calling guide](https://
|
|
2937
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
2935
2938
|
* for more information.
|
|
2936
2939
|
*/
|
|
2937
2940
|
export interface ResponseFunctionToolCallItem extends ResponseFunctionToolCall {
|
|
@@ -3009,8 +3012,8 @@ export declare namespace ResponseFunctionToolCallOutputItem {
|
|
|
3009
3012
|
}
|
|
3010
3013
|
/**
|
|
3011
3014
|
* The results of a web search tool call. See the
|
|
3012
|
-
* [web search guide](https://
|
|
3013
|
-
* more information.
|
|
3015
|
+
* [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
3016
|
+
* for more information.
|
|
3014
3017
|
*/
|
|
3015
3018
|
export interface ResponseFunctionWebSearch {
|
|
3016
3019
|
/**
|
|
@@ -3411,7 +3414,7 @@ export declare namespace ResponseInputFileContent {
|
|
|
3411
3414
|
}
|
|
3412
3415
|
/**
|
|
3413
3416
|
* An image input to the model. Learn about
|
|
3414
|
-
* [image inputs](https://
|
|
3417
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision).
|
|
3415
3418
|
*/
|
|
3416
3419
|
export interface ResponseInputImage {
|
|
3417
3420
|
/**
|
|
@@ -3454,7 +3457,7 @@ export declare namespace ResponseInputImage {
|
|
|
3454
3457
|
}
|
|
3455
3458
|
/**
|
|
3456
3459
|
* An image input to the model. Learn about
|
|
3457
|
-
* [image inputs](https://
|
|
3460
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
3458
3461
|
*/
|
|
3459
3462
|
export interface ResponseInputImageContent {
|
|
3460
3463
|
/**
|
|
@@ -5556,7 +5559,7 @@ export declare namespace ResponseOutputTextAnnotationAddedEvent {
|
|
|
5556
5559
|
}
|
|
5557
5560
|
/**
|
|
5558
5561
|
* Reference to a prompt template and its variables.
|
|
5559
|
-
* [Learn more](https://
|
|
5562
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
5560
5563
|
*/
|
|
5561
5564
|
export interface ResponsePrompt {
|
|
5562
5565
|
/**
|
|
@@ -5597,7 +5600,7 @@ export interface ResponseQueuedEvent {
|
|
|
5597
5600
|
* A description of the chain of thought used by a reasoning model while generating
|
|
5598
5601
|
* a response. Be sure to include these items in your `input` to the Responses API
|
|
5599
5602
|
* for subsequent turns of a conversation if you are manually
|
|
5600
|
-
* [managing context](https://
|
|
5603
|
+
* [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
5601
5604
|
*/
|
|
5602
5605
|
export interface ResponseReasoningItem {
|
|
5603
5606
|
/**
|
|
@@ -6584,8 +6587,8 @@ export type ResponseStreamEvent = ResponseAudioDeltaEvent | ResponseAudioDoneEve
|
|
|
6584
6587
|
* Configuration options for a text response from the model. Can be plain text or
|
|
6585
6588
|
* structured JSON data. Learn more:
|
|
6586
6589
|
*
|
|
6587
|
-
* - [Text inputs and outputs](https://
|
|
6588
|
-
* - [Structured Outputs](https://
|
|
6590
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
6591
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
6589
6592
|
*/
|
|
6590
6593
|
export interface ResponseTextConfig {
|
|
6591
6594
|
/**
|
|
@@ -6593,7 +6596,7 @@ export interface ResponseTextConfig {
|
|
|
6593
6596
|
*
|
|
6594
6597
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
6595
6598
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
6596
|
-
* [Structured Outputs guide](https://
|
|
6599
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
6597
6600
|
*
|
|
6598
6601
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
6599
6602
|
*
|
|
@@ -6867,7 +6870,7 @@ export declare namespace ResponseUsage {
|
|
|
6867
6870
|
cache_write_tokens: number;
|
|
6868
6871
|
/**
|
|
6869
6872
|
* The number of tokens that were retrieved from the cache.
|
|
6870
|
-
* [More on prompt caching](https://
|
|
6873
|
+
* [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
6871
6874
|
*/
|
|
6872
6875
|
cached_tokens: number;
|
|
6873
6876
|
}
|
|
@@ -6979,7 +6982,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
6979
6982
|
type: 'response.create';
|
|
6980
6983
|
/**
|
|
6981
6984
|
* Whether to run the model response in the background.
|
|
6982
|
-
* [Learn more](https://
|
|
6985
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
6983
6986
|
*/
|
|
6984
6987
|
background?: boolean | null;
|
|
6985
6988
|
/**
|
|
@@ -7019,11 +7022,11 @@ export declare namespace ResponsesClientEvent {
|
|
|
7019
7022
|
*
|
|
7020
7023
|
* Learn more:
|
|
7021
7024
|
*
|
|
7022
|
-
* - [Text inputs and outputs](https://
|
|
7023
|
-
* - [Image inputs](https://
|
|
7024
|
-
* - [File inputs](https://
|
|
7025
|
-
* - [Conversation state](https://
|
|
7026
|
-
* - [Function calling](https://
|
|
7025
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
7026
|
+
* - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
7027
|
+
* - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
7028
|
+
* - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
7029
|
+
* - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
7027
7030
|
*/
|
|
7028
7031
|
input?: string | ResponsesAPI.ResponseInput;
|
|
7029
7032
|
/**
|
|
@@ -7037,7 +7040,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7037
7040
|
/**
|
|
7038
7041
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
7039
7042
|
* including visible output tokens and
|
|
7040
|
-
* [reasoning tokens](https://
|
|
7043
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
7041
7044
|
*/
|
|
7042
7045
|
max_output_tokens?: number | null;
|
|
7043
7046
|
/**
|
|
@@ -7060,8 +7063,8 @@ export declare namespace ResponsesClientEvent {
|
|
|
7060
7063
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
7061
7064
|
* range of models with different capabilities, performance characteristics, and
|
|
7062
7065
|
* price points. Refer to the
|
|
7063
|
-
* [model guide](https://
|
|
7064
|
-
* available models.
|
|
7066
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
7067
|
+
* compare available models.
|
|
7065
7068
|
*/
|
|
7066
7069
|
model?: Shared.ResponsesModel;
|
|
7067
7070
|
/**
|
|
@@ -7075,19 +7078,19 @@ export declare namespace ResponsesClientEvent {
|
|
|
7075
7078
|
/**
|
|
7076
7079
|
* The unique ID of the previous response to the model. Use this to create
|
|
7077
7080
|
* multi-turn conversations. Learn more about
|
|
7078
|
-
* [conversation state](https://
|
|
7081
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
7079
7082
|
* Cannot be used in conjunction with `conversation`.
|
|
7080
7083
|
*/
|
|
7081
7084
|
previous_response_id?: string | null;
|
|
7082
7085
|
/**
|
|
7083
7086
|
* Reference to a prompt template and its variables.
|
|
7084
|
-
* [Learn more](https://
|
|
7087
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
7085
7088
|
*/
|
|
7086
7089
|
prompt?: ResponsesAPI.ResponsePrompt | null;
|
|
7087
7090
|
/**
|
|
7088
7091
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
7089
7092
|
* hit rates. Replaces the `user` field.
|
|
7090
|
-
* [Learn more](https://
|
|
7093
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
7091
7094
|
*/
|
|
7092
7095
|
prompt_cache_key?: string | null;
|
|
7093
7096
|
/**
|
|
@@ -7098,7 +7101,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7098
7101
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
7099
7102
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
7100
7103
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
7101
|
-
* [prompt caching guide](https://
|
|
7104
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
7102
7105
|
* for current details.
|
|
7103
7106
|
*/
|
|
7104
7107
|
prompt_cache_options?: ResponseCreate.PromptCacheOptions;
|
|
@@ -7108,7 +7111,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7108
7111
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
7109
7112
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
7110
7113
|
* of 24 hours.
|
|
7111
|
-
* [Learn more](https://
|
|
7114
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
7112
7115
|
* This field expresses a maximum retention policy, while
|
|
7113
7116
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
7114
7117
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -7124,7 +7127,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7124
7127
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
7125
7128
|
/**
|
|
7126
7129
|
* Configuration options for
|
|
7127
|
-
* [reasoning models](https://
|
|
7130
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
7128
7131
|
*/
|
|
7129
7132
|
reasoning?: Shared.Reasoning | null;
|
|
7130
7133
|
/**
|
|
@@ -7133,7 +7136,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7133
7136
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
7134
7137
|
* hashing their username or email address, in order to avoid sending us any
|
|
7135
7138
|
* identifying information.
|
|
7136
|
-
* [Learn more](https://
|
|
7139
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
7137
7140
|
*/
|
|
7138
7141
|
safety_identifier?: string | null;
|
|
7139
7142
|
/**
|
|
@@ -7144,13 +7147,15 @@ export declare namespace ResponsesClientEvent {
|
|
|
7144
7147
|
* will use 'default'.
|
|
7145
7148
|
* - If set to 'default', then the request will be processed with the standard
|
|
7146
7149
|
* pricing and performance for the selected model.
|
|
7147
|
-
* - If set to
|
|
7148
|
-
* then
|
|
7149
|
-
*
|
|
7150
|
-
*
|
|
7151
|
-
*
|
|
7152
|
-
*
|
|
7153
|
-
*
|
|
7150
|
+
* - If set to
|
|
7151
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
7152
|
+
* the request will be processed with the Flex Processing service tier.
|
|
7153
|
+
* - To opt-in to
|
|
7154
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
7155
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
7156
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
7157
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
7158
|
+
* `priority` in your request.
|
|
7154
7159
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
7155
7160
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
7156
7161
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -7167,7 +7172,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7167
7172
|
* Whether to store the generated model response for later retrieval via API.
|
|
7168
7173
|
* Defaults to true when omitted. If set to true, response data will be stored for
|
|
7169
7174
|
* at least 30 days, subject to the
|
|
7170
|
-
* [data retention exceptions](/api/docs/guides/your-data#v1responses).
|
|
7175
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
7171
7176
|
*/
|
|
7172
7177
|
store?: boolean | null;
|
|
7173
7178
|
/**
|
|
@@ -7175,7 +7180,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7175
7180
|
* generated using
|
|
7176
7181
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
7177
7182
|
* See the
|
|
7178
|
-
* [Streaming section below](https://
|
|
7183
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
7179
7184
|
* for more information.
|
|
7180
7185
|
*/
|
|
7181
7186
|
stream?: boolean | null;
|
|
@@ -7202,8 +7207,8 @@ export declare namespace ResponsesClientEvent {
|
|
|
7202
7207
|
* Configuration options for a text response from the model. Can be plain text or
|
|
7203
7208
|
* structured JSON data. Learn more:
|
|
7204
7209
|
*
|
|
7205
|
-
* - [Text inputs and outputs](https://
|
|
7206
|
-
* - [Structured Outputs](https://
|
|
7210
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
7211
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
7207
7212
|
*/
|
|
7208
7213
|
text?: ResponsesAPI.ResponseTextConfig;
|
|
7209
7214
|
/**
|
|
@@ -7220,17 +7225,18 @@ export declare namespace ResponsesClientEvent {
|
|
|
7220
7225
|
*
|
|
7221
7226
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
7222
7227
|
* capabilities, like
|
|
7223
|
-
* [web search](https://
|
|
7224
|
-
*
|
|
7228
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
7229
|
+
* or
|
|
7230
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
7225
7231
|
* Learn more about
|
|
7226
|
-
* [built-in tools](https://
|
|
7232
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
7227
7233
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
7228
7234
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
7229
|
-
* [MCP Tools](https://
|
|
7235
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
7230
7236
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
7231
7237
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
7232
7238
|
* Learn more about
|
|
7233
|
-
* [function calling](https://
|
|
7239
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
7234
7240
|
* You can also use custom tools to call your own code.
|
|
7235
7241
|
*/
|
|
7236
7242
|
tools?: Array<ResponsesAPI.Tool>;
|
|
@@ -7264,7 +7270,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7264
7270
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
7265
7271
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
7266
7272
|
* abuse.
|
|
7267
|
-
* [Learn more](https://
|
|
7273
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
7268
7274
|
*/
|
|
7269
7275
|
user?: string;
|
|
7270
7276
|
}
|
|
@@ -7330,7 +7336,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7330
7336
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
7331
7337
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
7332
7338
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
7333
|
-
* [prompt caching guide](https://
|
|
7339
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
7334
7340
|
* for current details.
|
|
7335
7341
|
*/
|
|
7336
7342
|
interface PromptCacheOptions {
|
|
@@ -8062,13 +8068,15 @@ export declare namespace ResponsesServerEvent {
|
|
|
8062
8068
|
* will use 'default'.
|
|
8063
8069
|
* - If set to 'default', then the request will be processed with the standard
|
|
8064
8070
|
* pricing and performance for the selected model.
|
|
8065
|
-
* - If set to
|
|
8066
|
-
* then
|
|
8067
|
-
*
|
|
8068
|
-
*
|
|
8069
|
-
*
|
|
8070
|
-
*
|
|
8071
|
-
*
|
|
8071
|
+
* - If set to
|
|
8072
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
8073
|
+
* the request will be processed with the Flex Processing service tier.
|
|
8074
|
+
* - To opt-in to
|
|
8075
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
8076
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
8077
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
8078
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
8079
|
+
* `priority` in your request.
|
|
8072
8080
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
8073
8081
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
8074
8082
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -8103,7 +8111,7 @@ export declare namespace Tool {
|
|
|
8103
8111
|
/**
|
|
8104
8112
|
* Give the model access to additional tools via remote Model Context Protocol
|
|
8105
8113
|
* (MCP) servers.
|
|
8106
|
-
* [Learn more about MCP](https://
|
|
8114
|
+
* [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
8107
8115
|
*/
|
|
8108
8116
|
interface Mcp {
|
|
8109
8117
|
/**
|
|
@@ -8132,7 +8140,7 @@ export declare namespace Tool {
|
|
|
8132
8140
|
* Identifier for service connectors, like those available in ChatGPT. One of
|
|
8133
8141
|
* `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
|
|
8134
8142
|
* service connectors
|
|
8135
|
-
* [here](https://
|
|
8143
|
+
* [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
|
|
8136
8144
|
*
|
|
8137
8145
|
* Currently supported `connector_id` values are:
|
|
8138
8146
|
*
|
|
@@ -8511,12 +8519,12 @@ export interface ToolChoiceShell {
|
|
|
8511
8519
|
}
|
|
8512
8520
|
/**
|
|
8513
8521
|
* Indicates that the model should use a built-in tool to generate a response.
|
|
8514
|
-
* [Learn more about built-in tools](https://
|
|
8522
|
+
* [Learn more about built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
8515
8523
|
*/
|
|
8516
8524
|
export interface ToolChoiceTypes {
|
|
8517
8525
|
/**
|
|
8518
8526
|
* The type of hosted tool the model should to use. Learn more about
|
|
8519
|
-
* [built-in tools](https://
|
|
8527
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
8520
8528
|
*
|
|
8521
8529
|
* Allowed values are:
|
|
8522
8530
|
*
|
|
@@ -8555,7 +8563,7 @@ export interface ToolSearchTool {
|
|
|
8555
8563
|
/**
|
|
8556
8564
|
* This tool searches the web for relevant results to use in a response. Learn more
|
|
8557
8565
|
* about the
|
|
8558
|
-
* [web search tool](https://
|
|
8566
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
8559
8567
|
*/
|
|
8560
8568
|
export interface WebSearchPreviewTool {
|
|
8561
8569
|
/**
|
|
@@ -8605,7 +8613,7 @@ export declare namespace WebSearchPreviewTool {
|
|
|
8605
8613
|
}
|
|
8606
8614
|
/**
|
|
8607
8615
|
* Search the Internet for sources related to the prompt. Learn more about the
|
|
8608
|
-
* [web search tool](https://
|
|
8616
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
8609
8617
|
*/
|
|
8610
8618
|
export interface WebSearchTool {
|
|
8611
8619
|
/**
|
|
@@ -8677,7 +8685,7 @@ export type ResponseCreateParams = ResponseCreateParamsNonStreaming | ResponseCr
|
|
|
8677
8685
|
export interface ResponseCreateParamsBase {
|
|
8678
8686
|
/**
|
|
8679
8687
|
* Whether to run the model response in the background.
|
|
8680
|
-
* [Learn more](https://
|
|
8688
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
8681
8689
|
*/
|
|
8682
8690
|
background?: boolean | null;
|
|
8683
8691
|
/**
|
|
@@ -8720,11 +8728,11 @@ export interface ResponseCreateParamsBase {
|
|
|
8720
8728
|
*
|
|
8721
8729
|
* Learn more:
|
|
8722
8730
|
*
|
|
8723
|
-
* - [Text inputs and outputs](https://
|
|
8724
|
-
* - [Image inputs](https://
|
|
8725
|
-
* - [File inputs](https://
|
|
8726
|
-
* - [Conversation state](https://
|
|
8727
|
-
* - [Function calling](https://
|
|
8731
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
8732
|
+
* - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
8733
|
+
* - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
8734
|
+
* - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
8735
|
+
* - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
8728
8736
|
*/
|
|
8729
8737
|
input?: string | ResponseInput;
|
|
8730
8738
|
/**
|
|
@@ -8738,7 +8746,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8738
8746
|
/**
|
|
8739
8747
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
8740
8748
|
* including visible output tokens and
|
|
8741
|
-
* [reasoning tokens](https://
|
|
8749
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
8742
8750
|
*/
|
|
8743
8751
|
max_output_tokens?: number | null;
|
|
8744
8752
|
/**
|
|
@@ -8754,8 +8762,8 @@ export interface ResponseCreateParamsBase {
|
|
|
8754
8762
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
8755
8763
|
* range of models with different capabilities, performance characteristics, and
|
|
8756
8764
|
* price points. Refer to the
|
|
8757
|
-
* [model guide](https://
|
|
8758
|
-
* available models.
|
|
8765
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
8766
|
+
* compare available models.
|
|
8759
8767
|
*/
|
|
8760
8768
|
model?: Shared.ResponsesModel;
|
|
8761
8769
|
/**
|
|
@@ -8769,19 +8777,19 @@ export interface ResponseCreateParamsBase {
|
|
|
8769
8777
|
/**
|
|
8770
8778
|
* The unique ID of the previous response to the model. Use this to create
|
|
8771
8779
|
* multi-turn conversations. Learn more about
|
|
8772
|
-
* [conversation state](https://
|
|
8780
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
8773
8781
|
* Cannot be used in conjunction with `conversation`.
|
|
8774
8782
|
*/
|
|
8775
8783
|
previous_response_id?: string | null;
|
|
8776
8784
|
/**
|
|
8777
8785
|
* Reference to a prompt template and its variables.
|
|
8778
|
-
* [Learn more](https://
|
|
8786
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
8779
8787
|
*/
|
|
8780
8788
|
prompt?: ResponsePrompt | null;
|
|
8781
8789
|
/**
|
|
8782
8790
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
8783
8791
|
* hit rates. Replaces the `user` field.
|
|
8784
|
-
* [Learn more](https://
|
|
8792
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
8785
8793
|
*/
|
|
8786
8794
|
prompt_cache_key?: string | null;
|
|
8787
8795
|
/**
|
|
@@ -8792,7 +8800,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8792
8800
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
8793
8801
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
8794
8802
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
8795
|
-
* [prompt caching guide](https://
|
|
8803
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
8796
8804
|
* for current details.
|
|
8797
8805
|
*/
|
|
8798
8806
|
prompt_cache_options?: ResponseCreateParams.PromptCacheOptions;
|
|
@@ -8802,7 +8810,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8802
8810
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
8803
8811
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
8804
8812
|
* of 24 hours.
|
|
8805
|
-
* [Learn more](https://
|
|
8813
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
8806
8814
|
* This field expresses a maximum retention policy, while
|
|
8807
8815
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
8808
8816
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -8818,7 +8826,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8818
8826
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
8819
8827
|
/**
|
|
8820
8828
|
* Configuration options for
|
|
8821
|
-
* [reasoning models](https://
|
|
8829
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
8822
8830
|
*/
|
|
8823
8831
|
reasoning?: Shared.Reasoning | null;
|
|
8824
8832
|
/**
|
|
@@ -8827,7 +8835,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8827
8835
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
8828
8836
|
* hashing their username or email address, in order to avoid sending us any
|
|
8829
8837
|
* identifying information.
|
|
8830
|
-
* [Learn more](https://
|
|
8838
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
8831
8839
|
*/
|
|
8832
8840
|
safety_identifier?: string | null;
|
|
8833
8841
|
/**
|
|
@@ -8839,13 +8847,15 @@ export interface ResponseCreateParamsBase {
|
|
|
8839
8847
|
* will use 'default'.
|
|
8840
8848
|
* - If set to 'default', then the request will be processed with the standard
|
|
8841
8849
|
* pricing and performance for the selected model.
|
|
8842
|
-
* - If set to
|
|
8843
|
-
* then
|
|
8844
|
-
*
|
|
8845
|
-
*
|
|
8846
|
-
*
|
|
8847
|
-
*
|
|
8848
|
-
*
|
|
8850
|
+
* - If set to
|
|
8851
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
8852
|
+
* the request will be processed with the Flex Processing service tier.
|
|
8853
|
+
* - To opt-in to
|
|
8854
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
8855
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
8856
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
8857
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
8858
|
+
* `priority` in your request.
|
|
8849
8859
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
8850
8860
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
8851
8861
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -8860,7 +8870,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8860
8870
|
* Whether to store the generated model response for later retrieval via API.
|
|
8861
8871
|
* Defaults to true when omitted. If set to true, response data will be stored for
|
|
8862
8872
|
* at least 30 days, subject to the
|
|
8863
|
-
* [data retention exceptions](/api/docs/guides/your-data#v1responses).
|
|
8873
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
8864
8874
|
*/
|
|
8865
8875
|
store?: boolean | null;
|
|
8866
8876
|
/**
|
|
@@ -8868,7 +8878,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8868
8878
|
* generated using
|
|
8869
8879
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
8870
8880
|
* See the
|
|
8871
|
-
* [Streaming section below](https://
|
|
8881
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
8872
8882
|
* for more information.
|
|
8873
8883
|
*/
|
|
8874
8884
|
stream?: boolean | null;
|
|
@@ -8887,8 +8897,8 @@ export interface ResponseCreateParamsBase {
|
|
|
8887
8897
|
* Configuration options for a text response from the model. Can be plain text or
|
|
8888
8898
|
* structured JSON data. Learn more:
|
|
8889
8899
|
*
|
|
8890
|
-
* - [Text inputs and outputs](https://
|
|
8891
|
-
* - [Structured Outputs](https://
|
|
8900
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
8901
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
8892
8902
|
*/
|
|
8893
8903
|
text?: ResponseTextConfig;
|
|
8894
8904
|
/**
|
|
@@ -8905,17 +8915,18 @@ export interface ResponseCreateParamsBase {
|
|
|
8905
8915
|
*
|
|
8906
8916
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
8907
8917
|
* capabilities, like
|
|
8908
|
-
* [web search](https://
|
|
8909
|
-
*
|
|
8918
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
8919
|
+
* or
|
|
8920
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
8910
8921
|
* Learn more about
|
|
8911
|
-
* [built-in tools](https://
|
|
8922
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
8912
8923
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
8913
8924
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
8914
|
-
* [MCP Tools](https://
|
|
8925
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
8915
8926
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
8916
8927
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
8917
8928
|
* Learn more about
|
|
8918
|
-
* [function calling](https://
|
|
8929
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
8919
8930
|
* You can also use custom tools to call your own code.
|
|
8920
8931
|
*/
|
|
8921
8932
|
tools?: Array<Tool>;
|
|
@@ -8949,7 +8960,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8949
8960
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
8950
8961
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
8951
8962
|
* abuse.
|
|
8952
|
-
* [Learn more](https://
|
|
8963
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
8953
8964
|
*/
|
|
8954
8965
|
user?: string;
|
|
8955
8966
|
}
|
|
@@ -9015,7 +9026,7 @@ export declare namespace ResponseCreateParams {
|
|
|
9015
9026
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
9016
9027
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
9017
9028
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
9018
|
-
* [prompt caching guide](https://
|
|
9029
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
9019
9030
|
* for current details.
|
|
9020
9031
|
*/
|
|
9021
9032
|
interface PromptCacheOptions {
|
|
@@ -9069,7 +9080,7 @@ export interface ResponseCreateParamsNonStreaming extends ResponseCreateParamsBa
|
|
|
9069
9080
|
* generated using
|
|
9070
9081
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
9071
9082
|
* See the
|
|
9072
|
-
* [Streaming section below](https://
|
|
9083
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
9073
9084
|
* for more information.
|
|
9074
9085
|
*/
|
|
9075
9086
|
stream?: false | null;
|
|
@@ -9080,7 +9091,7 @@ export interface ResponseCreateParamsStreaming extends ResponseCreateParamsBase
|
|
|
9080
9091
|
* generated using
|
|
9081
9092
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
9082
9093
|
* See the
|
|
9083
|
-
* [Streaming section below](https://
|
|
9094
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
9084
9095
|
* for more information.
|
|
9085
9096
|
*/
|
|
9086
9097
|
stream: true;
|
|
@@ -9110,7 +9121,7 @@ export interface ResponseRetrieveParamsBase {
|
|
|
9110
9121
|
* generated using
|
|
9111
9122
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
9112
9123
|
* See the
|
|
9113
|
-
* [Streaming section below](https://
|
|
9124
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
9114
9125
|
* for more information.
|
|
9115
9126
|
*/
|
|
9116
9127
|
stream?: boolean;
|
|
@@ -9125,7 +9136,7 @@ export interface ResponseRetrieveParamsNonStreaming extends ResponseRetrievePara
|
|
|
9125
9136
|
* generated using
|
|
9126
9137
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
9127
9138
|
* See the
|
|
9128
|
-
* [Streaming section below](https://
|
|
9139
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
9129
9140
|
* for more information.
|
|
9130
9141
|
*/
|
|
9131
9142
|
stream?: false;
|
|
@@ -9136,7 +9147,7 @@ export interface ResponseRetrieveParamsStreaming extends ResponseRetrieveParamsB
|
|
|
9136
9147
|
* generated using
|
|
9137
9148
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
9138
9149
|
* See the
|
|
9139
|
-
* [Streaming section below](https://
|
|
9150
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
9140
9151
|
* for more information.
|
|
9141
9152
|
*/
|
|
9142
9153
|
stream: true;
|
|
@@ -9146,8 +9157,8 @@ export interface ResponseCompactParams {
|
|
|
9146
9157
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
9147
9158
|
* range of models with different capabilities, performance characteristics, and
|
|
9148
9159
|
* price points. Refer to the
|
|
9149
|
-
* [model guide](https://
|
|
9150
|
-
* available models.
|
|
9160
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
9161
|
+
* compare available models.
|
|
9151
9162
|
*/
|
|
9152
9163
|
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;
|
|
9153
9164
|
/**
|
|
@@ -9164,7 +9175,7 @@ export interface ResponseCompactParams {
|
|
|
9164
9175
|
/**
|
|
9165
9176
|
* The unique ID of the previous response to the model. Use this to create
|
|
9166
9177
|
* multi-turn conversations. Learn more about
|
|
9167
|
-
* [conversation state](https://
|
|
9178
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
9168
9179
|
* Cannot be used in conjunction with `conversation`.
|
|
9169
9180
|
*/
|
|
9170
9181
|
previous_response_id?: string | null;
|
|
@@ -9180,7 +9191,7 @@ export interface ResponseCompactParams {
|
|
|
9180
9191
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
9181
9192
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
9182
9193
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
9183
|
-
* [prompt caching guide](https://
|
|
9194
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
9184
9195
|
* for current details.
|
|
9185
9196
|
*/
|
|
9186
9197
|
prompt_cache_options?: ResponseCompactParams.PromptCacheOptions | null;
|
|
@@ -9194,17 +9205,17 @@ export interface ResponseCompactParams {
|
|
|
9194
9205
|
* Project settings. Unless otherwise configured, the Project will use 'default'. -
|
|
9195
9206
|
* If set to 'default', then the request will be processed with the standard
|
|
9196
9207
|
* pricing and performance for the selected model. - If set to
|
|
9197
|
-
* '[flex](https://
|
|
9198
|
-
* request will be processed with the Flex Processing service tier. - To opt-in
|
|
9199
|
-
* [Fast mode](/api/docs/guides/fast-mode) at the
|
|
9200
|
-
* `service_tier=fast` or `service_tier=priority`
|
|
9201
|
-
* Completions. For models with a dedicated Fast
|
|
9202
|
-
* `service_tier=fast`; for other models, either
|
|
9203
|
-
* `service_tier=priority`. - When not set, the default behavior
|
|
9204
|
-
* the `service_tier` parameter is set, the response body will
|
|
9205
|
-
* `service_tier` value based on the processing mode actually used to
|
|
9206
|
-
* request. This response value may be different from the value set in
|
|
9207
|
-
* parameter.
|
|
9208
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
9209
|
+
* the request will be processed with the Flex Processing service tier. - To opt-in
|
|
9210
|
+
* to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
9211
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
9212
|
+
* parameter for Responses or Chat Completions. For models with a dedicated Fast
|
|
9213
|
+
* tier, either value resolves to `service_tier=fast`; for other models, either
|
|
9214
|
+
* value resolves to `service_tier=priority`. - When not set, the default behavior
|
|
9215
|
+
* is 'auto'. When the `service_tier` parameter is set, the response body will
|
|
9216
|
+
* include the `service_tier` value based on the processing mode actually used to
|
|
9217
|
+
* serve the request. This response value may be different from the value set in
|
|
9218
|
+
* the parameter.
|
|
9208
9219
|
*/
|
|
9209
9220
|
service_tier?: 'auto' | 'default' | 'fast' | 'flex' | 'priority' | null;
|
|
9210
9221
|
}
|
|
@@ -9217,7 +9228,7 @@ export declare namespace ResponseCompactParams {
|
|
|
9217
9228
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
9218
9229
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
9219
9230
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
9220
|
-
* [prompt caching guide](https://
|
|
9231
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
9221
9232
|
* for current details.
|
|
9222
9233
|
*/
|
|
9223
9234
|
interface PromptCacheOptions {
|