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
|
@@ -79,16 +79,16 @@ export class Responses extends APIResource {
|
|
|
79
79
|
|
|
80
80
|
/**
|
|
81
81
|
* Creates a model response. Provide
|
|
82
|
-
* [text](https://
|
|
83
|
-
* [image](https://
|
|
84
|
-
* [text](https://
|
|
85
|
-
* [JSON](https://
|
|
86
|
-
* the model call your own
|
|
87
|
-
* [custom code](https://
|
|
88
|
-
* built-in [tools](https://
|
|
89
|
-
* [web search](https://
|
|
90
|
-
* [file search](https://
|
|
91
|
-
* your own data as input for the model's response.
|
|
82
|
+
* [text](https://developers.openai.com/api/docs/guides/text) or
|
|
83
|
+
* [image](https://developers.openai.com/api/docs/guides/images-vision) inputs to
|
|
84
|
+
* generate [text](https://developers.openai.com/api/docs/guides/text) or
|
|
85
|
+
* [JSON](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
86
|
+
* outputs. Have the model call your own
|
|
87
|
+
* [custom code](https://developers.openai.com/api/docs/guides/function-calling) or
|
|
88
|
+
* use built-in [tools](https://developers.openai.com/api/docs/guides/tools) like
|
|
89
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search) or
|
|
90
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
91
|
+
* to use your own data as input for the model's response.
|
|
92
92
|
*
|
|
93
93
|
* @example
|
|
94
94
|
* ```ts
|
|
@@ -210,7 +210,7 @@ export class Responses extends APIResource {
|
|
|
210
210
|
/**
|
|
211
211
|
* Cancels a model response with the given ID. Only responses created with the
|
|
212
212
|
* `background` parameter set to `true` can be cancelled.
|
|
213
|
-
* [Learn more](https://
|
|
213
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
214
214
|
*
|
|
215
215
|
* @example
|
|
216
216
|
* ```ts
|
|
@@ -230,9 +230,9 @@ export class Responses extends APIResource {
|
|
|
230
230
|
* Compact a conversation. Returns a compacted response object.
|
|
231
231
|
*
|
|
232
232
|
* Learn when and how to compact long-running conversations in the
|
|
233
|
-
* [conversation state guide](https://
|
|
233
|
+
* [conversation state guide](https://developers.openai.com/api/docs/guides/conversation-state#managing-the-context-window).
|
|
234
234
|
* For ZDR-compatible compaction details, see
|
|
235
|
-
* [Compaction (advanced)](https://
|
|
235
|
+
* [Compaction (advanced)](https://developers.openai.com/api/docs/guides/conversation-state#compaction-advanced).
|
|
236
236
|
*
|
|
237
237
|
* @example
|
|
238
238
|
* ```ts
|
|
@@ -536,7 +536,7 @@ export type ComputerActionList = Array<ComputerAction>;
|
|
|
536
536
|
|
|
537
537
|
/**
|
|
538
538
|
* A tool that controls a virtual computer. Learn more about the
|
|
539
|
-
* [computer tool](https://
|
|
539
|
+
* [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).
|
|
540
540
|
*/
|
|
541
541
|
export interface ComputerTool {
|
|
542
542
|
/**
|
|
@@ -547,7 +547,7 @@ export interface ComputerTool {
|
|
|
547
547
|
|
|
548
548
|
/**
|
|
549
549
|
* A tool that controls a virtual computer. Learn more about the
|
|
550
|
-
* [computer tool](https://
|
|
550
|
+
* [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).
|
|
551
551
|
*/
|
|
552
552
|
export interface ComputerUsePreviewTool {
|
|
553
553
|
/**
|
|
@@ -653,7 +653,7 @@ export interface ContainerReference {
|
|
|
653
653
|
|
|
654
654
|
/**
|
|
655
655
|
* A custom tool that processes input using a specified format. Learn more about
|
|
656
|
-
* [custom tools](https://
|
|
656
|
+
* [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools)
|
|
657
657
|
*/
|
|
658
658
|
export interface CustomTool {
|
|
659
659
|
/**
|
|
@@ -730,7 +730,7 @@ export interface EasyInputMessage {
|
|
|
730
730
|
/**
|
|
731
731
|
* A tool that searches for relevant content from uploaded files. Learn more about
|
|
732
732
|
* the
|
|
733
|
-
* [file search tool](https://
|
|
733
|
+
* [file search tool](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
734
734
|
*/
|
|
735
735
|
export interface FileSearchTool {
|
|
736
736
|
/**
|
|
@@ -823,7 +823,7 @@ export interface FunctionShellTool {
|
|
|
823
823
|
/**
|
|
824
824
|
* Defines a function in your own code the model can choose to call. Learn more
|
|
825
825
|
* about
|
|
826
|
-
* [function calling](https://
|
|
826
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
827
827
|
*/
|
|
828
828
|
export interface FunctionTool {
|
|
829
829
|
/**
|
|
@@ -1085,8 +1085,8 @@ export interface Response {
|
|
|
1085
1085
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
1086
1086
|
* range of models with different capabilities, performance characteristics, and
|
|
1087
1087
|
* price points. Refer to the
|
|
1088
|
-
* [model guide](https://
|
|
1089
|
-
* available models.
|
|
1088
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
1089
|
+
* compare available models.
|
|
1090
1090
|
*/
|
|
1091
1091
|
model: Shared.ResponsesModel;
|
|
1092
1092
|
|
|
@@ -1143,17 +1143,18 @@ export interface Response {
|
|
|
1143
1143
|
*
|
|
1144
1144
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
1145
1145
|
* capabilities, like
|
|
1146
|
-
* [web search](https://
|
|
1147
|
-
*
|
|
1146
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
1147
|
+
* or
|
|
1148
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
1148
1149
|
* Learn more about
|
|
1149
|
-
* [built-in tools](https://
|
|
1150
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
1150
1151
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
1151
1152
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
1152
|
-
* [MCP Tools](https://
|
|
1153
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
1153
1154
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
1154
1155
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
1155
1156
|
* Learn more about
|
|
1156
|
-
* [function calling](https://
|
|
1157
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
1157
1158
|
* You can also use custom tools to call your own code.
|
|
1158
1159
|
*/
|
|
1159
1160
|
tools: Array<Tool>;
|
|
@@ -1169,7 +1170,7 @@ export interface Response {
|
|
|
1169
1170
|
|
|
1170
1171
|
/**
|
|
1171
1172
|
* Whether to run the model response in the background.
|
|
1172
|
-
* [Learn more](https://
|
|
1173
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
1173
1174
|
*/
|
|
1174
1175
|
background?: boolean | null;
|
|
1175
1176
|
|
|
@@ -1188,7 +1189,7 @@ export interface Response {
|
|
|
1188
1189
|
/**
|
|
1189
1190
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
1190
1191
|
* including visible output tokens and
|
|
1191
|
-
* [reasoning tokens](https://
|
|
1192
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
1192
1193
|
*/
|
|
1193
1194
|
max_output_tokens?: number | null;
|
|
1194
1195
|
|
|
@@ -1201,14 +1202,14 @@ export interface Response {
|
|
|
1201
1202
|
/**
|
|
1202
1203
|
* The unique ID of the previous response to the model. Use this to create
|
|
1203
1204
|
* multi-turn conversations. Learn more about
|
|
1204
|
-
* [conversation state](https://
|
|
1205
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
1205
1206
|
* Cannot be used in conjunction with `conversation`.
|
|
1206
1207
|
*/
|
|
1207
1208
|
previous_response_id?: string | null;
|
|
1208
1209
|
|
|
1209
1210
|
/**
|
|
1210
1211
|
* Reference to a prompt template and its variables.
|
|
1211
|
-
* [Learn more](https://
|
|
1212
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
1212
1213
|
*/
|
|
1213
1214
|
prompt?: ResponsePrompt | null;
|
|
1214
1215
|
|
|
@@ -1224,7 +1225,7 @@ export interface Response {
|
|
|
1224
1225
|
/**
|
|
1225
1226
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
1226
1227
|
* hit rates. Replaces the `user` field.
|
|
1227
|
-
* [Learn more](https://
|
|
1228
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
1228
1229
|
*/
|
|
1229
1230
|
prompt_cache_key?: string | null;
|
|
1230
1231
|
|
|
@@ -1240,7 +1241,7 @@ export interface Response {
|
|
|
1240
1241
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
1241
1242
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
1242
1243
|
* of 24 hours.
|
|
1243
|
-
* [Learn more](https://
|
|
1244
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
1244
1245
|
* This field expresses a maximum retention policy, while
|
|
1245
1246
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
1246
1247
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -1257,7 +1258,7 @@ export interface Response {
|
|
|
1257
1258
|
|
|
1258
1259
|
/**
|
|
1259
1260
|
* Configuration options for
|
|
1260
|
-
* [reasoning models](https://
|
|
1261
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
1261
1262
|
*/
|
|
1262
1263
|
reasoning?: Shared.Reasoning | null;
|
|
1263
1264
|
|
|
@@ -1267,7 +1268,7 @@ export interface Response {
|
|
|
1267
1268
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
1268
1269
|
* hashing their username or email address, in order to avoid sending us any
|
|
1269
1270
|
* identifying information.
|
|
1270
|
-
* [Learn more](https://
|
|
1271
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
1271
1272
|
*/
|
|
1272
1273
|
safety_identifier?: string | null;
|
|
1273
1274
|
|
|
@@ -1280,13 +1281,15 @@ export interface Response {
|
|
|
1280
1281
|
* will use 'default'.
|
|
1281
1282
|
* - If set to 'default', then the request will be processed with the standard
|
|
1282
1283
|
* pricing and performance for the selected model.
|
|
1283
|
-
* - If set to
|
|
1284
|
-
* then
|
|
1285
|
-
*
|
|
1286
|
-
*
|
|
1287
|
-
*
|
|
1288
|
-
*
|
|
1289
|
-
*
|
|
1284
|
+
* - If set to
|
|
1285
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
1286
|
+
* the request will be processed with the Flex Processing service tier.
|
|
1287
|
+
* - To opt-in to
|
|
1288
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
1289
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
1290
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
1291
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
1292
|
+
* `priority` in your request.
|
|
1290
1293
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
1291
1294
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
1292
1295
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -1308,8 +1311,8 @@ export interface Response {
|
|
|
1308
1311
|
* Configuration options for a text response from the model. Can be plain text or
|
|
1309
1312
|
* structured JSON data. Learn more:
|
|
1310
1313
|
*
|
|
1311
|
-
* - [Text inputs and outputs](https://
|
|
1312
|
-
* - [Structured Outputs](https://
|
|
1314
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
1315
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
1313
1316
|
*/
|
|
1314
1317
|
text?: ResponseTextConfig;
|
|
1315
1318
|
|
|
@@ -1343,7 +1346,7 @@ export interface Response {
|
|
|
1343
1346
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
1344
1347
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
1345
1348
|
* abuse.
|
|
1346
|
-
* [Learn more](https://
|
|
1349
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
1347
1350
|
*/
|
|
1348
1351
|
user?: string;
|
|
1349
1352
|
}
|
|
@@ -2025,7 +2028,7 @@ export namespace ResponseCodeInterpreterToolCall {
|
|
|
2025
2028
|
|
|
2026
2029
|
/**
|
|
2027
2030
|
* A compaction item generated by the
|
|
2028
|
-
* [`v1/responses/compact` API](https://
|
|
2031
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
2029
2032
|
*/
|
|
2030
2033
|
export interface ResponseCompactionItem {
|
|
2031
2034
|
/**
|
|
@@ -2051,7 +2054,7 @@ export interface ResponseCompactionItem {
|
|
|
2051
2054
|
|
|
2052
2055
|
/**
|
|
2053
2056
|
* A compaction item generated by the
|
|
2054
|
-
* [`v1/responses/compact` API](https://
|
|
2057
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
2055
2058
|
*/
|
|
2056
2059
|
export interface ResponseCompactionItemParam {
|
|
2057
2060
|
/**
|
|
@@ -2092,7 +2095,7 @@ export interface ResponseCompletedEvent {
|
|
|
2092
2095
|
|
|
2093
2096
|
/**
|
|
2094
2097
|
* A tool call to a computer use tool. See the
|
|
2095
|
-
* [computer use guide](https://
|
|
2098
|
+
* [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use)
|
|
2096
2099
|
* for more information.
|
|
2097
2100
|
*/
|
|
2098
2101
|
export interface ResponseComputerToolCall {
|
|
@@ -3125,7 +3128,7 @@ export interface ResponseFileSearchCallSearchingEvent {
|
|
|
3125
3128
|
|
|
3126
3129
|
/**
|
|
3127
3130
|
* The results of a file search tool call. See the
|
|
3128
|
-
* [file search guide](https://
|
|
3131
|
+
* [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
3129
3132
|
* for more information.
|
|
3130
3133
|
*/
|
|
3131
3134
|
export interface ResponseFileSearchToolCall {
|
|
@@ -3194,7 +3197,7 @@ export namespace ResponseFileSearchToolCall {
|
|
|
3194
3197
|
*
|
|
3195
3198
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
3196
3199
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
3197
|
-
* [Structured Outputs guide](https://
|
|
3200
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
3198
3201
|
*
|
|
3199
3202
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
3200
3203
|
*
|
|
@@ -3212,7 +3215,7 @@ export type ResponseFormatTextConfig =
|
|
|
3212
3215
|
/**
|
|
3213
3216
|
* JSON Schema response format. Used to generate structured JSON responses. Learn
|
|
3214
3217
|
* more about
|
|
3215
|
-
* [Structured Outputs](https://
|
|
3218
|
+
* [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
3216
3219
|
*/
|
|
3217
3220
|
export interface ResponseFormatTextJSONSchemaConfig {
|
|
3218
3221
|
/**
|
|
@@ -3243,7 +3246,7 @@ export interface ResponseFormatTextJSONSchemaConfig {
|
|
|
3243
3246
|
* true, the model will always follow the exact schema defined in the `schema`
|
|
3244
3247
|
* field. Only a subset of JSON Schema is supported when `strict` is `true`. To
|
|
3245
3248
|
* learn more, read the
|
|
3246
|
-
* [Structured Outputs guide](https://
|
|
3249
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
3247
3250
|
*/
|
|
3248
3251
|
strict?: boolean | null;
|
|
3249
3252
|
}
|
|
@@ -3562,7 +3565,7 @@ export namespace ResponseFunctionShellToolCallOutput {
|
|
|
3562
3565
|
|
|
3563
3566
|
/**
|
|
3564
3567
|
* A tool call to run a function. See the
|
|
3565
|
-
* [function calling guide](https://
|
|
3568
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
3566
3569
|
* for more information.
|
|
3567
3570
|
*/
|
|
3568
3571
|
export interface ResponseFunctionToolCall {
|
|
@@ -3630,7 +3633,7 @@ export namespace ResponseFunctionToolCall {
|
|
|
3630
3633
|
|
|
3631
3634
|
/**
|
|
3632
3635
|
* A tool call to run a function. See the
|
|
3633
|
-
* [function calling guide](https://
|
|
3636
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
3634
3637
|
* for more information.
|
|
3635
3638
|
*/
|
|
3636
3639
|
export interface ResponseFunctionToolCallItem extends ResponseFunctionToolCall {
|
|
@@ -3723,8 +3726,8 @@ export namespace ResponseFunctionToolCallOutputItem {
|
|
|
3723
3726
|
|
|
3724
3727
|
/**
|
|
3725
3728
|
* The results of a web search tool call. See the
|
|
3726
|
-
* [web search guide](https://
|
|
3727
|
-
* more information.
|
|
3729
|
+
* [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
3730
|
+
* for more information.
|
|
3728
3731
|
*/
|
|
3729
3732
|
export interface ResponseFunctionWebSearch {
|
|
3730
3733
|
/**
|
|
@@ -4202,7 +4205,7 @@ export namespace ResponseInputFileContent {
|
|
|
4202
4205
|
|
|
4203
4206
|
/**
|
|
4204
4207
|
* An image input to the model. Learn about
|
|
4205
|
-
* [image inputs](https://
|
|
4208
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision).
|
|
4206
4209
|
*/
|
|
4207
4210
|
export interface ResponseInputImage {
|
|
4208
4211
|
/**
|
|
@@ -4251,7 +4254,7 @@ export namespace ResponseInputImage {
|
|
|
4251
4254
|
|
|
4252
4255
|
/**
|
|
4253
4256
|
* An image input to the model. Learn about
|
|
4254
|
-
* [image inputs](https://
|
|
4257
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
4255
4258
|
*/
|
|
4256
4259
|
export interface ResponseInputImageContent {
|
|
4257
4260
|
/**
|
|
@@ -4575,12 +4578,32 @@ export namespace ResponseInputItem {
|
|
|
4575
4578
|
*/
|
|
4576
4579
|
type: 'image_generation_call';
|
|
4577
4580
|
|
|
4581
|
+
/**
|
|
4582
|
+
* The action used for image generation.
|
|
4583
|
+
*/
|
|
4584
|
+
action?: 'generate' | 'edit' | 'auto' | null;
|
|
4585
|
+
|
|
4586
|
+
/**
|
|
4587
|
+
* The background setting used for generation.
|
|
4588
|
+
*/
|
|
4589
|
+
background?: 'transparent' | 'opaque' | 'auto' | null;
|
|
4590
|
+
|
|
4591
|
+
/**
|
|
4592
|
+
* The output format used for generation.
|
|
4593
|
+
*/
|
|
4594
|
+
output_format?: 'png' | 'webp' | 'jpeg' | null;
|
|
4595
|
+
|
|
4578
4596
|
/**
|
|
4579
4597
|
* The quality of the image generated by the image generation tool call. One of
|
|
4580
4598
|
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
4581
4599
|
*/
|
|
4582
4600
|
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
4583
4601
|
|
|
4602
|
+
/**
|
|
4603
|
+
* The prompt that was used after any model prompt rewriting.
|
|
4604
|
+
*/
|
|
4605
|
+
revised_prompt?: string | null;
|
|
4606
|
+
|
|
4584
4607
|
/**
|
|
4585
4608
|
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
4586
4609
|
*/
|
|
@@ -5492,12 +5515,32 @@ export namespace ResponseItem {
|
|
|
5492
5515
|
*/
|
|
5493
5516
|
type: 'image_generation_call';
|
|
5494
5517
|
|
|
5518
|
+
/**
|
|
5519
|
+
* The action used for image generation.
|
|
5520
|
+
*/
|
|
5521
|
+
action?: 'generate' | 'edit' | 'auto' | null;
|
|
5522
|
+
|
|
5523
|
+
/**
|
|
5524
|
+
* The background setting used for generation.
|
|
5525
|
+
*/
|
|
5526
|
+
background?: 'transparent' | 'opaque' | 'auto' | null;
|
|
5527
|
+
|
|
5528
|
+
/**
|
|
5529
|
+
* The output format used for generation.
|
|
5530
|
+
*/
|
|
5531
|
+
output_format?: 'png' | 'webp' | 'jpeg' | null;
|
|
5532
|
+
|
|
5495
5533
|
/**
|
|
5496
5534
|
* The quality of the image generated by the image generation tool call. One of
|
|
5497
5535
|
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
5498
5536
|
*/
|
|
5499
5537
|
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
5500
5538
|
|
|
5539
|
+
/**
|
|
5540
|
+
* The prompt that was used after any model prompt rewriting.
|
|
5541
|
+
*/
|
|
5542
|
+
revised_prompt?: string | null;
|
|
5543
|
+
|
|
5501
5544
|
/**
|
|
5502
5545
|
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
5503
5546
|
*/
|
|
@@ -6144,12 +6187,32 @@ export namespace ResponseOutputItem {
|
|
|
6144
6187
|
*/
|
|
6145
6188
|
type: 'image_generation_call';
|
|
6146
6189
|
|
|
6190
|
+
/**
|
|
6191
|
+
* The action used for image generation.
|
|
6192
|
+
*/
|
|
6193
|
+
action?: 'generate' | 'edit' | 'auto' | null;
|
|
6194
|
+
|
|
6195
|
+
/**
|
|
6196
|
+
* The background setting used for generation.
|
|
6197
|
+
*/
|
|
6198
|
+
background?: 'transparent' | 'opaque' | 'auto' | null;
|
|
6199
|
+
|
|
6200
|
+
/**
|
|
6201
|
+
* The output format used for generation.
|
|
6202
|
+
*/
|
|
6203
|
+
output_format?: 'png' | 'webp' | 'jpeg' | null;
|
|
6204
|
+
|
|
6147
6205
|
/**
|
|
6148
6206
|
* The quality of the image generated by the image generation tool call. One of
|
|
6149
6207
|
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
6150
6208
|
*/
|
|
6151
6209
|
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
6152
6210
|
|
|
6211
|
+
/**
|
|
6212
|
+
* The prompt that was used after any model prompt rewriting.
|
|
6213
|
+
*/
|
|
6214
|
+
revised_prompt?: string | null;
|
|
6215
|
+
|
|
6153
6216
|
/**
|
|
6154
6217
|
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
6155
6218
|
*/
|
|
@@ -6850,7 +6913,7 @@ export namespace ResponseOutputTextAnnotationAddedEvent {
|
|
|
6850
6913
|
|
|
6851
6914
|
/**
|
|
6852
6915
|
* Reference to a prompt template and its variables.
|
|
6853
|
-
* [Learn more](https://
|
|
6916
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
6854
6917
|
*/
|
|
6855
6918
|
export interface ResponsePrompt {
|
|
6856
6919
|
/**
|
|
@@ -6895,7 +6958,7 @@ export interface ResponseQueuedEvent {
|
|
|
6895
6958
|
* A description of the chain of thought used by a reasoning model while generating
|
|
6896
6959
|
* a response. Be sure to include these items in your `input` to the Responses API
|
|
6897
6960
|
* for subsequent turns of a conversation if you are manually
|
|
6898
|
-
* [managing context](https://
|
|
6961
|
+
* [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
6899
6962
|
*/
|
|
6900
6963
|
export interface ResponseReasoningItem {
|
|
6901
6964
|
/**
|
|
@@ -8127,8 +8190,8 @@ export type ResponseStreamEvent =
|
|
|
8127
8190
|
* Configuration options for a text response from the model. Can be plain text or
|
|
8128
8191
|
* structured JSON data. Learn more:
|
|
8129
8192
|
*
|
|
8130
|
-
* - [Text inputs and outputs](https://
|
|
8131
|
-
* - [Structured Outputs](https://
|
|
8193
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
8194
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
8132
8195
|
*/
|
|
8133
8196
|
export interface ResponseTextConfig {
|
|
8134
8197
|
/**
|
|
@@ -8136,7 +8199,7 @@ export interface ResponseTextConfig {
|
|
|
8136
8199
|
*
|
|
8137
8200
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
8138
8201
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
8139
|
-
* [Structured Outputs guide](https://
|
|
8202
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
8140
8203
|
*
|
|
8141
8204
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
8142
8205
|
*
|
|
@@ -8462,7 +8525,7 @@ export namespace ResponseUsage {
|
|
|
8462
8525
|
|
|
8463
8526
|
/**
|
|
8464
8527
|
* The number of tokens that were retrieved from the cache.
|
|
8465
|
-
* [More on prompt caching](https://
|
|
8528
|
+
* [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
8466
8529
|
*/
|
|
8467
8530
|
cached_tokens: number;
|
|
8468
8531
|
}
|
|
@@ -8597,7 +8660,7 @@ export namespace ResponsesClientEvent {
|
|
|
8597
8660
|
|
|
8598
8661
|
/**
|
|
8599
8662
|
* Whether to run the model response in the background.
|
|
8600
|
-
* [Learn more](https://
|
|
8663
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
8601
8664
|
*/
|
|
8602
8665
|
background?: boolean | null;
|
|
8603
8666
|
|
|
@@ -8641,11 +8704,11 @@ export namespace ResponsesClientEvent {
|
|
|
8641
8704
|
*
|
|
8642
8705
|
* Learn more:
|
|
8643
8706
|
*
|
|
8644
|
-
* - [Text inputs and outputs](https://
|
|
8645
|
-
* - [Image inputs](https://
|
|
8646
|
-
* - [File inputs](https://
|
|
8647
|
-
* - [Conversation state](https://
|
|
8648
|
-
* - [Function calling](https://
|
|
8707
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
8708
|
+
* - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
8709
|
+
* - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
8710
|
+
* - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
8711
|
+
* - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
8649
8712
|
*/
|
|
8650
8713
|
input?: string | ResponsesAPI.ResponseInput;
|
|
8651
8714
|
|
|
@@ -8661,7 +8724,7 @@ export namespace ResponsesClientEvent {
|
|
|
8661
8724
|
/**
|
|
8662
8725
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
8663
8726
|
* including visible output tokens and
|
|
8664
|
-
* [reasoning tokens](https://
|
|
8727
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
8665
8728
|
*/
|
|
8666
8729
|
max_output_tokens?: number | null;
|
|
8667
8730
|
|
|
@@ -8687,8 +8750,8 @@ export namespace ResponsesClientEvent {
|
|
|
8687
8750
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
8688
8751
|
* range of models with different capabilities, performance characteristics, and
|
|
8689
8752
|
* price points. Refer to the
|
|
8690
|
-
* [model guide](https://
|
|
8691
|
-
* available models.
|
|
8753
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
8754
|
+
* compare available models.
|
|
8692
8755
|
*/
|
|
8693
8756
|
model?: Shared.ResponsesModel;
|
|
8694
8757
|
|
|
@@ -8705,21 +8768,21 @@ export namespace ResponsesClientEvent {
|
|
|
8705
8768
|
/**
|
|
8706
8769
|
* The unique ID of the previous response to the model. Use this to create
|
|
8707
8770
|
* multi-turn conversations. Learn more about
|
|
8708
|
-
* [conversation state](https://
|
|
8771
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
8709
8772
|
* Cannot be used in conjunction with `conversation`.
|
|
8710
8773
|
*/
|
|
8711
8774
|
previous_response_id?: string | null;
|
|
8712
8775
|
|
|
8713
8776
|
/**
|
|
8714
8777
|
* Reference to a prompt template and its variables.
|
|
8715
|
-
* [Learn more](https://
|
|
8778
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
8716
8779
|
*/
|
|
8717
8780
|
prompt?: ResponsesAPI.ResponsePrompt | null;
|
|
8718
8781
|
|
|
8719
8782
|
/**
|
|
8720
8783
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
8721
8784
|
* hit rates. Replaces the `user` field.
|
|
8722
|
-
* [Learn more](https://
|
|
8785
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
8723
8786
|
*/
|
|
8724
8787
|
prompt_cache_key?: string | null;
|
|
8725
8788
|
|
|
@@ -8731,7 +8794,7 @@ export namespace ResponsesClientEvent {
|
|
|
8731
8794
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
8732
8795
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
8733
8796
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
8734
|
-
* [prompt caching guide](https://
|
|
8797
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
8735
8798
|
* for current details.
|
|
8736
8799
|
*/
|
|
8737
8800
|
prompt_cache_options?: ResponseCreate.PromptCacheOptions;
|
|
@@ -8742,7 +8805,7 @@ export namespace ResponsesClientEvent {
|
|
|
8742
8805
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
8743
8806
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
8744
8807
|
* of 24 hours.
|
|
8745
|
-
* [Learn more](https://
|
|
8808
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
8746
8809
|
* This field expresses a maximum retention policy, while
|
|
8747
8810
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
8748
8811
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -8759,7 +8822,7 @@ export namespace ResponsesClientEvent {
|
|
|
8759
8822
|
|
|
8760
8823
|
/**
|
|
8761
8824
|
* Configuration options for
|
|
8762
|
-
* [reasoning models](https://
|
|
8825
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
8763
8826
|
*/
|
|
8764
8827
|
reasoning?: Shared.Reasoning | null;
|
|
8765
8828
|
|
|
@@ -8769,7 +8832,7 @@ export namespace ResponsesClientEvent {
|
|
|
8769
8832
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
8770
8833
|
* hashing their username or email address, in order to avoid sending us any
|
|
8771
8834
|
* identifying information.
|
|
8772
|
-
* [Learn more](https://
|
|
8835
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
8773
8836
|
*/
|
|
8774
8837
|
safety_identifier?: string | null;
|
|
8775
8838
|
|
|
@@ -8781,13 +8844,15 @@ export namespace ResponsesClientEvent {
|
|
|
8781
8844
|
* will use 'default'.
|
|
8782
8845
|
* - If set to 'default', then the request will be processed with the standard
|
|
8783
8846
|
* pricing and performance for the selected model.
|
|
8784
|
-
* - If set to
|
|
8785
|
-
* then
|
|
8786
|
-
*
|
|
8787
|
-
*
|
|
8788
|
-
*
|
|
8789
|
-
*
|
|
8790
|
-
*
|
|
8847
|
+
* - If set to
|
|
8848
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
8849
|
+
* the request will be processed with the Flex Processing service tier.
|
|
8850
|
+
* - To opt-in to
|
|
8851
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
8852
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
8853
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
8854
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
8855
|
+
* `priority` in your request.
|
|
8791
8856
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
8792
8857
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
8793
8858
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -8805,7 +8870,7 @@ export namespace ResponsesClientEvent {
|
|
|
8805
8870
|
* Whether to store the generated model response for later retrieval via API.
|
|
8806
8871
|
* Defaults to true when omitted. If set to true, response data will be stored for
|
|
8807
8872
|
* at least 30 days, subject to the
|
|
8808
|
-
* [data retention exceptions](/api/docs/guides/your-data#v1responses).
|
|
8873
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
8809
8874
|
*/
|
|
8810
8875
|
store?: boolean | null;
|
|
8811
8876
|
|
|
@@ -8814,7 +8879,7 @@ export namespace ResponsesClientEvent {
|
|
|
8814
8879
|
* generated using
|
|
8815
8880
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
8816
8881
|
* See the
|
|
8817
|
-
* [Streaming section below](https://
|
|
8882
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
8818
8883
|
* for more information.
|
|
8819
8884
|
*/
|
|
8820
8885
|
stream?: boolean | null;
|
|
@@ -8845,8 +8910,8 @@ export namespace ResponsesClientEvent {
|
|
|
8845
8910
|
* Configuration options for a text response from the model. Can be plain text or
|
|
8846
8911
|
* structured JSON data. Learn more:
|
|
8847
8912
|
*
|
|
8848
|
-
* - [Text inputs and outputs](https://
|
|
8849
|
-
* - [Structured Outputs](https://
|
|
8913
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
8914
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
8850
8915
|
*/
|
|
8851
8916
|
text?: ResponsesAPI.ResponseTextConfig;
|
|
8852
8917
|
|
|
@@ -8874,17 +8939,18 @@ export namespace ResponsesClientEvent {
|
|
|
8874
8939
|
*
|
|
8875
8940
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
8876
8941
|
* capabilities, like
|
|
8877
|
-
* [web search](https://
|
|
8878
|
-
*
|
|
8942
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
8943
|
+
* or
|
|
8944
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
8879
8945
|
* Learn more about
|
|
8880
|
-
* [built-in tools](https://
|
|
8946
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
8881
8947
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
8882
8948
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
8883
|
-
* [MCP Tools](https://
|
|
8949
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
8884
8950
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
8885
8951
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
8886
8952
|
* Learn more about
|
|
8887
|
-
* [function calling](https://
|
|
8953
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
8888
8954
|
* You can also use custom tools to call your own code.
|
|
8889
8955
|
*/
|
|
8890
8956
|
tools?: Array<ResponsesAPI.Tool>;
|
|
@@ -8922,7 +8988,7 @@ export namespace ResponsesClientEvent {
|
|
|
8922
8988
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
8923
8989
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
8924
8990
|
* abuse.
|
|
8925
|
-
* [Learn more](https://
|
|
8991
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
8926
8992
|
*/
|
|
8927
8993
|
user?: string;
|
|
8928
8994
|
}
|
|
@@ -8997,7 +9063,7 @@ export namespace ResponsesClientEvent {
|
|
|
8997
9063
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
8998
9064
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
8999
9065
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
9000
|
-
* [prompt caching guide](https://
|
|
9066
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
9001
9067
|
* for current details.
|
|
9002
9068
|
*/
|
|
9003
9069
|
export interface PromptCacheOptions {
|
|
@@ -9873,13 +9939,15 @@ export namespace ResponsesServerEvent {
|
|
|
9873
9939
|
* will use 'default'.
|
|
9874
9940
|
* - If set to 'default', then the request will be processed with the standard
|
|
9875
9941
|
* pricing and performance for the selected model.
|
|
9876
|
-
* - If set to
|
|
9877
|
-
* then
|
|
9878
|
-
*
|
|
9879
|
-
*
|
|
9880
|
-
*
|
|
9881
|
-
*
|
|
9882
|
-
*
|
|
9942
|
+
* - If set to
|
|
9943
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
9944
|
+
* the request will be processed with the Flex Processing service tier.
|
|
9945
|
+
* - To opt-in to
|
|
9946
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
9947
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
9948
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
9949
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
9950
|
+
* `priority` in your request.
|
|
9883
9951
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
9884
9952
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
9885
9953
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -9935,7 +10003,7 @@ export namespace Tool {
|
|
|
9935
10003
|
/**
|
|
9936
10004
|
* Give the model access to additional tools via remote Model Context Protocol
|
|
9937
10005
|
* (MCP) servers.
|
|
9938
|
-
* [Learn more about MCP](https://
|
|
10006
|
+
* [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
9939
10007
|
*/
|
|
9940
10008
|
export interface Mcp {
|
|
9941
10009
|
/**
|
|
@@ -9969,7 +10037,7 @@ export namespace Tool {
|
|
|
9969
10037
|
* Identifier for service connectors, like those available in ChatGPT. One of
|
|
9970
10038
|
* `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
|
|
9971
10039
|
* service connectors
|
|
9972
|
-
* [here](https://
|
|
10040
|
+
* [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
|
|
9973
10041
|
*
|
|
9974
10042
|
* Currently supported `connector_id` values are:
|
|
9975
10043
|
*
|
|
@@ -10416,12 +10484,12 @@ export interface ToolChoiceShell {
|
|
|
10416
10484
|
|
|
10417
10485
|
/**
|
|
10418
10486
|
* Indicates that the model should use a built-in tool to generate a response.
|
|
10419
|
-
* [Learn more about built-in tools](https://
|
|
10487
|
+
* [Learn more about built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
10420
10488
|
*/
|
|
10421
10489
|
export interface ToolChoiceTypes {
|
|
10422
10490
|
/**
|
|
10423
10491
|
* The type of hosted tool the model should to use. Learn more about
|
|
10424
|
-
* [built-in tools](https://
|
|
10492
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
10425
10493
|
*
|
|
10426
10494
|
* Allowed values are:
|
|
10427
10495
|
*
|
|
@@ -10474,7 +10542,7 @@ export interface ToolSearchTool {
|
|
|
10474
10542
|
/**
|
|
10475
10543
|
* This tool searches the web for relevant results to use in a response. Learn more
|
|
10476
10544
|
* about the
|
|
10477
|
-
* [web search tool](https://
|
|
10545
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
10478
10546
|
*/
|
|
10479
10547
|
export interface WebSearchPreviewTool {
|
|
10480
10548
|
/**
|
|
@@ -10533,7 +10601,7 @@ export namespace WebSearchPreviewTool {
|
|
|
10533
10601
|
|
|
10534
10602
|
/**
|
|
10535
10603
|
* Search the Internet for sources related to the prompt. Learn more about the
|
|
10536
|
-
* [web search tool](https://
|
|
10604
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
10537
10605
|
*/
|
|
10538
10606
|
export interface WebSearchTool {
|
|
10539
10607
|
/**
|
|
@@ -10617,7 +10685,7 @@ export type ResponseCreateParams = ResponseCreateParamsNonStreaming | ResponseCr
|
|
|
10617
10685
|
export interface ResponseCreateParamsBase {
|
|
10618
10686
|
/**
|
|
10619
10687
|
* Whether to run the model response in the background.
|
|
10620
|
-
* [Learn more](https://
|
|
10688
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
10621
10689
|
*/
|
|
10622
10690
|
background?: boolean | null;
|
|
10623
10691
|
|
|
@@ -10664,11 +10732,11 @@ export interface ResponseCreateParamsBase {
|
|
|
10664
10732
|
*
|
|
10665
10733
|
* Learn more:
|
|
10666
10734
|
*
|
|
10667
|
-
* - [Text inputs and outputs](https://
|
|
10668
|
-
* - [Image inputs](https://
|
|
10669
|
-
* - [File inputs](https://
|
|
10670
|
-
* - [Conversation state](https://
|
|
10671
|
-
* - [Function calling](https://
|
|
10735
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
10736
|
+
* - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
10737
|
+
* - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
10738
|
+
* - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
10739
|
+
* - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
10672
10740
|
*/
|
|
10673
10741
|
input?: string | ResponseInput;
|
|
10674
10742
|
|
|
@@ -10684,7 +10752,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10684
10752
|
/**
|
|
10685
10753
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
10686
10754
|
* including visible output tokens and
|
|
10687
|
-
* [reasoning tokens](https://
|
|
10755
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
10688
10756
|
*/
|
|
10689
10757
|
max_output_tokens?: number | null;
|
|
10690
10758
|
|
|
@@ -10702,8 +10770,8 @@ export interface ResponseCreateParamsBase {
|
|
|
10702
10770
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
10703
10771
|
* range of models with different capabilities, performance characteristics, and
|
|
10704
10772
|
* price points. Refer to the
|
|
10705
|
-
* [model guide](https://
|
|
10706
|
-
* available models.
|
|
10773
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
10774
|
+
* compare available models.
|
|
10707
10775
|
*/
|
|
10708
10776
|
model?: Shared.ResponsesModel;
|
|
10709
10777
|
|
|
@@ -10720,21 +10788,21 @@ export interface ResponseCreateParamsBase {
|
|
|
10720
10788
|
/**
|
|
10721
10789
|
* The unique ID of the previous response to the model. Use this to create
|
|
10722
10790
|
* multi-turn conversations. Learn more about
|
|
10723
|
-
* [conversation state](https://
|
|
10791
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
10724
10792
|
* Cannot be used in conjunction with `conversation`.
|
|
10725
10793
|
*/
|
|
10726
10794
|
previous_response_id?: string | null;
|
|
10727
10795
|
|
|
10728
10796
|
/**
|
|
10729
10797
|
* Reference to a prompt template and its variables.
|
|
10730
|
-
* [Learn more](https://
|
|
10798
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
10731
10799
|
*/
|
|
10732
10800
|
prompt?: ResponsePrompt | null;
|
|
10733
10801
|
|
|
10734
10802
|
/**
|
|
10735
10803
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
10736
10804
|
* hit rates. Replaces the `user` field.
|
|
10737
|
-
* [Learn more](https://
|
|
10805
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
10738
10806
|
*/
|
|
10739
10807
|
prompt_cache_key?: string | null;
|
|
10740
10808
|
|
|
@@ -10746,7 +10814,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10746
10814
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
10747
10815
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
10748
10816
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
10749
|
-
* [prompt caching guide](https://
|
|
10817
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
10750
10818
|
* for current details.
|
|
10751
10819
|
*/
|
|
10752
10820
|
prompt_cache_options?: ResponseCreateParams.PromptCacheOptions;
|
|
@@ -10757,7 +10825,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10757
10825
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
10758
10826
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
10759
10827
|
* of 24 hours.
|
|
10760
|
-
* [Learn more](https://
|
|
10828
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
10761
10829
|
* This field expresses a maximum retention policy, while
|
|
10762
10830
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
10763
10831
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -10774,7 +10842,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10774
10842
|
|
|
10775
10843
|
/**
|
|
10776
10844
|
* Configuration options for
|
|
10777
|
-
* [reasoning models](https://
|
|
10845
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
10778
10846
|
*/
|
|
10779
10847
|
reasoning?: Shared.Reasoning | null;
|
|
10780
10848
|
|
|
@@ -10784,7 +10852,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10784
10852
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
10785
10853
|
* hashing their username or email address, in order to avoid sending us any
|
|
10786
10854
|
* identifying information.
|
|
10787
|
-
* [Learn more](https://
|
|
10855
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
10788
10856
|
*/
|
|
10789
10857
|
safety_identifier?: string | null;
|
|
10790
10858
|
|
|
@@ -10797,13 +10865,15 @@ export interface ResponseCreateParamsBase {
|
|
|
10797
10865
|
* will use 'default'.
|
|
10798
10866
|
* - If set to 'default', then the request will be processed with the standard
|
|
10799
10867
|
* pricing and performance for the selected model.
|
|
10800
|
-
* - If set to
|
|
10801
|
-
* then
|
|
10802
|
-
*
|
|
10803
|
-
*
|
|
10804
|
-
*
|
|
10805
|
-
*
|
|
10806
|
-
*
|
|
10868
|
+
* - If set to
|
|
10869
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
10870
|
+
* the request will be processed with the Flex Processing service tier.
|
|
10871
|
+
* - To opt-in to
|
|
10872
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
10873
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
10874
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
10875
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
10876
|
+
* `priority` in your request.
|
|
10807
10877
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
10808
10878
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
10809
10879
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -10819,7 +10889,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10819
10889
|
* Whether to store the generated model response for later retrieval via API.
|
|
10820
10890
|
* Defaults to true when omitted. If set to true, response data will be stored for
|
|
10821
10891
|
* at least 30 days, subject to the
|
|
10822
|
-
* [data retention exceptions](/api/docs/guides/your-data#v1responses).
|
|
10892
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
10823
10893
|
*/
|
|
10824
10894
|
store?: boolean | null;
|
|
10825
10895
|
|
|
@@ -10828,7 +10898,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10828
10898
|
* generated using
|
|
10829
10899
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
10830
10900
|
* See the
|
|
10831
|
-
* [Streaming section below](https://
|
|
10901
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
10832
10902
|
* for more information.
|
|
10833
10903
|
*/
|
|
10834
10904
|
stream?: boolean | null;
|
|
@@ -10850,8 +10920,8 @@ export interface ResponseCreateParamsBase {
|
|
|
10850
10920
|
* Configuration options for a text response from the model. Can be plain text or
|
|
10851
10921
|
* structured JSON data. Learn more:
|
|
10852
10922
|
*
|
|
10853
|
-
* - [Text inputs and outputs](https://
|
|
10854
|
-
* - [Structured Outputs](https://
|
|
10923
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
10924
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
10855
10925
|
*/
|
|
10856
10926
|
text?: ResponseTextConfig;
|
|
10857
10927
|
|
|
@@ -10879,17 +10949,18 @@ export interface ResponseCreateParamsBase {
|
|
|
10879
10949
|
*
|
|
10880
10950
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
10881
10951
|
* capabilities, like
|
|
10882
|
-
* [web search](https://
|
|
10883
|
-
*
|
|
10952
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
10953
|
+
* or
|
|
10954
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
10884
10955
|
* Learn more about
|
|
10885
|
-
* [built-in tools](https://
|
|
10956
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
10886
10957
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
10887
10958
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
10888
|
-
* [MCP Tools](https://
|
|
10959
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
10889
10960
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
10890
10961
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
10891
10962
|
* Learn more about
|
|
10892
|
-
* [function calling](https://
|
|
10963
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
10893
10964
|
* You can also use custom tools to call your own code.
|
|
10894
10965
|
*/
|
|
10895
10966
|
tools?: Array<Tool>;
|
|
@@ -10927,7 +10998,7 @@ export interface ResponseCreateParamsBase {
|
|
|
10927
10998
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
10928
10999
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
10929
11000
|
* abuse.
|
|
10930
|
-
* [Learn more](https://
|
|
11001
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
10931
11002
|
*/
|
|
10932
11003
|
user?: string;
|
|
10933
11004
|
}
|
|
@@ -11002,7 +11073,7 @@ export namespace ResponseCreateParams {
|
|
|
11002
11073
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
11003
11074
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
11004
11075
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
11005
|
-
* [prompt caching guide](https://
|
|
11076
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11006
11077
|
* for current details.
|
|
11007
11078
|
*/
|
|
11008
11079
|
export interface PromptCacheOptions {
|
|
@@ -11062,7 +11133,7 @@ export interface ResponseCreateParamsNonStreaming extends ResponseCreateParamsBa
|
|
|
11062
11133
|
* generated using
|
|
11063
11134
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11064
11135
|
* See the
|
|
11065
|
-
* [Streaming section below](https://
|
|
11136
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11066
11137
|
* for more information.
|
|
11067
11138
|
*/
|
|
11068
11139
|
stream?: false | null;
|
|
@@ -11074,7 +11145,7 @@ export interface ResponseCreateParamsStreaming extends ResponseCreateParamsBase
|
|
|
11074
11145
|
* generated using
|
|
11075
11146
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11076
11147
|
* See the
|
|
11077
|
-
* [Streaming section below](https://
|
|
11148
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11078
11149
|
* for more information.
|
|
11079
11150
|
*/
|
|
11080
11151
|
stream: true;
|
|
@@ -11109,7 +11180,7 @@ export interface ResponseRetrieveParamsBase {
|
|
|
11109
11180
|
* generated using
|
|
11110
11181
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11111
11182
|
* See the
|
|
11112
|
-
* [Streaming section below](https://
|
|
11183
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11113
11184
|
* for more information.
|
|
11114
11185
|
*/
|
|
11115
11186
|
stream?: boolean;
|
|
@@ -11126,7 +11197,7 @@ export interface ResponseRetrieveParamsNonStreaming extends ResponseRetrievePara
|
|
|
11126
11197
|
* generated using
|
|
11127
11198
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11128
11199
|
* See the
|
|
11129
|
-
* [Streaming section below](https://
|
|
11200
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11130
11201
|
* for more information.
|
|
11131
11202
|
*/
|
|
11132
11203
|
stream?: false;
|
|
@@ -11138,7 +11209,7 @@ export interface ResponseRetrieveParamsStreaming extends ResponseRetrieveParamsB
|
|
|
11138
11209
|
* generated using
|
|
11139
11210
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11140
11211
|
* See the
|
|
11141
|
-
* [Streaming section below](https://
|
|
11212
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11142
11213
|
* for more information.
|
|
11143
11214
|
*/
|
|
11144
11215
|
stream: true;
|
|
@@ -11149,8 +11220,8 @@ export interface ResponseCompactParams {
|
|
|
11149
11220
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
11150
11221
|
* range of models with different capabilities, performance characteristics, and
|
|
11151
11222
|
* price points. Refer to the
|
|
11152
|
-
* [model guide](https://
|
|
11153
|
-
* available models.
|
|
11223
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
11224
|
+
* compare available models.
|
|
11154
11225
|
*/
|
|
11155
11226
|
model:
|
|
11156
11227
|
| 'gpt-6-astra'
|
|
@@ -11275,7 +11346,7 @@ export interface ResponseCompactParams {
|
|
|
11275
11346
|
/**
|
|
11276
11347
|
* The unique ID of the previous response to the model. Use this to create
|
|
11277
11348
|
* multi-turn conversations. Learn more about
|
|
11278
|
-
* [conversation state](https://
|
|
11349
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
11279
11350
|
* Cannot be used in conjunction with `conversation`.
|
|
11280
11351
|
*/
|
|
11281
11352
|
previous_response_id?: string | null;
|
|
@@ -11293,7 +11364,7 @@ export interface ResponseCompactParams {
|
|
|
11293
11364
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
11294
11365
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
11295
11366
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
11296
|
-
* [prompt caching guide](https://
|
|
11367
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11297
11368
|
* for current details.
|
|
11298
11369
|
*/
|
|
11299
11370
|
prompt_cache_options?: ResponseCompactParams.PromptCacheOptions | null;
|
|
@@ -11309,17 +11380,17 @@ export interface ResponseCompactParams {
|
|
|
11309
11380
|
* Project settings. Unless otherwise configured, the Project will use 'default'. -
|
|
11310
11381
|
* If set to 'default', then the request will be processed with the standard
|
|
11311
11382
|
* pricing and performance for the selected model. - If set to
|
|
11312
|
-
* '[flex](https://
|
|
11313
|
-
* request will be processed with the Flex Processing service tier. - To opt-in
|
|
11314
|
-
* [Fast mode](/api/docs/guides/fast-mode) at the
|
|
11315
|
-
* `service_tier=fast` or `service_tier=priority`
|
|
11316
|
-
* Completions. For models with a dedicated Fast
|
|
11317
|
-
* `service_tier=fast`; for other models, either
|
|
11318
|
-
* `service_tier=priority`. - When not set, the default behavior
|
|
11319
|
-
* the `service_tier` parameter is set, the response body will
|
|
11320
|
-
* `service_tier` value based on the processing mode actually used to
|
|
11321
|
-
* request. This response value may be different from the value set in
|
|
11322
|
-
* parameter.
|
|
11383
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
11384
|
+
* the request will be processed with the Flex Processing service tier. - To opt-in
|
|
11385
|
+
* to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
11386
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
11387
|
+
* parameter for Responses or Chat Completions. For models with a dedicated Fast
|
|
11388
|
+
* tier, either value resolves to `service_tier=fast`; for other models, either
|
|
11389
|
+
* value resolves to `service_tier=priority`. - When not set, the default behavior
|
|
11390
|
+
* is 'auto'. When the `service_tier` parameter is set, the response body will
|
|
11391
|
+
* include the `service_tier` value based on the processing mode actually used to
|
|
11392
|
+
* serve the request. This response value may be different from the value set in
|
|
11393
|
+
* the parameter.
|
|
11323
11394
|
*/
|
|
11324
11395
|
service_tier?: 'auto' | 'default' | 'fast' | 'flex' | 'priority' | null;
|
|
11325
11396
|
}
|
|
@@ -11333,7 +11404,7 @@ export namespace ResponseCompactParams {
|
|
|
11333
11404
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
11334
11405
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
11335
11406
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
11336
|
-
* [prompt caching guide](https://
|
|
11407
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11337
11408
|
* for current details.
|
|
11338
11409
|
*/
|
|
11339
11410
|
export interface PromptCacheOptions {
|