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
|
@@ -19,16 +19,16 @@ export class Responses extends APIResource {
|
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
* Creates a model response. Provide
|
|
22
|
-
* [text](https://
|
|
23
|
-
* [image](https://
|
|
24
|
-
* [text](https://
|
|
25
|
-
* [JSON](https://
|
|
26
|
-
* the model call your own
|
|
27
|
-
* [custom code](https://
|
|
28
|
-
* built-in [tools](https://
|
|
29
|
-
* [web search](https://
|
|
30
|
-
* [file search](https://
|
|
31
|
-
* your own data as input for the model's response.
|
|
22
|
+
* [text](https://developers.openai.com/api/docs/guides/text) or
|
|
23
|
+
* [image](https://developers.openai.com/api/docs/guides/images-vision) inputs to
|
|
24
|
+
* generate [text](https://developers.openai.com/api/docs/guides/text) or
|
|
25
|
+
* [JSON](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
26
|
+
* outputs. Have the model call your own
|
|
27
|
+
* [custom code](https://developers.openai.com/api/docs/guides/function-calling) or
|
|
28
|
+
* use built-in [tools](https://developers.openai.com/api/docs/guides/tools) like
|
|
29
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search) or
|
|
30
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
31
|
+
* to use your own data as input for the model's response.
|
|
32
32
|
*
|
|
33
33
|
* @example
|
|
34
34
|
* ```ts
|
|
@@ -133,7 +133,7 @@ export class Responses extends APIResource {
|
|
|
133
133
|
/**
|
|
134
134
|
* Cancels a model response with the given ID. Only responses created with the
|
|
135
135
|
* `background` parameter set to `true` can be cancelled.
|
|
136
|
-
* [Learn more](https://
|
|
136
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
137
137
|
*
|
|
138
138
|
* @example
|
|
139
139
|
* ```ts
|
|
@@ -162,9 +162,9 @@ export class Responses extends APIResource {
|
|
|
162
162
|
* Compact a conversation. Returns a compacted response object.
|
|
163
163
|
*
|
|
164
164
|
* Learn when and how to compact long-running conversations in the
|
|
165
|
-
* [conversation state guide](https://
|
|
165
|
+
* [conversation state guide](https://developers.openai.com/api/docs/guides/conversation-state#managing-the-context-window).
|
|
166
166
|
* For ZDR-compatible compaction details, see
|
|
167
|
-
* [Compaction (advanced)](https://
|
|
167
|
+
* [Compaction (advanced)](https://developers.openai.com/api/docs/guides/conversation-state#compaction-advanced).
|
|
168
168
|
*
|
|
169
169
|
* @example
|
|
170
170
|
* ```ts
|
|
@@ -478,7 +478,7 @@ export type BetaComputerActionList = Array<BetaComputerAction>;
|
|
|
478
478
|
|
|
479
479
|
/**
|
|
480
480
|
* A tool that controls a virtual computer. Learn more about the
|
|
481
|
-
* [computer tool](https://
|
|
481
|
+
* [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).
|
|
482
482
|
*/
|
|
483
483
|
export interface BetaComputerTool {
|
|
484
484
|
/**
|
|
@@ -489,7 +489,7 @@ export interface BetaComputerTool {
|
|
|
489
489
|
|
|
490
490
|
/**
|
|
491
491
|
* A tool that controls a virtual computer. Learn more about the
|
|
492
|
-
* [computer tool](https://
|
|
492
|
+
* [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).
|
|
493
493
|
*/
|
|
494
494
|
export interface BetaComputerUsePreviewTool {
|
|
495
495
|
/**
|
|
@@ -595,7 +595,7 @@ export interface BetaContainerReference {
|
|
|
595
595
|
|
|
596
596
|
/**
|
|
597
597
|
* A custom tool that processes input using a specified format. Learn more about
|
|
598
|
-
* [custom tools](https://
|
|
598
|
+
* [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools)
|
|
599
599
|
*/
|
|
600
600
|
export interface BetaCustomTool {
|
|
601
601
|
/**
|
|
@@ -704,7 +704,7 @@ export interface BetaEasyInputMessage {
|
|
|
704
704
|
/**
|
|
705
705
|
* A tool that searches for relevant content from uploaded files. Learn more about
|
|
706
706
|
* the
|
|
707
|
-
* [file search tool](https://
|
|
707
|
+
* [file search tool](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
708
708
|
*/
|
|
709
709
|
export interface BetaFileSearchTool {
|
|
710
710
|
/**
|
|
@@ -879,7 +879,7 @@ export interface BetaFunctionShellTool {
|
|
|
879
879
|
/**
|
|
880
880
|
* Defines a function in your own code the model can choose to call. Learn more
|
|
881
881
|
* about
|
|
882
|
-
* [function calling](https://
|
|
882
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
883
883
|
*/
|
|
884
884
|
export interface BetaFunctionTool {
|
|
885
885
|
/**
|
|
@@ -1139,8 +1139,8 @@ export interface BetaResponse {
|
|
|
1139
1139
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
1140
1140
|
* range of models with different capabilities, performance characteristics, and
|
|
1141
1141
|
* price points. Refer to the
|
|
1142
|
-
* [model guide](https://
|
|
1143
|
-
* available models.
|
|
1142
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
1143
|
+
* compare available models.
|
|
1144
1144
|
*/
|
|
1145
1145
|
model:
|
|
1146
1146
|
| 'gpt-6-astra'
|
|
@@ -1301,17 +1301,18 @@ export interface BetaResponse {
|
|
|
1301
1301
|
*
|
|
1302
1302
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
1303
1303
|
* capabilities, like
|
|
1304
|
-
* [web search](https://
|
|
1305
|
-
*
|
|
1304
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
1305
|
+
* or
|
|
1306
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
1306
1307
|
* Learn more about
|
|
1307
|
-
* [built-in tools](https://
|
|
1308
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
1308
1309
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
1309
1310
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
1310
|
-
* [MCP Tools](https://
|
|
1311
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
1311
1312
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
1312
1313
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
1313
1314
|
* Learn more about
|
|
1314
|
-
* [function calling](https://
|
|
1315
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
1315
1316
|
* You can also use custom tools to call your own code.
|
|
1316
1317
|
*/
|
|
1317
1318
|
tools: Array<BetaTool>;
|
|
@@ -1327,7 +1328,7 @@ export interface BetaResponse {
|
|
|
1327
1328
|
|
|
1328
1329
|
/**
|
|
1329
1330
|
* Whether to run the model response in the background.
|
|
1330
|
-
* [Learn more](https://
|
|
1331
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
1331
1332
|
*/
|
|
1332
1333
|
background?: boolean | null;
|
|
1333
1334
|
|
|
@@ -1346,7 +1347,7 @@ export interface BetaResponse {
|
|
|
1346
1347
|
/**
|
|
1347
1348
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
1348
1349
|
* including visible output tokens and
|
|
1349
|
-
* [reasoning tokens](https://
|
|
1350
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
1350
1351
|
*/
|
|
1351
1352
|
max_output_tokens?: number | null;
|
|
1352
1353
|
|
|
@@ -1367,14 +1368,14 @@ export interface BetaResponse {
|
|
|
1367
1368
|
/**
|
|
1368
1369
|
* The unique ID of the previous response to the model. Use this to create
|
|
1369
1370
|
* multi-turn conversations. Learn more about
|
|
1370
|
-
* [conversation state](https://
|
|
1371
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
1371
1372
|
* Cannot be used in conjunction with `conversation`.
|
|
1372
1373
|
*/
|
|
1373
1374
|
previous_response_id?: string | null;
|
|
1374
1375
|
|
|
1375
1376
|
/**
|
|
1376
1377
|
* Reference to a prompt template and its variables.
|
|
1377
|
-
* [Learn more](https://
|
|
1378
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
1378
1379
|
*/
|
|
1379
1380
|
prompt?: BetaResponsePrompt | null;
|
|
1380
1381
|
|
|
@@ -1390,7 +1391,7 @@ export interface BetaResponse {
|
|
|
1390
1391
|
/**
|
|
1391
1392
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
1392
1393
|
* hit rates. Replaces the `user` field.
|
|
1393
|
-
* [Learn more](https://
|
|
1394
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
1394
1395
|
*/
|
|
1395
1396
|
prompt_cache_key?: string | null;
|
|
1396
1397
|
|
|
@@ -1406,7 +1407,7 @@ export interface BetaResponse {
|
|
|
1406
1407
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
1407
1408
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
1408
1409
|
* of 24 hours.
|
|
1409
|
-
* [Learn more](https://
|
|
1410
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
1410
1411
|
* This field expresses a maximum retention policy, while
|
|
1411
1412
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
1412
1413
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -1423,7 +1424,7 @@ export interface BetaResponse {
|
|
|
1423
1424
|
|
|
1424
1425
|
/**
|
|
1425
1426
|
* Configuration options for
|
|
1426
|
-
* [reasoning models](https://
|
|
1427
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
1427
1428
|
*/
|
|
1428
1429
|
reasoning?: BetaResponse.Reasoning | null;
|
|
1429
1430
|
|
|
@@ -1433,7 +1434,7 @@ export interface BetaResponse {
|
|
|
1433
1434
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
1434
1435
|
* hashing their username or email address, in order to avoid sending us any
|
|
1435
1436
|
* identifying information.
|
|
1436
|
-
* [Learn more](https://
|
|
1437
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
1437
1438
|
*/
|
|
1438
1439
|
safety_identifier?: string | null;
|
|
1439
1440
|
|
|
@@ -1445,13 +1446,15 @@ export interface BetaResponse {
|
|
|
1445
1446
|
* will use 'default'.
|
|
1446
1447
|
* - If set to 'default', then the request will be processed with the standard
|
|
1447
1448
|
* pricing and performance for the selected model.
|
|
1448
|
-
* - If set to
|
|
1449
|
-
* then
|
|
1450
|
-
*
|
|
1451
|
-
*
|
|
1452
|
-
*
|
|
1453
|
-
*
|
|
1454
|
-
*
|
|
1449
|
+
* - If set to
|
|
1450
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
1451
|
+
* the request will be processed with the Flex Processing service tier.
|
|
1452
|
+
* - To opt-in to
|
|
1453
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
1454
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
1455
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
1456
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
1457
|
+
* `priority` in your request.
|
|
1455
1458
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
1456
1459
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
1457
1460
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -1475,8 +1478,8 @@ export interface BetaResponse {
|
|
|
1475
1478
|
* Configuration options for a text response from the model. Can be plain text or
|
|
1476
1479
|
* structured JSON data. Learn more:
|
|
1477
1480
|
*
|
|
1478
|
-
* - [Text inputs and outputs](https://
|
|
1479
|
-
* - [Structured Outputs](https://
|
|
1481
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
1482
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
1480
1483
|
*/
|
|
1481
1484
|
text?: BetaResponseTextConfig;
|
|
1482
1485
|
|
|
@@ -1510,7 +1513,7 @@ export interface BetaResponse {
|
|
|
1510
1513
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
1511
1514
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
1512
1515
|
* abuse.
|
|
1513
|
-
* [Learn more](https://
|
|
1516
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
1514
1517
|
*/
|
|
1515
1518
|
user?: string;
|
|
1516
1519
|
}
|
|
@@ -1742,7 +1745,7 @@ export namespace BetaResponse {
|
|
|
1742
1745
|
|
|
1743
1746
|
/**
|
|
1744
1747
|
* Configuration options for
|
|
1745
|
-
* [reasoning models](https://
|
|
1748
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
1746
1749
|
*/
|
|
1747
1750
|
export interface Reasoning {
|
|
1748
1751
|
/**
|
|
@@ -1760,7 +1763,7 @@ export namespace BetaResponse {
|
|
|
1760
1763
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
1761
1764
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
1762
1765
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
1763
|
-
* [reasoning guide](https://
|
|
1766
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
1764
1767
|
* model-specific support.
|
|
1765
1768
|
*/
|
|
1766
1769
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
|
|
@@ -2442,7 +2445,7 @@ export namespace BetaResponseCodeInterpreterToolCall {
|
|
|
2442
2445
|
|
|
2443
2446
|
/**
|
|
2444
2447
|
* A compaction item generated by the
|
|
2445
|
-
* [`v1/responses/compact` API](https://
|
|
2448
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
2446
2449
|
*/
|
|
2447
2450
|
export interface BetaResponseCompactionItem {
|
|
2448
2451
|
/**
|
|
@@ -2485,7 +2488,7 @@ export namespace BetaResponseCompactionItem {
|
|
|
2485
2488
|
|
|
2486
2489
|
/**
|
|
2487
2490
|
* A compaction item generated by the
|
|
2488
|
-
* [`v1/responses/compact` API](https://
|
|
2491
|
+
* [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
|
|
2489
2492
|
*/
|
|
2490
2493
|
export interface BetaResponseCompactionItemParam {
|
|
2491
2494
|
/**
|
|
@@ -2560,7 +2563,7 @@ export namespace BetaResponseCompletedEvent {
|
|
|
2560
2563
|
|
|
2561
2564
|
/**
|
|
2562
2565
|
* A tool call to a computer use tool. See the
|
|
2563
|
-
* [computer use guide](https://
|
|
2566
|
+
* [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use)
|
|
2564
2567
|
* for more information.
|
|
2565
2568
|
*/
|
|
2566
2569
|
export interface BetaResponseComputerToolCall {
|
|
@@ -3620,7 +3623,7 @@ export namespace BetaResponseFileSearchCallSearchingEvent {
|
|
|
3620
3623
|
|
|
3621
3624
|
/**
|
|
3622
3625
|
* The results of a file search tool call. See the
|
|
3623
|
-
* [file search guide](https://
|
|
3626
|
+
* [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search)
|
|
3624
3627
|
* for more information.
|
|
3625
3628
|
*/
|
|
3626
3629
|
export interface BetaResponseFileSearchToolCall {
|
|
@@ -3704,7 +3707,7 @@ export namespace BetaResponseFileSearchToolCall {
|
|
|
3704
3707
|
*
|
|
3705
3708
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
3706
3709
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
3707
|
-
* [Structured Outputs guide](https://
|
|
3710
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
3708
3711
|
*
|
|
3709
3712
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
3710
3713
|
*
|
|
@@ -3746,7 +3749,7 @@ export namespace BetaResponseFormatTextConfig {
|
|
|
3746
3749
|
/**
|
|
3747
3750
|
* JSON Schema response format. Used to generate structured JSON responses. Learn
|
|
3748
3751
|
* more about
|
|
3749
|
-
* [Structured Outputs](https://
|
|
3752
|
+
* [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
3750
3753
|
*/
|
|
3751
3754
|
export interface BetaResponseFormatTextJSONSchemaConfig {
|
|
3752
3755
|
/**
|
|
@@ -3777,7 +3780,7 @@ export interface BetaResponseFormatTextJSONSchemaConfig {
|
|
|
3777
3780
|
* true, the model will always follow the exact schema defined in the `schema`
|
|
3778
3781
|
* field. Only a subset of JSON Schema is supported when `strict` is `true`. To
|
|
3779
3782
|
* learn more, read the
|
|
3780
|
-
* [Structured Outputs guide](https://
|
|
3783
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
3781
3784
|
*/
|
|
3782
3785
|
strict?: boolean | null;
|
|
3783
3786
|
}
|
|
@@ -4165,7 +4168,7 @@ export namespace BetaResponseFunctionShellToolCallOutput {
|
|
|
4165
4168
|
|
|
4166
4169
|
/**
|
|
4167
4170
|
* A tool call to run a function. See the
|
|
4168
|
-
* [function calling guide](https://
|
|
4171
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
4169
4172
|
* for more information.
|
|
4170
4173
|
*/
|
|
4171
4174
|
export interface BetaResponseFunctionToolCall {
|
|
@@ -4248,7 +4251,7 @@ export namespace BetaResponseFunctionToolCall {
|
|
|
4248
4251
|
|
|
4249
4252
|
/**
|
|
4250
4253
|
* A tool call to run a function. See the
|
|
4251
|
-
* [function calling guide](https://
|
|
4254
|
+
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling)
|
|
4252
4255
|
* for more information.
|
|
4253
4256
|
*/
|
|
4254
4257
|
export interface BetaResponseFunctionToolCallItem extends BetaResponseFunctionToolCall {
|
|
@@ -4359,8 +4362,8 @@ export namespace BetaResponseFunctionToolCallOutputItem {
|
|
|
4359
4362
|
|
|
4360
4363
|
/**
|
|
4361
4364
|
* The results of a web search tool call. See the
|
|
4362
|
-
* [web search guide](https://
|
|
4363
|
-
* more information.
|
|
4365
|
+
* [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
4366
|
+
* for more information.
|
|
4364
4367
|
*/
|
|
4365
4368
|
export interface BetaResponseFunctionWebSearch {
|
|
4366
4369
|
/**
|
|
@@ -5056,7 +5059,7 @@ export namespace BetaResponseInputFileContent {
|
|
|
5056
5059
|
|
|
5057
5060
|
/**
|
|
5058
5061
|
* An image input to the model. Learn about
|
|
5059
|
-
* [image inputs](https://
|
|
5062
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision).
|
|
5060
5063
|
*/
|
|
5061
5064
|
export interface BetaResponseInputImage {
|
|
5062
5065
|
/**
|
|
@@ -5105,7 +5108,7 @@ export namespace BetaResponseInputImage {
|
|
|
5105
5108
|
|
|
5106
5109
|
/**
|
|
5107
5110
|
* An image input to the model. Learn about
|
|
5108
|
-
* [image inputs](https://
|
|
5111
|
+
* [image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
5109
5112
|
*/
|
|
5110
5113
|
export interface BetaResponseInputImageContent {
|
|
5111
5114
|
/**
|
|
@@ -5780,17 +5783,37 @@ export namespace BetaResponseInputItem {
|
|
|
5780
5783
|
*/
|
|
5781
5784
|
type: 'image_generation_call';
|
|
5782
5785
|
|
|
5786
|
+
/**
|
|
5787
|
+
* The action used for image generation.
|
|
5788
|
+
*/
|
|
5789
|
+
action?: 'generate' | 'edit' | 'auto' | null;
|
|
5790
|
+
|
|
5783
5791
|
/**
|
|
5784
5792
|
* The agent that produced this item.
|
|
5785
5793
|
*/
|
|
5786
5794
|
agent?: ImageGenerationCall.Agent | null;
|
|
5787
5795
|
|
|
5796
|
+
/**
|
|
5797
|
+
* The background setting used for generation.
|
|
5798
|
+
*/
|
|
5799
|
+
background?: 'transparent' | 'opaque' | 'auto' | null;
|
|
5800
|
+
|
|
5801
|
+
/**
|
|
5802
|
+
* The output format used for generation.
|
|
5803
|
+
*/
|
|
5804
|
+
output_format?: 'png' | 'webp' | 'jpeg' | null;
|
|
5805
|
+
|
|
5788
5806
|
/**
|
|
5789
5807
|
* The quality of the image generated by the image generation tool call. One of
|
|
5790
5808
|
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
5791
5809
|
*/
|
|
5792
5810
|
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
5793
5811
|
|
|
5812
|
+
/**
|
|
5813
|
+
* The prompt that was used after any model prompt rewriting.
|
|
5814
|
+
*/
|
|
5815
|
+
revised_prompt?: string | null;
|
|
5816
|
+
|
|
5794
5817
|
/**
|
|
5795
5818
|
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
5796
5819
|
*/
|
|
@@ -7269,17 +7292,37 @@ export namespace BetaResponseItem {
|
|
|
7269
7292
|
*/
|
|
7270
7293
|
type: 'image_generation_call';
|
|
7271
7294
|
|
|
7295
|
+
/**
|
|
7296
|
+
* The action used for image generation.
|
|
7297
|
+
*/
|
|
7298
|
+
action?: 'generate' | 'edit' | 'auto' | null;
|
|
7299
|
+
|
|
7272
7300
|
/**
|
|
7273
7301
|
* The agent that produced this item.
|
|
7274
7302
|
*/
|
|
7275
7303
|
agent?: ImageGenerationCall.Agent | null;
|
|
7276
7304
|
|
|
7305
|
+
/**
|
|
7306
|
+
* The background setting used for generation.
|
|
7307
|
+
*/
|
|
7308
|
+
background?: 'transparent' | 'opaque' | 'auto' | null;
|
|
7309
|
+
|
|
7310
|
+
/**
|
|
7311
|
+
* The output format used for generation.
|
|
7312
|
+
*/
|
|
7313
|
+
output_format?: 'png' | 'webp' | 'jpeg' | null;
|
|
7314
|
+
|
|
7277
7315
|
/**
|
|
7278
7316
|
* The quality of the image generated by the image generation tool call. One of
|
|
7279
7317
|
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
7280
7318
|
*/
|
|
7281
7319
|
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
7282
7320
|
|
|
7321
|
+
/**
|
|
7322
|
+
* The prompt that was used after any model prompt rewriting.
|
|
7323
|
+
*/
|
|
7324
|
+
revised_prompt?: string | null;
|
|
7325
|
+
|
|
7283
7326
|
/**
|
|
7284
7327
|
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
7285
7328
|
*/
|
|
@@ -8484,17 +8527,37 @@ export namespace BetaResponseOutputItem {
|
|
|
8484
8527
|
*/
|
|
8485
8528
|
type: 'image_generation_call';
|
|
8486
8529
|
|
|
8530
|
+
/**
|
|
8531
|
+
* The action used for image generation.
|
|
8532
|
+
*/
|
|
8533
|
+
action?: 'generate' | 'edit' | 'auto' | null;
|
|
8534
|
+
|
|
8487
8535
|
/**
|
|
8488
8536
|
* The agent that produced this item.
|
|
8489
8537
|
*/
|
|
8490
8538
|
agent?: ImageGenerationCall.Agent | null;
|
|
8491
8539
|
|
|
8540
|
+
/**
|
|
8541
|
+
* The background setting used for generation.
|
|
8542
|
+
*/
|
|
8543
|
+
background?: 'transparent' | 'opaque' | 'auto' | null;
|
|
8544
|
+
|
|
8545
|
+
/**
|
|
8546
|
+
* The output format used for generation.
|
|
8547
|
+
*/
|
|
8548
|
+
output_format?: 'png' | 'webp' | 'jpeg' | null;
|
|
8549
|
+
|
|
8492
8550
|
/**
|
|
8493
8551
|
* The quality of the image generated by the image generation tool call. One of
|
|
8494
8552
|
* `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
8495
8553
|
*/
|
|
8496
8554
|
quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
|
|
8497
8555
|
|
|
8556
|
+
/**
|
|
8557
|
+
* The prompt that was used after any model prompt rewriting.
|
|
8558
|
+
*/
|
|
8559
|
+
revised_prompt?: string | null;
|
|
8560
|
+
|
|
8498
8561
|
/**
|
|
8499
8562
|
* The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
8500
8563
|
*/
|
|
@@ -9371,7 +9434,7 @@ export namespace BetaResponseOutputTextAnnotationAddedEvent {
|
|
|
9371
9434
|
|
|
9372
9435
|
/**
|
|
9373
9436
|
* Reference to a prompt template and its variables.
|
|
9374
|
-
* [Learn more](https://
|
|
9437
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
9375
9438
|
*/
|
|
9376
9439
|
export interface BetaResponsePrompt {
|
|
9377
9440
|
/**
|
|
@@ -9435,7 +9498,7 @@ export namespace BetaResponseQueuedEvent {
|
|
|
9435
9498
|
* A description of the chain of thought used by a reasoning model while generating
|
|
9436
9499
|
* a response. Be sure to include these items in your `input` to the Responses API
|
|
9437
9500
|
* for subsequent turns of a conversation if you are manually
|
|
9438
|
-
* [managing context](https://
|
|
9501
|
+
* [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
9439
9502
|
*/
|
|
9440
9503
|
export interface BetaResponseReasoningItem {
|
|
9441
9504
|
/**
|
|
@@ -10933,8 +10996,8 @@ export type BetaResponseStreamEvent =
|
|
|
10933
10996
|
* Configuration options for a text response from the model. Can be plain text or
|
|
10934
10997
|
* structured JSON data. Learn more:
|
|
10935
10998
|
*
|
|
10936
|
-
* - [Text inputs and outputs](https://
|
|
10937
|
-
* - [Structured Outputs](https://
|
|
10999
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
11000
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
10938
11001
|
*/
|
|
10939
11002
|
export interface BetaResponseTextConfig {
|
|
10940
11003
|
/**
|
|
@@ -10942,7 +11005,7 @@ export interface BetaResponseTextConfig {
|
|
|
10942
11005
|
*
|
|
10943
11006
|
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
10944
11007
|
* ensures the model will match your supplied JSON schema. Learn more in the
|
|
10945
|
-
* [Structured Outputs guide](https://
|
|
11008
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
10946
11009
|
*
|
|
10947
11010
|
* The default format is `{ "type": "text" }` with no additional options.
|
|
10948
11011
|
*
|
|
@@ -11349,7 +11412,7 @@ export namespace BetaResponseUsage {
|
|
|
11349
11412
|
|
|
11350
11413
|
/**
|
|
11351
11414
|
* The number of tokens that were retrieved from the cache.
|
|
11352
|
-
* [More on prompt caching](https://
|
|
11415
|
+
* [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
11353
11416
|
*/
|
|
11354
11417
|
cached_tokens: number;
|
|
11355
11418
|
}
|
|
@@ -11519,7 +11582,7 @@ export namespace BetaResponsesClientEvent {
|
|
|
11519
11582
|
|
|
11520
11583
|
/**
|
|
11521
11584
|
* Whether to run the model response in the background.
|
|
11522
|
-
* [Learn more](https://
|
|
11585
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
11523
11586
|
*/
|
|
11524
11587
|
background?: boolean | null;
|
|
11525
11588
|
|
|
@@ -11563,11 +11626,11 @@ export namespace BetaResponsesClientEvent {
|
|
|
11563
11626
|
*
|
|
11564
11627
|
* Learn more:
|
|
11565
11628
|
*
|
|
11566
|
-
* - [Text inputs and outputs](https://
|
|
11567
|
-
* - [Image inputs](https://
|
|
11568
|
-
* - [File inputs](https://
|
|
11569
|
-
* - [Conversation state](https://
|
|
11570
|
-
* - [Function calling](https://
|
|
11629
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
11630
|
+
* - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
11631
|
+
* - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
11632
|
+
* - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
11633
|
+
* - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
11571
11634
|
*/
|
|
11572
11635
|
input?: string | ResponsesAPI.BetaResponseInput;
|
|
11573
11636
|
|
|
@@ -11583,7 +11646,7 @@ export namespace BetaResponsesClientEvent {
|
|
|
11583
11646
|
/**
|
|
11584
11647
|
* An upper bound for the number of tokens that can be generated for a response,
|
|
11585
11648
|
* including visible output tokens and
|
|
11586
|
-
* [reasoning tokens](https://
|
|
11649
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
11587
11650
|
*/
|
|
11588
11651
|
max_output_tokens?: number | null;
|
|
11589
11652
|
|
|
@@ -11609,8 +11672,8 @@ export namespace BetaResponsesClientEvent {
|
|
|
11609
11672
|
* Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
|
|
11610
11673
|
* range of models with different capabilities, performance characteristics, and
|
|
11611
11674
|
* price points. Refer to the
|
|
11612
|
-
* [model guide](https://
|
|
11613
|
-
* available models.
|
|
11675
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
11676
|
+
* compare available models.
|
|
11614
11677
|
*/
|
|
11615
11678
|
model?:
|
|
11616
11679
|
| 'gpt-6-astra'
|
|
@@ -11736,21 +11799,21 @@ export namespace BetaResponsesClientEvent {
|
|
|
11736
11799
|
/**
|
|
11737
11800
|
* The unique ID of the previous response to the model. Use this to create
|
|
11738
11801
|
* multi-turn conversations. Learn more about
|
|
11739
|
-
* [conversation state](https://
|
|
11802
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
11740
11803
|
* Cannot be used in conjunction with `conversation`.
|
|
11741
11804
|
*/
|
|
11742
11805
|
previous_response_id?: string | null;
|
|
11743
11806
|
|
|
11744
11807
|
/**
|
|
11745
11808
|
* Reference to a prompt template and its variables.
|
|
11746
|
-
* [Learn more](https://
|
|
11809
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
11747
11810
|
*/
|
|
11748
11811
|
prompt?: ResponsesAPI.BetaResponsePrompt | null;
|
|
11749
11812
|
|
|
11750
11813
|
/**
|
|
11751
11814
|
* Used by OpenAI to cache responses for similar requests to optimize your cache
|
|
11752
11815
|
* hit rates. Replaces the `user` field.
|
|
11753
|
-
* [Learn more](https://
|
|
11816
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
11754
11817
|
*/
|
|
11755
11818
|
prompt_cache_key?: string | null;
|
|
11756
11819
|
|
|
@@ -11762,7 +11825,7 @@ export namespace BetaResponsesClientEvent {
|
|
|
11762
11825
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
11763
11826
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
11764
11827
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
11765
|
-
* [prompt caching guide](https://
|
|
11828
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
11766
11829
|
* for current details.
|
|
11767
11830
|
*/
|
|
11768
11831
|
prompt_cache_options?: ResponseCreate.PromptCacheOptions;
|
|
@@ -11773,7 +11836,7 @@ export namespace BetaResponsesClientEvent {
|
|
|
11773
11836
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
11774
11837
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
11775
11838
|
* of 24 hours.
|
|
11776
|
-
* [Learn more](https://
|
|
11839
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
11777
11840
|
* This field expresses a maximum retention policy, while
|
|
11778
11841
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
11779
11842
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -11790,7 +11853,7 @@ export namespace BetaResponsesClientEvent {
|
|
|
11790
11853
|
|
|
11791
11854
|
/**
|
|
11792
11855
|
* Configuration options for
|
|
11793
|
-
* [reasoning models](https://
|
|
11856
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
11794
11857
|
*/
|
|
11795
11858
|
reasoning?: ResponseCreate.Reasoning | null;
|
|
11796
11859
|
|
|
@@ -11800,7 +11863,7 @@ export namespace BetaResponsesClientEvent {
|
|
|
11800
11863
|
* identifies each user, with a maximum length of 64 characters. We recommend
|
|
11801
11864
|
* hashing their username or email address, in order to avoid sending us any
|
|
11802
11865
|
* identifying information.
|
|
11803
|
-
* [Learn more](https://
|
|
11866
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
11804
11867
|
*/
|
|
11805
11868
|
safety_identifier?: string | null;
|
|
11806
11869
|
|
|
@@ -11812,13 +11875,15 @@ export namespace BetaResponsesClientEvent {
|
|
|
11812
11875
|
* will use 'default'.
|
|
11813
11876
|
* - If set to 'default', then the request will be processed with the standard
|
|
11814
11877
|
* pricing and performance for the selected model.
|
|
11815
|
-
* - If set to
|
|
11816
|
-
* then
|
|
11817
|
-
*
|
|
11818
|
-
*
|
|
11819
|
-
*
|
|
11820
|
-
*
|
|
11821
|
-
*
|
|
11878
|
+
* - If set to
|
|
11879
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
11880
|
+
* the request will be processed with the Flex Processing service tier.
|
|
11881
|
+
* - To opt-in to
|
|
11882
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
11883
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
11884
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
11885
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
11886
|
+
* `priority` in your request.
|
|
11822
11887
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
11823
11888
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
11824
11889
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -11836,7 +11901,7 @@ export namespace BetaResponsesClientEvent {
|
|
|
11836
11901
|
* Whether to store the generated model response for later retrieval via API.
|
|
11837
11902
|
* Defaults to true when omitted. If set to true, response data will be stored for
|
|
11838
11903
|
* at least 30 days, subject to the
|
|
11839
|
-
* [data retention exceptions](/api/docs/guides/your-data#v1responses).
|
|
11904
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
11840
11905
|
*/
|
|
11841
11906
|
store?: boolean | null;
|
|
11842
11907
|
|
|
@@ -11845,7 +11910,7 @@ export namespace BetaResponsesClientEvent {
|
|
|
11845
11910
|
* generated using
|
|
11846
11911
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
11847
11912
|
* See the
|
|
11848
|
-
* [Streaming section below](https://
|
|
11913
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
11849
11914
|
* for more information.
|
|
11850
11915
|
*/
|
|
11851
11916
|
stream?: boolean | null;
|
|
@@ -11876,8 +11941,8 @@ export namespace BetaResponsesClientEvent {
|
|
|
11876
11941
|
* Configuration options for a text response from the model. Can be plain text or
|
|
11877
11942
|
* structured JSON data. Learn more:
|
|
11878
11943
|
*
|
|
11879
|
-
* - [Text inputs and outputs](https://
|
|
11880
|
-
* - [Structured Outputs](https://
|
|
11944
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
11945
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
11881
11946
|
*/
|
|
11882
11947
|
text?: ResponsesAPI.BetaResponseTextConfig;
|
|
11883
11948
|
|
|
@@ -11905,17 +11970,18 @@ export namespace BetaResponsesClientEvent {
|
|
|
11905
11970
|
*
|
|
11906
11971
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
11907
11972
|
* capabilities, like
|
|
11908
|
-
* [web search](https://
|
|
11909
|
-
*
|
|
11973
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
11974
|
+
* or
|
|
11975
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
11910
11976
|
* Learn more about
|
|
11911
|
-
* [built-in tools](https://
|
|
11977
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
11912
11978
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
11913
11979
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
11914
|
-
* [MCP Tools](https://
|
|
11980
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
11915
11981
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
11916
11982
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
11917
11983
|
* Learn more about
|
|
11918
|
-
* [function calling](https://
|
|
11984
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
11919
11985
|
* You can also use custom tools to call your own code.
|
|
11920
11986
|
*/
|
|
11921
11987
|
tools?: Array<ResponsesAPI.BetaTool>;
|
|
@@ -11953,7 +12019,7 @@ export namespace BetaResponsesClientEvent {
|
|
|
11953
12019
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
11954
12020
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
11955
12021
|
* abuse.
|
|
11956
|
-
* [Learn more](https://
|
|
12022
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
11957
12023
|
*/
|
|
11958
12024
|
user?: string;
|
|
11959
12025
|
}
|
|
@@ -12048,7 +12114,7 @@ export namespace BetaResponsesClientEvent {
|
|
|
12048
12114
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
12049
12115
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
12050
12116
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
12051
|
-
* [prompt caching guide](https://
|
|
12117
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
12052
12118
|
* for current details.
|
|
12053
12119
|
*/
|
|
12054
12120
|
export interface PromptCacheOptions {
|
|
@@ -12078,7 +12144,7 @@ export namespace BetaResponsesClientEvent {
|
|
|
12078
12144
|
|
|
12079
12145
|
/**
|
|
12080
12146
|
* Configuration options for
|
|
12081
|
-
* [reasoning models](https://
|
|
12147
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
12082
12148
|
*/
|
|
12083
12149
|
export interface Reasoning {
|
|
12084
12150
|
/**
|
|
@@ -12096,7 +12162,7 @@ export namespace BetaResponsesClientEvent {
|
|
|
12096
12162
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
12097
12163
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
12098
12164
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
12099
|
-
* [reasoning guide](https://
|
|
12165
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
12100
12166
|
* model-specific support.
|
|
12101
12167
|
*/
|
|
12102
12168
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
|
|
@@ -12993,13 +13059,15 @@ export namespace BetaResponsesServerEvent {
|
|
|
12993
13059
|
* will use 'default'.
|
|
12994
13060
|
* - If set to 'default', then the request will be processed with the standard
|
|
12995
13061
|
* pricing and performance for the selected model.
|
|
12996
|
-
* - If set to
|
|
12997
|
-
* then
|
|
12998
|
-
*
|
|
12999
|
-
*
|
|
13000
|
-
*
|
|
13001
|
-
*
|
|
13002
|
-
*
|
|
13062
|
+
* - If set to
|
|
13063
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
13064
|
+
* the request will be processed with the Flex Processing service tier.
|
|
13065
|
+
* - To opt-in to
|
|
13066
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
13067
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
13068
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
13069
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
13070
|
+
* `priority` in your request.
|
|
13003
13071
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
13004
13072
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
13005
13073
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -13063,7 +13131,7 @@ export namespace BetaTool {
|
|
|
13063
13131
|
/**
|
|
13064
13132
|
* Give the model access to additional tools via remote Model Context Protocol
|
|
13065
13133
|
* (MCP) servers.
|
|
13066
|
-
* [Learn more about MCP](https://
|
|
13134
|
+
* [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
13067
13135
|
*/
|
|
13068
13136
|
export interface Mcp {
|
|
13069
13137
|
/**
|
|
@@ -13097,7 +13165,7 @@ export namespace BetaTool {
|
|
|
13097
13165
|
* Identifier for service connectors, like those available in ChatGPT. One of
|
|
13098
13166
|
* `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
|
|
13099
13167
|
* service connectors
|
|
13100
|
-
* [here](https://
|
|
13168
|
+
* [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
|
|
13101
13169
|
*
|
|
13102
13170
|
* Currently supported `connector_id` values are:
|
|
13103
13171
|
*
|
|
@@ -13544,12 +13612,12 @@ export interface BetaToolChoiceShell {
|
|
|
13544
13612
|
|
|
13545
13613
|
/**
|
|
13546
13614
|
* Indicates that the model should use a built-in tool to generate a response.
|
|
13547
|
-
* [Learn more about built-in tools](https://
|
|
13615
|
+
* [Learn more about built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
13548
13616
|
*/
|
|
13549
13617
|
export interface BetaToolChoiceTypes {
|
|
13550
13618
|
/**
|
|
13551
13619
|
* The type of hosted tool the model should to use. Learn more about
|
|
13552
|
-
* [built-in tools](https://
|
|
13620
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
13553
13621
|
*
|
|
13554
13622
|
* Allowed values are:
|
|
13555
13623
|
*
|
|
@@ -13600,7 +13668,7 @@ export interface BetaToolSearchTool {
|
|
|
13600
13668
|
/**
|
|
13601
13669
|
* This tool searches the web for relevant results to use in a response. Learn more
|
|
13602
13670
|
* about the
|
|
13603
|
-
* [web search tool](https://
|
|
13671
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
13604
13672
|
*/
|
|
13605
13673
|
export interface BetaWebSearchPreviewTool {
|
|
13606
13674
|
/**
|
|
@@ -13659,7 +13727,7 @@ export namespace BetaWebSearchPreviewTool {
|
|
|
13659
13727
|
|
|
13660
13728
|
/**
|
|
13661
13729
|
* Search the Internet for sources related to the prompt. Learn more about the
|
|
13662
|
-
* [web search tool](https://
|
|
13730
|
+
* [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
|
|
13663
13731
|
*/
|
|
13664
13732
|
export interface BetaWebSearchTool {
|
|
13665
13733
|
/**
|
|
@@ -13743,7 +13811,7 @@ export type ResponseCreateParams = ResponseCreateParamsNonStreaming | ResponseCr
|
|
|
13743
13811
|
export interface ResponseCreateParamsBase {
|
|
13744
13812
|
/**
|
|
13745
13813
|
* Body param: Whether to run the model response in the background.
|
|
13746
|
-
* [Learn more](https://
|
|
13814
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/background).
|
|
13747
13815
|
*/
|
|
13748
13816
|
background?: boolean | null;
|
|
13749
13817
|
|
|
@@ -13788,11 +13856,11 @@ export interface ResponseCreateParamsBase {
|
|
|
13788
13856
|
*
|
|
13789
13857
|
* Learn more:
|
|
13790
13858
|
*
|
|
13791
|
-
* - [Text inputs and outputs](https://
|
|
13792
|
-
* - [Image inputs](https://
|
|
13793
|
-
* - [File inputs](https://
|
|
13794
|
-
* - [Conversation state](https://
|
|
13795
|
-
* - [Function calling](https://
|
|
13859
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
13860
|
+
* - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)
|
|
13861
|
+
* - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)
|
|
13862
|
+
* - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)
|
|
13863
|
+
* - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)
|
|
13796
13864
|
*/
|
|
13797
13865
|
input?: string | BetaResponseInput;
|
|
13798
13866
|
|
|
@@ -13808,7 +13876,7 @@ export interface ResponseCreateParamsBase {
|
|
|
13808
13876
|
/**
|
|
13809
13877
|
* Body param: An upper bound for the number of tokens that can be generated for a
|
|
13810
13878
|
* response, including visible output tokens and
|
|
13811
|
-
* [reasoning tokens](https://
|
|
13879
|
+
* [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
13812
13880
|
*/
|
|
13813
13881
|
max_output_tokens?: number | null;
|
|
13814
13882
|
|
|
@@ -13834,8 +13902,8 @@ export interface ResponseCreateParamsBase {
|
|
|
13834
13902
|
* Body param: Model ID used to generate the response, like `gpt-6-astra`. OpenAI
|
|
13835
13903
|
* offers a wide range of models with different capabilities, performance
|
|
13836
13904
|
* characteristics, and price points. Refer to the
|
|
13837
|
-
* [model guide](https://
|
|
13838
|
-
* available models.
|
|
13905
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
13906
|
+
* compare available models.
|
|
13839
13907
|
*/
|
|
13840
13908
|
model?:
|
|
13841
13909
|
| 'gpt-6-astra'
|
|
@@ -13962,21 +14030,21 @@ export interface ResponseCreateParamsBase {
|
|
|
13962
14030
|
/**
|
|
13963
14031
|
* Body param: The unique ID of the previous response to the model. Use this to
|
|
13964
14032
|
* create multi-turn conversations. Learn more about
|
|
13965
|
-
* [conversation state](https://
|
|
14033
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
13966
14034
|
* Cannot be used in conjunction with `conversation`.
|
|
13967
14035
|
*/
|
|
13968
14036
|
previous_response_id?: string | null;
|
|
13969
14037
|
|
|
13970
14038
|
/**
|
|
13971
14039
|
* Body param: Reference to a prompt template and its variables.
|
|
13972
|
-
* [Learn more](https://
|
|
14040
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
13973
14041
|
*/
|
|
13974
14042
|
prompt?: BetaResponsePrompt | null;
|
|
13975
14043
|
|
|
13976
14044
|
/**
|
|
13977
14045
|
* Body param: Used by OpenAI to cache responses for similar requests to optimize
|
|
13978
14046
|
* your cache hit rates. Replaces the `user` field.
|
|
13979
|
-
* [Learn more](https://
|
|
14047
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).
|
|
13980
14048
|
*/
|
|
13981
14049
|
prompt_cache_key?: string | null;
|
|
13982
14050
|
|
|
@@ -13989,7 +14057,7 @@ export interface ResponseCreateParamsBase {
|
|
|
13989
14057
|
* conversation, without a content-block lookback limit. Set `mode` to `explicit`
|
|
13990
14058
|
* to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is
|
|
13991
14059
|
* currently the only supported value. See the
|
|
13992
|
-
* [prompt caching guide](https://
|
|
14060
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
13993
14061
|
* for current details.
|
|
13994
14062
|
*/
|
|
13995
14063
|
prompt_cache_options?: ResponseCreateParams.PromptCacheOptions;
|
|
@@ -14000,7 +14068,7 @@ export interface ResponseCreateParamsBase {
|
|
|
14000
14068
|
* The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
14001
14069
|
* prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
14002
14070
|
* of 24 hours.
|
|
14003
|
-
* [Learn more](https://
|
|
14071
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).
|
|
14004
14072
|
* This field expresses a maximum retention policy, while
|
|
14005
14073
|
* `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields
|
|
14006
14074
|
* are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future
|
|
@@ -14017,7 +14085,7 @@ export interface ResponseCreateParamsBase {
|
|
|
14017
14085
|
|
|
14018
14086
|
/**
|
|
14019
14087
|
* Body param: Configuration options for
|
|
14020
|
-
* [reasoning models](https://
|
|
14088
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
14021
14089
|
*/
|
|
14022
14090
|
reasoning?: ResponseCreateParams.Reasoning | null;
|
|
14023
14091
|
|
|
@@ -14027,7 +14095,7 @@ export interface ResponseCreateParamsBase {
|
|
|
14027
14095
|
* uniquely identifies each user, with a maximum length of 64 characters. We
|
|
14028
14096
|
* recommend hashing their username or email address, in order to avoid sending us
|
|
14029
14097
|
* any identifying information.
|
|
14030
|
-
* [Learn more](https://
|
|
14098
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
14031
14099
|
*/
|
|
14032
14100
|
safety_identifier?: string | null;
|
|
14033
14101
|
|
|
@@ -14039,13 +14107,15 @@ export interface ResponseCreateParamsBase {
|
|
|
14039
14107
|
* will use 'default'.
|
|
14040
14108
|
* - If set to 'default', then the request will be processed with the standard
|
|
14041
14109
|
* pricing and performance for the selected model.
|
|
14042
|
-
* - If set to
|
|
14043
|
-
* then
|
|
14044
|
-
*
|
|
14045
|
-
*
|
|
14046
|
-
*
|
|
14047
|
-
*
|
|
14048
|
-
*
|
|
14110
|
+
* - If set to
|
|
14111
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
14112
|
+
* the request will be processed with the Flex Processing service tier.
|
|
14113
|
+
* - To opt-in to
|
|
14114
|
+
* [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
14115
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
14116
|
+
* parameter for Responses or Chat Completions. The response will show
|
|
14117
|
+
* `service_tier=priority` regardless of if you specify `service_tier=fast` or
|
|
14118
|
+
* `priority` in your request.
|
|
14049
14119
|
* - If set to 'ultrafast', then the request will be processed with the
|
|
14050
14120
|
* access-controlled Ultrafast Processing service tier. This tier is currently
|
|
14051
14121
|
* available for `gpt-5.6-sol`; a response served through it will show
|
|
@@ -14063,7 +14133,7 @@ export interface ResponseCreateParamsBase {
|
|
|
14063
14133
|
* Body param: Whether to store the generated model response for later retrieval
|
|
14064
14134
|
* via API. Defaults to true when omitted. If set to true, response data will be
|
|
14065
14135
|
* stored for at least 30 days, subject to the
|
|
14066
|
-
* [data retention exceptions](/api/docs/guides/your-data#v1responses).
|
|
14136
|
+
* [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).
|
|
14067
14137
|
*/
|
|
14068
14138
|
store?: boolean | null;
|
|
14069
14139
|
|
|
@@ -14072,7 +14142,7 @@ export interface ResponseCreateParamsBase {
|
|
|
14072
14142
|
* client as it is generated using
|
|
14073
14143
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
14074
14144
|
* See the
|
|
14075
|
-
* [Streaming section below](https://
|
|
14145
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
14076
14146
|
* for more information.
|
|
14077
14147
|
*/
|
|
14078
14148
|
stream?: boolean | null;
|
|
@@ -14095,8 +14165,8 @@ export interface ResponseCreateParamsBase {
|
|
|
14095
14165
|
* Body param: Configuration options for a text response from the model. Can be
|
|
14096
14166
|
* plain text or structured JSON data. Learn more:
|
|
14097
14167
|
*
|
|
14098
|
-
* - [Text inputs and outputs](https://
|
|
14099
|
-
* - [Structured Outputs](https://
|
|
14168
|
+
* - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
|
|
14169
|
+
* - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
|
|
14100
14170
|
*/
|
|
14101
14171
|
text?: BetaResponseTextConfig;
|
|
14102
14172
|
|
|
@@ -14124,17 +14194,18 @@ export interface ResponseCreateParamsBase {
|
|
|
14124
14194
|
*
|
|
14125
14195
|
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
|
|
14126
14196
|
* capabilities, like
|
|
14127
|
-
* [web search](https://
|
|
14128
|
-
*
|
|
14197
|
+
* [web search](https://developers.openai.com/api/docs/guides/tools-web-search)
|
|
14198
|
+
* or
|
|
14199
|
+
* [file search](https://developers.openai.com/api/docs/guides/tools-file-search).
|
|
14129
14200
|
* Learn more about
|
|
14130
|
-
* [built-in tools](https://
|
|
14201
|
+
* [built-in tools](https://developers.openai.com/api/docs/guides/tools).
|
|
14131
14202
|
* - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
|
|
14132
14203
|
* predefined connectors such as Google Drive and SharePoint. Learn more about
|
|
14133
|
-
* [MCP Tools](https://
|
|
14204
|
+
* [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
14134
14205
|
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
|
|
14135
14206
|
* the model to call your own code with strongly typed arguments and outputs.
|
|
14136
14207
|
* Learn more about
|
|
14137
|
-
* [function calling](https://
|
|
14208
|
+
* [function calling](https://developers.openai.com/api/docs/guides/function-calling).
|
|
14138
14209
|
* You can also use custom tools to call your own code.
|
|
14139
14210
|
*/
|
|
14140
14211
|
tools?: Array<BetaTool>;
|
|
@@ -14174,7 +14245,7 @@ export interface ResponseCreateParamsBase {
|
|
|
14174
14245
|
* optimizations. A stable identifier for your end-users. Used to boost cache hit
|
|
14175
14246
|
* rates by better bucketing similar requests and to help OpenAI detect and prevent
|
|
14176
14247
|
* abuse.
|
|
14177
|
-
* [Learn more](https://
|
|
14248
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
14178
14249
|
*/
|
|
14179
14250
|
user?: string;
|
|
14180
14251
|
|
|
@@ -14274,7 +14345,7 @@ export namespace ResponseCreateParams {
|
|
|
14274
14345
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
14275
14346
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
14276
14347
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
14277
|
-
* [prompt caching guide](https://
|
|
14348
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
14278
14349
|
* for current details.
|
|
14279
14350
|
*/
|
|
14280
14351
|
export interface PromptCacheOptions {
|
|
@@ -14304,7 +14375,7 @@ export namespace ResponseCreateParams {
|
|
|
14304
14375
|
|
|
14305
14376
|
/**
|
|
14306
14377
|
* Configuration options for
|
|
14307
|
-
* [reasoning models](https://
|
|
14378
|
+
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
|
|
14308
14379
|
*/
|
|
14309
14380
|
export interface Reasoning {
|
|
14310
14381
|
/**
|
|
@@ -14322,7 +14393,7 @@ export namespace ResponseCreateParams {
|
|
|
14322
14393
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
14323
14394
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
14324
14395
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
14325
|
-
* [reasoning guide](https://
|
|
14396
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
14326
14397
|
* model-specific support.
|
|
14327
14398
|
*/
|
|
14328
14399
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | null;
|
|
@@ -14386,7 +14457,7 @@ export interface ResponseCreateParamsNonStreaming extends ResponseCreateParamsBa
|
|
|
14386
14457
|
* client as it is generated using
|
|
14387
14458
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
14388
14459
|
* See the
|
|
14389
|
-
* [Streaming section below](https://
|
|
14460
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
14390
14461
|
* for more information.
|
|
14391
14462
|
*/
|
|
14392
14463
|
stream?: false | null;
|
|
@@ -14398,7 +14469,7 @@ export interface ResponseCreateParamsStreaming extends ResponseCreateParamsBase
|
|
|
14398
14469
|
* client as it is generated using
|
|
14399
14470
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
14400
14471
|
* See the
|
|
14401
|
-
* [Streaming section below](https://
|
|
14472
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
14402
14473
|
* for more information.
|
|
14403
14474
|
*/
|
|
14404
14475
|
stream: true;
|
|
@@ -14434,7 +14505,7 @@ export interface ResponseRetrieveParamsBase {
|
|
|
14434
14505
|
* client as it is generated using
|
|
14435
14506
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
14436
14507
|
* See the
|
|
14437
|
-
* [Streaming section below](https://
|
|
14508
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
14438
14509
|
* for more information.
|
|
14439
14510
|
*/
|
|
14440
14511
|
stream?: boolean;
|
|
@@ -14456,7 +14527,7 @@ export interface ResponseRetrieveParamsNonStreaming extends ResponseRetrievePara
|
|
|
14456
14527
|
* client as it is generated using
|
|
14457
14528
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
14458
14529
|
* See the
|
|
14459
|
-
* [Streaming section below](https://
|
|
14530
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
14460
14531
|
* for more information.
|
|
14461
14532
|
*/
|
|
14462
14533
|
stream?: false;
|
|
@@ -14468,7 +14539,7 @@ export interface ResponseRetrieveParamsStreaming extends ResponseRetrieveParamsB
|
|
|
14468
14539
|
* client as it is generated using
|
|
14469
14540
|
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
|
|
14470
14541
|
* See the
|
|
14471
|
-
* [Streaming section below](https://
|
|
14542
|
+
* [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)
|
|
14472
14543
|
* for more information.
|
|
14473
14544
|
*/
|
|
14474
14545
|
stream: true;
|
|
@@ -14493,8 +14564,8 @@ export interface ResponseCompactParams {
|
|
|
14493
14564
|
* Body param: Model ID used to generate the response, like `gpt-6-astra`. OpenAI
|
|
14494
14565
|
* offers a wide range of models with different capabilities, performance
|
|
14495
14566
|
* characteristics, and price points. Refer to the
|
|
14496
|
-
* [model guide](https://
|
|
14497
|
-
* available models.
|
|
14567
|
+
* [model guide](https://developers.openai.com/api/docs/models) to browse and
|
|
14568
|
+
* compare available models.
|
|
14498
14569
|
*/
|
|
14499
14570
|
model:
|
|
14500
14571
|
| 'gpt-6-astra'
|
|
@@ -14620,7 +14691,7 @@ export interface ResponseCompactParams {
|
|
|
14620
14691
|
/**
|
|
14621
14692
|
* Body param: The unique ID of the previous response to the model. Use this to
|
|
14622
14693
|
* create multi-turn conversations. Learn more about
|
|
14623
|
-
* [conversation state](https://
|
|
14694
|
+
* [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
|
|
14624
14695
|
* Cannot be used in conjunction with `conversation`.
|
|
14625
14696
|
*/
|
|
14626
14697
|
previous_response_id?: string | null;
|
|
@@ -14639,7 +14710,7 @@ export interface ResponseCompactParams {
|
|
|
14639
14710
|
* conversation, without a content-block lookback limit. Set `mode` to `explicit`
|
|
14640
14711
|
* to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is
|
|
14641
14712
|
* currently the only supported value. See the
|
|
14642
|
-
* [prompt caching guide](https://
|
|
14713
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
14643
14714
|
* for current details.
|
|
14644
14715
|
*/
|
|
14645
14716
|
prompt_cache_options?: ResponseCompactParams.PromptCacheOptions | null;
|
|
@@ -14656,17 +14727,17 @@ export interface ResponseCompactParams {
|
|
|
14656
14727
|
* in the Project settings. Unless otherwise configured, the Project will use
|
|
14657
14728
|
* 'default'. - If set to 'default', then the request will be processed with the
|
|
14658
14729
|
* standard pricing and performance for the selected model. - If set to
|
|
14659
|
-
* '[flex](https://
|
|
14660
|
-
* request will be processed with the Flex Processing service tier. - To opt-in
|
|
14661
|
-
* [Fast mode](/api/docs/guides/fast-mode) at the
|
|
14662
|
-
* `service_tier=fast` or `service_tier=priority`
|
|
14663
|
-
* Completions. For models with a dedicated Fast
|
|
14664
|
-
* `service_tier=fast`; for other models, either
|
|
14665
|
-
* `service_tier=priority`. - When not set, the default behavior
|
|
14666
|
-
* the `service_tier` parameter is set, the response body will
|
|
14667
|
-
* `service_tier` value based on the processing mode actually used to
|
|
14668
|
-
* request. This response value may be different from the value set in
|
|
14669
|
-
* parameter.
|
|
14730
|
+
* '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
|
|
14731
|
+
* the request will be processed with the Flex Processing service tier. - To opt-in
|
|
14732
|
+
* to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
|
|
14733
|
+
* request level, include the `service_tier=fast` or `service_tier=priority`
|
|
14734
|
+
* parameter for Responses or Chat Completions. For models with a dedicated Fast
|
|
14735
|
+
* tier, either value resolves to `service_tier=fast`; for other models, either
|
|
14736
|
+
* value resolves to `service_tier=priority`. - When not set, the default behavior
|
|
14737
|
+
* is 'auto'. When the `service_tier` parameter is set, the response body will
|
|
14738
|
+
* include the `service_tier` value based on the processing mode actually used to
|
|
14739
|
+
* serve the request. This response value may be different from the value set in
|
|
14740
|
+
* the parameter.
|
|
14670
14741
|
*/
|
|
14671
14742
|
service_tier?: 'auto' | 'default' | 'fast' | 'flex' | 'priority' | null;
|
|
14672
14743
|
|
|
@@ -14685,7 +14756,7 @@ export namespace ResponseCompactParams {
|
|
|
14685
14756
|
* up to the latest 80 breakpoints in the conversation, without a content-block
|
|
14686
14757
|
* lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
|
|
14687
14758
|
* `ttl` defaults to `30m`, which is currently the only supported value. See the
|
|
14688
|
-
* [prompt caching guide](https://
|
|
14759
|
+
* [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
|
|
14689
14760
|
* for current details.
|
|
14690
14761
|
*/
|
|
14691
14762
|
export interface PromptCacheOptions {
|