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
|
@@ -32,16 +32,16 @@ export declare class Responses extends APIResource {
|
|
|
32
32
|
inputTokens: InputTokensAPI.InputTokens;
|
|
33
33
|
/**
|
|
34
34
|
* Creates a model response. Provide
|
|
35
|
-
* [text](https://
|
|
36
|
-
* [image](https://
|
|
37
|
-
* [text](https://
|
|
38
|
-
* [JSON](https://
|
|
39
|
-
* the model call your own
|
|
40
|
-
* [custom code](https://
|
|
41
|
-
* built-in [tools](https://
|
|
42
|
-
* [web search](https://
|
|
43
|
-
* [file search](https://
|
|
44
|
-
* your own data as input for the model's response.
|
|
35
|
+
* [text](https://developers.openai.com/api/docs/guides/text) or
|
|
36
|
+
* [image](https://developers.openai.com/api/docs/guides/images-vision) inputs to
|
|
37
|
+
* generate [text](https://developers.openai.com/api/docs/guides/text) or
|
|
38
|
+
* [JSON](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
39
|
+
* outputs. Have the model call your own
|
|
40
|
+
* [custom code](https://developers.openai.com/api/docs/guides/function-calling) or
|
|
41
|
+
* use built-in [tools](https://developers.openai.com/api/docs/guides/tools) like
|
|
42
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search) or
|
|
43
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
44
|
+
* to use your own data as input for the model's response.
|
|
45
45
|
*
|
|
46
46
|
* @example
|
|
47
47
|
* ```ts
|
|
@@ -83,7 +83,7 @@ export declare class Responses extends APIResource {
|
|
|
83
83
|
/**
|
|
84
84
|
* Cancels a model response with the given ID. Only responses created with the
|
|
85
85
|
* `background` parameter set to `true` can be cancelled.
|
|
86
|
-
* [Learn more](https://
|
|
86
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
87
87
|
*
|
|
88
88
|
* @example
|
|
89
89
|
* ```ts
|
|
@@ -97,9 +97,9 @@ export declare class Responses extends APIResource {
|
|
|
97
97
|
* Compact a conversation. Returns a compacted response object.
|
|
98
98
|
*
|
|
99
99
|
* Learn when and how to compact long-running conversations in the
|
|
100
|
-
* [conversation state guide](https://
|
|
100
|
+
* [conversation state guide](https://developers.openai.com/api/docs/guides/conversation-state#managing-the-context-window).
|
|
101
101
|
* For ZDR-compatible compaction details, see
|
|
102
|
-
* [Compaction (advanced)](https://
|
|
102
|
+
* [Compaction (advanced)](https://developers.openai.com/api/docs/guides/conversation-state#compaction-advanced).
|
|
103
103
|
*
|
|
104
104
|
* @example
|
|
105
105
|
* ```ts
|
|
@@ -351,7 +351,7 @@ export declare namespace ComputerAction {
|
|
|
351
351
|
export type ComputerActionList = Array<ComputerAction>;
|
|
352
352
|
/**
|
|
353
353
|
* A tool that controls a virtual computer. Learn more about the
|
|
354
|
-
* [computer tool](https://
|
|
354
|
+
* [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).
|
|
355
355
|
*/
|
|
356
356
|
export interface ComputerTool {
|
|
357
357
|
/**
|
|
@@ -361,7 +361,7 @@ export interface ComputerTool {
|
|
|
361
361
|
}
|
|
362
362
|
/**
|
|
363
363
|
* A tool that controls a virtual computer. Learn more about the
|
|
364
|
-
* [computer tool](https://
|
|
364
|
+
* [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).
|
|
365
365
|
*/
|
|
366
366
|
export interface ComputerUsePreviewTool {
|
|
367
367
|
/**
|
|
@@ -449,7 +449,7 @@ export interface ContainerReference {
|
|
|
449
449
|
}
|
|
450
450
|
/**
|
|
451
451
|
* A custom tool that processes input using a specified format. Learn more about
|
|
452
|
-
* [custom tools](https://
|
|
452
|
+
* [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools)
|
|
453
453
|
*/
|
|
454
454
|
export interface CustomTool {
|
|
455
455
|
/**
|
|
@@ -515,7 +515,7 @@ export interface EasyInputMessage {
|
|
|
515
515
|
/**
|
|
516
516
|
* A tool that searches for relevant content from uploaded files. Learn more about
|
|
517
517
|
* the
|
|
518
|
-
* [file search tool](https://
|
|
518
|
+
* [file search tool](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
519
519
|
*/
|
|
520
520
|
export interface FileSearchTool {
|
|
521
521
|
/**
|
|
@@ -595,7 +595,7 @@ export interface FunctionShellTool {
|
|
|
595
595
|
/**
|
|
596
596
|
* Defines a function in your own code the model can choose to call. Learn more
|
|
597
597
|
* about
|
|
598
|
-
* [function calling](https://
|
|
598
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
599
599
|
*/
|
|
600
600
|
export interface FunctionTool {
|
|
601
601
|
/**
|
|
@@ -809,8 +809,8 @@ export interface Response {
|
|
|
809
809
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
810
810
|
* range of models with different capabilities, performance characteristics, and
|
|
811
811
|
* price points. Refer to the
|
|
812
|
-
* [model guide](https://
|
|
813
|
-
* available models.
|
|
812
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
813
|
+
* compare available models.
|
|
814
814
|
*/
|
|
815
815
|
model: Shared.ResponsesModel;
|
|
816
816
|
/**
|
|
@@ -852,17 +852,18 @@ export interface Response {
|
|
|
852
852
|
*
|
|
853
853
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
854
854
|
* capabilities, like
|
|
855
|
-
* [web search](https://
|
|
856
|
-
*
|
|
855
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
856
|
+
* or
|
|
857
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
857
858
|
* Learn more about
|
|
858
|
-
* [built-in tools](https://
|
|
859
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
859
860
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
860
861
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
861
|
-
* [MCP Tools](https://
|
|
862
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
862
863
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
863
864
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
864
865
|
* Learn more about
|
|
865
|
-
* [function calling](https://
|
|
866
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
866
867
|
* You can also use custom tools to call your own code.
|
|
867
868
|
*/
|
|
868
869
|
tools: Array<Tool>;
|
|
@@ -876,7 +877,7 @@ export interface Response {
|
|
|
876
877
|
top_p: number | null;
|
|
877
878
|
/**
|
|
878
879
|
* Whether to run the model response in the background.
|
|
879
|
-
* [Learn more](https://
|
|
880
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
880
881
|
*/
|
|
881
882
|
background?: boolean | null;
|
|
882
883
|
/**
|
|
@@ -892,7 +893,7 @@ export interface Response {
|
|
|
892
893
|
/**
|
|
893
894
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
894
895
|
* including visible output tokens and
|
|
895
|
-
* [reasoning tokens](https://
|
|
896
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
896
897
|
*/
|
|
897
898
|
max_output_tokens?: number | null;
|
|
898
899
|
/**
|
|
@@ -903,13 +904,13 @@ export interface Response {
|
|
|
903
904
|
/**
|
|
904
905
|
* The unique ID of the previous response to the model. Use this to create
|
|
905
906
|
* multi-turn conversations. Learn more about
|
|
906
|
-
* [conversation state](https://
|
|
907
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
907
908
|
* Cannot be used in conjunction with `conversation`.
|
|
908
909
|
*/
|
|
909
910
|
previous_response_id?: string | null;
|
|
910
911
|
/**
|
|
911
912
|
* Reference to a prompt template and its variables.
|
|
912
|
-
* [Learn more](https://
|
|
913
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
913
914
|
*/
|
|
914
915
|
prompt?: ResponsePrompt | null;
|
|
915
916
|
/**
|
|
@@ -919,7 +920,7 @@ export interface Response {
|
|
|
919
920
|
/**
|
|
920
921
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
921
922
|
* hit rates. Replaces the `user` field.
|
|
922
|
-
* [Learn more](https://
|
|
923
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
923
924
|
*/
|
|
924
925
|
prompt_cache_key?: string | null;
|
|
925
926
|
/**
|
|
@@ -933,7 +934,7 @@ export interface Response {
|
|
|
933
934
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
934
935
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
935
936
|
* of 24 hours.
|
|
936
|
-
* [Learn more](https://
|
|
937
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
937
938
|
* This field expresses a maximum retention policy, while
|
|
938
939
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
939
940
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -949,7 +950,7 @@ export interface Response {
|
|
|
949
950
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
950
951
|
/**
|
|
951
952
|
* Configuration options for
|
|
952
|
-
* [reasoning models](https://
|
|
953
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
953
954
|
*/
|
|
954
955
|
reasoning?: Shared.Reasoning | null;
|
|
955
956
|
/**
|
|
@@ -958,7 +959,7 @@ export interface Response {
|
|
|
958
959
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
959
960
|
* hashing their username or email address, in order to avoid sending us any
|
|
960
961
|
* identifying information.
|
|
961
|
-
* [Learn more](https://
|
|
962
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
962
963
|
*/
|
|
963
964
|
safety_identifier?: string | null;
|
|
964
965
|
/**
|
|
@@ -970,13 +971,15 @@ export interface Response {
|
|
|
970
971
|
* will use 'default'.
|
|
971
972
|
* - If set to 'default', then the request will be processed with the standard
|
|
972
973
|
* pricing and performance for the selected model.
|
|
973
|
-
* - If set to
|
|
974
|
-
* then
|
|
975
|
-
*
|
|
976
|
-
*
|
|
977
|
-
*
|
|
978
|
-
*
|
|
979
|
-
*
|
|
974
|
+
* - If set to
|
|
975
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
976
|
+
* the request will be processed with the Flex Processing service tier.
|
|
977
|
+
* - To opt-in to
|
|
978
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
979
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
980
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
981
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
982
|
+
* `priority` in your request.
|
|
980
983
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
981
984
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
982
985
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -996,8 +999,8 @@ export interface Response {
|
|
|
996
999
|
* Configuration options for a text response from the model. Can be plain text or
|
|
997
1000
|
* structured JSON data. Learn more:
|
|
998
1001
|
*
|
|
999
|
-
* - [Text inputs and outputs](https://
|
|
1000
|
-
* - [Structured Outputs](https://
|
|
1002
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
1003
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
1001
1004
|
*/
|
|
1002
1005
|
text?: ResponseTextConfig;
|
|
1003
1006
|
/**
|
|
@@ -1027,7 +1030,7 @@ export interface Response {
|
|
|
1027
1030
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
1028
1031
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
1029
1032
|
* abuse.
|
|
1030
|
-
* [Learn more](https://
|
|
1033
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
1031
1034
|
*/
|
|
1032
1035
|
user?: string;
|
|
1033
1036
|
}
|
|
@@ -1605,7 +1608,7 @@ export declare namespace ResponseCodeInterpreterToolCall {
|
|
|
1605
1608
|
}
|
|
1606
1609
|
/**
|
|
1607
1610
|
* A compaction item generated by the
|
|
1608
|
-
* [`v1/responses/compact` API](https://
|
|
1611
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
1609
1612
|
*/
|
|
1610
1613
|
export interface ResponseCompactionItem {
|
|
1611
1614
|
/**
|
|
@@ -1627,7 +1630,7 @@ export interface ResponseCompactionItem {
|
|
|
1627
1630
|
}
|
|
1628
1631
|
/**
|
|
1629
1632
|
* A compaction item generated by the
|
|
1630
|
-
* [`v1/responses/compact` API](https://
|
|
1633
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
1631
1634
|
*/
|
|
1632
1635
|
export interface ResponseCompactionItemParam {
|
|
1633
1636
|
/**
|
|
@@ -1662,7 +1665,7 @@ export interface ResponseCompletedEvent {
|
|
|
1662
1665
|
}
|
|
1663
1666
|
/**
|
|
1664
1667
|
* A tool call to a computer use tool. See the
|
|
1665
|
-
* [computer use guide](https://
|
|
1668
|
+
* [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use)
|
|
1666
1669
|
* for more information.
|
|
1667
1670
|
*/
|
|
1668
1671
|
export interface ResponseComputerToolCall {
|
|
@@ -2506,7 +2509,7 @@ export interface ResponseFileSearchCallSearchingEvent {
|
|
|
2506
2509
|
}
|
|
2507
2510
|
/**
|
|
2508
2511
|
* The results of a file search tool call. See the
|
|
2509
|
-
* [file search guide](https://
|
|
2512
|
+
* [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
2510
2513
|
* for more information.
|
|
2511
2514
|
*/
|
|
2512
2515
|
export interface ResponseFileSearchToolCall {
|
|
@@ -2567,7 +2570,7 @@ export declare namespace ResponseFileSearchToolCall {
|
|
|
2567
2570
|
*
|
|
2568
2571
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
2569
2572
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
2570
|
-
* [Structured Outputs guide](https://
|
|
2573
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
2571
2574
|
*
|
|
2572
2575
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
2573
2576
|
*
|
|
@@ -2581,7 +2584,7 @@ export type ResponseFormatTextConfig = Shared.ResponseFormatText | ResponseForma
|
|
|
2581
2584
|
/**
|
|
2582
2585
|
* JSON Schema response format. Used to generate structured JSON responses. Learn
|
|
2583
2586
|
* more about
|
|
2584
|
-
* [Structured Outputs](https://
|
|
2587
|
+
* [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
2585
2588
|
*/
|
|
2586
2589
|
export interface ResponseFormatTextJSONSchemaConfig {
|
|
2587
2590
|
/**
|
|
@@ -2610,7 +2613,7 @@ export interface ResponseFormatTextJSONSchemaConfig {
|
|
|
2610
2613
|
* true, the model will always follow the exact schema defined in the `schema`
|
|
2611
2614
|
* field. Only a subset of JSON Schema is supported when `strict` is `true`. To
|
|
2612
2615
|
* learn more, read the
|
|
2613
|
-
* [Structured Outputs guide](https://
|
|
2616
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
2614
2617
|
*/
|
|
2615
2618
|
strict?: boolean | null;
|
|
2616
2619
|
}
|
|
@@ -2875,7 +2878,7 @@ export declare namespace ResponseFunctionShellToolCallOutput {
|
|
|
2875
2878
|
}
|
|
2876
2879
|
/**
|
|
2877
2880
|
* A tool call to run a function. See the
|
|
2878
|
-
* [function calling guide](https://
|
|
2881
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
2879
2882
|
* for more information.
|
|
2880
2883
|
*/
|
|
2881
2884
|
export interface ResponseFunctionToolCall {
|
|
@@ -2931,7 +2934,7 @@ export declare namespace ResponseFunctionToolCall {
|
|
|
2931
2934
|
}
|
|
2932
2935
|
/**
|
|
2933
2936
|
* A tool call to run a function. See the
|
|
2934
|
-
* [function calling guide](https://
|
|
2937
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
2935
2938
|
* for more information.
|
|
2936
2939
|
*/
|
|
2937
2940
|
export interface ResponseFunctionToolCallItem extends ResponseFunctionToolCall {
|
|
@@ -3009,8 +3012,8 @@ export declare namespace ResponseFunctionToolCallOutputItem {
|
|
|
3009
3012
|
}
|
|
3010
3013
|
/**
|
|
3011
3014
|
* The results of a web search tool call. See the
|
|
3012
|
-
* [web search guide](https://
|
|
3013
|
-
* more information.
|
|
3015
|
+
* [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
3016
|
+
* for more information.
|
|
3014
3017
|
*/
|
|
3015
3018
|
export interface ResponseFunctionWebSearch {
|
|
3016
3019
|
/**
|
|
@@ -3411,7 +3414,7 @@ export declare namespace ResponseInputFileContent {
|
|
|
3411
3414
|
}
|
|
3412
3415
|
/**
|
|
3413
3416
|
* An image input to the model. Learn about
|
|
3414
|
-
* [image inputs](https://
|
|
3417
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision).
|
|
3415
3418
|
*/
|
|
3416
3419
|
export interface ResponseInputImage {
|
|
3417
3420
|
/**
|
|
@@ -3454,7 +3457,7 @@ export declare namespace ResponseInputImage {
|
|
|
3454
3457
|
}
|
|
3455
3458
|
/**
|
|
3456
3459
|
* An image input to the model. Learn about
|
|
3457
|
-
* [image inputs](https://
|
|
3460
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
3458
3461
|
*/
|
|
3459
3462
|
export interface ResponseInputImageContent {
|
|
3460
3463
|
/**
|
|
@@ -3700,11 +3703,27 @@ export declare namespace ResponseInputItem {
|
|
|
3700
3703
|
* The type of the image generation call. Always `image_generation_call`.
|
|
3701
3704
|
*/
|
|
3702
3705
|
type: 'image_generation_call';
|
|
3706
|
+
/**
|
|
3707
|
+
* The action used for image generation.
|
|
3708
|
+
*/
|
|
3709
|
+
action?: 'generate' | 'edit' | 'auto' | null;
|
|
3710
|
+
/**
|
|
3711
|
+
* The background setting used for generation.
|
|
3712
|
+
*/
|
|
3713
|
+
background?: 'transparent' | 'opaque' | 'auto' | null;
|
|
3714
|
+
/**
|
|
3715
|
+
* The output format used for generation.
|
|
3716
|
+
*/
|
|
3717
|
+
output_format?: 'png' | 'webp' | 'jpeg' | null;
|
|
3703
3718
|
/**
|
|
3704
3719
|
* The quality of the image generated by the image generation tool call. One of
|
|
3705
3720
|
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
3706
3721
|
*/
|
|
3707
3722
|
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
3723
|
+
/**
|
|
3724
|
+
* The prompt that was used after any model prompt rewriting.
|
|
3725
|
+
*/
|
|
3726
|
+
revised_prompt?: string | null;
|
|
3708
3727
|
/**
|
|
3709
3728
|
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
3710
3729
|
*/
|
|
@@ -4449,11 +4468,27 @@ export declare namespace ResponseItem {
|
|
|
4449
4468
|
* The type of the image generation call. Always `image_generation_call`.
|
|
4450
4469
|
*/
|
|
4451
4470
|
type: 'image_generation_call';
|
|
4471
|
+
/**
|
|
4472
|
+
* The action used for image generation.
|
|
4473
|
+
*/
|
|
4474
|
+
action?: 'generate' | 'edit' | 'auto' | null;
|
|
4475
|
+
/**
|
|
4476
|
+
* The background setting used for generation.
|
|
4477
|
+
*/
|
|
4478
|
+
background?: 'transparent' | 'opaque' | 'auto' | null;
|
|
4479
|
+
/**
|
|
4480
|
+
* The output format used for generation.
|
|
4481
|
+
*/
|
|
4482
|
+
output_format?: 'png' | 'webp' | 'jpeg' | null;
|
|
4452
4483
|
/**
|
|
4453
4484
|
* The quality of the image generated by the image generation tool call. One of
|
|
4454
4485
|
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
4455
4486
|
*/
|
|
4456
4487
|
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
4488
|
+
/**
|
|
4489
|
+
* The prompt that was used after any model prompt rewriting.
|
|
4490
|
+
*/
|
|
4491
|
+
revised_prompt?: string | null;
|
|
4457
4492
|
/**
|
|
4458
4493
|
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
4459
4494
|
*/
|
|
@@ -4973,11 +5008,27 @@ export declare namespace ResponseOutputItem {
|
|
|
4973
5008
|
* The type of the image generation call. Always `image_generation_call`.
|
|
4974
5009
|
*/
|
|
4975
5010
|
type: 'image_generation_call';
|
|
5011
|
+
/**
|
|
5012
|
+
* The action used for image generation.
|
|
5013
|
+
*/
|
|
5014
|
+
action?: 'generate' | 'edit' | 'auto' | null;
|
|
5015
|
+
/**
|
|
5016
|
+
* The background setting used for generation.
|
|
5017
|
+
*/
|
|
5018
|
+
background?: 'transparent' | 'opaque' | 'auto' | null;
|
|
5019
|
+
/**
|
|
5020
|
+
* The output format used for generation.
|
|
5021
|
+
*/
|
|
5022
|
+
output_format?: 'png' | 'webp' | 'jpeg' | null;
|
|
4976
5023
|
/**
|
|
4977
5024
|
* The quality of the image generated by the image generation tool call. One of
|
|
4978
5025
|
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
4979
5026
|
*/
|
|
4980
5027
|
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
5028
|
+
/**
|
|
5029
|
+
* The prompt that was used after any model prompt rewriting.
|
|
5030
|
+
*/
|
|
5031
|
+
revised_prompt?: string | null;
|
|
4981
5032
|
/**
|
|
4982
5033
|
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
4983
5034
|
*/
|
|
@@ -5556,7 +5607,7 @@ export declare namespace ResponseOutputTextAnnotationAddedEvent {
|
|
|
5556
5607
|
}
|
|
5557
5608
|
/**
|
|
5558
5609
|
* Reference to a prompt template and its variables.
|
|
5559
|
-
* [Learn more](https://
|
|
5610
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
5560
5611
|
*/
|
|
5561
5612
|
export interface ResponsePrompt {
|
|
5562
5613
|
/**
|
|
@@ -5597,7 +5648,7 @@ export interface ResponseQueuedEvent {
|
|
|
5597
5648
|
* A description of the chain of thought used by a reasoning model while generating
|
|
5598
5649
|
* a response. Be sure to include these items in your `input` to the Responses API
|
|
5599
5650
|
* for subsequent turns of a conversation if you are manually
|
|
5600
|
-
* [managing context](https://
|
|
5651
|
+
* [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
5601
5652
|
*/
|
|
5602
5653
|
export interface ResponseReasoningItem {
|
|
5603
5654
|
/**
|
|
@@ -6584,8 +6635,8 @@ export type ResponseStreamEvent = ResponseAudioDeltaEvent | ResponseAudioDoneEve
|
|
|
6584
6635
|
* Configuration options for a text response from the model. Can be plain text or
|
|
6585
6636
|
* structured JSON data. Learn more:
|
|
6586
6637
|
*
|
|
6587
|
-
* - [Text inputs and outputs](https://
|
|
6588
|
-
* - [Structured Outputs](https://
|
|
6638
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
6639
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
6589
6640
|
*/
|
|
6590
6641
|
export interface ResponseTextConfig {
|
|
6591
6642
|
/**
|
|
@@ -6593,7 +6644,7 @@ export interface ResponseTextConfig {
|
|
|
6593
6644
|
*
|
|
6594
6645
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
6595
6646
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
6596
|
-
* [Structured Outputs guide](https://
|
|
6647
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
6597
6648
|
*
|
|
6598
6649
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
6599
6650
|
*
|
|
@@ -6867,7 +6918,7 @@ export declare namespace ResponseUsage {
|
|
|
6867
6918
|
cache_write_tokens: number;
|
|
6868
6919
|
/**
|
|
6869
6920
|
* The number of tokens that were retrieved from the cache.
|
|
6870
|
-
* [More on prompt caching](https://
|
|
6921
|
+
* [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
6871
6922
|
*/
|
|
6872
6923
|
cached_tokens: number;
|
|
6873
6924
|
}
|
|
@@ -6979,7 +7030,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
6979
7030
|
type: 'response.create';
|
|
6980
7031
|
/**
|
|
6981
7032
|
* Whether to run the model response in the background.
|
|
6982
|
-
* [Learn more](https://
|
|
7033
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
6983
7034
|
*/
|
|
6984
7035
|
background?: boolean | null;
|
|
6985
7036
|
/**
|
|
@@ -7019,11 +7070,11 @@ export declare namespace ResponsesClientEvent {
|
|
|
7019
7070
|
*
|
|
7020
7071
|
* Learn more:
|
|
7021
7072
|
*
|
|
7022
|
-
* - [Text inputs and outputs](https://
|
|
7023
|
-
* - [Image inputs](https://
|
|
7024
|
-
* - [File inputs](https://
|
|
7025
|
-
* - [Conversation state](https://
|
|
7026
|
-
* - [Function calling](https://
|
|
7073
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
7074
|
+
* - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
7075
|
+
* - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
7076
|
+
* - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
7077
|
+
* - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
7027
7078
|
*/
|
|
7028
7079
|
input?: string | ResponsesAPI.ResponseInput;
|
|
7029
7080
|
/**
|
|
@@ -7037,7 +7088,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7037
7088
|
/**
|
|
7038
7089
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
7039
7090
|
* including visible output tokens and
|
|
7040
|
-
* [reasoning tokens](https://
|
|
7091
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
7041
7092
|
*/
|
|
7042
7093
|
max_output_tokens?: number | null;
|
|
7043
7094
|
/**
|
|
@@ -7060,8 +7111,8 @@ export declare namespace ResponsesClientEvent {
|
|
|
7060
7111
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
7061
7112
|
* range of models with different capabilities, performance characteristics, and
|
|
7062
7113
|
* price points. Refer to the
|
|
7063
|
-
* [model guide](https://
|
|
7064
|
-
* available models.
|
|
7114
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
7115
|
+
* compare available models.
|
|
7065
7116
|
*/
|
|
7066
7117
|
model?: Shared.ResponsesModel;
|
|
7067
7118
|
/**
|
|
@@ -7075,19 +7126,19 @@ export declare namespace ResponsesClientEvent {
|
|
|
7075
7126
|
/**
|
|
7076
7127
|
* The unique ID of the previous response to the model. Use this to create
|
|
7077
7128
|
* multi-turn conversations. Learn more about
|
|
7078
|
-
* [conversation state](https://
|
|
7129
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
7079
7130
|
* Cannot be used in conjunction with `conversation`.
|
|
7080
7131
|
*/
|
|
7081
7132
|
previous_response_id?: string | null;
|
|
7082
7133
|
/**
|
|
7083
7134
|
* Reference to a prompt template and its variables.
|
|
7084
|
-
* [Learn more](https://
|
|
7135
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
7085
7136
|
*/
|
|
7086
7137
|
prompt?: ResponsesAPI.ResponsePrompt | null;
|
|
7087
7138
|
/**
|
|
7088
7139
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
7089
7140
|
* hit rates. Replaces the `user` field.
|
|
7090
|
-
* [Learn more](https://
|
|
7141
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
7091
7142
|
*/
|
|
7092
7143
|
prompt_cache_key?: string | null;
|
|
7093
7144
|
/**
|
|
@@ -7098,7 +7149,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7098
7149
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
7099
7150
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
7100
7151
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
7101
|
-
* [prompt caching guide](https://
|
|
7152
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
7102
7153
|
* for current details.
|
|
7103
7154
|
*/
|
|
7104
7155
|
prompt_cache_options?: ResponseCreate.PromptCacheOptions;
|
|
@@ -7108,7 +7159,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7108
7159
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
7109
7160
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
7110
7161
|
* of 24 hours.
|
|
7111
|
-
* [Learn more](https://
|
|
7162
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
7112
7163
|
* This field expresses a maximum retention policy, while
|
|
7113
7164
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
7114
7165
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -7124,7 +7175,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7124
7175
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
7125
7176
|
/**
|
|
7126
7177
|
* Configuration options for
|
|
7127
|
-
* [reasoning models](https://
|
|
7178
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
7128
7179
|
*/
|
|
7129
7180
|
reasoning?: Shared.Reasoning | null;
|
|
7130
7181
|
/**
|
|
@@ -7133,7 +7184,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7133
7184
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
7134
7185
|
* hashing their username or email address, in order to avoid sending us any
|
|
7135
7186
|
* identifying information.
|
|
7136
|
-
* [Learn more](https://
|
|
7187
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
7137
7188
|
*/
|
|
7138
7189
|
safety_identifier?: string | null;
|
|
7139
7190
|
/**
|
|
@@ -7144,13 +7195,15 @@ export declare namespace ResponsesClientEvent {
|
|
|
7144
7195
|
* will use 'default'.
|
|
7145
7196
|
* - If set to 'default', then the request will be processed with the standard
|
|
7146
7197
|
* pricing and performance for the selected model.
|
|
7147
|
-
* - If set to
|
|
7148
|
-
* then
|
|
7149
|
-
*
|
|
7150
|
-
*
|
|
7151
|
-
*
|
|
7152
|
-
*
|
|
7153
|
-
*
|
|
7198
|
+
* - If set to
|
|
7199
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
7200
|
+
* the request will be processed with the Flex Processing service tier.
|
|
7201
|
+
* - To opt-in to
|
|
7202
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
7203
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
7204
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
7205
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
7206
|
+
* `priority` in your request.
|
|
7154
7207
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
7155
7208
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
7156
7209
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -7167,7 +7220,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7167
7220
|
* Whether to store the generated model response for later retrieval via API.
|
|
7168
7221
|
* Defaults to true when omitted. If set to true, response data will be stored for
|
|
7169
7222
|
* at least 30 days, subject to the
|
|
7170
|
-
* [data retention exceptions](/api/docs/guides/your-data#v1responses).
|
|
7223
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
7171
7224
|
*/
|
|
7172
7225
|
store?: boolean | null;
|
|
7173
7226
|
/**
|
|
@@ -7175,7 +7228,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7175
7228
|
* generated using
|
|
7176
7229
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
7177
7230
|
* See the
|
|
7178
|
-
* [Streaming section below](https://
|
|
7231
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
7179
7232
|
* for more information.
|
|
7180
7233
|
*/
|
|
7181
7234
|
stream?: boolean | null;
|
|
@@ -7202,8 +7255,8 @@ export declare namespace ResponsesClientEvent {
|
|
|
7202
7255
|
* Configuration options for a text response from the model. Can be plain text or
|
|
7203
7256
|
* structured JSON data. Learn more:
|
|
7204
7257
|
*
|
|
7205
|
-
* - [Text inputs and outputs](https://
|
|
7206
|
-
* - [Structured Outputs](https://
|
|
7258
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
7259
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
7207
7260
|
*/
|
|
7208
7261
|
text?: ResponsesAPI.ResponseTextConfig;
|
|
7209
7262
|
/**
|
|
@@ -7220,17 +7273,18 @@ export declare namespace ResponsesClientEvent {
|
|
|
7220
7273
|
*
|
|
7221
7274
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
7222
7275
|
* capabilities, like
|
|
7223
|
-
* [web search](https://
|
|
7224
|
-
*
|
|
7276
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
7277
|
+
* or
|
|
7278
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
7225
7279
|
* Learn more about
|
|
7226
|
-
* [built-in tools](https://
|
|
7280
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
7227
7281
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
7228
7282
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
7229
|
-
* [MCP Tools](https://
|
|
7283
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
7230
7284
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
7231
7285
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
7232
7286
|
* Learn more about
|
|
7233
|
-
* [function calling](https://
|
|
7287
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
7234
7288
|
* You can also use custom tools to call your own code.
|
|
7235
7289
|
*/
|
|
7236
7290
|
tools?: Array<ResponsesAPI.Tool>;
|
|
@@ -7264,7 +7318,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7264
7318
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
7265
7319
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
7266
7320
|
* abuse.
|
|
7267
|
-
* [Learn more](https://
|
|
7321
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
7268
7322
|
*/
|
|
7269
7323
|
user?: string;
|
|
7270
7324
|
}
|
|
@@ -7330,7 +7384,7 @@ export declare namespace ResponsesClientEvent {
|
|
|
7330
7384
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
7331
7385
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
7332
7386
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
7333
|
-
* [prompt caching guide](https://
|
|
7387
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
7334
7388
|
* for current details.
|
|
7335
7389
|
*/
|
|
7336
7390
|
interface PromptCacheOptions {
|
|
@@ -8062,13 +8116,15 @@ export declare namespace ResponsesServerEvent {
|
|
|
8062
8116
|
* will use 'default'.
|
|
8063
8117
|
* - If set to 'default', then the request will be processed with the standard
|
|
8064
8118
|
* pricing and performance for the selected model.
|
|
8065
|
-
* - If set to
|
|
8066
|
-
* then
|
|
8067
|
-
*
|
|
8068
|
-
*
|
|
8069
|
-
*
|
|
8070
|
-
*
|
|
8071
|
-
*
|
|
8119
|
+
* - If set to
|
|
8120
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
8121
|
+
* the request will be processed with the Flex Processing service tier.
|
|
8122
|
+
* - To opt-in to
|
|
8123
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
8124
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
8125
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
8126
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
8127
|
+
* `priority` in your request.
|
|
8072
8128
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
8073
8129
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
8074
8130
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -8103,7 +8159,7 @@ export declare namespace Tool {
|
|
|
8103
8159
|
/**
|
|
8104
8160
|
* Give the model access to additional tools via remote Model Context Protocol
|
|
8105
8161
|
* (MCP) servers.
|
|
8106
|
-
* [Learn more about MCP](https://
|
|
8162
|
+
* [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
8107
8163
|
*/
|
|
8108
8164
|
interface Mcp {
|
|
8109
8165
|
/**
|
|
@@ -8132,7 +8188,7 @@ export declare namespace Tool {
|
|
|
8132
8188
|
* Identifier for service connectors, like those available in ChatGPT. One of
|
|
8133
8189
|
* `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
|
|
8134
8190
|
* service connectors
|
|
8135
|
-
* [here](https://
|
|
8191
|
+
* [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
|
|
8136
8192
|
*
|
|
8137
8193
|
* Currently supported `connector_id` values are:
|
|
8138
8194
|
*
|
|
@@ -8511,12 +8567,12 @@ export interface ToolChoiceShell {
|
|
|
8511
8567
|
}
|
|
8512
8568
|
/**
|
|
8513
8569
|
* Indicates that the model should use a built-in tool to generate a response.
|
|
8514
|
-
* [Learn more about built-in tools](https://
|
|
8570
|
+
* [Learn more about built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
8515
8571
|
*/
|
|
8516
8572
|
export interface ToolChoiceTypes {
|
|
8517
8573
|
/**
|
|
8518
8574
|
* The type of hosted tool the model should to use. Learn more about
|
|
8519
|
-
* [built-in tools](https://
|
|
8575
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
8520
8576
|
*
|
|
8521
8577
|
* Allowed values are:
|
|
8522
8578
|
*
|
|
@@ -8555,7 +8611,7 @@ export interface ToolSearchTool {
|
|
|
8555
8611
|
/**
|
|
8556
8612
|
* This tool searches the web for relevant results to use in a response. Learn more
|
|
8557
8613
|
* about the
|
|
8558
|
-
* [web search tool](https://
|
|
8614
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
8559
8615
|
*/
|
|
8560
8616
|
export interface WebSearchPreviewTool {
|
|
8561
8617
|
/**
|
|
@@ -8605,7 +8661,7 @@ export declare namespace WebSearchPreviewTool {
|
|
|
8605
8661
|
}
|
|
8606
8662
|
/**
|
|
8607
8663
|
* Search the Internet for sources related to the prompt. Learn more about the
|
|
8608
|
-
* [web search tool](https://
|
|
8664
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
8609
8665
|
*/
|
|
8610
8666
|
export interface WebSearchTool {
|
|
8611
8667
|
/**
|
|
@@ -8677,7 +8733,7 @@ export type ResponseCreateParams = ResponseCreateParamsNonStreaming | ResponseCr
|
|
|
8677
8733
|
export interface ResponseCreateParamsBase {
|
|
8678
8734
|
/**
|
|
8679
8735
|
* Whether to run the model response in the background.
|
|
8680
|
-
* [Learn more](https://
|
|
8736
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
8681
8737
|
*/
|
|
8682
8738
|
background?: boolean | null;
|
|
8683
8739
|
/**
|
|
@@ -8720,11 +8776,11 @@ export interface ResponseCreateParamsBase {
|
|
|
8720
8776
|
*
|
|
8721
8777
|
* Learn more:
|
|
8722
8778
|
*
|
|
8723
|
-
* - [Text inputs and outputs](https://
|
|
8724
|
-
* - [Image inputs](https://
|
|
8725
|
-
* - [File inputs](https://
|
|
8726
|
-
* - [Conversation state](https://
|
|
8727
|
-
* - [Function calling](https://
|
|
8779
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
8780
|
+
* - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
8781
|
+
* - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
8782
|
+
* - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
8783
|
+
* - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
8728
8784
|
*/
|
|
8729
8785
|
input?: string | ResponseInput;
|
|
8730
8786
|
/**
|
|
@@ -8738,7 +8794,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8738
8794
|
/**
|
|
8739
8795
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
8740
8796
|
* including visible output tokens and
|
|
8741
|
-
* [reasoning tokens](https://
|
|
8797
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
8742
8798
|
*/
|
|
8743
8799
|
max_output_tokens?: number | null;
|
|
8744
8800
|
/**
|
|
@@ -8754,8 +8810,8 @@ export interface ResponseCreateParamsBase {
|
|
|
8754
8810
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
8755
8811
|
* range of models with different capabilities, performance characteristics, and
|
|
8756
8812
|
* price points. Refer to the
|
|
8757
|
-
* [model guide](https://
|
|
8758
|
-
* available models.
|
|
8813
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
8814
|
+
* compare available models.
|
|
8759
8815
|
*/
|
|
8760
8816
|
model?: Shared.ResponsesModel;
|
|
8761
8817
|
/**
|
|
@@ -8769,19 +8825,19 @@ export interface ResponseCreateParamsBase {
|
|
|
8769
8825
|
/**
|
|
8770
8826
|
* The unique ID of the previous response to the model. Use this to create
|
|
8771
8827
|
* multi-turn conversations. Learn more about
|
|
8772
|
-
* [conversation state](https://
|
|
8828
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
8773
8829
|
* Cannot be used in conjunction with `conversation`.
|
|
8774
8830
|
*/
|
|
8775
8831
|
previous_response_id?: string | null;
|
|
8776
8832
|
/**
|
|
8777
8833
|
* Reference to a prompt template and its variables.
|
|
8778
|
-
* [Learn more](https://
|
|
8834
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
8779
8835
|
*/
|
|
8780
8836
|
prompt?: ResponsePrompt | null;
|
|
8781
8837
|
/**
|
|
8782
8838
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
8783
8839
|
* hit rates. Replaces the `user` field.
|
|
8784
|
-
* [Learn more](https://
|
|
8840
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
8785
8841
|
*/
|
|
8786
8842
|
prompt_cache_key?: string | null;
|
|
8787
8843
|
/**
|
|
@@ -8792,7 +8848,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8792
8848
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
8793
8849
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
8794
8850
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
8795
|
-
* [prompt caching guide](https://
|
|
8851
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
8796
8852
|
* for current details.
|
|
8797
8853
|
*/
|
|
8798
8854
|
prompt_cache_options?: ResponseCreateParams.PromptCacheOptions;
|
|
@@ -8802,7 +8858,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8802
8858
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
8803
8859
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
8804
8860
|
* of 24 hours.
|
|
8805
|
-
* [Learn more](https://
|
|
8861
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
8806
8862
|
* This field expresses a maximum retention policy, while
|
|
8807
8863
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
8808
8864
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -8818,7 +8874,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8818
8874
|
prompt_cache_retention?: 'in_memory' | '24h' | null;
|
|
8819
8875
|
/**
|
|
8820
8876
|
* Configuration options for
|
|
8821
|
-
* [reasoning models](https://
|
|
8877
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
8822
8878
|
*/
|
|
8823
8879
|
reasoning?: Shared.Reasoning | null;
|
|
8824
8880
|
/**
|
|
@@ -8827,7 +8883,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8827
8883
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
8828
8884
|
* hashing their username or email address, in order to avoid sending us any
|
|
8829
8885
|
* identifying information.
|
|
8830
|
-
* [Learn more](https://
|
|
8886
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
8831
8887
|
*/
|
|
8832
8888
|
safety_identifier?: string | null;
|
|
8833
8889
|
/**
|
|
@@ -8839,13 +8895,15 @@ export interface ResponseCreateParamsBase {
|
|
|
8839
8895
|
* will use 'default'.
|
|
8840
8896
|
* - If set to 'default', then the request will be processed with the standard
|
|
8841
8897
|
* pricing and performance for the selected model.
|
|
8842
|
-
* - If set to
|
|
8843
|
-
* then
|
|
8844
|
-
*
|
|
8845
|
-
*
|
|
8846
|
-
*
|
|
8847
|
-
*
|
|
8848
|
-
*
|
|
8898
|
+
* - If set to
|
|
8899
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
8900
|
+
* the request will be processed with the Flex Processing service tier.
|
|
8901
|
+
* - To opt-in to
|
|
8902
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
8903
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
8904
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
8905
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
8906
|
+
* `priority` in your request.
|
|
8849
8907
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
8850
8908
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
8851
8909
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -8860,7 +8918,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8860
8918
|
* Whether to store the generated model response for later retrieval via API.
|
|
8861
8919
|
* Defaults to true when omitted. If set to true, response data will be stored for
|
|
8862
8920
|
* at least 30 days, subject to the
|
|
8863
|
-
* [data retention exceptions](/api/docs/guides/your-data#v1responses).
|
|
8921
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
8864
8922
|
*/
|
|
8865
8923
|
store?: boolean | null;
|
|
8866
8924
|
/**
|
|
@@ -8868,7 +8926,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8868
8926
|
* generated using
|
|
8869
8927
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
8870
8928
|
* See the
|
|
8871
|
-
* [Streaming section below](https://
|
|
8929
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
8872
8930
|
* for more information.
|
|
8873
8931
|
*/
|
|
8874
8932
|
stream?: boolean | null;
|
|
@@ -8887,8 +8945,8 @@ export interface ResponseCreateParamsBase {
|
|
|
8887
8945
|
* Configuration options for a text response from the model. Can be plain text or
|
|
8888
8946
|
* structured JSON data. Learn more:
|
|
8889
8947
|
*
|
|
8890
|
-
* - [Text inputs and outputs](https://
|
|
8891
|
-
* - [Structured Outputs](https://
|
|
8948
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
8949
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
8892
8950
|
*/
|
|
8893
8951
|
text?: ResponseTextConfig;
|
|
8894
8952
|
/**
|
|
@@ -8905,17 +8963,18 @@ export interface ResponseCreateParamsBase {
|
|
|
8905
8963
|
*
|
|
8906
8964
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
8907
8965
|
* capabilities, like
|
|
8908
|
-
* [web search](https://
|
|
8909
|
-
*
|
|
8966
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
8967
|
+
* or
|
|
8968
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
8910
8969
|
* Learn more about
|
|
8911
|
-
* [built-in tools](https://
|
|
8970
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
8912
8971
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
8913
8972
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
8914
|
-
* [MCP Tools](https://
|
|
8973
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
8915
8974
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
8916
8975
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
8917
8976
|
* Learn more about
|
|
8918
|
-
* [function calling](https://
|
|
8977
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
8919
8978
|
* You can also use custom tools to call your own code.
|
|
8920
8979
|
*/
|
|
8921
8980
|
tools?: Array<Tool>;
|
|
@@ -8949,7 +9008,7 @@ export interface ResponseCreateParamsBase {
|
|
|
8949
9008
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
8950
9009
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
8951
9010
|
* abuse.
|
|
8952
|
-
* [Learn more](https://
|
|
9011
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
8953
9012
|
*/
|
|
8954
9013
|
user?: string;
|
|
8955
9014
|
}
|
|
@@ -9015,7 +9074,7 @@ export declare namespace ResponseCreateParams {
|
|
|
9015
9074
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
9016
9075
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
9017
9076
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
9018
|
-
* [prompt caching guide](https://
|
|
9077
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
9019
9078
|
* for current details.
|
|
9020
9079
|
*/
|
|
9021
9080
|
interface PromptCacheOptions {
|
|
@@ -9069,7 +9128,7 @@ export interface ResponseCreateParamsNonStreaming extends ResponseCreateParamsBa
|
|
|
9069
9128
|
* generated using
|
|
9070
9129
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
9071
9130
|
* See the
|
|
9072
|
-
* [Streaming section below](https://
|
|
9131
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
9073
9132
|
* for more information.
|
|
9074
9133
|
*/
|
|
9075
9134
|
stream?: false | null;
|
|
@@ -9080,7 +9139,7 @@ export interface ResponseCreateParamsStreaming extends ResponseCreateParamsBase
|
|
|
9080
9139
|
* generated using
|
|
9081
9140
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
9082
9141
|
* See the
|
|
9083
|
-
* [Streaming section below](https://
|
|
9142
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
9084
9143
|
* for more information.
|
|
9085
9144
|
*/
|
|
9086
9145
|
stream: true;
|
|
@@ -9110,7 +9169,7 @@ export interface ResponseRetrieveParamsBase {
|
|
|
9110
9169
|
* generated using
|
|
9111
9170
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
9112
9171
|
* See the
|
|
9113
|
-
* [Streaming section below](https://
|
|
9172
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
9114
9173
|
* for more information.
|
|
9115
9174
|
*/
|
|
9116
9175
|
stream?: boolean;
|
|
@@ -9125,7 +9184,7 @@ export interface ResponseRetrieveParamsNonStreaming extends ResponseRetrievePara
|
|
|
9125
9184
|
* generated using
|
|
9126
9185
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
9127
9186
|
* See the
|
|
9128
|
-
* [Streaming section below](https://
|
|
9187
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
9129
9188
|
* for more information.
|
|
9130
9189
|
*/
|
|
9131
9190
|
stream?: false;
|
|
@@ -9136,7 +9195,7 @@ export interface ResponseRetrieveParamsStreaming extends ResponseRetrieveParamsB
|
|
|
9136
9195
|
* generated using
|
|
9137
9196
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
9138
9197
|
* See the
|
|
9139
|
-
* [Streaming section below](https://
|
|
9198
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
9140
9199
|
* for more information.
|
|
9141
9200
|
*/
|
|
9142
9201
|
stream: true;
|
|
@@ -9146,8 +9205,8 @@ export interface ResponseCompactParams {
|
|
|
9146
9205
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
9147
9206
|
* range of models with different capabilities, performance characteristics, and
|
|
9148
9207
|
* price points. Refer to the
|
|
9149
|
-
* [model guide](https://
|
|
9150
|
-
* available models.
|
|
9208
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
9209
|
+
* compare available models.
|
|
9151
9210
|
*/
|
|
9152
9211
|
model: 'gpt-6-astra' | 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-5.5' | 'gpt-5.5-2026-04-23' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.4-mini-2026-03-17' | 'gpt-5.4-nano-2026-03-17' | 'gpt-5.3-chat-latest' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-codex' | 'gpt-5.1-mini' | 'gpt-5.1-chat-latest' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5-2025-08-07' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano-2025-04-14' | 'o4-mini' | 'o4-mini-2025-04-16' | 'o3' | 'o3-2025-04-16' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o1' | 'o1-2024-12-17' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o1-mini' | 'o1-mini-2024-09-12' | 'gpt-4o' | 'gpt-4o-2024-11-20' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-05-13' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-audio-preview-2025-06-03' | 'gpt-4o-mini-audio-preview' | 'gpt-4o-mini-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-mini-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview-2025-03-11' | 'chatgpt-4o-latest' | 'codex-mini-latest' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-0125-preview' | 'gpt-4-turbo-preview' | 'gpt-4-1106-preview' | 'gpt-4-vision-preview' | 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0301' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-16k-0613' | 'o1-pro' | 'o1-pro-2025-03-19' | 'o3-pro' | 'o3-pro-2025-06-10' | 'o3-deep-research' | 'o3-deep-research-2025-06-26' | 'o4-mini-deep-research' | 'o4-mini-deep-research-2025-06-26' | 'computer-use-preview' | 'computer-use-preview-2025-03-11' | 'gpt-5.5-pro' | 'gpt-5.5-pro-2026-04-23' | 'gpt-5-codex' | 'gpt-5-pro' | 'gpt-5-pro-2025-10-06' | 'gpt-5.1-codex-max' | 'gpt-daybreak-blue-latest' | 'gpt-daybreak-red-latest' | 'gpt-5.6-cyber' | (string & {}) | null;
|
|
9153
9212
|
/**
|
|
@@ -9164,7 +9223,7 @@ export interface ResponseCompactParams {
|
|
|
9164
9223
|
/**
|
|
9165
9224
|
* The unique ID of the previous response to the model. Use this to create
|
|
9166
9225
|
* multi-turn conversations. Learn more about
|
|
9167
|
-
* [conversation state](https://
|
|
9226
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
9168
9227
|
* Cannot be used in conjunction with `conversation`.
|
|
9169
9228
|
*/
|
|
9170
9229
|
previous_response_id?: string | null;
|
|
@@ -9180,7 +9239,7 @@ export interface ResponseCompactParams {
|
|
|
9180
9239
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
9181
9240
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
9182
9241
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
9183
|
-
* [prompt caching guide](https://
|
|
9242
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
9184
9243
|
* for current details.
|
|
9185
9244
|
*/
|
|
9186
9245
|
prompt_cache_options?: ResponseCompactParams.PromptCacheOptions | null;
|
|
@@ -9194,17 +9253,17 @@ export interface ResponseCompactParams {
|
|
|
9194
9253
|
* Project settings. Unless otherwise configured, the Project will use 'default'. -
|
|
9195
9254
|
* If set to 'default', then the request will be processed with the standard
|
|
9196
9255
|
* pricing and performance for the selected model. - If set to
|
|
9197
|
-
* '[flex](https://
|
|
9198
|
-
* request will be processed with the Flex Processing service tier. - To opt-in
|
|
9199
|
-
* [Fast mode](/api/docs/guides/fast-mode) at the
|
|
9200
|
-
* `service_tier=fast` or `service_tier=priority`
|
|
9201
|
-
* Completions. For models with a dedicated Fast
|
|
9202
|
-
* `service_tier=fast`; for other models, either
|
|
9203
|
-
* `service_tier=priority`. - When not set, the default behavior
|
|
9204
|
-
* the `service_tier` parameter is set, the response body will
|
|
9205
|
-
* `service_tier` value based on the processing mode actually used to
|
|
9206
|
-
* request. This response value may be different from the value set in
|
|
9207
|
-
* parameter.
|
|
9256
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
9257
|
+
* the request will be processed with the Flex Processing service tier. - To opt-in
|
|
9258
|
+
* to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
9259
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
9260
|
+
* parameter for Responses or Chat Completions. For models with a dedicated Fast
|
|
9261
|
+
* tier, either value resolves to `service_tier=fast`; for other models, either
|
|
9262
|
+
* value resolves to `service_tier=priority`. - When not set, the default behavior
|
|
9263
|
+
* is 'auto'. When the `service_tier` parameter is set, the response body will
|
|
9264
|
+
* include the `service_tier` value based on the processing mode actually used to
|
|
9265
|
+
* serve the request. This response value may be different from the value set in
|
|
9266
|
+
* the parameter.
|
|
9208
9267
|
*/
|
|
9209
9268
|
service_tier?: 'auto' | 'default' | 'fast' | 'flex' | 'priority' | null;
|
|
9210
9269
|
}
|
|
@@ -9217,7 +9276,7 @@ export declare namespace ResponseCompactParams {
|
|
|
9217
9276
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
9218
9277
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
9219
9278
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
9220
|
-
* [prompt caching guide](https://
|
|
9279
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
9221
9280
|
* for current details.
|
|
9222
9281
|
*/
|
|
9223
9282
|
interface PromptCacheOptions {
|