openai 7.10.0 → 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 +203 -0
- package/README.md +7 -5
- package/_vendor/partial-json-parser/parser.d.mts.map +1 -1
- package/_vendor/partial-json-parser/parser.d.ts.map +1 -1
- package/_vendor/partial-json-parser/parser.js +4 -3
- package/_vendor/partial-json-parser/parser.js.map +1 -1
- package/_vendor/partial-json-parser/parser.mjs +4 -3
- package/_vendor/partial-json-parser/parser.mjs.map +1 -1
- package/_vendor/zod-to-json-schema/parsers/string.js +1 -1
- package/_vendor/zod-to-json-schema/parsers/string.js.map +1 -1
- package/_vendor/zod-to-json-schema/parsers/string.mjs +1 -1
- package/_vendor/zod-to-json-schema/parsers/string.mjs.map +1 -1
- package/_vendor/zod-to-json-schema/parsers/tuple.d.mts.map +1 -1
- package/_vendor/zod-to-json-schema/parsers/tuple.d.ts.map +1 -1
- package/_vendor/zod-to-json-schema/parsers/tuple.js +19 -12
- package/_vendor/zod-to-json-schema/parsers/tuple.js.map +1 -1
- package/_vendor/zod-to-json-schema/parsers/tuple.mjs +19 -12
- package/_vendor/zod-to-json-schema/parsers/tuple.mjs.map +1 -1
- package/_vendor/zod-to-json-schema/zodToJsonSchema.d.mts.map +1 -1
- package/_vendor/zod-to-json-schema/zodToJsonSchema.d.ts.map +1 -1
- package/_vendor/zod-to-json-schema/zodToJsonSchema.js +6 -2
- package/_vendor/zod-to-json-schema/zodToJsonSchema.js.map +1 -1
- package/_vendor/zod-to-json-schema/zodToJsonSchema.mjs +6 -2
- package/_vendor/zod-to-json-schema/zodToJsonSchema.mjs.map +1 -1
- package/auth/subject-token-providers.d.mts.map +1 -1
- package/auth/subject-token-providers.d.ts.map +1 -1
- package/auth/subject-token-providers.js +10 -5
- package/auth/subject-token-providers.js.map +1 -1
- package/auth/subject-token-providers.mjs +10 -5
- package/auth/subject-token-providers.mjs.map +1 -1
- package/auth/workload-identity-auth.d.mts.map +1 -1
- package/auth/workload-identity-auth.d.ts.map +1 -1
- package/auth/workload-identity-auth.js +21 -11
- package/auth/workload-identity-auth.js.map +1 -1
- package/auth/workload-identity-auth.mjs +21 -11
- package/auth/workload-identity-auth.mjs.map +1 -1
- package/azure.d.mts.map +1 -1
- package/azure.d.ts.map +1 -1
- package/azure.js +31 -2
- package/azure.js.map +1 -1
- package/azure.mjs +32 -3
- package/azure.mjs.map +1 -1
- package/beta/realtime/internal-base.d.mts.map +1 -1
- package/beta/realtime/internal-base.d.ts.map +1 -1
- package/beta/realtime/internal-base.js +3 -2
- package/beta/realtime/internal-base.js.map +1 -1
- package/beta/realtime/internal-base.mjs +3 -2
- package/beta/realtime/internal-base.mjs.map +1 -1
- package/beta/realtime/websocket.d.mts +2 -0
- package/beta/realtime/websocket.d.mts.map +1 -1
- package/beta/realtime/websocket.d.ts +2 -0
- package/beta/realtime/websocket.d.ts.map +1 -1
- package/beta/realtime/websocket.js +12 -7
- package/beta/realtime/websocket.js.map +1 -1
- package/beta/realtime/websocket.mjs +12 -7
- package/beta/realtime/websocket.mjs.map +1 -1
- package/beta/realtime/ws.d.mts +2 -0
- package/beta/realtime/ws.d.mts.map +1 -1
- package/beta/realtime/ws.d.ts +2 -0
- package/beta/realtime/ws.d.ts.map +1 -1
- package/beta/realtime/ws.js +7 -5
- package/beta/realtime/ws.js.map +1 -1
- package/beta/realtime/ws.mjs +7 -5
- package/beta/realtime/ws.mjs.map +1 -1
- package/client.d.mts +9 -1
- package/client.d.mts.map +1 -1
- package/client.d.ts +9 -1
- package/client.d.ts.map +1 -1
- package/client.js +17 -4
- package/client.js.map +1 -1
- package/client.mjs +17 -4
- package/client.mjs.map +1 -1
- package/core/EventEmitter.d.mts +2 -1
- package/core/EventEmitter.d.mts.map +1 -1
- package/core/EventEmitter.d.ts +2 -1
- package/core/EventEmitter.d.ts.map +1 -1
- package/core/EventEmitter.js +2 -1
- package/core/EventEmitter.js.map +1 -1
- package/core/EventEmitter.mjs +2 -1
- package/core/EventEmitter.mjs.map +1 -1
- package/core/pagination.js +1 -1
- package/core/pagination.js.map +1 -1
- package/core/pagination.mjs +1 -1
- package/core/pagination.mjs.map +1 -1
- package/core/streaming.d.mts +8 -0
- package/core/streaming.d.mts.map +1 -1
- package/core/streaming.d.ts +8 -0
- package/core/streaming.d.ts.map +1 -1
- package/core/streaming.js +68 -15
- package/core/streaming.js.map +1 -1
- package/core/streaming.mjs +68 -15
- package/core/streaming.mjs.map +1 -1
- package/helpers/audio.d.mts +1 -1
- package/helpers/audio.d.mts.map +1 -1
- package/helpers/audio.d.ts +1 -1
- package/helpers/audio.d.ts.map +1 -1
- package/helpers/audio.js +25 -5
- package/helpers/audio.js.map +1 -1
- package/helpers/audio.mjs +25 -5
- package/helpers/audio.mjs.map +1 -1
- package/helpers/zod.d.mts +28 -15
- package/helpers/zod.d.mts.map +1 -1
- package/helpers/zod.d.ts +28 -15
- package/helpers/zod.d.ts.map +1 -1
- package/helpers/zod.js +30 -23
- package/helpers/zod.js.map +1 -1
- package/helpers/zod.mjs +30 -23
- package/helpers/zod.mjs.map +1 -1
- package/index.js +4 -5
- package/internal/bedrock.d.mts +11 -0
- package/internal/bedrock.d.mts.map +1 -1
- package/internal/bedrock.d.ts +11 -0
- package/internal/bedrock.d.ts.map +1 -1
- package/internal/bedrock.js +71 -55
- package/internal/bedrock.js.map +1 -1
- package/internal/bedrock.mjs +70 -55
- package/internal/bedrock.mjs.map +1 -1
- package/internal/detect-platform.js +2 -2
- package/internal/detect-platform.js.map +1 -1
- package/internal/detect-platform.mjs +2 -2
- package/internal/detect-platform.mjs.map +1 -1
- package/internal/errors.d.mts.map +1 -1
- package/internal/errors.d.ts.map +1 -1
- package/internal/errors.js +3 -2
- package/internal/errors.js.map +1 -1
- package/internal/errors.mjs +3 -2
- package/internal/errors.mjs.map +1 -1
- package/internal/headers.d.mts.map +1 -1
- package/internal/headers.d.ts.map +1 -1
- package/internal/headers.js +4 -5
- package/internal/headers.js.map +1 -1
- package/internal/headers.mjs +4 -5
- package/internal/headers.mjs.map +1 -1
- package/internal/parse.js +1 -1
- package/internal/parse.js.map +1 -1
- package/internal/parse.mjs +1 -1
- package/internal/parse.mjs.map +1 -1
- package/internal/realtime-credentials.d.mts +15 -0
- package/internal/realtime-credentials.d.mts.map +1 -0
- package/internal/realtime-credentials.d.ts +15 -0
- package/internal/realtime-credentials.d.ts.map +1 -0
- package/internal/realtime-credentials.js +23 -0
- package/internal/realtime-credentials.js.map +1 -0
- package/internal/realtime-credentials.mjs +19 -0
- package/internal/realtime-credentials.mjs.map +1 -0
- package/internal/responses/response-accumulator.d.mts.map +1 -1
- package/internal/responses/response-accumulator.d.ts.map +1 -1
- package/internal/responses/response-accumulator.js +2 -1
- package/internal/responses/response-accumulator.js.map +1 -1
- package/internal/responses/response-accumulator.mjs +2 -1
- package/internal/responses/response-accumulator.mjs.map +1 -1
- package/internal/to-file.d.mts +2 -1
- package/internal/to-file.d.mts.map +1 -1
- package/internal/to-file.d.ts +2 -1
- package/internal/to-file.d.ts.map +1 -1
- package/internal/to-file.js +5 -4
- package/internal/to-file.js.map +1 -1
- package/internal/to-file.mjs +6 -5
- package/internal/to-file.mjs.map +1 -1
- package/internal/types.d.mts +3 -3
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +3 -3
- package/internal/types.d.ts.map +1 -1
- package/internal/uploads.d.mts +2 -0
- package/internal/uploads.d.mts.map +1 -1
- package/internal/uploads.d.ts +2 -0
- package/internal/uploads.d.ts.map +1 -1
- package/internal/uploads.js +12 -1
- package/internal/uploads.js.map +1 -1
- package/internal/uploads.mjs +11 -1
- package/internal/uploads.mjs.map +1 -1
- package/internal/utils/base64.d.mts.map +1 -1
- package/internal/utils/base64.d.ts.map +1 -1
- package/internal/utils/base64.js +3 -0
- package/internal/utils/base64.js.map +1 -1
- package/internal/utils/base64.mjs +3 -0
- package/internal/utils/base64.mjs.map +1 -1
- package/lib/AbstractChatCompletionRunner.d.mts +1 -1
- package/lib/AbstractChatCompletionRunner.d.mts.map +1 -1
- package/lib/AbstractChatCompletionRunner.d.ts +1 -1
- package/lib/AbstractChatCompletionRunner.d.ts.map +1 -1
- package/lib/AbstractChatCompletionRunner.js +31 -9
- package/lib/AbstractChatCompletionRunner.js.map +1 -1
- package/lib/AbstractChatCompletionRunner.mjs +31 -9
- package/lib/AbstractChatCompletionRunner.mjs.map +1 -1
- package/lib/AssistantStream.d.mts +4 -1
- package/lib/AssistantStream.d.mts.map +1 -1
- package/lib/AssistantStream.d.ts +4 -1
- package/lib/AssistantStream.d.ts.map +1 -1
- package/lib/AssistantStream.js +23 -8
- package/lib/AssistantStream.js.map +1 -1
- package/lib/AssistantStream.mjs +24 -9
- package/lib/AssistantStream.mjs.map +1 -1
- package/lib/ChatCompletionRunner.d.mts +6 -3
- package/lib/ChatCompletionRunner.d.mts.map +1 -1
- package/lib/ChatCompletionRunner.d.ts +6 -3
- package/lib/ChatCompletionRunner.d.ts.map +1 -1
- package/lib/ChatCompletionRunner.js +7 -4
- package/lib/ChatCompletionRunner.js.map +1 -1
- package/lib/ChatCompletionRunner.mjs +7 -4
- package/lib/ChatCompletionRunner.mjs.map +1 -1
- package/lib/ChatCompletionStream.d.mts.map +1 -1
- package/lib/ChatCompletionStream.d.ts.map +1 -1
- package/lib/ChatCompletionStream.js +6 -0
- package/lib/ChatCompletionStream.js.map +1 -1
- package/lib/ChatCompletionStream.mjs +7 -1
- package/lib/ChatCompletionStream.mjs.map +1 -1
- package/lib/ChatCompletionStreamingRunner.d.mts.map +1 -1
- package/lib/ChatCompletionStreamingRunner.d.ts.map +1 -1
- package/lib/ChatCompletionStreamingRunner.js +1 -0
- package/lib/ChatCompletionStreamingRunner.js.map +1 -1
- package/lib/ChatCompletionStreamingRunner.mjs +1 -0
- package/lib/ChatCompletionStreamingRunner.mjs.map +1 -1
- package/lib/EventEmitter.d.mts +3 -1
- package/lib/EventEmitter.d.mts.map +1 -1
- package/lib/EventEmitter.d.ts +3 -1
- package/lib/EventEmitter.d.ts.map +1 -1
- package/lib/EventEmitter.js +2 -1
- package/lib/EventEmitter.js.map +1 -1
- package/lib/EventEmitter.mjs +2 -1
- package/lib/EventEmitter.mjs.map +1 -1
- package/lib/EventStream.d.mts +2 -1
- package/lib/EventStream.d.mts.map +1 -1
- package/lib/EventStream.d.ts +2 -1
- package/lib/EventStream.d.ts.map +1 -1
- package/lib/EventStream.js +99 -46
- package/lib/EventStream.js.map +1 -1
- package/lib/EventStream.mjs +99 -46
- package/lib/EventStream.mjs.map +1 -1
- package/lib/ResponsesParser.d.mts +5 -4
- package/lib/ResponsesParser.d.mts.map +1 -1
- package/lib/ResponsesParser.d.ts +5 -4
- package/lib/ResponsesParser.d.ts.map +1 -1
- package/lib/ResponsesParser.js +21 -7
- package/lib/ResponsesParser.js.map +1 -1
- package/lib/ResponsesParser.mjs +21 -7
- package/lib/ResponsesParser.mjs.map +1 -1
- package/lib/RunnableFunction.d.mts +2 -2
- package/lib/RunnableFunction.d.mts.map +1 -1
- package/lib/RunnableFunction.d.ts +2 -2
- package/lib/RunnableFunction.d.ts.map +1 -1
- package/lib/embeddings.d.mts.map +1 -1
- package/lib/embeddings.d.ts.map +1 -1
- package/lib/embeddings.js +18 -12
- package/lib/embeddings.js.map +1 -1
- package/lib/embeddings.mjs +18 -12
- package/lib/embeddings.mjs.map +1 -1
- package/lib/file-processing.d.mts +3 -2
- package/lib/file-processing.d.mts.map +1 -1
- package/lib/file-processing.d.ts +3 -2
- package/lib/file-processing.d.ts.map +1 -1
- package/lib/file-processing.js +5 -4
- package/lib/file-processing.js.map +1 -1
- package/lib/file-processing.mjs +5 -4
- package/lib/file-processing.mjs.map +1 -1
- package/lib/parser.d.mts +16 -4
- package/lib/parser.d.mts.map +1 -1
- package/lib/parser.d.ts +16 -4
- package/lib/parser.d.ts.map +1 -1
- package/lib/parser.js +1 -1
- package/lib/parser.js.map +1 -1
- package/lib/parser.mjs +1 -1
- package/lib/parser.mjs.map +1 -1
- package/lib/polling.d.mts +2 -2
- package/lib/polling.d.mts.map +1 -1
- package/lib/polling.d.ts +2 -2
- package/lib/polling.d.ts.map +1 -1
- package/lib/polling.js +5 -4
- package/lib/polling.js.map +1 -1
- package/lib/polling.mjs +5 -4
- package/lib/polling.mjs.map +1 -1
- package/lib/responses/EventTypes.d.mts +2 -2
- package/lib/responses/EventTypes.d.mts.map +1 -1
- package/lib/responses/EventTypes.d.ts +2 -2
- package/lib/responses/EventTypes.d.ts.map +1 -1
- package/lib/responses/ResponseInputItems.d.mts +3 -2
- package/lib/responses/ResponseInputItems.d.mts.map +1 -1
- package/lib/responses/ResponseInputItems.d.ts +3 -2
- package/lib/responses/ResponseInputItems.d.ts.map +1 -1
- package/lib/responses/ResponseInputItems.js +27 -4
- package/lib/responses/ResponseInputItems.js.map +1 -1
- package/lib/responses/ResponseInputItems.mjs +27 -4
- package/lib/responses/ResponseInputItems.mjs.map +1 -1
- package/lib/transform.d.mts.map +1 -1
- package/lib/transform.d.ts.map +1 -1
- package/lib/transform.js +1 -0
- package/lib/transform.js.map +1 -1
- package/lib/transform.mjs +1 -0
- package/lib/transform.mjs.map +1 -1
- package/lib/vector-store-polling.d.mts +2 -2
- package/lib/vector-store-polling.d.ts +2 -2
- package/lib/vector-store-polling.js +3 -3
- package/lib/vector-store-polling.js.map +1 -1
- package/lib/vector-store-polling.mjs +3 -3
- package/lib/vector-store-polling.mjs.map +1 -1
- package/lib/vector-store-upload.d.mts +2 -1
- package/lib/vector-store-upload.d.mts.map +1 -1
- package/lib/vector-store-upload.d.ts +2 -1
- package/lib/vector-store-upload.d.ts.map +1 -1
- package/lib/vector-store-upload.js +5 -1
- package/lib/vector-store-upload.js.map +1 -1
- package/lib/vector-store-upload.mjs +5 -1
- package/lib/vector-store-upload.mjs.map +1 -1
- package/package.json +1 -1
- package/providers/bedrock/aws.d.mts.map +1 -1
- package/providers/bedrock/aws.d.ts.map +1 -1
- package/providers/bedrock/aws.js +14 -16
- package/providers/bedrock/aws.js.map +1 -1
- package/providers/bedrock/aws.mjs +15 -17
- package/providers/bedrock/aws.mjs.map +1 -1
- package/realtime/internal-base.d.mts.map +1 -1
- package/realtime/internal-base.d.ts.map +1 -1
- package/realtime/internal-base.js +3 -5
- package/realtime/internal-base.js.map +1 -1
- package/realtime/internal-base.mjs +3 -5
- package/realtime/internal-base.mjs.map +1 -1
- package/realtime/websocket.d.mts +2 -0
- package/realtime/websocket.d.mts.map +1 -1
- package/realtime/websocket.d.ts +2 -0
- package/realtime/websocket.d.ts.map +1 -1
- package/realtime/websocket.js +12 -6
- package/realtime/websocket.js.map +1 -1
- package/realtime/websocket.mjs +12 -6
- package/realtime/websocket.mjs.map +1 -1
- package/realtime/ws.d.mts +2 -0
- package/realtime/ws.d.mts.map +1 -1
- package/realtime/ws.d.ts +2 -0
- package/realtime/ws.d.ts.map +1 -1
- package/realtime/ws.js +7 -4
- package/realtime/ws.js.map +1 -1
- package/realtime/ws.mjs +7 -4
- package/realtime/ws.mjs.map +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/api-keys.d.mts +9 -0
- package/resources/admin/organization/projects/service-accounts/api-keys.d.mts.map +1 -1
- package/resources/admin/organization/projects/service-accounts/api-keys.d.ts +9 -0
- package/resources/admin/organization/projects/service-accounts/api-keys.d.ts.map +1 -1
- 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 +284 -194
- package/resources/beta/responses/responses.d.mts.map +1 -1
- package/resources/beta/responses/responses.d.ts +284 -194
- 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 +12 -3
- package/resources/conversations/items.d.mts.map +1 -1
- package/resources/conversations/items.d.ts +12 -3
- package/resources/conversations/items.d.ts.map +1 -1
- 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 +83 -68
- package/resources/images.d.mts.map +1 -1
- package/resources/images.d.ts +83 -68
- package/resources/images.d.ts.map +1 -1
- package/resources/images.js.map +1 -1
- package/resources/images.mjs.map +1 -1
- 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 +278 -187
- package/resources/responses/responses.d.mts.map +1 -1
- package/resources/responses/responses.d.ts +278 -187
- 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 +12 -6
- package/resources/webhooks/webhooks.d.mts.map +1 -1
- package/resources/webhooks/webhooks.d.ts +12 -6
- package/resources/webhooks/webhooks.d.ts.map +1 -1
- package/src/_vendor/partial-json-parser/parser.ts +4 -3
- package/src/_vendor/zod-to-json-schema/parsers/string.ts +1 -1
- package/src/_vendor/zod-to-json-schema/parsers/tuple.ts +23 -16
- package/src/_vendor/zod-to-json-schema/zodToJsonSchema.ts +11 -6
- package/src/auth/subject-token-providers.ts +12 -7
- package/src/auth/workload-identity-auth.ts +27 -12
- package/src/azure.ts +34 -3
- package/src/beta/realtime/internal-base.ts +3 -2
- package/src/beta/realtime/websocket.ts +17 -7
- package/src/beta/realtime/ws.ts +9 -5
- package/src/client.ts +19 -4
- package/src/core/EventEmitter.ts +5 -8
- package/src/core/pagination.ts +1 -1
- package/src/core/streaming.ts +69 -13
- package/src/helpers/audio.ts +27 -6
- package/src/helpers/zod.ts +78 -29
- package/src/internal/bedrock.ts +84 -58
- package/src/internal/detect-platform.ts +2 -2
- package/src/internal/errors.ts +3 -2
- package/src/internal/headers.ts +7 -5
- package/src/internal/parse.ts +1 -1
- package/src/internal/realtime-credentials.ts +27 -0
- package/src/internal/responses/response-accumulator.ts +1 -0
- package/src/internal/to-file.ts +6 -5
- package/src/internal/uploads.ts +12 -1
- package/src/internal/utils/base64.ts +3 -0
- package/src/lib/AbstractChatCompletionRunner.ts +31 -6
- package/src/lib/AssistantStream.ts +25 -11
- package/src/lib/ChatCompletionRunner.ts +8 -4
- package/src/lib/ChatCompletionStream.ts +8 -0
- package/src/lib/ChatCompletionStreamingRunner.ts +1 -0
- package/src/lib/EventEmitter.ts +17 -8
- package/src/lib/EventStream.ts +105 -52
- package/src/lib/ResponsesParser.ts +33 -12
- package/src/lib/RunnableFunction.ts +2 -2
- package/src/lib/embeddings.ts +18 -12
- package/src/lib/file-processing.ts +5 -4
- package/src/lib/parser.ts +35 -11
- package/src/lib/polling.ts +5 -4
- package/src/lib/responses/EventTypes.ts +3 -69
- package/src/lib/responses/ResponseInputItems.ts +29 -4
- package/src/lib/transform.ts +1 -0
- package/src/lib/vector-store-polling.ts +3 -3
- package/src/lib/vector-store-upload.ts +5 -1
- package/src/providers/bedrock/aws.ts +23 -24
- package/src/realtime/internal-base.ts +3 -5
- package/src/realtime/websocket.ts +14 -6
- package/src/realtime/ws.ts +9 -4
- 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/api-keys.ts +11 -0
- 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 +315 -192
- 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 +14 -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 +86 -67
- 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 +309 -185
- 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 +12 -6
- 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,19 +991,23 @@ 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;
|
|
1003
|
+
/**
|
|
1004
|
+
* Prompt cache diagnostics requested for this response.
|
|
1005
|
+
*/
|
|
1006
|
+
prompt_cache_diagnostics?: BetaResponse.CacheMiss | BetaResponse.CacheHit | BetaResponse.ComparisonResponseNotFound | BetaResponse.Unavailable;
|
|
1002
1007
|
/**
|
|
1003
1008
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
1004
1009
|
* hit rates. Replaces the `user` field.
|
|
1005
|
-
* [Learn more](https://
|
|
1010
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
1006
1011
|
*/
|
|
1007
1012
|
prompt_cache_key?: string | null;
|
|
1008
1013
|
/**
|
|
@@ -1016,7 +1021,7 @@ export interface BetaResponse {
|
|
|
1016
1021
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
1017
1022
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
1018
1023
|
* of 24 hours.
|
|
1019
|
-
* [Learn more](https://
|
|
1024
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
1020
1025
|
* This field expresses a maximum retention policy, while
|
|
1021
1026
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
1022
1027
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -1032,7 +1037,7 @@ export interface BetaResponse {
|
|
|
1032
1037
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
1033
1038
|
/**
|
|
1034
1039
|
* Configuration options for
|
|
1035
|
-
* [reasoning models](https://
|
|
1040
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
1036
1041
|
*/
|
|
1037
1042
|
reasoning?: BetaResponse.Reasoning | null;
|
|
1038
1043
|
/**
|
|
@@ -1041,7 +1046,7 @@ export interface BetaResponse {
|
|
|
1041
1046
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
1042
1047
|
* hashing their username or email address, in order to avoid sending us any
|
|
1043
1048
|
* identifying information.
|
|
1044
|
-
* [Learn more](https://
|
|
1049
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
1045
1050
|
*/
|
|
1046
1051
|
safety_identifier?: string | null;
|
|
1047
1052
|
/**
|
|
@@ -1052,13 +1057,15 @@ export interface BetaResponse {
|
|
|
1052
1057
|
* will use 'default'.
|
|
1053
1058
|
* - If set to 'default', then the request will be processed with the standard
|
|
1054
1059
|
* pricing and performance for the selected model.
|
|
1055
|
-
* - If set to
|
|
1056
|
-
* then
|
|
1057
|
-
*
|
|
1058
|
-
*
|
|
1059
|
-
*
|
|
1060
|
-
*
|
|
1061
|
-
*
|
|
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.
|
|
1062
1069
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
1063
1070
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
1064
1071
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -1080,8 +1087,8 @@ export interface BetaResponse {
|
|
|
1080
1087
|
* Configuration options for a text response from the model. Can be plain text or
|
|
1081
1088
|
* structured JSON data. Learn more:
|
|
1082
1089
|
*
|
|
1083
|
-
* - [Text inputs and outputs](https://
|
|
1084
|
-
* - [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)
|
|
1085
1092
|
*/
|
|
1086
1093
|
text?: BetaResponseTextConfig;
|
|
1087
1094
|
/**
|
|
@@ -1111,7 +1118,7 @@ export interface BetaResponse {
|
|
|
1111
1118
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
1112
1119
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
1113
1120
|
* abuse.
|
|
1114
|
-
* [Learn more](https://
|
|
1121
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
1115
1122
|
*/
|
|
1116
1123
|
user?: string;
|
|
1117
1124
|
}
|
|
@@ -1267,6 +1274,31 @@ export declare namespace BetaResponse {
|
|
|
1267
1274
|
type: 'error';
|
|
1268
1275
|
}
|
|
1269
1276
|
}
|
|
1277
|
+
interface CacheMiss {
|
|
1278
|
+
/**
|
|
1279
|
+
* The estimated number of input tokens affected after the first detected
|
|
1280
|
+
* divergence.
|
|
1281
|
+
*/
|
|
1282
|
+
cache_missed_tokens: number;
|
|
1283
|
+
/**
|
|
1284
|
+
* The reason prompt cache reuse did not occur.
|
|
1285
|
+
*/
|
|
1286
|
+
reason: 'model_changed' | 'prompt_cache_key_changed' | 'tools_changed' | 'text_format_changed' | 'reasoning_effort_changed' | 'verbosity_changed' | 'context_compacted' | 'input_changed' | 'service_tier_changed';
|
|
1287
|
+
type: 'cache_miss';
|
|
1288
|
+
/**
|
|
1289
|
+
* The raw token count of the reusable prefix in the compared response.
|
|
1290
|
+
*/
|
|
1291
|
+
comparison_reusable_tokens?: number;
|
|
1292
|
+
}
|
|
1293
|
+
interface CacheHit {
|
|
1294
|
+
type: 'cache_hit';
|
|
1295
|
+
}
|
|
1296
|
+
interface ComparisonResponseNotFound {
|
|
1297
|
+
type: 'comparison_response_not_found';
|
|
1298
|
+
}
|
|
1299
|
+
interface Unavailable {
|
|
1300
|
+
type: 'unavailable';
|
|
1301
|
+
}
|
|
1270
1302
|
/**
|
|
1271
1303
|
* The prompt-caching options that were applied to the response. Supported for
|
|
1272
1304
|
* `gpt-5.6` and later models.
|
|
@@ -1280,10 +1312,14 @@ export declare namespace BetaResponse {
|
|
|
1280
1312
|
* The minimum lifetime applied to each cache breakpoint.
|
|
1281
1313
|
*/
|
|
1282
1314
|
ttl: '30m';
|
|
1315
|
+
/**
|
|
1316
|
+
* The response ID supplied as the prompt cache diagnostics comparison.
|
|
1317
|
+
*/
|
|
1318
|
+
comparison_response_id?: string | null;
|
|
1283
1319
|
}
|
|
1284
1320
|
/**
|
|
1285
1321
|
* Configuration options for
|
|
1286
|
-
* [reasoning models](https://
|
|
1322
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
1287
1323
|
*/
|
|
1288
1324
|
interface Reasoning {
|
|
1289
1325
|
/**
|
|
@@ -1300,7 +1336,7 @@ export declare namespace BetaResponse {
|
|
|
1300
1336
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
1301
1337
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
1302
1338
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
1303
|
-
* [reasoning guide](https://
|
|
1339
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
1304
1340
|
* model-specific support.
|
|
1305
1341
|
*/
|
|
1306
1342
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
|
|
@@ -1881,7 +1917,7 @@ export declare namespace BetaResponseCodeInterpreterToolCall {
|
|
|
1881
1917
|
}
|
|
1882
1918
|
/**
|
|
1883
1919
|
* A compaction item generated by the
|
|
1884
|
-
* [`v1/responses/compact` API](https://
|
|
1920
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
1885
1921
|
*/
|
|
1886
1922
|
export interface BetaResponseCompactionItem {
|
|
1887
1923
|
/**
|
|
@@ -1918,7 +1954,7 @@ export declare namespace BetaResponseCompactionItem {
|
|
|
1918
1954
|
}
|
|
1919
1955
|
/**
|
|
1920
1956
|
* A compaction item generated by the
|
|
1921
|
-
* [`v1/responses/compact` API](https://
|
|
1957
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
1922
1958
|
*/
|
|
1923
1959
|
export interface BetaResponseCompactionItemParam {
|
|
1924
1960
|
/**
|
|
@@ -1983,7 +2019,7 @@ export declare namespace BetaResponseCompletedEvent {
|
|
|
1983
2019
|
}
|
|
1984
2020
|
/**
|
|
1985
2021
|
* A tool call to a computer use tool. See the
|
|
1986
|
-
* [computer use guide](https://
|
|
2022
|
+
* [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use)
|
|
1987
2023
|
* for more information.
|
|
1988
2024
|
*/
|
|
1989
2025
|
export interface BetaResponseComputerToolCall {
|
|
@@ -2861,7 +2897,7 @@ export declare namespace BetaResponseFileSearchCallSearchingEvent {
|
|
|
2861
2897
|
}
|
|
2862
2898
|
/**
|
|
2863
2899
|
* The results of a file search tool call. See the
|
|
2864
|
-
* [file search guide](https://
|
|
2900
|
+
* [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
2865
2901
|
* for more information.
|
|
2866
2902
|
*/
|
|
2867
2903
|
export interface BetaResponseFileSearchToolCall {
|
|
@@ -2935,7 +2971,7 @@ export declare namespace BetaResponseFileSearchToolCall {
|
|
|
2935
2971
|
*
|
|
2936
2972
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
2937
2973
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
2938
|
-
* [Structured Outputs guide](https://
|
|
2974
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
2939
2975
|
*
|
|
2940
2976
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
2941
2977
|
*
|
|
@@ -2971,7 +3007,7 @@ export declare namespace BetaResponseFormatTextConfig {
|
|
|
2971
3007
|
/**
|
|
2972
3008
|
* JSON Schema response format. Used to generate structured JSON responses. Learn
|
|
2973
3009
|
* more about
|
|
2974
|
-
* [Structured Outputs](https://
|
|
3010
|
+
* [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
2975
3011
|
*/
|
|
2976
3012
|
export interface BetaResponseFormatTextJSONSchemaConfig {
|
|
2977
3013
|
/**
|
|
@@ -3000,7 +3036,7 @@ export interface BetaResponseFormatTextJSONSchemaConfig {
|
|
|
3000
3036
|
* true, the model will always follow the exact schema defined in the `schema`
|
|
3001
3037
|
* field. Only a subset of JSON Schema is supported when `strict` is `true`. To
|
|
3002
3038
|
* learn more, read the
|
|
3003
|
-
* [Structured Outputs guide](https://
|
|
3039
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
3004
3040
|
*/
|
|
3005
3041
|
strict?: boolean | null;
|
|
3006
3042
|
}
|
|
@@ -3056,10 +3092,6 @@ export interface BetaResponseFunctionCallArgumentsDoneEvent {
|
|
|
3056
3092
|
* The ID of the item.
|
|
3057
3093
|
*/
|
|
3058
3094
|
item_id: string;
|
|
3059
|
-
/**
|
|
3060
|
-
* The name of the function that was called.
|
|
3061
|
-
*/
|
|
3062
|
-
name: string;
|
|
3063
3095
|
/**
|
|
3064
3096
|
* The index of the output item.
|
|
3065
3097
|
*/
|
|
@@ -3325,7 +3357,7 @@ export declare namespace BetaResponseFunctionShellToolCallOutput {
|
|
|
3325
3357
|
}
|
|
3326
3358
|
/**
|
|
3327
3359
|
* A tool call to run a function. See the
|
|
3328
|
-
* [function calling guide](https://
|
|
3360
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
3329
3361
|
* for more information.
|
|
3330
3362
|
*/
|
|
3331
3363
|
export interface BetaResponseFunctionToolCall {
|
|
@@ -3394,7 +3426,7 @@ export declare namespace BetaResponseFunctionToolCall {
|
|
|
3394
3426
|
}
|
|
3395
3427
|
/**
|
|
3396
3428
|
* A tool call to run a function. See the
|
|
3397
|
-
* [function calling guide](https://
|
|
3429
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
3398
3430
|
* for more information.
|
|
3399
3431
|
*/
|
|
3400
3432
|
export interface BetaResponseFunctionToolCallItem extends BetaResponseFunctionToolCall {
|
|
@@ -3485,8 +3517,8 @@ export declare namespace BetaResponseFunctionToolCallOutputItem {
|
|
|
3485
3517
|
}
|
|
3486
3518
|
/**
|
|
3487
3519
|
* The results of a web search tool call. See the
|
|
3488
|
-
* [web search guide](https://
|
|
3489
|
-
* more information.
|
|
3520
|
+
* [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
3521
|
+
* for more information.
|
|
3490
3522
|
*/
|
|
3491
3523
|
export interface BetaResponseFunctionWebSearch {
|
|
3492
3524
|
/**
|
|
@@ -3501,7 +3533,7 @@ export interface BetaResponseFunctionWebSearch {
|
|
|
3501
3533
|
/**
|
|
3502
3534
|
* The status of the web search tool call.
|
|
3503
3535
|
*/
|
|
3504
|
-
status: 'in_progress' | 'searching' | 'completed' | 'failed';
|
|
3536
|
+
status: 'in_progress' | 'searching' | 'completed' | 'failed' | 'incomplete';
|
|
3505
3537
|
/**
|
|
3506
3538
|
* The type of the web search tool call. Always `web_search_call`.
|
|
3507
3539
|
*/
|
|
@@ -4076,7 +4108,7 @@ export declare namespace BetaResponseInputFileContent {
|
|
|
4076
4108
|
}
|
|
4077
4109
|
/**
|
|
4078
4110
|
* An image input to the model. Learn about
|
|
4079
|
-
* [image inputs](https://
|
|
4111
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision).
|
|
4080
4112
|
*/
|
|
4081
4113
|
export interface BetaResponseInputImage {
|
|
4082
4114
|
/**
|
|
@@ -4119,7 +4151,7 @@ export declare namespace BetaResponseInputImage {
|
|
|
4119
4151
|
}
|
|
4120
4152
|
/**
|
|
4121
4153
|
* An image input to the model. Learn about
|
|
4122
|
-
* [image inputs](https://
|
|
4154
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
4123
4155
|
*/
|
|
4124
4156
|
export interface BetaResponseInputImageContent {
|
|
4125
4157
|
/**
|
|
@@ -4650,6 +4682,15 @@ export declare namespace BetaResponseInputItem {
|
|
|
4650
4682
|
* The agent that produced this item.
|
|
4651
4683
|
*/
|
|
4652
4684
|
agent?: ImageGenerationCall.Agent | null;
|
|
4685
|
+
/**
|
|
4686
|
+
* The quality of the image generated by the image generation tool call. One of
|
|
4687
|
+
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
4688
|
+
*/
|
|
4689
|
+
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
4690
|
+
/**
|
|
4691
|
+
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
4692
|
+
*/
|
|
4693
|
+
size?: (string & {}) | '1024x1024' | '1024x1536' | '1536x1024' | null;
|
|
4653
4694
|
}
|
|
4654
4695
|
namespace ImageGenerationCall {
|
|
4655
4696
|
/**
|
|
@@ -5863,6 +5904,15 @@ export declare namespace BetaResponseItem {
|
|
|
5863
5904
|
* The agent that produced this item.
|
|
5864
5905
|
*/
|
|
5865
5906
|
agent?: ImageGenerationCall.Agent | null;
|
|
5907
|
+
/**
|
|
5908
|
+
* The quality of the image generated by the image generation tool call. One of
|
|
5909
|
+
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
5910
|
+
*/
|
|
5911
|
+
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
5912
|
+
/**
|
|
5913
|
+
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
5914
|
+
*/
|
|
5915
|
+
size?: (string & {}) | '1024x1024' | '1024x1536' | '1536x1024' | null;
|
|
5866
5916
|
}
|
|
5867
5917
|
namespace ImageGenerationCall {
|
|
5868
5918
|
/**
|
|
@@ -6844,6 +6894,15 @@ export declare namespace BetaResponseOutputItem {
|
|
|
6844
6894
|
* The agent that produced this item.
|
|
6845
6895
|
*/
|
|
6846
6896
|
agent?: ImageGenerationCall.Agent | null;
|
|
6897
|
+
/**
|
|
6898
|
+
* The quality of the image generated by the image generation tool call. One of
|
|
6899
|
+
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
6900
|
+
*/
|
|
6901
|
+
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
6902
|
+
/**
|
|
6903
|
+
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
6904
|
+
*/
|
|
6905
|
+
size?: (string & {}) | '1024x1024' | '1024x1536' | '1536x1024' | null;
|
|
6847
6906
|
}
|
|
6848
6907
|
namespace ImageGenerationCall {
|
|
6849
6908
|
/**
|
|
@@ -7573,7 +7632,7 @@ export declare namespace BetaResponseOutputTextAnnotationAddedEvent {
|
|
|
7573
7632
|
}
|
|
7574
7633
|
/**
|
|
7575
7634
|
* Reference to a prompt template and its variables.
|
|
7576
|
-
* [Learn more](https://
|
|
7635
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
7577
7636
|
*/
|
|
7578
7637
|
export interface BetaResponsePrompt {
|
|
7579
7638
|
/**
|
|
@@ -7629,7 +7688,7 @@ export declare namespace BetaResponseQueuedEvent {
|
|
|
7629
7688
|
* A description of the chain of thought used by a reasoning model while generating
|
|
7630
7689
|
* a response. Be sure to include these items in your `input` to the Responses API
|
|
7631
7690
|
* for subsequent turns of a conversation if you are manually
|
|
7632
|
-
* [managing context](https://
|
|
7691
|
+
* [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
7633
7692
|
*/
|
|
7634
7693
|
export interface BetaResponseReasoningItem {
|
|
7635
7694
|
/**
|
|
@@ -8844,8 +8903,8 @@ export type BetaResponseStreamEvent = BetaResponseAudioDeltaEvent | BetaResponse
|
|
|
8844
8903
|
* Configuration options for a text response from the model. Can be plain text or
|
|
8845
8904
|
* structured JSON data. Learn more:
|
|
8846
8905
|
*
|
|
8847
|
-
* - [Text inputs and outputs](https://
|
|
8848
|
-
* - [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)
|
|
8849
8908
|
*/
|
|
8850
8909
|
export interface BetaResponseTextConfig {
|
|
8851
8910
|
/**
|
|
@@ -8853,7 +8912,7 @@ export interface BetaResponseTextConfig {
|
|
|
8853
8912
|
*
|
|
8854
8913
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
8855
8914
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
8856
|
-
* [Structured Outputs guide](https://
|
|
8915
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
8857
8916
|
*
|
|
8858
8917
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
8859
8918
|
*
|
|
@@ -9198,7 +9257,7 @@ export declare namespace BetaResponseUsage {
|
|
|
9198
9257
|
cache_write_tokens: number;
|
|
9199
9258
|
/**
|
|
9200
9259
|
* The number of tokens that were retrieved from the cache.
|
|
9201
|
-
* [More on prompt caching](https://
|
|
9260
|
+
* [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
9202
9261
|
*/
|
|
9203
9262
|
cached_tokens: number;
|
|
9204
9263
|
}
|
|
@@ -9343,7 +9402,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9343
9402
|
type: 'response.create';
|
|
9344
9403
|
/**
|
|
9345
9404
|
* Whether to run the model response in the background.
|
|
9346
|
-
* [Learn more](https://
|
|
9405
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
9347
9406
|
*/
|
|
9348
9407
|
background?: boolean | null;
|
|
9349
9408
|
/**
|
|
@@ -9383,11 +9442,11 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9383
9442
|
*
|
|
9384
9443
|
* Learn more:
|
|
9385
9444
|
*
|
|
9386
|
-
* - [Text inputs and outputs](https://
|
|
9387
|
-
* - [Image inputs](https://
|
|
9388
|
-
* - [File inputs](https://
|
|
9389
|
-
* - [Conversation state](https://
|
|
9390
|
-
* - [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)
|
|
9391
9450
|
*/
|
|
9392
9451
|
input?: string | ResponsesAPI.BetaResponseInput;
|
|
9393
9452
|
/**
|
|
@@ -9401,7 +9460,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9401
9460
|
/**
|
|
9402
9461
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
9403
9462
|
* including visible output tokens and
|
|
9404
|
-
* [reasoning tokens](https://
|
|
9463
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
9405
9464
|
*/
|
|
9406
9465
|
max_output_tokens?: number | null;
|
|
9407
9466
|
/**
|
|
@@ -9426,8 +9485,8 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9426
9485
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
9427
9486
|
* range of models with different capabilities, performance characteristics, and
|
|
9428
9487
|
* price points. Refer to the
|
|
9429
|
-
* [model guide](https://
|
|
9430
|
-
* available models.
|
|
9488
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
9489
|
+
* compare available models.
|
|
9431
9490
|
*/
|
|
9432
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 & {});
|
|
9433
9492
|
/**
|
|
@@ -9445,19 +9504,19 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9445
9504
|
/**
|
|
9446
9505
|
* The unique ID of the previous response to the model. Use this to create
|
|
9447
9506
|
* multi-turn conversations. Learn more about
|
|
9448
|
-
* [conversation state](https://
|
|
9507
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
9449
9508
|
* Cannot be used in conjunction with `conversation`.
|
|
9450
9509
|
*/
|
|
9451
9510
|
previous_response_id?: string | null;
|
|
9452
9511
|
/**
|
|
9453
9512
|
* Reference to a prompt template and its variables.
|
|
9454
|
-
* [Learn more](https://
|
|
9513
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
9455
9514
|
*/
|
|
9456
9515
|
prompt?: ResponsesAPI.BetaResponsePrompt | null;
|
|
9457
9516
|
/**
|
|
9458
9517
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
9459
9518
|
* hit rates. Replaces the `user` field.
|
|
9460
|
-
* [Learn more](https://
|
|
9519
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
9461
9520
|
*/
|
|
9462
9521
|
prompt_cache_key?: string | null;
|
|
9463
9522
|
/**
|
|
@@ -9468,7 +9527,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9468
9527
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
9469
9528
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
9470
9529
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
9471
|
-
* [prompt caching guide](https://
|
|
9530
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
9472
9531
|
* for current details.
|
|
9473
9532
|
*/
|
|
9474
9533
|
prompt_cache_options?: ResponseCreate.PromptCacheOptions;
|
|
@@ -9478,7 +9537,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9478
9537
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
9479
9538
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
9480
9539
|
* of 24 hours.
|
|
9481
|
-
* [Learn more](https://
|
|
9540
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
9482
9541
|
* This field expresses a maximum retention policy, while
|
|
9483
9542
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
9484
9543
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -9494,7 +9553,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9494
9553
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
9495
9554
|
/**
|
|
9496
9555
|
* Configuration options for
|
|
9497
|
-
* [reasoning models](https://
|
|
9556
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
9498
9557
|
*/
|
|
9499
9558
|
reasoning?: ResponseCreate.Reasoning | null;
|
|
9500
9559
|
/**
|
|
@@ -9503,7 +9562,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9503
9562
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
9504
9563
|
* hashing their username or email address, in order to avoid sending us any
|
|
9505
9564
|
* identifying information.
|
|
9506
|
-
* [Learn more](https://
|
|
9565
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
9507
9566
|
*/
|
|
9508
9567
|
safety_identifier?: string | null;
|
|
9509
9568
|
/**
|
|
@@ -9514,13 +9573,15 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9514
9573
|
* will use 'default'.
|
|
9515
9574
|
* - If set to 'default', then the request will be processed with the standard
|
|
9516
9575
|
* pricing and performance for the selected model.
|
|
9517
|
-
* - If set to
|
|
9518
|
-
* then
|
|
9519
|
-
*
|
|
9520
|
-
*
|
|
9521
|
-
*
|
|
9522
|
-
*
|
|
9523
|
-
*
|
|
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.
|
|
9524
9585
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
9525
9586
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
9526
9587
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -9535,6 +9596,9 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9535
9596
|
service_tier?: ResponsesAPI.BetaServiceTier | null;
|
|
9536
9597
|
/**
|
|
9537
9598
|
* Whether to store the generated model response for later retrieval via API.
|
|
9599
|
+
* Defaults to true when omitted. If set to true, response data will be stored for
|
|
9600
|
+
* at least 30 days, subject to the
|
|
9601
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
9538
9602
|
*/
|
|
9539
9603
|
store?: boolean | null;
|
|
9540
9604
|
/**
|
|
@@ -9542,7 +9606,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9542
9606
|
* generated using
|
|
9543
9607
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
9544
9608
|
* See the
|
|
9545
|
-
* [Streaming section below](https://
|
|
9609
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
9546
9610
|
* for more information.
|
|
9547
9611
|
*/
|
|
9548
9612
|
stream?: boolean | null;
|
|
@@ -9569,8 +9633,8 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9569
9633
|
* Configuration options for a text response from the model. Can be plain text or
|
|
9570
9634
|
* structured JSON data. Learn more:
|
|
9571
9635
|
*
|
|
9572
|
-
* - [Text inputs and outputs](https://
|
|
9573
|
-
* - [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)
|
|
9574
9638
|
*/
|
|
9575
9639
|
text?: ResponsesAPI.BetaResponseTextConfig;
|
|
9576
9640
|
/**
|
|
@@ -9587,17 +9651,18 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9587
9651
|
*
|
|
9588
9652
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
9589
9653
|
* capabilities, like
|
|
9590
|
-
* [web search](https://
|
|
9591
|
-
*
|
|
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).
|
|
9592
9657
|
* Learn more about
|
|
9593
|
-
* [built-in tools](https://
|
|
9658
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
9594
9659
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
9595
9660
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
9596
|
-
* [MCP Tools](https://
|
|
9661
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
9597
9662
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
9598
9663
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
9599
9664
|
* Learn more about
|
|
9600
|
-
* [function calling](https://
|
|
9665
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
9601
9666
|
* You can also use custom tools to call your own code.
|
|
9602
9667
|
*/
|
|
9603
9668
|
tools?: Array<ResponsesAPI.BetaTool>;
|
|
@@ -9631,7 +9696,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9631
9696
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
9632
9697
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
9633
9698
|
* abuse.
|
|
9634
|
-
* [Learn more](https://
|
|
9699
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
9635
9700
|
*/
|
|
9636
9701
|
user?: string;
|
|
9637
9702
|
}
|
|
@@ -9715,10 +9780,15 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9715
9780
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
9716
9781
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
9717
9782
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
9718
|
-
* [prompt caching guide](https://
|
|
9783
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
9719
9784
|
* for current details.
|
|
9720
9785
|
*/
|
|
9721
9786
|
interface PromptCacheOptions {
|
|
9787
|
+
/**
|
|
9788
|
+
* The ID of a response to compare when diagnosing prompt cache reuse. Supplying
|
|
9789
|
+
* this field requests prompt cache diagnostics when the feature is enabled.
|
|
9790
|
+
*/
|
|
9791
|
+
comparison_response_id?: string | null;
|
|
9722
9792
|
/**
|
|
9723
9793
|
* Controls whether OpenAI automatically creates an implicit cache breakpoint.
|
|
9724
9794
|
* Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
|
|
@@ -9737,7 +9807,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9737
9807
|
}
|
|
9738
9808
|
/**
|
|
9739
9809
|
* Configuration options for
|
|
9740
|
-
* [reasoning models](https://
|
|
9810
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
9741
9811
|
*/
|
|
9742
9812
|
interface Reasoning {
|
|
9743
9813
|
/**
|
|
@@ -9754,7 +9824,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9754
9824
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
9755
9825
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
9756
9826
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
9757
|
-
* [reasoning guide](https://
|
|
9827
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
9758
9828
|
* model-specific support.
|
|
9759
9829
|
*/
|
|
9760
9830
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
|
|
@@ -10502,13 +10572,15 @@ export declare namespace BetaResponsesServerEvent {
|
|
|
10502
10572
|
* will use 'default'.
|
|
10503
10573
|
* - If set to 'default', then the request will be processed with the standard
|
|
10504
10574
|
* pricing and performance for the selected model.
|
|
10505
|
-
* - If set to
|
|
10506
|
-
* then
|
|
10507
|
-
*
|
|
10508
|
-
*
|
|
10509
|
-
*
|
|
10510
|
-
*
|
|
10511
|
-
*
|
|
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.
|
|
10512
10584
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
10513
10585
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
10514
10586
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -10543,7 +10615,7 @@ export declare namespace BetaTool {
|
|
|
10543
10615
|
/**
|
|
10544
10616
|
* Give the model access to additional tools via remote Model Context Protocol
|
|
10545
10617
|
* (MCP) servers.
|
|
10546
|
-
* [Learn more about MCP](https://
|
|
10618
|
+
* [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
10547
10619
|
*/
|
|
10548
10620
|
interface Mcp {
|
|
10549
10621
|
/**
|
|
@@ -10572,7 +10644,7 @@ export declare namespace BetaTool {
|
|
|
10572
10644
|
* Identifier for service connectors, like those available in ChatGPT. One of
|
|
10573
10645
|
* `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
|
|
10574
10646
|
* service connectors
|
|
10575
|
-
* [here](https://
|
|
10647
|
+
* [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
|
|
10576
10648
|
*
|
|
10577
10649
|
* Currently supported `connector_id` values are:
|
|
10578
10650
|
*
|
|
@@ -10748,9 +10820,11 @@ export declare namespace BetaTool {
|
|
|
10748
10820
|
* one of `transparent`, `opaque`, or `auto` (default value). When `auto` is used,
|
|
10749
10821
|
* the model will automatically determine the best background for the image.
|
|
10750
10822
|
*
|
|
10751
|
-
*
|
|
10752
|
-
* `
|
|
10753
|
-
*
|
|
10823
|
+
* `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their `2026-09-08`
|
|
10824
|
+
* snapshots, support `opaque` and `transparent` backgrounds. Transparent
|
|
10825
|
+
* backgrounds are available for supported GPT Image models. For `gpt-image-2` and
|
|
10826
|
+
* `gpt-image-2-2026-04-21`, this support is in preview. When using `transparent`,
|
|
10827
|
+
* set the output format to `png` or `webp`.
|
|
10754
10828
|
*/
|
|
10755
10829
|
background?: 'transparent' | 'opaque' | 'auto';
|
|
10756
10830
|
/**
|
|
@@ -10767,10 +10841,12 @@ export declare namespace BetaTool {
|
|
|
10767
10841
|
input_image_mask?: ImageGeneration.InputImageMask;
|
|
10768
10842
|
/**
|
|
10769
10843
|
* The image generation model to use. One of `gpt-image-1`, `gpt-image-1-mini`,
|
|
10770
|
-
* `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`,
|
|
10844
|
+
* `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`,
|
|
10845
|
+
* `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
|
|
10846
|
+
* `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`, or
|
|
10771
10847
|
* `chatgpt-image-latest`. Default: `gpt-image-1`.
|
|
10772
10848
|
*/
|
|
10773
|
-
model?: (string & {}) | 'gpt-image-1' | 'gpt-image-1-mini' | 'gpt-image-2' | 'gpt-image-2-2026-04-21' | 'gpt-image-1.5' | 'chatgpt-image-latest';
|
|
10849
|
+
model?: (string & {}) | 'gpt-image-1' | 'gpt-image-1-mini' | 'gpt-image-2' | 'gpt-image-2-2026-04-21' | 'gpt-image-2.5-sunburst' | 'gpt-image-2.5-sunburst-2026-09-08' | 'gpt-image-2.5-flare' | 'gpt-image-2.5-flare-2026-09-08' | 'gpt-image-1.5' | 'chatgpt-image-latest';
|
|
10774
10850
|
/**
|
|
10775
10851
|
* Moderation level for the generated image. Default: `auto`.
|
|
10776
10852
|
*/
|
|
@@ -10790,22 +10866,25 @@ export declare namespace BetaTool {
|
|
|
10790
10866
|
*/
|
|
10791
10867
|
partial_images?: number;
|
|
10792
10868
|
/**
|
|
10793
|
-
* The quality of the generated image.
|
|
10794
|
-
*
|
|
10795
|
-
|
|
10796
|
-
|
|
10797
|
-
|
|
10798
|
-
|
|
10799
|
-
|
|
10800
|
-
*
|
|
10801
|
-
*
|
|
10802
|
-
* `
|
|
10803
|
-
*
|
|
10804
|
-
*
|
|
10805
|
-
*
|
|
10806
|
-
*
|
|
10807
|
-
*
|
|
10808
|
-
* `
|
|
10869
|
+
* The quality of the generated image. The GPT image models support `low`,
|
|
10870
|
+
* `medium`, and `high`. `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`,
|
|
10871
|
+
* including their `2026-09-08` snapshots, also support `xhigh` and `max`. Default:
|
|
10872
|
+
* `auto`.
|
|
10873
|
+
*/
|
|
10874
|
+
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto';
|
|
10875
|
+
/**
|
|
10876
|
+
* The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
|
|
10877
|
+
* `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
|
|
10878
|
+
* `gpt-image-2.5-flare`, and `gpt-image-2.5-flare-2026-09-08`, arbitrary
|
|
10879
|
+
* resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`.
|
|
10880
|
+
* Width and height must both be divisible by 16 and the requested aspect ratio
|
|
10881
|
+
* must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and
|
|
10882
|
+
* the maximum supported resolution is `3840x2160`. The requested size must also
|
|
10883
|
+
* satisfy the model's current pixel and edge limits. The standard sizes
|
|
10884
|
+
* `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
|
|
10885
|
+
* `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
|
|
10886
|
+
* one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
|
|
10887
|
+
* `1024x1024`, `1792x1024`, or `1024x1792`.
|
|
10809
10888
|
*/
|
|
10810
10889
|
size?: (string & {}) | '1024x1024' | '1024x1536' | '1536x1024' | 'auto';
|
|
10811
10890
|
}
|
|
@@ -10944,12 +11023,12 @@ export interface BetaToolChoiceShell {
|
|
|
10944
11023
|
}
|
|
10945
11024
|
/**
|
|
10946
11025
|
* Indicates that the model should use a built-in tool to generate a response.
|
|
10947
|
-
* [Learn more about built-in tools](https://
|
|
11026
|
+
* [Learn more about built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
10948
11027
|
*/
|
|
10949
11028
|
export interface BetaToolChoiceTypes {
|
|
10950
11029
|
/**
|
|
10951
11030
|
* The type of hosted tool the model should to use. Learn more about
|
|
10952
|
-
* [built-in tools](https://
|
|
11031
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
10953
11032
|
*
|
|
10954
11033
|
* Allowed values are:
|
|
10955
11034
|
*
|
|
@@ -10987,7 +11066,7 @@ export interface BetaToolSearchTool {
|
|
|
10987
11066
|
/**
|
|
10988
11067
|
* This tool searches the web for relevant results to use in a response. Learn more
|
|
10989
11068
|
* about the
|
|
10990
|
-
* [web search tool](https://
|
|
11069
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
10991
11070
|
*/
|
|
10992
11071
|
export interface BetaWebSearchPreviewTool {
|
|
10993
11072
|
/**
|
|
@@ -11037,7 +11116,7 @@ export declare namespace BetaWebSearchPreviewTool {
|
|
|
11037
11116
|
}
|
|
11038
11117
|
/**
|
|
11039
11118
|
* Search the Internet for sources related to the prompt. Learn more about the
|
|
11040
|
-
* [web search tool](https://
|
|
11119
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
11041
11120
|
*/
|
|
11042
11121
|
export interface BetaWebSearchTool {
|
|
11043
11122
|
/**
|
|
@@ -11109,7 +11188,7 @@ export type ResponseCreateParams = ResponseCreateParamsNonStreaming | ResponseCr
|
|
|
11109
11188
|
export interface ResponseCreateParamsBase {
|
|
11110
11189
|
/**
|
|
11111
11190
|
* Body param: Whether to run the model response in the background.
|
|
11112
|
-
* [Learn more](https://
|
|
11191
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
11113
11192
|
*/
|
|
11114
11193
|
background?: boolean | null;
|
|
11115
11194
|
/**
|
|
@@ -11150,11 +11229,11 @@ export interface ResponseCreateParamsBase {
|
|
|
11150
11229
|
*
|
|
11151
11230
|
* Learn more:
|
|
11152
11231
|
*
|
|
11153
|
-
* - [Text inputs and outputs](https://
|
|
11154
|
-
* - [Image inputs](https://
|
|
11155
|
-
* - [File inputs](https://
|
|
11156
|
-
* - [Conversation state](https://
|
|
11157
|
-
* - [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)
|
|
11158
11237
|
*/
|
|
11159
11238
|
input?: string | BetaResponseInput;
|
|
11160
11239
|
/**
|
|
@@ -11168,7 +11247,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11168
11247
|
/**
|
|
11169
11248
|
* Body param: An upper bound for the number of tokens that can be generated for a
|
|
11170
11249
|
* response, including visible output tokens and
|
|
11171
|
-
* [reasoning tokens](https://
|
|
11250
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
11172
11251
|
*/
|
|
11173
11252
|
max_output_tokens?: number | null;
|
|
11174
11253
|
/**
|
|
@@ -11193,8 +11272,8 @@ export interface ResponseCreateParamsBase {
|
|
|
11193
11272
|
* Body param: Model ID used to generate the response, like `gpt-6-astra`. OpenAI
|
|
11194
11273
|
* offers a wide range of models with different capabilities, performance
|
|
11195
11274
|
* characteristics, and price points. Refer to the
|
|
11196
|
-
* [model guide](https://
|
|
11197
|
-
* available models.
|
|
11275
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
11276
|
+
* compare available models.
|
|
11198
11277
|
*/
|
|
11199
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 & {});
|
|
11200
11279
|
/**
|
|
@@ -11213,19 +11292,19 @@ export interface ResponseCreateParamsBase {
|
|
|
11213
11292
|
/**
|
|
11214
11293
|
* Body param: The unique ID of the previous response to the model. Use this to
|
|
11215
11294
|
* create multi-turn conversations. Learn more about
|
|
11216
|
-
* [conversation state](https://
|
|
11295
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
11217
11296
|
* Cannot be used in conjunction with `conversation`.
|
|
11218
11297
|
*/
|
|
11219
11298
|
previous_response_id?: string | null;
|
|
11220
11299
|
/**
|
|
11221
11300
|
* Body param: Reference to a prompt template and its variables.
|
|
11222
|
-
* [Learn more](https://
|
|
11301
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
11223
11302
|
*/
|
|
11224
11303
|
prompt?: BetaResponsePrompt | null;
|
|
11225
11304
|
/**
|
|
11226
11305
|
* Body param: Used by OpenAI to cache responses for similar requests to optimize
|
|
11227
11306
|
* your cache hit rates. Replaces the `user` field.
|
|
11228
|
-
* [Learn more](https://
|
|
11307
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
11229
11308
|
*/
|
|
11230
11309
|
prompt_cache_key?: string | null;
|
|
11231
11310
|
/**
|
|
@@ -11237,7 +11316,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11237
11316
|
* conversation, without a content-block lookback limit. Set `mode` to `explicit`
|
|
11238
11317
|
* to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is
|
|
11239
11318
|
* currently the only supported value. See the
|
|
11240
|
-
* [prompt caching guide](https://
|
|
11319
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11241
11320
|
* for current details.
|
|
11242
11321
|
*/
|
|
11243
11322
|
prompt_cache_options?: ResponseCreateParams.PromptCacheOptions;
|
|
@@ -11247,7 +11326,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11247
11326
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
11248
11327
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
11249
11328
|
* of 24 hours.
|
|
11250
|
-
* [Learn more](https://
|
|
11329
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
11251
11330
|
* This field expresses a maximum retention policy, while
|
|
11252
11331
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
11253
11332
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -11263,7 +11342,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11263
11342
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
11264
11343
|
/**
|
|
11265
11344
|
* Body param: Configuration options for
|
|
11266
|
-
* [reasoning models](https://
|
|
11345
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
11267
11346
|
*/
|
|
11268
11347
|
reasoning?: ResponseCreateParams.Reasoning | null;
|
|
11269
11348
|
/**
|
|
@@ -11272,7 +11351,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11272
11351
|
* uniquely identifies each user, with a maximum length of 64 characters. We
|
|
11273
11352
|
* recommend hashing their username or email address, in order to avoid sending us
|
|
11274
11353
|
* any identifying information.
|
|
11275
|
-
* [Learn more](https://
|
|
11354
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
11276
11355
|
*/
|
|
11277
11356
|
safety_identifier?: string | null;
|
|
11278
11357
|
/**
|
|
@@ -11283,13 +11362,15 @@ export interface ResponseCreateParamsBase {
|
|
|
11283
11362
|
* will use 'default'.
|
|
11284
11363
|
* - If set to 'default', then the request will be processed with the standard
|
|
11285
11364
|
* pricing and performance for the selected model.
|
|
11286
|
-
* - If set to
|
|
11287
|
-
* then
|
|
11288
|
-
*
|
|
11289
|
-
*
|
|
11290
|
-
*
|
|
11291
|
-
*
|
|
11292
|
-
*
|
|
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.
|
|
11293
11374
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
11294
11375
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
11295
11376
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -11304,7 +11385,9 @@ export interface ResponseCreateParamsBase {
|
|
|
11304
11385
|
service_tier?: BetaServiceTier | null;
|
|
11305
11386
|
/**
|
|
11306
11387
|
* Body param: Whether to store the generated model response for later retrieval
|
|
11307
|
-
* via API.
|
|
11388
|
+
* via API. Defaults to true when omitted. If set to true, response data will be
|
|
11389
|
+
* stored for at least 30 days, subject to the
|
|
11390
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
11308
11391
|
*/
|
|
11309
11392
|
store?: boolean | null;
|
|
11310
11393
|
/**
|
|
@@ -11312,7 +11395,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11312
11395
|
* client as it is generated using
|
|
11313
11396
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11314
11397
|
* See the
|
|
11315
|
-
* [Streaming section below](https://
|
|
11398
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11316
11399
|
* for more information.
|
|
11317
11400
|
*/
|
|
11318
11401
|
stream?: boolean | null;
|
|
@@ -11332,8 +11415,8 @@ export interface ResponseCreateParamsBase {
|
|
|
11332
11415
|
* Body param: Configuration options for a text response from the model. Can be
|
|
11333
11416
|
* plain text or structured JSON data. Learn more:
|
|
11334
11417
|
*
|
|
11335
|
-
* - [Text inputs and outputs](https://
|
|
11336
|
-
* - [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)
|
|
11337
11420
|
*/
|
|
11338
11421
|
text?: BetaResponseTextConfig;
|
|
11339
11422
|
/**
|
|
@@ -11350,17 +11433,18 @@ export interface ResponseCreateParamsBase {
|
|
|
11350
11433
|
*
|
|
11351
11434
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
11352
11435
|
* capabilities, like
|
|
11353
|
-
* [web search](https://
|
|
11354
|
-
*
|
|
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).
|
|
11355
11439
|
* Learn more about
|
|
11356
|
-
* [built-in tools](https://
|
|
11440
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
11357
11441
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
11358
11442
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
11359
|
-
* [MCP Tools](https://
|
|
11443
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
11360
11444
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
11361
11445
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
11362
11446
|
* Learn more about
|
|
11363
|
-
* [function calling](https://
|
|
11447
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
11364
11448
|
* You can also use custom tools to call your own code.
|
|
11365
11449
|
*/
|
|
11366
11450
|
tools?: Array<BetaTool>;
|
|
@@ -11396,7 +11480,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11396
11480
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
11397
11481
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
11398
11482
|
* abuse.
|
|
11399
|
-
* [Learn more](https://
|
|
11483
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
11400
11484
|
*/
|
|
11401
11485
|
user?: string;
|
|
11402
11486
|
/**
|
|
@@ -11484,10 +11568,15 @@ export declare namespace ResponseCreateParams {
|
|
|
11484
11568
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
11485
11569
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
11486
11570
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
11487
|
-
* [prompt caching guide](https://
|
|
11571
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11488
11572
|
* for current details.
|
|
11489
11573
|
*/
|
|
11490
11574
|
interface PromptCacheOptions {
|
|
11575
|
+
/**
|
|
11576
|
+
* The ID of a response to compare when diagnosing prompt cache reuse. Supplying
|
|
11577
|
+
* this field requests prompt cache diagnostics when the feature is enabled.
|
|
11578
|
+
*/
|
|
11579
|
+
comparison_response_id?: string | null;
|
|
11491
11580
|
/**
|
|
11492
11581
|
* Controls whether OpenAI automatically creates an implicit cache breakpoint.
|
|
11493
11582
|
* Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
|
|
@@ -11506,7 +11595,7 @@ export declare namespace ResponseCreateParams {
|
|
|
11506
11595
|
}
|
|
11507
11596
|
/**
|
|
11508
11597
|
* Configuration options for
|
|
11509
|
-
* [reasoning models](https://
|
|
11598
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
11510
11599
|
*/
|
|
11511
11600
|
interface Reasoning {
|
|
11512
11601
|
/**
|
|
@@ -11523,7 +11612,7 @@ export declare namespace ResponseCreateParams {
|
|
|
11523
11612
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
11524
11613
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
11525
11614
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
11526
|
-
* [reasoning guide](https://
|
|
11615
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
11527
11616
|
* model-specific support.
|
|
11528
11617
|
*/
|
|
11529
11618
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
|
|
@@ -11580,7 +11669,7 @@ export interface ResponseCreateParamsNonStreaming extends ResponseCreateParamsBa
|
|
|
11580
11669
|
* client as it is generated using
|
|
11581
11670
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11582
11671
|
* See the
|
|
11583
|
-
* [Streaming section below](https://
|
|
11672
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11584
11673
|
* for more information.
|
|
11585
11674
|
*/
|
|
11586
11675
|
stream?: false | null;
|
|
@@ -11591,7 +11680,7 @@ export interface ResponseCreateParamsStreaming extends ResponseCreateParamsBase
|
|
|
11591
11680
|
* client as it is generated using
|
|
11592
11681
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11593
11682
|
* See the
|
|
11594
|
-
* [Streaming section below](https://
|
|
11683
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11595
11684
|
* for more information.
|
|
11596
11685
|
*/
|
|
11597
11686
|
stream: true;
|
|
@@ -11622,7 +11711,7 @@ export interface ResponseRetrieveParamsBase {
|
|
|
11622
11711
|
* client as it is generated using
|
|
11623
11712
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11624
11713
|
* See the
|
|
11625
|
-
* [Streaming section below](https://
|
|
11714
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11626
11715
|
* for more information.
|
|
11627
11716
|
*/
|
|
11628
11717
|
stream?: boolean;
|
|
@@ -11641,7 +11730,7 @@ export interface ResponseRetrieveParamsNonStreaming extends ResponseRetrievePara
|
|
|
11641
11730
|
* client as it is generated using
|
|
11642
11731
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11643
11732
|
* See the
|
|
11644
|
-
* [Streaming section below](https://
|
|
11733
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11645
11734
|
* for more information.
|
|
11646
11735
|
*/
|
|
11647
11736
|
stream?: false;
|
|
@@ -11652,7 +11741,7 @@ export interface ResponseRetrieveParamsStreaming extends ResponseRetrieveParamsB
|
|
|
11652
11741
|
* client as it is generated using
|
|
11653
11742
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11654
11743
|
* See the
|
|
11655
|
-
* [Streaming section below](https://
|
|
11744
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11656
11745
|
* for more information.
|
|
11657
11746
|
*/
|
|
11658
11747
|
stream: true;
|
|
@@ -11674,8 +11763,8 @@ export interface ResponseCompactParams {
|
|
|
11674
11763
|
* Body param: Model ID used to generate the response, like `gpt-6-astra`. OpenAI
|
|
11675
11764
|
* offers a wide range of models with different capabilities, performance
|
|
11676
11765
|
* characteristics, and price points. Refer to the
|
|
11677
|
-
* [model guide](https://
|
|
11678
|
-
* available models.
|
|
11766
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
11767
|
+
* compare available models.
|
|
11679
11768
|
*/
|
|
11680
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;
|
|
11681
11770
|
/**
|
|
@@ -11693,7 +11782,7 @@ export interface ResponseCompactParams {
|
|
|
11693
11782
|
/**
|
|
11694
11783
|
* Body param: The unique ID of the previous response to the model. Use this to
|
|
11695
11784
|
* create multi-turn conversations. Learn more about
|
|
11696
|
-
* [conversation state](https://
|
|
11785
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
11697
11786
|
* Cannot be used in conjunction with `conversation`.
|
|
11698
11787
|
*/
|
|
11699
11788
|
previous_response_id?: string | null;
|
|
@@ -11710,7 +11799,7 @@ export interface ResponseCompactParams {
|
|
|
11710
11799
|
* conversation, without a content-block lookback limit. Set `mode` to `explicit`
|
|
11711
11800
|
* to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is
|
|
11712
11801
|
* currently the only supported value. See the
|
|
11713
|
-
* [prompt caching guide](https://
|
|
11802
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11714
11803
|
* for current details.
|
|
11715
11804
|
*/
|
|
11716
11805
|
prompt_cache_options?: ResponseCompactParams.PromptCacheOptions | null;
|
|
@@ -11725,16 +11814,17 @@ export interface ResponseCompactParams {
|
|
|
11725
11814
|
* in the Project settings. Unless otherwise configured, the Project will use
|
|
11726
11815
|
* 'default'. - If set to 'default', then the request will be processed with the
|
|
11727
11816
|
* standard pricing and performance for the selected model. - If set to
|
|
11728
|
-
* '[flex](https://
|
|
11729
|
-
* request will be processed with the Flex Processing service tier. - To opt-in
|
|
11730
|
-
* [Fast mode](/api/docs/guides/fast-mode) at the
|
|
11731
|
-
* `service_tier=fast` or `service_tier=priority`
|
|
11732
|
-
*
|
|
11733
|
-
*
|
|
11734
|
-
*
|
|
11735
|
-
*
|
|
11736
|
-
*
|
|
11737
|
-
* the value
|
|
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.
|
|
11738
11828
|
*/
|
|
11739
11829
|
service_tier?: 'auto' | 'default' | 'fast' | 'flex' | 'priority' | null;
|
|
11740
11830
|
/**
|
|
@@ -11751,7 +11841,7 @@ export declare namespace ResponseCompactParams {
|
|
|
11751
11841
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
11752
11842
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
11753
11843
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
11754
|
-
* [prompt caching guide](https://
|
|
11844
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11755
11845
|
* for current details.
|
|
11756
11846
|
*/
|
|
11757
11847
|
interface PromptCacheOptions {
|