openai 7.12.1 → 7.14.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 +22 -0
- package/client.d.mts +3 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts +3 -0
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/helpers/live.d.mts +2 -0
- package/helpers/live.d.mts.map +1 -0
- package/helpers/live.d.ts +2 -0
- package/helpers/live.d.ts.map +1 -0
- package/helpers/live.js +6 -0
- package/helpers/live.js.map +1 -0
- package/helpers/live.mjs +2 -0
- package/helpers/live.mjs.map +1 -0
- package/lib/live/transcript-grouper.d.mts +96 -0
- package/lib/live/transcript-grouper.d.mts.map +1 -0
- package/lib/live/transcript-grouper.d.ts +96 -0
- package/lib/live/transcript-grouper.d.ts.map +1 -0
- package/lib/live/transcript-grouper.js +223 -0
- package/lib/live/transcript-grouper.js.map +1 -0
- package/lib/live/transcript-grouper.mjs +219 -0
- package/lib/live/transcript-grouper.mjs.map +1 -0
- package/lib/live/transcript-grouping.d.mts +49 -0
- package/lib/live/transcript-grouping.d.mts.map +1 -0
- package/lib/live/transcript-grouping.d.ts +49 -0
- package/lib/live/transcript-grouping.d.ts.map +1 -0
- package/lib/live/transcript-grouping.js +287 -0
- package/lib/live/transcript-grouping.js.map +1 -0
- package/lib/live/transcript-grouping.mjs +283 -0
- package/lib/live/transcript-grouping.mjs.map +1 -0
- package/lib/live/webrtc.d.mts +13 -0
- package/lib/live/webrtc.d.mts.map +1 -0
- package/lib/live/webrtc.d.ts +13 -0
- package/lib/live/webrtc.d.ts.map +1 -0
- package/lib/live/webrtc.js +16 -0
- package/lib/live/webrtc.js.map +1 -0
- package/lib/live/webrtc.mjs +10 -0
- package/lib/live/webrtc.mjs.map +1 -0
- package/lib/realtime/webrtc.d.mts +13 -0
- package/lib/realtime/webrtc.d.mts.map +1 -0
- package/lib/realtime/webrtc.d.ts +13 -0
- package/lib/realtime/webrtc.d.ts.map +1 -0
- package/lib/realtime/webrtc.js +16 -0
- package/lib/realtime/webrtc.js.map +1 -0
- package/lib/realtime/webrtc.mjs +10 -0
- package/lib/realtime/webrtc.mjs.map +1 -0
- package/lib/webrtc/connection.d.mts +40 -0
- package/lib/webrtc/connection.d.mts.map +1 -0
- package/lib/webrtc/connection.d.ts +40 -0
- package/lib/webrtc/connection.d.ts.map +1 -0
- package/lib/webrtc/connection.js +228 -0
- package/lib/webrtc/connection.js.map +1 -0
- package/lib/webrtc/connection.mjs +224 -0
- package/lib/webrtc/connection.mjs.map +1 -0
- package/lib/webrtc/data-channel.d.mts +32 -0
- package/lib/webrtc/data-channel.d.mts.map +1 -0
- package/lib/webrtc/data-channel.d.ts +32 -0
- package/lib/webrtc/data-channel.d.ts.map +1 -0
- package/lib/webrtc/data-channel.js +125 -0
- package/lib/webrtc/data-channel.js.map +1 -0
- package/lib/webrtc/data-channel.mjs +121 -0
- package/lib/webrtc/data-channel.mjs.map +1 -0
- package/lib/webrtc/errors.d.mts +19 -0
- package/lib/webrtc/errors.d.mts.map +1 -0
- package/lib/webrtc/errors.d.ts +19 -0
- package/lib/webrtc/errors.d.ts.map +1 -0
- package/lib/webrtc/errors.js +18 -0
- package/lib/webrtc/errors.js.map +1 -0
- package/lib/webrtc/errors.mjs +14 -0
- package/lib/webrtc/errors.mjs.map +1 -0
- package/lib/webrtc/subscriptions.d.mts +13 -0
- package/lib/webrtc/subscriptions.d.mts.map +1 -0
- package/lib/webrtc/subscriptions.d.ts +13 -0
- package/lib/webrtc/subscriptions.d.ts.map +1 -0
- package/lib/webrtc/subscriptions.js +62 -0
- package/lib/webrtc/subscriptions.js.map +1 -0
- package/lib/webrtc/subscriptions.mjs +58 -0
- package/lib/webrtc/subscriptions.mjs.map +1 -0
- package/lib/webrtc/types.d.mts +99 -0
- package/lib/webrtc/types.d.mts.map +1 -0
- package/lib/webrtc/types.d.ts +99 -0
- package/lib/webrtc/types.d.ts.map +1 -0
- package/lib/webrtc/types.js +3 -0
- package/lib/webrtc/types.js.map +1 -0
- package/lib/webrtc/types.mjs +2 -0
- package/lib/webrtc/types.mjs.map +1 -0
- package/live/webrtc.d.mts +3 -0
- package/live/webrtc.d.mts.map +1 -0
- package/live/webrtc.d.ts +3 -0
- package/live/webrtc.d.ts.map +1 -0
- package/live/webrtc.js +8 -0
- package/live/webrtc.js.map +1 -0
- package/live/webrtc.mjs +2 -0
- package/live/webrtc.mjs.map +1 -0
- package/package.json +11 -1
- package/realtime/webrtc.d.mts +3 -0
- package/realtime/webrtc.d.mts.map +1 -0
- package/realtime/webrtc.d.ts +3 -0
- package/realtime/webrtc.d.ts.map +1 -0
- package/realtime/webrtc.js +8 -0
- package/realtime/webrtc.js.map +1 -0
- package/realtime/webrtc.mjs +2 -0
- package/realtime/webrtc.mjs.map +1 -0
- package/resources/admin/organization/audit-logs.d.mts +1 -1
- package/resources/admin/organization/audit-logs.d.ts +1 -1
- package/resources/admin/organization/projects/api-keys.d.mts +5 -0
- package/resources/admin/organization/projects/api-keys.d.mts.map +1 -1
- package/resources/admin/organization/projects/api-keys.d.ts +5 -0
- package/resources/admin/organization/projects/api-keys.d.ts.map +1 -1
- package/resources/admin/organization/projects/projects.d.mts +2 -2
- package/resources/admin/organization/projects/projects.d.ts +2 -2
- package/resources/admin/organization/projects/service-accounts/service-accounts.d.mts +13 -0
- package/resources/admin/organization/projects/service-accounts/service-accounts.d.mts.map +1 -1
- package/resources/admin/organization/projects/service-accounts/service-accounts.d.ts +13 -0
- package/resources/admin/organization/projects/service-accounts/service-accounts.d.ts.map +1 -1
- package/resources/admin/organization/projects/service-accounts/service-accounts.js.map +1 -1
- package/resources/admin/organization/projects/service-accounts/service-accounts.mjs.map +1 -1
- package/resources/audio/speech.d.mts +3 -2
- package/resources/audio/speech.d.mts.map +1 -1
- package/resources/audio/speech.d.ts +3 -2
- package/resources/audio/speech.d.ts.map +1 -1
- package/resources/audio/transcriptions.d.mts +10 -10
- package/resources/audio/transcriptions.d.ts +10 -10
- package/resources/audio/translations.d.mts +1 -1
- package/resources/audio/translations.d.ts +1 -1
- package/resources/batches.d.mts +6 -5
- package/resources/batches.d.mts.map +1 -1
- package/resources/batches.d.ts +6 -5
- package/resources/batches.d.ts.map +1 -1
- package/resources/beta/assistants.d.mts +143 -147
- package/resources/beta/assistants.d.mts.map +1 -1
- package/resources/beta/assistants.d.ts +143 -147
- package/resources/beta/assistants.d.ts.map +1 -1
- package/resources/beta/responses/input-tokens.d.mts +11 -11
- package/resources/beta/responses/input-tokens.d.ts +11 -11
- package/resources/beta/responses/responses.d.mts +229 -170
- package/resources/beta/responses/responses.d.mts.map +1 -1
- package/resources/beta/responses/responses.d.ts +229 -170
- package/resources/beta/responses/responses.d.ts.map +1 -1
- package/resources/beta/responses/responses.js +3 -3
- package/resources/beta/responses/responses.js.map +1 -1
- package/resources/beta/responses/responses.mjs +3 -3
- package/resources/beta/responses/responses.mjs.map +1 -1
- package/resources/beta/threads/messages.d.mts +29 -23
- package/resources/beta/threads/messages.d.mts.map +1 -1
- package/resources/beta/threads/messages.d.ts +29 -23
- package/resources/beta/threads/messages.d.ts.map +1 -1
- package/resources/beta/threads/runs/runs.d.mts +39 -35
- package/resources/beta/threads/runs/runs.d.mts.map +1 -1
- package/resources/beta/threads/runs/runs.d.ts +39 -35
- package/resources/beta/threads/runs/runs.d.ts.map +1 -1
- package/resources/beta/threads/runs/runs.js.map +1 -1
- package/resources/beta/threads/runs/runs.mjs.map +1 -1
- package/resources/beta/threads/runs/steps.d.mts +14 -15
- package/resources/beta/threads/runs/steps.d.mts.map +1 -1
- package/resources/beta/threads/runs/steps.d.ts +14 -15
- package/resources/beta/threads/runs/steps.d.ts.map +1 -1
- package/resources/beta/threads/threads.d.mts +53 -50
- package/resources/beta/threads/threads.d.mts.map +1 -1
- package/resources/beta/threads/threads.d.ts +53 -50
- package/resources/beta/threads/threads.d.ts.map +1 -1
- package/resources/beta/threads/threads.js.map +1 -1
- package/resources/beta/threads/threads.mjs.map +1 -1
- package/resources/chat/completions/completions.d.mts +89 -81
- package/resources/chat/completions/completions.d.mts.map +1 -1
- package/resources/chat/completions/completions.d.ts +89 -81
- package/resources/chat/completions/completions.d.ts.map +1 -1
- package/resources/chat/completions/completions.js.map +1 -1
- package/resources/chat/completions/completions.mjs.map +1 -1
- package/resources/completions.d.mts +15 -14
- package/resources/completions.d.mts.map +1 -1
- package/resources/completions.d.ts +15 -14
- package/resources/completions.d.ts.map +1 -1
- package/resources/content-provenance-checks.d.mts +1 -1
- package/resources/content-provenance-checks.d.ts +1 -1
- package/resources/content-provenance-checks.js +1 -1
- package/resources/content-provenance-checks.mjs +1 -1
- package/resources/conversations/items.d.mts +19 -3
- package/resources/conversations/items.d.mts.map +1 -1
- package/resources/conversations/items.d.ts +19 -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 +10 -10
- package/resources/images.d.ts +10 -10
- package/resources/index.d.mts +1 -0
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/live/forks/forks.d.mts +110 -0
- package/resources/live/forks/forks.d.mts.map +1 -0
- package/resources/live/forks/forks.d.ts +110 -0
- package/resources/live/forks/forks.d.ts.map +1 -0
- package/resources/live/forks/forks.js +9 -0
- package/resources/live/forks/forks.js.map +1 -0
- package/resources/live/forks/forks.mjs +5 -0
- package/resources/live/forks/forks.mjs.map +1 -0
- package/resources/live/forks/index.d.mts +4 -0
- package/resources/live/forks/index.d.mts.map +1 -0
- package/resources/live/forks/index.d.ts +4 -0
- package/resources/live/forks/index.d.ts.map +1 -0
- package/resources/live/forks/index.js +7 -0
- package/resources/live/forks/index.js.map +1 -0
- package/resources/live/forks/index.mjs +3 -0
- package/resources/live/forks/index.mjs.map +1 -0
- package/resources/live/forks/internal-base.d.mts +73 -0
- package/resources/live/forks/internal-base.d.mts.map +1 -0
- package/resources/live/forks/internal-base.d.ts +73 -0
- package/resources/live/forks/internal-base.d.ts.map +1 -0
- package/resources/live/forks/internal-base.js +49 -0
- package/resources/live/forks/internal-base.js.map +1 -0
- package/resources/live/forks/internal-base.mjs +43 -0
- package/resources/live/forks/internal-base.mjs.map +1 -0
- package/resources/live/forks/ws-base.d.mts +109 -0
- package/resources/live/forks/ws-base.d.mts.map +1 -0
- package/resources/live/forks/ws-base.d.ts +109 -0
- package/resources/live/forks/ws-base.d.ts.map +1 -0
- package/resources/live/forks/ws-base.js +476 -0
- package/resources/live/forks/ws-base.js.map +1 -0
- package/resources/live/forks/ws-base.mjs +472 -0
- package/resources/live/forks/ws-base.mjs.map +1 -0
- package/resources/live/forks/ws.d.mts +13 -0
- package/resources/live/forks/ws.d.mts.map +1 -0
- package/resources/live/forks/ws.d.ts +13 -0
- package/resources/live/forks/ws.d.ts.map +1 -0
- package/resources/live/forks/ws.js +34 -0
- package/resources/live/forks/ws.js.map +1 -0
- package/resources/live/forks/ws.mjs +29 -0
- package/resources/live/forks/ws.mjs.map +1 -0
- package/resources/live/forks.d.mts +2 -0
- package/resources/live/forks.d.mts.map +1 -0
- package/resources/live/forks.d.ts +2 -0
- package/resources/live/forks.d.ts.map +1 -0
- package/resources/live/forks.js +6 -0
- package/resources/live/forks.js.map +1 -0
- package/resources/live/forks.mjs +3 -0
- package/resources/live/forks.mjs.map +1 -0
- package/resources/live/index.d.mts +7 -0
- package/resources/live/index.d.mts.map +1 -0
- package/resources/live/index.d.ts +7 -0
- package/resources/live/index.d.ts.map +1 -0
- package/resources/live/index.js +13 -0
- package/resources/live/index.js.map +1 -0
- package/resources/live/index.mjs +6 -0
- package/resources/live/index.mjs.map +1 -0
- package/resources/live/internal-base.d.mts +71 -0
- package/resources/live/internal-base.d.mts.map +1 -0
- package/resources/live/internal-base.d.ts +71 -0
- package/resources/live/internal-base.d.ts.map +1 -0
- package/resources/live/internal-base.js +48 -0
- package/resources/live/internal-base.js.map +1 -0
- package/resources/live/internal-base.mjs +42 -0
- package/resources/live/internal-base.mjs.map +1 -0
- package/resources/live/live.d.mts +1864 -0
- package/resources/live/live.d.mts.map +1 -0
- package/resources/live/live.d.ts +1864 -0
- package/resources/live/live.d.ts.map +1 -0
- package/resources/live/live.js +40 -0
- package/resources/live/live.js.map +1 -0
- package/resources/live/live.mjs +35 -0
- package/resources/live/live.mjs.map +1 -0
- package/resources/live/sessions.d.mts +254 -0
- package/resources/live/sessions.d.mts.map +1 -0
- package/resources/live/sessions.d.ts +254 -0
- package/resources/live/sessions.d.ts.map +1 -0
- package/resources/live/sessions.js +118 -0
- package/resources/live/sessions.js.map +1 -0
- package/resources/live/sessions.mjs +114 -0
- package/resources/live/sessions.mjs.map +1 -0
- package/resources/live/sideband/index.d.mts +4 -0
- package/resources/live/sideband/index.d.mts.map +1 -0
- package/resources/live/sideband/index.d.ts +4 -0
- package/resources/live/sideband/index.d.ts.map +1 -0
- package/resources/live/sideband/index.js +7 -0
- package/resources/live/sideband/index.js.map +1 -0
- package/resources/live/sideband/index.mjs +3 -0
- package/resources/live/sideband/index.mjs.map +1 -0
- package/resources/live/sideband/internal-base.d.mts +73 -0
- package/resources/live/sideband/internal-base.d.mts.map +1 -0
- package/resources/live/sideband/internal-base.d.ts +73 -0
- package/resources/live/sideband/internal-base.d.ts.map +1 -0
- package/resources/live/sideband/internal-base.js +49 -0
- package/resources/live/sideband/internal-base.js.map +1 -0
- package/resources/live/sideband/internal-base.mjs +43 -0
- package/resources/live/sideband/internal-base.mjs.map +1 -0
- package/resources/live/sideband/sideband.d.mts +25 -0
- package/resources/live/sideband/sideband.d.mts.map +1 -0
- package/resources/live/sideband/sideband.d.ts +25 -0
- package/resources/live/sideband/sideband.d.ts.map +1 -0
- package/resources/live/sideband/sideband.js +9 -0
- package/resources/live/sideband/sideband.js.map +1 -0
- package/resources/live/sideband/sideband.mjs +5 -0
- package/resources/live/sideband/sideband.mjs.map +1 -0
- package/resources/live/sideband/ws-base.d.mts +114 -0
- package/resources/live/sideband/ws-base.d.mts.map +1 -0
- package/resources/live/sideband/ws-base.d.ts +114 -0
- package/resources/live/sideband/ws-base.d.ts.map +1 -0
- package/resources/live/sideband/ws-base.js +476 -0
- package/resources/live/sideband/ws-base.js.map +1 -0
- package/resources/live/sideband/ws-base.mjs +472 -0
- package/resources/live/sideband/ws-base.mjs.map +1 -0
- package/resources/live/sideband/ws.d.mts +13 -0
- package/resources/live/sideband/ws.d.mts.map +1 -0
- package/resources/live/sideband/ws.d.ts +13 -0
- package/resources/live/sideband/ws.d.ts.map +1 -0
- package/resources/live/sideband/ws.js +34 -0
- package/resources/live/sideband/ws.js.map +1 -0
- package/resources/live/sideband/ws.mjs +29 -0
- package/resources/live/sideband/ws.mjs.map +1 -0
- package/resources/live/sideband.d.mts +2 -0
- package/resources/live/sideband.d.mts.map +1 -0
- package/resources/live/sideband.d.ts +2 -0
- package/resources/live/sideband.d.ts.map +1 -0
- package/resources/live/sideband.js +6 -0
- package/resources/live/sideband.js.map +1 -0
- package/resources/live/sideband.mjs +3 -0
- package/resources/live/sideband.mjs.map +1 -0
- package/resources/live/ws-base.d.mts +106 -0
- package/resources/live/ws-base.d.mts.map +1 -0
- package/resources/live/ws-base.d.ts +106 -0
- package/resources/live/ws-base.d.ts.map +1 -0
- package/resources/live/ws-base.js +476 -0
- package/resources/live/ws-base.js.map +1 -0
- package/resources/live/ws-base.mjs +472 -0
- package/resources/live/ws-base.mjs.map +1 -0
- package/resources/live/ws.d.mts +13 -0
- package/resources/live/ws.d.mts.map +1 -0
- package/resources/live/ws.d.ts +13 -0
- package/resources/live/ws.d.ts.map +1 -0
- package/resources/live/ws.js +34 -0
- package/resources/live/ws.js.map +1 -0
- package/resources/live/ws.mjs +29 -0
- package/resources/live/ws.mjs.map +1 -0
- package/resources/live.d.mts +2 -0
- package/resources/live.d.mts.map +1 -0
- package/resources/live.d.ts +2 -0
- package/resources/live.d.ts.map +1 -0
- package/resources/live.js +6 -0
- package/resources/live.js.map +1 -0
- package/resources/live.mjs +3 -0
- package/resources/live.mjs.map +1 -0
- 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 +223 -164
- package/resources/responses/responses.d.mts.map +1 -1
- package/resources/responses/responses.d.ts +223 -164
- package/resources/responses/responses.d.ts.map +1 -1
- package/resources/responses/responses.js +3 -3
- package/resources/responses/responses.js.map +1 -1
- package/resources/responses/responses.mjs +3 -3
- package/resources/responses/responses.mjs.map +1 -1
- package/resources/shared.d.mts +12 -12
- package/resources/shared.d.ts +12 -12
- package/resources/uploads/parts.d.mts +5 -4
- package/resources/uploads/parts.d.mts.map +1 -1
- package/resources/uploads/parts.d.ts +5 -4
- package/resources/uploads/parts.d.ts.map +1 -1
- package/resources/uploads/parts.js +5 -4
- package/resources/uploads/parts.js.map +1 -1
- package/resources/uploads/parts.mjs +5 -4
- package/resources/uploads/parts.mjs.map +1 -1
- package/resources/uploads/uploads.d.mts +11 -11
- package/resources/uploads/uploads.d.ts +11 -11
- package/resources/uploads/uploads.js +9 -9
- package/resources/uploads/uploads.mjs +9 -9
- package/resources/vector-stores/file-batches.d.mts +11 -11
- package/resources/vector-stores/file-batches.d.ts +11 -11
- package/resources/vector-stores/files.d.mts +8 -8
- package/resources/vector-stores/files.d.ts +8 -8
- package/resources/vector-stores/files.js +3 -3
- package/resources/vector-stores/files.mjs +3 -3
- package/resources/vector-stores/vector-stores.d.mts +3 -3
- package/resources/vector-stores/vector-stores.d.ts +3 -3
- package/resources/webhooks/webhooks.d.mts +78 -7
- package/resources/webhooks/webhooks.d.mts.map +1 -1
- package/resources/webhooks/webhooks.d.ts +78 -7
- package/resources/webhooks/webhooks.d.ts.map +1 -1
- package/src/client.ts +5 -0
- package/src/helpers/live.ts +8 -0
- package/src/lib/live/transcript-grouper.ts +303 -0
- package/src/lib/live/transcript-grouping.ts +362 -0
- package/src/lib/live/webrtc.ts +23 -0
- package/src/lib/realtime/webrtc.ts +20 -0
- package/src/lib/webrtc/connection.ts +309 -0
- package/src/lib/webrtc/data-channel.ts +144 -0
- package/src/lib/webrtc/errors.ts +38 -0
- package/src/lib/webrtc/subscriptions.ts +62 -0
- package/src/lib/webrtc/types.ts +109 -0
- package/src/live/webrtc.ts +10 -0
- package/src/realtime/webrtc.ts +10 -0
- package/src/resources/admin/organization/audit-logs.ts +1 -1
- package/src/resources/admin/organization/projects/api-keys.ts +6 -0
- package/src/resources/admin/organization/projects/projects.ts +2 -2
- package/src/resources/admin/organization/projects/service-accounts/service-accounts.ts +15 -0
- package/src/resources/audio/speech.ts +3 -2
- package/src/resources/audio/transcriptions.ts +10 -10
- package/src/resources/audio/translations.ts +1 -1
- package/src/resources/batches.ts +6 -5
- package/src/resources/beta/assistants.ts +143 -147
- package/src/resources/beta/responses/input-tokens.ts +11 -11
- package/src/resources/beta/responses/responses.ts +241 -170
- package/src/resources/beta/threads/messages.ts +29 -23
- package/src/resources/beta/threads/runs/runs.ts +39 -35
- package/src/resources/beta/threads/runs/steps.ts +14 -15
- package/src/resources/beta/threads/threads.ts +53 -50
- package/src/resources/chat/completions/completions.ts +89 -81
- package/src/resources/completions.ts +15 -14
- package/src/resources/content-provenance-checks.ts +1 -1
- package/src/resources/conversations/items.ts +23 -3
- package/src/resources/embeddings.ts +6 -6
- package/src/resources/evals/evals.ts +1 -1
- package/src/resources/evals/runs/runs.ts +62 -57
- package/src/resources/files.ts +5 -5
- package/src/resources/fine-tuning/alpha/graders.ts +5 -4
- package/src/resources/fine-tuning/checkpoints/permissions.ts +8 -4
- package/src/resources/fine-tuning/jobs/jobs.ts +13 -12
- package/src/resources/graders/grader-models.ts +1 -1
- package/src/resources/images.ts +10 -10
- package/src/resources/index.ts +1 -0
- package/src/resources/live/api.md +87 -0
- package/src/resources/live/forks/forks.ts +169 -0
- package/src/resources/live/forks/index.ts +5 -0
- package/src/resources/live/forks/internal-base.ts +107 -0
- package/src/resources/live/forks/ws-base.ts +611 -0
- package/src/resources/live/forks/ws.ts +46 -0
- package/src/resources/live/forks.ts +3 -0
- package/src/resources/live/index.ts +20 -0
- package/src/resources/live/internal-base.ts +104 -0
- package/src/resources/live/live.ts +2296 -0
- package/src/resources/live/sessions.ts +337 -0
- package/src/resources/live/sideband/index.ts +10 -0
- package/src/resources/live/sideband/internal-base.ts +107 -0
- package/src/resources/live/sideband/sideband.ts +58 -0
- package/src/resources/live/sideband/ws-base.ts +621 -0
- package/src/resources/live/sideband/ws.ts +46 -0
- package/src/resources/live/sideband.ts +3 -0
- package/src/resources/live/ws-base.ts +607 -0
- package/src/resources/live/ws.ts +42 -0
- package/src/resources/live.ts +3 -0
- 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 +235 -164
- package/src/resources/shared.ts +12 -12
- package/src/resources/uploads/parts.ts +5 -4
- package/src/resources/uploads/uploads.ts +11 -11
- package/src/resources/vector-stores/file-batches.ts +11 -11
- package/src/resources/vector-stores/files.ts +8 -8
- package/src/resources/vector-stores/vector-stores.ts +3 -3
- package/src/resources/webhooks/api.md +1 -0
- package/src/resources/webhooks/webhooks.ts +88 -5
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -13,16 +13,16 @@ export declare class Responses extends APIResource {
|
|
|
13
13
|
inputTokens: InputTokensAPI.InputTokens;
|
|
14
14
|
/**
|
|
15
15
|
* Creates a model response. Provide
|
|
16
|
-
* [text](https://
|
|
17
|
-
* [image](https://
|
|
18
|
-
* [text](https://
|
|
19
|
-
* [JSON](https://
|
|
20
|
-
* the model call your own
|
|
21
|
-
* [custom code](https://
|
|
22
|
-
* built-in [tools](https://
|
|
23
|
-
* [web search](https://
|
|
24
|
-
* [file search](https://
|
|
25
|
-
* your own data as input for the model's response.
|
|
16
|
+
* [text](https://developers.openai.com/api/docs/guides/text) or
|
|
17
|
+
* [image](https://developers.openai.com/api/docs/guides/images-vision) inputs to
|
|
18
|
+
* generate [text](https://developers.openai.com/api/docs/guides/text) or
|
|
19
|
+
* [JSON](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
20
|
+
* outputs. Have the model call your own
|
|
21
|
+
* [custom code](https://developers.openai.com/api/docs/guides/function-calling) or
|
|
22
|
+
* use built-in [tools](https://developers.openai.com/api/docs/guides/tools) like
|
|
23
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search) or
|
|
24
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
25
|
+
* to use your own data as input for the model's response.
|
|
26
26
|
*
|
|
27
27
|
* @example
|
|
28
28
|
* ```ts
|
|
@@ -59,7 +59,7 @@ export declare class Responses extends APIResource {
|
|
|
59
59
|
/**
|
|
60
60
|
* Cancels a model response with the given ID. Only responses created with the
|
|
61
61
|
* `background` parameter set to `true` can be cancelled.
|
|
62
|
-
* [Learn more](https://
|
|
62
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
63
63
|
*
|
|
64
64
|
* @example
|
|
65
65
|
* ```ts
|
|
@@ -73,9 +73,9 @@ export declare class Responses extends APIResource {
|
|
|
73
73
|
* Compact a conversation. Returns a compacted response object.
|
|
74
74
|
*
|
|
75
75
|
* Learn when and how to compact long-running conversations in the
|
|
76
|
-
* [conversation state guide](https://
|
|
76
|
+
* [conversation state guide](https://developers.openai.com/api/docs/guides/conversation-state#managing-the-context-window).
|
|
77
77
|
* For ZDR-compatible compaction details, see
|
|
78
|
-
* [Compaction (advanced)](https://
|
|
78
|
+
* [Compaction (advanced)](https://developers.openai.com/api/docs/guides/conversation-state#compaction-advanced).
|
|
79
79
|
*
|
|
80
80
|
* @example
|
|
81
81
|
* ```ts
|
|
@@ -328,7 +328,7 @@ export declare namespace BetaComputerAction {
|
|
|
328
328
|
export type BetaComputerActionList = Array<BetaComputerAction>;
|
|
329
329
|
/**
|
|
330
330
|
* A tool that controls a virtual computer. Learn more about the
|
|
331
|
-
* [computer tool](https://
|
|
331
|
+
* [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).
|
|
332
332
|
*/
|
|
333
333
|
export interface BetaComputerTool {
|
|
334
334
|
/**
|
|
@@ -338,7 +338,7 @@ export interface BetaComputerTool {
|
|
|
338
338
|
}
|
|
339
339
|
/**
|
|
340
340
|
* A tool that controls a virtual computer. Learn more about the
|
|
341
|
-
* [computer tool](https://
|
|
341
|
+
* [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).
|
|
342
342
|
*/
|
|
343
343
|
export interface BetaComputerUsePreviewTool {
|
|
344
344
|
/**
|
|
@@ -426,7 +426,7 @@ export interface BetaContainerReference {
|
|
|
426
426
|
}
|
|
427
427
|
/**
|
|
428
428
|
* A custom tool that processes input using a specified format. Learn more about
|
|
429
|
-
* [custom tools](https://
|
|
429
|
+
* [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools)
|
|
430
430
|
*/
|
|
431
431
|
export interface BetaCustomTool {
|
|
432
432
|
/**
|
|
@@ -520,7 +520,7 @@ export interface BetaEasyInputMessage {
|
|
|
520
520
|
/**
|
|
521
521
|
* A tool that searches for relevant content from uploaded files. Learn more about
|
|
522
522
|
* the
|
|
523
|
-
* [file search tool](https://
|
|
523
|
+
* [file search tool](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
524
524
|
*/
|
|
525
525
|
export interface BetaFileSearchTool {
|
|
526
526
|
/**
|
|
@@ -674,7 +674,7 @@ export interface BetaFunctionShellTool {
|
|
|
674
674
|
/**
|
|
675
675
|
* Defines a function in your own code the model can choose to call. Learn more
|
|
676
676
|
* about
|
|
677
|
-
* [function calling](https://
|
|
677
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
678
678
|
*/
|
|
679
679
|
export interface BetaFunctionTool {
|
|
680
680
|
/**
|
|
@@ -889,8 +889,8 @@ export interface BetaResponse {
|
|
|
889
889
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
890
890
|
* range of models with different capabilities, performance characteristics, and
|
|
891
891
|
* price points. Refer to the
|
|
892
|
-
* [model guide](https://
|
|
893
|
-
* available models.
|
|
892
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
893
|
+
* compare available models.
|
|
894
894
|
*/
|
|
895
895
|
model: 'gpt-6-astra' | 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-5.5' | 'gpt-5.5-2026-04-23' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.4-mini-2026-03-17' | 'gpt-5.4-nano-2026-03-17' | 'gpt-5.3-chat-latest' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-codex' | 'gpt-5.1-mini' | 'gpt-5.1-chat-latest' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5-2025-08-07' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano-2025-04-14' | 'o4-mini' | 'o4-mini-2025-04-16' | 'o3' | 'o3-2025-04-16' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o1' | 'o1-2024-12-17' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o1-mini' | 'o1-mini-2024-09-12' | 'gpt-4o' | 'gpt-4o-2024-11-20' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-05-13' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-audio-preview-2025-06-03' | 'gpt-4o-mini-audio-preview' | 'gpt-4o-mini-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-mini-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview-2025-03-11' | 'chatgpt-4o-latest' | 'codex-mini-latest' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-0125-preview' | 'gpt-4-turbo-preview' | 'gpt-4-1106-preview' | 'gpt-4-vision-preview' | 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-16k-0613' | 'o1-pro' | 'o1-pro-2025-03-19' | 'o3-pro' | 'o3-pro-2025-06-10' | 'o3-deep-research' | 'o3-deep-research-2025-06-26' | 'o4-mini-deep-research' | 'o4-mini-deep-research-2025-06-26' | 'computer-use-preview' | 'computer-use-preview-2025-03-11' | 'gpt-5.5-pro' | 'gpt-5.5-pro-2026-04-23' | 'gpt-5-codex' | 'gpt-5-pro' | 'gpt-5-pro-2025-10-06' | 'gpt-5.1-codex-max' | 'gpt-daybreak-blue-latest' | 'gpt-daybreak-red-latest' | 'gpt-5.6-cyber' | (string & {});
|
|
896
896
|
/**
|
|
@@ -932,17 +932,18 @@ export interface BetaResponse {
|
|
|
932
932
|
*
|
|
933
933
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
934
934
|
* capabilities, like
|
|
935
|
-
* [web search](https://
|
|
936
|
-
*
|
|
935
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
936
|
+
* or
|
|
937
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
937
938
|
* Learn more about
|
|
938
|
-
* [built-in tools](https://
|
|
939
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
939
940
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
940
941
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
941
|
-
* [MCP Tools](https://
|
|
942
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
942
943
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
943
944
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
944
945
|
* Learn more about
|
|
945
|
-
* [function calling](https://
|
|
946
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
946
947
|
* You can also use custom tools to call your own code.
|
|
947
948
|
*/
|
|
948
949
|
tools: Array<BetaTool>;
|
|
@@ -956,7 +957,7 @@ export interface BetaResponse {
|
|
|
956
957
|
top_p: number | null;
|
|
957
958
|
/**
|
|
958
959
|
* Whether to run the model response in the background.
|
|
959
|
-
* [Learn more](https://
|
|
960
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
960
961
|
*/
|
|
961
962
|
background?: boolean | null;
|
|
962
963
|
/**
|
|
@@ -972,7 +973,7 @@ export interface BetaResponse {
|
|
|
972
973
|
/**
|
|
973
974
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
974
975
|
* including visible output tokens and
|
|
975
|
-
* [reasoning tokens](https://
|
|
976
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
976
977
|
*/
|
|
977
978
|
max_output_tokens?: number | null;
|
|
978
979
|
/**
|
|
@@ -990,13 +991,13 @@ export interface BetaResponse {
|
|
|
990
991
|
/**
|
|
991
992
|
* The unique ID of the previous response to the model. Use this to create
|
|
992
993
|
* multi-turn conversations. Learn more about
|
|
993
|
-
* [conversation state](https://
|
|
994
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
994
995
|
* Cannot be used in conjunction with `conversation`.
|
|
995
996
|
*/
|
|
996
997
|
previous_response_id?: string | null;
|
|
997
998
|
/**
|
|
998
999
|
* Reference to a prompt template and its variables.
|
|
999
|
-
* [Learn more](https://
|
|
1000
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
1000
1001
|
*/
|
|
1001
1002
|
prompt?: BetaResponsePrompt | null;
|
|
1002
1003
|
/**
|
|
@@ -1006,7 +1007,7 @@ export interface BetaResponse {
|
|
|
1006
1007
|
/**
|
|
1007
1008
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
1008
1009
|
* hit rates. Replaces the `user` field.
|
|
1009
|
-
* [Learn more](https://
|
|
1010
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
1010
1011
|
*/
|
|
1011
1012
|
prompt_cache_key?: string | null;
|
|
1012
1013
|
/**
|
|
@@ -1020,7 +1021,7 @@ export interface BetaResponse {
|
|
|
1020
1021
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
1021
1022
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
1022
1023
|
* of 24 hours.
|
|
1023
|
-
* [Learn more](https://
|
|
1024
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
1024
1025
|
* This field expresses a maximum retention policy, while
|
|
1025
1026
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
1026
1027
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -1036,7 +1037,7 @@ export interface BetaResponse {
|
|
|
1036
1037
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
1037
1038
|
/**
|
|
1038
1039
|
* Configuration options for
|
|
1039
|
-
* [reasoning models](https://
|
|
1040
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
1040
1041
|
*/
|
|
1041
1042
|
reasoning?: BetaResponse.Reasoning | null;
|
|
1042
1043
|
/**
|
|
@@ -1045,7 +1046,7 @@ export interface BetaResponse {
|
|
|
1045
1046
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
1046
1047
|
* hashing their username or email address, in order to avoid sending us any
|
|
1047
1048
|
* identifying information.
|
|
1048
|
-
* [Learn more](https://
|
|
1049
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
1049
1050
|
*/
|
|
1050
1051
|
safety_identifier?: string | null;
|
|
1051
1052
|
/**
|
|
@@ -1056,13 +1057,15 @@ export interface BetaResponse {
|
|
|
1056
1057
|
* will use 'default'.
|
|
1057
1058
|
* - If set to 'default', then the request will be processed with the standard
|
|
1058
1059
|
* pricing and performance for the selected model.
|
|
1059
|
-
* - If set to
|
|
1060
|
-
* then
|
|
1061
|
-
*
|
|
1062
|
-
*
|
|
1063
|
-
*
|
|
1064
|
-
*
|
|
1065
|
-
*
|
|
1060
|
+
* - If set to
|
|
1061
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
1062
|
+
* the request will be processed with the Flex Processing service tier.
|
|
1063
|
+
* - To opt-in to
|
|
1064
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
1065
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
1066
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
1067
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
1068
|
+
* `priority` in your request.
|
|
1066
1069
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
1067
1070
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
1068
1071
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -1084,8 +1087,8 @@ export interface BetaResponse {
|
|
|
1084
1087
|
* Configuration options for a text response from the model. Can be plain text or
|
|
1085
1088
|
* structured JSON data. Learn more:
|
|
1086
1089
|
*
|
|
1087
|
-
* - [Text inputs and outputs](https://
|
|
1088
|
-
* - [Structured Outputs](https://
|
|
1090
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
1091
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
1089
1092
|
*/
|
|
1090
1093
|
text?: BetaResponseTextConfig;
|
|
1091
1094
|
/**
|
|
@@ -1115,7 +1118,7 @@ export interface BetaResponse {
|
|
|
1115
1118
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
1116
1119
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
1117
1120
|
* abuse.
|
|
1118
|
-
* [Learn more](https://
|
|
1121
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
1119
1122
|
*/
|
|
1120
1123
|
user?: string;
|
|
1121
1124
|
}
|
|
@@ -1316,7 +1319,7 @@ export declare namespace BetaResponse {
|
|
|
1316
1319
|
}
|
|
1317
1320
|
/**
|
|
1318
1321
|
* Configuration options for
|
|
1319
|
-
* [reasoning models](https://
|
|
1322
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
1320
1323
|
*/
|
|
1321
1324
|
interface Reasoning {
|
|
1322
1325
|
/**
|
|
@@ -1333,7 +1336,7 @@ export declare namespace BetaResponse {
|
|
|
1333
1336
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
1334
1337
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
1335
1338
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
1336
|
-
* [reasoning guide](https://
|
|
1339
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
1337
1340
|
* model-specific support.
|
|
1338
1341
|
*/
|
|
1339
1342
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
|
|
@@ -1914,7 +1917,7 @@ export declare namespace BetaResponseCodeInterpreterToolCall {
|
|
|
1914
1917
|
}
|
|
1915
1918
|
/**
|
|
1916
1919
|
* A compaction item generated by the
|
|
1917
|
-
* [`v1/responses/compact` API](https://
|
|
1920
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
1918
1921
|
*/
|
|
1919
1922
|
export interface BetaResponseCompactionItem {
|
|
1920
1923
|
/**
|
|
@@ -1951,7 +1954,7 @@ export declare namespace BetaResponseCompactionItem {
|
|
|
1951
1954
|
}
|
|
1952
1955
|
/**
|
|
1953
1956
|
* A compaction item generated by the
|
|
1954
|
-
* [`v1/responses/compact` API](https://
|
|
1957
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
1955
1958
|
*/
|
|
1956
1959
|
export interface BetaResponseCompactionItemParam {
|
|
1957
1960
|
/**
|
|
@@ -2016,7 +2019,7 @@ export declare namespace BetaResponseCompletedEvent {
|
|
|
2016
2019
|
}
|
|
2017
2020
|
/**
|
|
2018
2021
|
* A tool call to a computer use tool. See the
|
|
2019
|
-
* [computer use guide](https://
|
|
2022
|
+
* [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use)
|
|
2020
2023
|
* for more information.
|
|
2021
2024
|
*/
|
|
2022
2025
|
export interface BetaResponseComputerToolCall {
|
|
@@ -2894,7 +2897,7 @@ export declare namespace BetaResponseFileSearchCallSearchingEvent {
|
|
|
2894
2897
|
}
|
|
2895
2898
|
/**
|
|
2896
2899
|
* The results of a file search tool call. See the
|
|
2897
|
-
* [file search guide](https://
|
|
2900
|
+
* [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
2898
2901
|
* for more information.
|
|
2899
2902
|
*/
|
|
2900
2903
|
export interface BetaResponseFileSearchToolCall {
|
|
@@ -2968,7 +2971,7 @@ export declare namespace BetaResponseFileSearchToolCall {
|
|
|
2968
2971
|
*
|
|
2969
2972
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
2970
2973
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
2971
|
-
* [Structured Outputs guide](https://
|
|
2974
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
2972
2975
|
*
|
|
2973
2976
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
2974
2977
|
*
|
|
@@ -3004,7 +3007,7 @@ export declare namespace BetaResponseFormatTextConfig {
|
|
|
3004
3007
|
/**
|
|
3005
3008
|
* JSON Schema response format. Used to generate structured JSON responses. Learn
|
|
3006
3009
|
* more about
|
|
3007
|
-
* [Structured Outputs](https://
|
|
3010
|
+
* [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
3008
3011
|
*/
|
|
3009
3012
|
export interface BetaResponseFormatTextJSONSchemaConfig {
|
|
3010
3013
|
/**
|
|
@@ -3033,7 +3036,7 @@ export interface BetaResponseFormatTextJSONSchemaConfig {
|
|
|
3033
3036
|
* true, the model will always follow the exact schema defined in the `schema`
|
|
3034
3037
|
* field. Only a subset of JSON Schema is supported when `strict` is `true`. To
|
|
3035
3038
|
* learn more, read the
|
|
3036
|
-
* [Structured Outputs guide](https://
|
|
3039
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
3037
3040
|
*/
|
|
3038
3041
|
strict?: boolean | null;
|
|
3039
3042
|
}
|
|
@@ -3354,7 +3357,7 @@ export declare namespace BetaResponseFunctionShellToolCallOutput {
|
|
|
3354
3357
|
}
|
|
3355
3358
|
/**
|
|
3356
3359
|
* A tool call to run a function. See the
|
|
3357
|
-
* [function calling guide](https://
|
|
3360
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
3358
3361
|
* for more information.
|
|
3359
3362
|
*/
|
|
3360
3363
|
export interface BetaResponseFunctionToolCall {
|
|
@@ -3423,7 +3426,7 @@ export declare namespace BetaResponseFunctionToolCall {
|
|
|
3423
3426
|
}
|
|
3424
3427
|
/**
|
|
3425
3428
|
* A tool call to run a function. See the
|
|
3426
|
-
* [function calling guide](https://
|
|
3429
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
3427
3430
|
* for more information.
|
|
3428
3431
|
*/
|
|
3429
3432
|
export interface BetaResponseFunctionToolCallItem extends BetaResponseFunctionToolCall {
|
|
@@ -3514,8 +3517,8 @@ export declare namespace BetaResponseFunctionToolCallOutputItem {
|
|
|
3514
3517
|
}
|
|
3515
3518
|
/**
|
|
3516
3519
|
* The results of a web search tool call. See the
|
|
3517
|
-
* [web search guide](https://
|
|
3518
|
-
* more information.
|
|
3520
|
+
* [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
3521
|
+
* for more information.
|
|
3519
3522
|
*/
|
|
3520
3523
|
export interface BetaResponseFunctionWebSearch {
|
|
3521
3524
|
/**
|
|
@@ -4105,7 +4108,7 @@ export declare namespace BetaResponseInputFileContent {
|
|
|
4105
4108
|
}
|
|
4106
4109
|
/**
|
|
4107
4110
|
* An image input to the model. Learn about
|
|
4108
|
-
* [image inputs](https://
|
|
4111
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision).
|
|
4109
4112
|
*/
|
|
4110
4113
|
export interface BetaResponseInputImage {
|
|
4111
4114
|
/**
|
|
@@ -4148,7 +4151,7 @@ export declare namespace BetaResponseInputImage {
|
|
|
4148
4151
|
}
|
|
4149
4152
|
/**
|
|
4150
4153
|
* An image input to the model. Learn about
|
|
4151
|
-
* [image inputs](https://
|
|
4154
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
4152
4155
|
*/
|
|
4153
4156
|
export interface BetaResponseInputImageContent {
|
|
4154
4157
|
/**
|
|
@@ -4675,15 +4678,31 @@ export declare namespace BetaResponseInputItem {
|
|
|
4675
4678
|
* The type of the image generation call. Always `image_generation_call`.
|
|
4676
4679
|
*/
|
|
4677
4680
|
type: 'image_generation_call';
|
|
4681
|
+
/**
|
|
4682
|
+
* The action used for image generation.
|
|
4683
|
+
*/
|
|
4684
|
+
action?: 'generate' | 'edit' | 'auto' | null;
|
|
4678
4685
|
/**
|
|
4679
4686
|
* The agent that produced this item.
|
|
4680
4687
|
*/
|
|
4681
4688
|
agent?: ImageGenerationCall.Agent | null;
|
|
4689
|
+
/**
|
|
4690
|
+
* The background setting used for generation.
|
|
4691
|
+
*/
|
|
4692
|
+
background?: 'transparent' | 'opaque' | 'auto' | null;
|
|
4693
|
+
/**
|
|
4694
|
+
* The output format used for generation.
|
|
4695
|
+
*/
|
|
4696
|
+
output_format?: 'png' | 'webp' | 'jpeg' | null;
|
|
4682
4697
|
/**
|
|
4683
4698
|
* The quality of the image generated by the image generation tool call. One of
|
|
4684
4699
|
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
4685
4700
|
*/
|
|
4686
4701
|
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
4702
|
+
/**
|
|
4703
|
+
* The prompt that was used after any model prompt rewriting.
|
|
4704
|
+
*/
|
|
4705
|
+
revised_prompt?: string | null;
|
|
4687
4706
|
/**
|
|
4688
4707
|
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
4689
4708
|
*/
|
|
@@ -5897,15 +5916,31 @@ export declare namespace BetaResponseItem {
|
|
|
5897
5916
|
* The type of the image generation call. Always `image_generation_call`.
|
|
5898
5917
|
*/
|
|
5899
5918
|
type: 'image_generation_call';
|
|
5919
|
+
/**
|
|
5920
|
+
* The action used for image generation.
|
|
5921
|
+
*/
|
|
5922
|
+
action?: 'generate' | 'edit' | 'auto' | null;
|
|
5900
5923
|
/**
|
|
5901
5924
|
* The agent that produced this item.
|
|
5902
5925
|
*/
|
|
5903
5926
|
agent?: ImageGenerationCall.Agent | null;
|
|
5927
|
+
/**
|
|
5928
|
+
* The background setting used for generation.
|
|
5929
|
+
*/
|
|
5930
|
+
background?: 'transparent' | 'opaque' | 'auto' | null;
|
|
5931
|
+
/**
|
|
5932
|
+
* The output format used for generation.
|
|
5933
|
+
*/
|
|
5934
|
+
output_format?: 'png' | 'webp' | 'jpeg' | null;
|
|
5904
5935
|
/**
|
|
5905
5936
|
* The quality of the image generated by the image generation tool call. One of
|
|
5906
5937
|
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
5907
5938
|
*/
|
|
5908
5939
|
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
5940
|
+
/**
|
|
5941
|
+
* The prompt that was used after any model prompt rewriting.
|
|
5942
|
+
*/
|
|
5943
|
+
revised_prompt?: string | null;
|
|
5909
5944
|
/**
|
|
5910
5945
|
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
5911
5946
|
*/
|
|
@@ -6887,15 +6922,31 @@ export declare namespace BetaResponseOutputItem {
|
|
|
6887
6922
|
* The type of the image generation call. Always `image_generation_call`.
|
|
6888
6923
|
*/
|
|
6889
6924
|
type: 'image_generation_call';
|
|
6925
|
+
/**
|
|
6926
|
+
* The action used for image generation.
|
|
6927
|
+
*/
|
|
6928
|
+
action?: 'generate' | 'edit' | 'auto' | null;
|
|
6890
6929
|
/**
|
|
6891
6930
|
* The agent that produced this item.
|
|
6892
6931
|
*/
|
|
6893
6932
|
agent?: ImageGenerationCall.Agent | null;
|
|
6933
|
+
/**
|
|
6934
|
+
* The background setting used for generation.
|
|
6935
|
+
*/
|
|
6936
|
+
background?: 'transparent' | 'opaque' | 'auto' | null;
|
|
6937
|
+
/**
|
|
6938
|
+
* The output format used for generation.
|
|
6939
|
+
*/
|
|
6940
|
+
output_format?: 'png' | 'webp' | 'jpeg' | null;
|
|
6894
6941
|
/**
|
|
6895
6942
|
* The quality of the image generated by the image generation tool call. One of
|
|
6896
6943
|
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
6897
6944
|
*/
|
|
6898
6945
|
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
6946
|
+
/**
|
|
6947
|
+
* The prompt that was used after any model prompt rewriting.
|
|
6948
|
+
*/
|
|
6949
|
+
revised_prompt?: string | null;
|
|
6899
6950
|
/**
|
|
6900
6951
|
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
6901
6952
|
*/
|
|
@@ -7629,7 +7680,7 @@ export declare namespace BetaResponseOutputTextAnnotationAddedEvent {
|
|
|
7629
7680
|
}
|
|
7630
7681
|
/**
|
|
7631
7682
|
* Reference to a prompt template and its variables.
|
|
7632
|
-
* [Learn more](https://
|
|
7683
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
7633
7684
|
*/
|
|
7634
7685
|
export interface BetaResponsePrompt {
|
|
7635
7686
|
/**
|
|
@@ -7685,7 +7736,7 @@ export declare namespace BetaResponseQueuedEvent {
|
|
|
7685
7736
|
* A description of the chain of thought used by a reasoning model while generating
|
|
7686
7737
|
* a response. Be sure to include these items in your `input` to the Responses API
|
|
7687
7738
|
* for subsequent turns of a conversation if you are manually
|
|
7688
|
-
* [managing context](https://
|
|
7739
|
+
* [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
7689
7740
|
*/
|
|
7690
7741
|
export interface BetaResponseReasoningItem {
|
|
7691
7742
|
/**
|
|
@@ -8900,8 +8951,8 @@ export type BetaResponseStreamEvent = BetaResponseAudioDeltaEvent | BetaResponse
|
|
|
8900
8951
|
* Configuration options for a text response from the model. Can be plain text or
|
|
8901
8952
|
* structured JSON data. Learn more:
|
|
8902
8953
|
*
|
|
8903
|
-
* - [Text inputs and outputs](https://
|
|
8904
|
-
* - [Structured Outputs](https://
|
|
8954
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
8955
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
8905
8956
|
*/
|
|
8906
8957
|
export interface BetaResponseTextConfig {
|
|
8907
8958
|
/**
|
|
@@ -8909,7 +8960,7 @@ export interface BetaResponseTextConfig {
|
|
|
8909
8960
|
*
|
|
8910
8961
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
8911
8962
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
8912
|
-
* [Structured Outputs guide](https://
|
|
8963
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
8913
8964
|
*
|
|
8914
8965
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
8915
8966
|
*
|
|
@@ -9254,7 +9305,7 @@ export declare namespace BetaResponseUsage {
|
|
|
9254
9305
|
cache_write_tokens: number;
|
|
9255
9306
|
/**
|
|
9256
9307
|
* The number of tokens that were retrieved from the cache.
|
|
9257
|
-
* [More on prompt caching](https://
|
|
9308
|
+
* [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
9258
9309
|
*/
|
|
9259
9310
|
cached_tokens: number;
|
|
9260
9311
|
}
|
|
@@ -9399,7 +9450,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9399
9450
|
type: 'response.create';
|
|
9400
9451
|
/**
|
|
9401
9452
|
* Whether to run the model response in the background.
|
|
9402
|
-
* [Learn more](https://
|
|
9453
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
9403
9454
|
*/
|
|
9404
9455
|
background?: boolean | null;
|
|
9405
9456
|
/**
|
|
@@ -9439,11 +9490,11 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9439
9490
|
*
|
|
9440
9491
|
* Learn more:
|
|
9441
9492
|
*
|
|
9442
|
-
* - [Text inputs and outputs](https://
|
|
9443
|
-
* - [Image inputs](https://
|
|
9444
|
-
* - [File inputs](https://
|
|
9445
|
-
* - [Conversation state](https://
|
|
9446
|
-
* - [Function calling](https://
|
|
9493
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
9494
|
+
* - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
9495
|
+
* - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
9496
|
+
* - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
9497
|
+
* - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
9447
9498
|
*/
|
|
9448
9499
|
input?: string | ResponsesAPI.BetaResponseInput;
|
|
9449
9500
|
/**
|
|
@@ -9457,7 +9508,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9457
9508
|
/**
|
|
9458
9509
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
9459
9510
|
* including visible output tokens and
|
|
9460
|
-
* [reasoning tokens](https://
|
|
9511
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
9461
9512
|
*/
|
|
9462
9513
|
max_output_tokens?: number | null;
|
|
9463
9514
|
/**
|
|
@@ -9482,8 +9533,8 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9482
9533
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
9483
9534
|
* range of models with different capabilities, performance characteristics, and
|
|
9484
9535
|
* price points. Refer to the
|
|
9485
|
-
* [model guide](https://
|
|
9486
|
-
* available models.
|
|
9536
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
9537
|
+
* compare available models.
|
|
9487
9538
|
*/
|
|
9488
9539
|
model?: 'gpt-6-astra' | 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-5.5' | 'gpt-5.5-2026-04-23' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.4-mini-2026-03-17' | 'gpt-5.4-nano-2026-03-17' | 'gpt-5.3-chat-latest' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-codex' | 'gpt-5.1-mini' | 'gpt-5.1-chat-latest' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5-2025-08-07' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano-2025-04-14' | 'o4-mini' | 'o4-mini-2025-04-16' | 'o3' | 'o3-2025-04-16' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o1' | 'o1-2024-12-17' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o1-mini' | 'o1-mini-2024-09-12' | 'gpt-4o' | 'gpt-4o-2024-11-20' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-05-13' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-audio-preview-2025-06-03' | 'gpt-4o-mini-audio-preview' | 'gpt-4o-mini-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-mini-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview-2025-03-11' | 'chatgpt-4o-latest' | 'codex-mini-latest' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-0125-preview' | 'gpt-4-turbo-preview' | 'gpt-4-1106-preview' | 'gpt-4-vision-preview' | 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-16k-0613' | 'o1-pro' | 'o1-pro-2025-03-19' | 'o3-pro' | 'o3-pro-2025-06-10' | 'o3-deep-research' | 'o3-deep-research-2025-06-26' | 'o4-mini-deep-research' | 'o4-mini-deep-research-2025-06-26' | 'computer-use-preview' | 'computer-use-preview-2025-03-11' | 'gpt-5.5-pro' | 'gpt-5.5-pro-2026-04-23' | 'gpt-5-codex' | 'gpt-5-pro' | 'gpt-5-pro-2025-10-06' | 'gpt-5.1-codex-max' | 'gpt-daybreak-blue-latest' | 'gpt-daybreak-red-latest' | 'gpt-5.6-cyber' | (string & {});
|
|
9489
9540
|
/**
|
|
@@ -9501,19 +9552,19 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9501
9552
|
/**
|
|
9502
9553
|
* The unique ID of the previous response to the model. Use this to create
|
|
9503
9554
|
* multi-turn conversations. Learn more about
|
|
9504
|
-
* [conversation state](https://
|
|
9555
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
9505
9556
|
* Cannot be used in conjunction with `conversation`.
|
|
9506
9557
|
*/
|
|
9507
9558
|
previous_response_id?: string | null;
|
|
9508
9559
|
/**
|
|
9509
9560
|
* Reference to a prompt template and its variables.
|
|
9510
|
-
* [Learn more](https://
|
|
9561
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
9511
9562
|
*/
|
|
9512
9563
|
prompt?: ResponsesAPI.BetaResponsePrompt | null;
|
|
9513
9564
|
/**
|
|
9514
9565
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
9515
9566
|
* hit rates. Replaces the `user` field.
|
|
9516
|
-
* [Learn more](https://
|
|
9567
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
9517
9568
|
*/
|
|
9518
9569
|
prompt_cache_key?: string | null;
|
|
9519
9570
|
/**
|
|
@@ -9524,7 +9575,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9524
9575
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
9525
9576
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
9526
9577
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
9527
|
-
* [prompt caching guide](https://
|
|
9578
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
9528
9579
|
* for current details.
|
|
9529
9580
|
*/
|
|
9530
9581
|
prompt_cache_options?: ResponseCreate.PromptCacheOptions;
|
|
@@ -9534,7 +9585,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9534
9585
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
9535
9586
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
9536
9587
|
* of 24 hours.
|
|
9537
|
-
* [Learn more](https://
|
|
9588
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
9538
9589
|
* This field expresses a maximum retention policy, while
|
|
9539
9590
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
9540
9591
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -9550,7 +9601,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9550
9601
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
9551
9602
|
/**
|
|
9552
9603
|
* Configuration options for
|
|
9553
|
-
* [reasoning models](https://
|
|
9604
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
9554
9605
|
*/
|
|
9555
9606
|
reasoning?: ResponseCreate.Reasoning | null;
|
|
9556
9607
|
/**
|
|
@@ -9559,7 +9610,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9559
9610
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
9560
9611
|
* hashing their username or email address, in order to avoid sending us any
|
|
9561
9612
|
* identifying information.
|
|
9562
|
-
* [Learn more](https://
|
|
9613
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
9563
9614
|
*/
|
|
9564
9615
|
safety_identifier?: string | null;
|
|
9565
9616
|
/**
|
|
@@ -9570,13 +9621,15 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9570
9621
|
* will use 'default'.
|
|
9571
9622
|
* - If set to 'default', then the request will be processed with the standard
|
|
9572
9623
|
* pricing and performance for the selected model.
|
|
9573
|
-
* - If set to
|
|
9574
|
-
* then
|
|
9575
|
-
*
|
|
9576
|
-
*
|
|
9577
|
-
*
|
|
9578
|
-
*
|
|
9579
|
-
*
|
|
9624
|
+
* - If set to
|
|
9625
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
9626
|
+
* the request will be processed with the Flex Processing service tier.
|
|
9627
|
+
* - To opt-in to
|
|
9628
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
9629
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
9630
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
9631
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
9632
|
+
* `priority` in your request.
|
|
9580
9633
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
9581
9634
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
9582
9635
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -9593,7 +9646,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9593
9646
|
* Whether to store the generated model response for later retrieval via API.
|
|
9594
9647
|
* Defaults to true when omitted. If set to true, response data will be stored for
|
|
9595
9648
|
* at least 30 days, subject to the
|
|
9596
|
-
* [data retention exceptions](/api/docs/guides/your-data#v1responses).
|
|
9649
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
9597
9650
|
*/
|
|
9598
9651
|
store?: boolean | null;
|
|
9599
9652
|
/**
|
|
@@ -9601,7 +9654,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9601
9654
|
* generated using
|
|
9602
9655
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
9603
9656
|
* See the
|
|
9604
|
-
* [Streaming section below](https://
|
|
9657
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
9605
9658
|
* for more information.
|
|
9606
9659
|
*/
|
|
9607
9660
|
stream?: boolean | null;
|
|
@@ -9628,8 +9681,8 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9628
9681
|
* Configuration options for a text response from the model. Can be plain text or
|
|
9629
9682
|
* structured JSON data. Learn more:
|
|
9630
9683
|
*
|
|
9631
|
-
* - [Text inputs and outputs](https://
|
|
9632
|
-
* - [Structured Outputs](https://
|
|
9684
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
9685
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
9633
9686
|
*/
|
|
9634
9687
|
text?: ResponsesAPI.BetaResponseTextConfig;
|
|
9635
9688
|
/**
|
|
@@ -9646,17 +9699,18 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9646
9699
|
*
|
|
9647
9700
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
9648
9701
|
* capabilities, like
|
|
9649
|
-
* [web search](https://
|
|
9650
|
-
*
|
|
9702
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
9703
|
+
* or
|
|
9704
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
9651
9705
|
* Learn more about
|
|
9652
|
-
* [built-in tools](https://
|
|
9706
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
9653
9707
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
9654
9708
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
9655
|
-
* [MCP Tools](https://
|
|
9709
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
9656
9710
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
9657
9711
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
9658
9712
|
* Learn more about
|
|
9659
|
-
* [function calling](https://
|
|
9713
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
9660
9714
|
* You can also use custom tools to call your own code.
|
|
9661
9715
|
*/
|
|
9662
9716
|
tools?: Array<ResponsesAPI.BetaTool>;
|
|
@@ -9690,7 +9744,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9690
9744
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
9691
9745
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
9692
9746
|
* abuse.
|
|
9693
|
-
* [Learn more](https://
|
|
9747
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
9694
9748
|
*/
|
|
9695
9749
|
user?: string;
|
|
9696
9750
|
}
|
|
@@ -9774,7 +9828,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9774
9828
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
9775
9829
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
9776
9830
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
9777
|
-
* [prompt caching guide](https://
|
|
9831
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
9778
9832
|
* for current details.
|
|
9779
9833
|
*/
|
|
9780
9834
|
interface PromptCacheOptions {
|
|
@@ -9801,7 +9855,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9801
9855
|
}
|
|
9802
9856
|
/**
|
|
9803
9857
|
* Configuration options for
|
|
9804
|
-
* [reasoning models](https://
|
|
9858
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
9805
9859
|
*/
|
|
9806
9860
|
interface Reasoning {
|
|
9807
9861
|
/**
|
|
@@ -9818,7 +9872,7 @@ export declare namespace BetaResponsesClientEvent {
|
|
|
9818
9872
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
9819
9873
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
9820
9874
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
9821
|
-
* [reasoning guide](https://
|
|
9875
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
9822
9876
|
* model-specific support.
|
|
9823
9877
|
*/
|
|
9824
9878
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
|
|
@@ -10566,13 +10620,15 @@ export declare namespace BetaResponsesServerEvent {
|
|
|
10566
10620
|
* will use 'default'.
|
|
10567
10621
|
* - If set to 'default', then the request will be processed with the standard
|
|
10568
10622
|
* pricing and performance for the selected model.
|
|
10569
|
-
* - If set to
|
|
10570
|
-
* then
|
|
10571
|
-
*
|
|
10572
|
-
*
|
|
10573
|
-
*
|
|
10574
|
-
*
|
|
10575
|
-
*
|
|
10623
|
+
* - If set to
|
|
10624
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
10625
|
+
* the request will be processed with the Flex Processing service tier.
|
|
10626
|
+
* - To opt-in to
|
|
10627
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
10628
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
10629
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
10630
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
10631
|
+
* `priority` in your request.
|
|
10576
10632
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
10577
10633
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
10578
10634
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -10607,7 +10663,7 @@ export declare namespace BetaTool {
|
|
|
10607
10663
|
/**
|
|
10608
10664
|
* Give the model access to additional tools via remote Model Context Protocol
|
|
10609
10665
|
* (MCP) servers.
|
|
10610
|
-
* [Learn more about MCP](https://
|
|
10666
|
+
* [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
10611
10667
|
*/
|
|
10612
10668
|
interface Mcp {
|
|
10613
10669
|
/**
|
|
@@ -10636,7 +10692,7 @@ export declare namespace BetaTool {
|
|
|
10636
10692
|
* Identifier for service connectors, like those available in ChatGPT. One of
|
|
10637
10693
|
* `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
|
|
10638
10694
|
* service connectors
|
|
10639
|
-
* [here](https://
|
|
10695
|
+
* [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
|
|
10640
10696
|
*
|
|
10641
10697
|
* Currently supported `connector_id` values are:
|
|
10642
10698
|
*
|
|
@@ -11015,12 +11071,12 @@ export interface BetaToolChoiceShell {
|
|
|
11015
11071
|
}
|
|
11016
11072
|
/**
|
|
11017
11073
|
* Indicates that the model should use a built-in tool to generate a response.
|
|
11018
|
-
* [Learn more about built-in tools](https://
|
|
11074
|
+
* [Learn more about built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
11019
11075
|
*/
|
|
11020
11076
|
export interface BetaToolChoiceTypes {
|
|
11021
11077
|
/**
|
|
11022
11078
|
* The type of hosted tool the model should to use. Learn more about
|
|
11023
|
-
* [built-in tools](https://
|
|
11079
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
11024
11080
|
*
|
|
11025
11081
|
* Allowed values are:
|
|
11026
11082
|
*
|
|
@@ -11058,7 +11114,7 @@ export interface BetaToolSearchTool {
|
|
|
11058
11114
|
/**
|
|
11059
11115
|
* This tool searches the web for relevant results to use in a response. Learn more
|
|
11060
11116
|
* about the
|
|
11061
|
-
* [web search tool](https://
|
|
11117
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
11062
11118
|
*/
|
|
11063
11119
|
export interface BetaWebSearchPreviewTool {
|
|
11064
11120
|
/**
|
|
@@ -11108,7 +11164,7 @@ export declare namespace BetaWebSearchPreviewTool {
|
|
|
11108
11164
|
}
|
|
11109
11165
|
/**
|
|
11110
11166
|
* Search the Internet for sources related to the prompt. Learn more about the
|
|
11111
|
-
* [web search tool](https://
|
|
11167
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
11112
11168
|
*/
|
|
11113
11169
|
export interface BetaWebSearchTool {
|
|
11114
11170
|
/**
|
|
@@ -11180,7 +11236,7 @@ export type ResponseCreateParams = ResponseCreateParamsNonStreaming | ResponseCr
|
|
|
11180
11236
|
export interface ResponseCreateParamsBase {
|
|
11181
11237
|
/**
|
|
11182
11238
|
* Body param: Whether to run the model response in the background.
|
|
11183
|
-
* [Learn more](https://
|
|
11239
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
11184
11240
|
*/
|
|
11185
11241
|
background?: boolean | null;
|
|
11186
11242
|
/**
|
|
@@ -11221,11 +11277,11 @@ export interface ResponseCreateParamsBase {
|
|
|
11221
11277
|
*
|
|
11222
11278
|
* Learn more:
|
|
11223
11279
|
*
|
|
11224
|
-
* - [Text inputs and outputs](https://
|
|
11225
|
-
* - [Image inputs](https://
|
|
11226
|
-
* - [File inputs](https://
|
|
11227
|
-
* - [Conversation state](https://
|
|
11228
|
-
* - [Function calling](https://
|
|
11280
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
11281
|
+
* - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
11282
|
+
* - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
11283
|
+
* - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
11284
|
+
* - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
11229
11285
|
*/
|
|
11230
11286
|
input?: string | BetaResponseInput;
|
|
11231
11287
|
/**
|
|
@@ -11239,7 +11295,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11239
11295
|
/**
|
|
11240
11296
|
* Body param: An upper bound for the number of tokens that can be generated for a
|
|
11241
11297
|
* response, including visible output tokens and
|
|
11242
|
-
* [reasoning tokens](https://
|
|
11298
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
11243
11299
|
*/
|
|
11244
11300
|
max_output_tokens?: number | null;
|
|
11245
11301
|
/**
|
|
@@ -11264,8 +11320,8 @@ export interface ResponseCreateParamsBase {
|
|
|
11264
11320
|
* Body param: Model ID used to generate the response, like `gpt-6-astra`. OpenAI
|
|
11265
11321
|
* offers a wide range of models with different capabilities, performance
|
|
11266
11322
|
* characteristics, and price points. Refer to the
|
|
11267
|
-
* [model guide](https://
|
|
11268
|
-
* available models.
|
|
11323
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
11324
|
+
* compare available models.
|
|
11269
11325
|
*/
|
|
11270
11326
|
model?: 'gpt-6-astra' | 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-5.5' | 'gpt-5.5-2026-04-23' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.4-mini-2026-03-17' | 'gpt-5.4-nano-2026-03-17' | 'gpt-5.3-chat-latest' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-codex' | 'gpt-5.1-mini' | 'gpt-5.1-chat-latest' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5-2025-08-07' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano-2025-04-14' | 'o4-mini' | 'o4-mini-2025-04-16' | 'o3' | 'o3-2025-04-16' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o1' | 'o1-2024-12-17' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o1-mini' | 'o1-mini-2024-09-12' | 'gpt-4o' | 'gpt-4o-2024-11-20' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-05-13' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-audio-preview-2025-06-03' | 'gpt-4o-mini-audio-preview' | 'gpt-4o-mini-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-mini-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview-2025-03-11' | 'chatgpt-4o-latest' | 'codex-mini-latest' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-0125-preview' | 'gpt-4-turbo-preview' | 'gpt-4-1106-preview' | 'gpt-4-vision-preview' | 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-16k-0613' | 'o1-pro' | 'o1-pro-2025-03-19' | 'o3-pro' | 'o3-pro-2025-06-10' | 'o3-deep-research' | 'o3-deep-research-2025-06-26' | 'o4-mini-deep-research' | 'o4-mini-deep-research-2025-06-26' | 'computer-use-preview' | 'computer-use-preview-2025-03-11' | 'gpt-5.5-pro' | 'gpt-5.5-pro-2026-04-23' | 'gpt-5-codex' | 'gpt-5-pro' | 'gpt-5-pro-2025-10-06' | 'gpt-5.1-codex-max' | 'gpt-daybreak-blue-latest' | 'gpt-daybreak-red-latest' | 'gpt-5.6-cyber' | (string & {});
|
|
11271
11327
|
/**
|
|
@@ -11284,19 +11340,19 @@ export interface ResponseCreateParamsBase {
|
|
|
11284
11340
|
/**
|
|
11285
11341
|
* Body param: The unique ID of the previous response to the model. Use this to
|
|
11286
11342
|
* create multi-turn conversations. Learn more about
|
|
11287
|
-
* [conversation state](https://
|
|
11343
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
11288
11344
|
* Cannot be used in conjunction with `conversation`.
|
|
11289
11345
|
*/
|
|
11290
11346
|
previous_response_id?: string | null;
|
|
11291
11347
|
/**
|
|
11292
11348
|
* Body param: Reference to a prompt template and its variables.
|
|
11293
|
-
* [Learn more](https://
|
|
11349
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
11294
11350
|
*/
|
|
11295
11351
|
prompt?: BetaResponsePrompt | null;
|
|
11296
11352
|
/**
|
|
11297
11353
|
* Body param: Used by OpenAI to cache responses for similar requests to optimize
|
|
11298
11354
|
* your cache hit rates. Replaces the `user` field.
|
|
11299
|
-
* [Learn more](https://
|
|
11355
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
11300
11356
|
*/
|
|
11301
11357
|
prompt_cache_key?: string | null;
|
|
11302
11358
|
/**
|
|
@@ -11308,7 +11364,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11308
11364
|
* conversation, without a content-block lookback limit. Set `mode` to `explicit`
|
|
11309
11365
|
* to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is
|
|
11310
11366
|
* currently the only supported value. See the
|
|
11311
|
-
* [prompt caching guide](https://
|
|
11367
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11312
11368
|
* for current details.
|
|
11313
11369
|
*/
|
|
11314
11370
|
prompt_cache_options?: ResponseCreateParams.PromptCacheOptions;
|
|
@@ -11318,7 +11374,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11318
11374
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
11319
11375
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
11320
11376
|
* of 24 hours.
|
|
11321
|
-
* [Learn more](https://
|
|
11377
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
11322
11378
|
* This field expresses a maximum retention policy, while
|
|
11323
11379
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
11324
11380
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -11334,7 +11390,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11334
11390
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
11335
11391
|
/**
|
|
11336
11392
|
* Body param: Configuration options for
|
|
11337
|
-
* [reasoning models](https://
|
|
11393
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
11338
11394
|
*/
|
|
11339
11395
|
reasoning?: ResponseCreateParams.Reasoning | null;
|
|
11340
11396
|
/**
|
|
@@ -11343,7 +11399,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11343
11399
|
* uniquely identifies each user, with a maximum length of 64 characters. We
|
|
11344
11400
|
* recommend hashing their username or email address, in order to avoid sending us
|
|
11345
11401
|
* any identifying information.
|
|
11346
|
-
* [Learn more](https://
|
|
11402
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
11347
11403
|
*/
|
|
11348
11404
|
safety_identifier?: string | null;
|
|
11349
11405
|
/**
|
|
@@ -11354,13 +11410,15 @@ export interface ResponseCreateParamsBase {
|
|
|
11354
11410
|
* will use 'default'.
|
|
11355
11411
|
* - If set to 'default', then the request will be processed with the standard
|
|
11356
11412
|
* pricing and performance for the selected model.
|
|
11357
|
-
* - If set to
|
|
11358
|
-
* then
|
|
11359
|
-
*
|
|
11360
|
-
*
|
|
11361
|
-
*
|
|
11362
|
-
*
|
|
11363
|
-
*
|
|
11413
|
+
* - If set to
|
|
11414
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
11415
|
+
* the request will be processed with the Flex Processing service tier.
|
|
11416
|
+
* - To opt-in to
|
|
11417
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
11418
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
11419
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
11420
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
11421
|
+
* `priority` in your request.
|
|
11364
11422
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
11365
11423
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
11366
11424
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -11377,7 +11435,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11377
11435
|
* Body param: Whether to store the generated model response for later retrieval
|
|
11378
11436
|
* via API. Defaults to true when omitted. If set to true, response data will be
|
|
11379
11437
|
* stored for at least 30 days, subject to the
|
|
11380
|
-
* [data retention exceptions](/api/docs/guides/your-data#v1responses).
|
|
11438
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
11381
11439
|
*/
|
|
11382
11440
|
store?: boolean | null;
|
|
11383
11441
|
/**
|
|
@@ -11385,7 +11443,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11385
11443
|
* client as it is generated using
|
|
11386
11444
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11387
11445
|
* See the
|
|
11388
|
-
* [Streaming section below](https://
|
|
11446
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11389
11447
|
* for more information.
|
|
11390
11448
|
*/
|
|
11391
11449
|
stream?: boolean | null;
|
|
@@ -11405,8 +11463,8 @@ export interface ResponseCreateParamsBase {
|
|
|
11405
11463
|
* Body param: Configuration options for a text response from the model. Can be
|
|
11406
11464
|
* plain text or structured JSON data. Learn more:
|
|
11407
11465
|
*
|
|
11408
|
-
* - [Text inputs and outputs](https://
|
|
11409
|
-
* - [Structured Outputs](https://
|
|
11466
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
11467
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
11410
11468
|
*/
|
|
11411
11469
|
text?: BetaResponseTextConfig;
|
|
11412
11470
|
/**
|
|
@@ -11423,17 +11481,18 @@ export interface ResponseCreateParamsBase {
|
|
|
11423
11481
|
*
|
|
11424
11482
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
11425
11483
|
* capabilities, like
|
|
11426
|
-
* [web search](https://
|
|
11427
|
-
*
|
|
11484
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
11485
|
+
* or
|
|
11486
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
11428
11487
|
* Learn more about
|
|
11429
|
-
* [built-in tools](https://
|
|
11488
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
11430
11489
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
11431
11490
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
11432
|
-
* [MCP Tools](https://
|
|
11491
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
11433
11492
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
11434
11493
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
11435
11494
|
* Learn more about
|
|
11436
|
-
* [function calling](https://
|
|
11495
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
11437
11496
|
* You can also use custom tools to call your own code.
|
|
11438
11497
|
*/
|
|
11439
11498
|
tools?: Array<BetaTool>;
|
|
@@ -11469,7 +11528,7 @@ export interface ResponseCreateParamsBase {
|
|
|
11469
11528
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
11470
11529
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
11471
11530
|
* abuse.
|
|
11472
|
-
* [Learn more](https://
|
|
11531
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
11473
11532
|
*/
|
|
11474
11533
|
user?: string;
|
|
11475
11534
|
/**
|
|
@@ -11557,7 +11616,7 @@ export declare namespace ResponseCreateParams {
|
|
|
11557
11616
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
11558
11617
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
11559
11618
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
11560
|
-
* [prompt caching guide](https://
|
|
11619
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11561
11620
|
* for current details.
|
|
11562
11621
|
*/
|
|
11563
11622
|
interface PromptCacheOptions {
|
|
@@ -11584,7 +11643,7 @@ export declare namespace ResponseCreateParams {
|
|
|
11584
11643
|
}
|
|
11585
11644
|
/**
|
|
11586
11645
|
* Configuration options for
|
|
11587
|
-
* [reasoning models](https://
|
|
11646
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
11588
11647
|
*/
|
|
11589
11648
|
interface Reasoning {
|
|
11590
11649
|
/**
|
|
@@ -11601,7 +11660,7 @@ export declare namespace ResponseCreateParams {
|
|
|
11601
11660
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
11602
11661
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
11603
11662
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
11604
|
-
* [reasoning guide](https://
|
|
11663
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
11605
11664
|
* model-specific support.
|
|
11606
11665
|
*/
|
|
11607
11666
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
|
|
@@ -11658,7 +11717,7 @@ export interface ResponseCreateParamsNonStreaming extends ResponseCreateParamsBa
|
|
|
11658
11717
|
* client as it is generated using
|
|
11659
11718
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11660
11719
|
* See the
|
|
11661
|
-
* [Streaming section below](https://
|
|
11720
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11662
11721
|
* for more information.
|
|
11663
11722
|
*/
|
|
11664
11723
|
stream?: false | null;
|
|
@@ -11669,7 +11728,7 @@ export interface ResponseCreateParamsStreaming extends ResponseCreateParamsBase
|
|
|
11669
11728
|
* client as it is generated using
|
|
11670
11729
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11671
11730
|
* See the
|
|
11672
|
-
* [Streaming section below](https://
|
|
11731
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11673
11732
|
* for more information.
|
|
11674
11733
|
*/
|
|
11675
11734
|
stream: true;
|
|
@@ -11700,7 +11759,7 @@ export interface ResponseRetrieveParamsBase {
|
|
|
11700
11759
|
* client as it is generated using
|
|
11701
11760
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11702
11761
|
* See the
|
|
11703
|
-
* [Streaming section below](https://
|
|
11762
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11704
11763
|
* for more information.
|
|
11705
11764
|
*/
|
|
11706
11765
|
stream?: boolean;
|
|
@@ -11719,7 +11778,7 @@ export interface ResponseRetrieveParamsNonStreaming extends ResponseRetrievePara
|
|
|
11719
11778
|
* client as it is generated using
|
|
11720
11779
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11721
11780
|
* See the
|
|
11722
|
-
* [Streaming section below](https://
|
|
11781
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11723
11782
|
* for more information.
|
|
11724
11783
|
*/
|
|
11725
11784
|
stream?: false;
|
|
@@ -11730,7 +11789,7 @@ export interface ResponseRetrieveParamsStreaming extends ResponseRetrieveParamsB
|
|
|
11730
11789
|
* client as it is generated using
|
|
11731
11790
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11732
11791
|
* See the
|
|
11733
|
-
* [Streaming section below](https://
|
|
11792
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11734
11793
|
* for more information.
|
|
11735
11794
|
*/
|
|
11736
11795
|
stream: true;
|
|
@@ -11752,8 +11811,8 @@ export interface ResponseCompactParams {
|
|
|
11752
11811
|
* Body param: Model ID used to generate the response, like `gpt-6-astra`. OpenAI
|
|
11753
11812
|
* offers a wide range of models with different capabilities, performance
|
|
11754
11813
|
* characteristics, and price points. Refer to the
|
|
11755
|
-
* [model guide](https://
|
|
11756
|
-
* available models.
|
|
11814
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
11815
|
+
* compare available models.
|
|
11757
11816
|
*/
|
|
11758
11817
|
model: 'gpt-6-astra' | 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-5.5' | 'gpt-5.5-2026-04-23' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.4-mini-2026-03-17' | 'gpt-5.4-nano-2026-03-17' | 'gpt-5.3-chat-latest' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-codex' | 'gpt-5.1-mini' | 'gpt-5.1-chat-latest' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5-2025-08-07' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano-2025-04-14' | 'o4-mini' | 'o4-mini-2025-04-16' | 'o3' | 'o3-2025-04-16' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o1' | 'o1-2024-12-17' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o1-mini' | 'o1-mini-2024-09-12' | 'gpt-4o' | 'gpt-4o-2024-11-20' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-05-13' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-audio-preview-2025-06-03' | 'gpt-4o-mini-audio-preview' | 'gpt-4o-mini-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-mini-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview-2025-03-11' | 'chatgpt-4o-latest' | 'codex-mini-latest' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-0125-preview' | 'gpt-4-turbo-preview' | 'gpt-4-1106-preview' | 'gpt-4-vision-preview' | 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-16k-0613' | 'o1-pro' | 'o1-pro-2025-03-19' | 'o3-pro' | 'o3-pro-2025-06-10' | 'o3-deep-research' | 'o3-deep-research-2025-06-26' | 'o4-mini-deep-research' | 'o4-mini-deep-research-2025-06-26' | 'computer-use-preview' | 'computer-use-preview-2025-03-11' | 'gpt-5.5-pro' | 'gpt-5.5-pro-2026-04-23' | 'gpt-5-codex' | 'gpt-5-pro' | 'gpt-5-pro-2025-10-06' | 'gpt-5.1-codex-max' | 'gpt-daybreak-blue-latest' | 'gpt-daybreak-red-latest' | 'gpt-5.6-cyber' | (string & {}) | null;
|
|
11759
11818
|
/**
|
|
@@ -11771,7 +11830,7 @@ export interface ResponseCompactParams {
|
|
|
11771
11830
|
/**
|
|
11772
11831
|
* Body param: The unique ID of the previous response to the model. Use this to
|
|
11773
11832
|
* create multi-turn conversations. Learn more about
|
|
11774
|
-
* [conversation state](https://
|
|
11833
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
11775
11834
|
* Cannot be used in conjunction with `conversation`.
|
|
11776
11835
|
*/
|
|
11777
11836
|
previous_response_id?: string | null;
|
|
@@ -11788,7 +11847,7 @@ export interface ResponseCompactParams {
|
|
|
11788
11847
|
* conversation, without a content-block lookback limit. Set `mode` to `explicit`
|
|
11789
11848
|
* to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is
|
|
11790
11849
|
* currently the only supported value. See the
|
|
11791
|
-
* [prompt caching guide](https://
|
|
11850
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11792
11851
|
* for current details.
|
|
11793
11852
|
*/
|
|
11794
11853
|
prompt_cache_options?: ResponseCompactParams.PromptCacheOptions | null;
|
|
@@ -11803,17 +11862,17 @@ export interface ResponseCompactParams {
|
|
|
11803
11862
|
* in the Project settings. Unless otherwise configured, the Project will use
|
|
11804
11863
|
* 'default'. - If set to 'default', then the request will be processed with the
|
|
11805
11864
|
* standard pricing and performance for the selected model. - If set to
|
|
11806
|
-
* '[flex](https://
|
|
11807
|
-
* request will be processed with the Flex Processing service tier. - To opt-in
|
|
11808
|
-
* [Fast mode](/api/docs/guides/fast-mode) at the
|
|
11809
|
-
* `service_tier=fast` or `service_tier=priority`
|
|
11810
|
-
* Completions. For models with a dedicated Fast
|
|
11811
|
-
* `service_tier=fast`; for other models, either
|
|
11812
|
-
* `service_tier=priority`. - When not set, the default behavior
|
|
11813
|
-
* the `service_tier` parameter is set, the response body will
|
|
11814
|
-
* `service_tier` value based on the processing mode actually used to
|
|
11815
|
-
* request. This response value may be different from the value set in
|
|
11816
|
-
* parameter.
|
|
11865
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
11866
|
+
* the request will be processed with the Flex Processing service tier. - To opt-in
|
|
11867
|
+
* to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
11868
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
11869
|
+
* parameter for Responses or Chat Completions. For models with a dedicated Fast
|
|
11870
|
+
* tier, either value resolves to `service_tier=fast`; for other models, either
|
|
11871
|
+
* value resolves to `service_tier=priority`. - When not set, the default behavior
|
|
11872
|
+
* is 'auto'. When the `service_tier` parameter is set, the response body will
|
|
11873
|
+
* include the `service_tier` value based on the processing mode actually used to
|
|
11874
|
+
* serve the request. This response value may be different from the value set in
|
|
11875
|
+
* the parameter.
|
|
11817
11876
|
*/
|
|
11818
11877
|
service_tier?: 'auto' | 'default' | 'fast' | 'flex' | 'priority' | null;
|
|
11819
11878
|
/**
|
|
@@ -11830,7 +11889,7 @@ export declare namespace ResponseCompactParams {
|
|
|
11830
11889
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
11831
11890
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
11832
11891
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
11833
|
-
* [prompt caching guide](https://
|
|
11892
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11834
11893
|
* for current details.
|
|
11835
11894
|
*/
|
|
11836
11895
|
interface PromptCacheOptions {
|