@ai-sdk/openai 4.0.8 → 4.0.10
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 +17 -0
- package/dist/index.d.ts +2 -2
- package/dist/index.js +7 -3
- package/dist/index.js.map +1 -1
- package/dist/internal/index.d.ts +2 -2
- package/dist/internal/index.js +6 -2
- package/dist/internal/index.js.map +1 -1
- package/docs/03-openai.mdx +48 -71
- package/package.json +3 -3
- package/src/chat/openai-chat-language-model-options.ts +4 -0
- package/src/openai-language-model-capabilities.ts +2 -1
- package/src/responses/openai-responses-language-model-options.ts +8 -0
package/docs/03-openai.mdx
CHANGED
|
@@ -11,21 +11,7 @@ The [OpenAI](https://openai.com/) provider contains language model support for t
|
|
|
11
11
|
|
|
12
12
|
The OpenAI provider is available in the `@ai-sdk/openai` module. You can install it with
|
|
13
13
|
|
|
14
|
-
<
|
|
15
|
-
<Tab>
|
|
16
|
-
<Snippet text="pnpm add @ai-sdk/openai" dark />
|
|
17
|
-
</Tab>
|
|
18
|
-
<Tab>
|
|
19
|
-
<Snippet text="npm install @ai-sdk/openai" dark />
|
|
20
|
-
</Tab>
|
|
21
|
-
<Tab>
|
|
22
|
-
<Snippet text="yarn add @ai-sdk/openai" dark />
|
|
23
|
-
</Tab>
|
|
24
|
-
|
|
25
|
-
<Tab>
|
|
26
|
-
<Snippet text="bun add @ai-sdk/openai" dark />
|
|
27
|
-
</Tab>
|
|
28
|
-
</Tabs>
|
|
14
|
+
<InstallPackages packages="@ai-sdk/openai" />
|
|
29
15
|
|
|
30
16
|
## Provider Instance
|
|
31
17
|
|
|
@@ -363,20 +349,7 @@ The [`ai-sdk-openai-websocket-fetch`](https://www.npmjs.com/package/ai-sdk-opena
|
|
|
363
349
|
package provides a drop-in `fetch` replacement that routes streaming requests
|
|
364
350
|
through a persistent WebSocket connection.
|
|
365
351
|
|
|
366
|
-
<
|
|
367
|
-
<Tab>
|
|
368
|
-
<Snippet text="pnpm add ai-sdk-openai-websocket-fetch" dark />
|
|
369
|
-
</Tab>
|
|
370
|
-
<Tab>
|
|
371
|
-
<Snippet text="npm install ai-sdk-openai-websocket-fetch" dark />
|
|
372
|
-
</Tab>
|
|
373
|
-
<Tab>
|
|
374
|
-
<Snippet text="yarn add ai-sdk-openai-websocket-fetch" dark />
|
|
375
|
-
</Tab>
|
|
376
|
-
<Tab>
|
|
377
|
-
<Snippet text="bun add ai-sdk-openai-websocket-fetch" dark />
|
|
378
|
-
</Tab>
|
|
379
|
-
</Tabs>
|
|
352
|
+
<InstallPackages packages="ai-sdk-openai-websocket-fetch" />
|
|
380
353
|
|
|
381
354
|
Pass the WebSocket fetch to `createOpenAI` via the `fetch` option:
|
|
382
355
|
|
|
@@ -2374,32 +2347,36 @@ The following optional provider options are available for OpenAI completion mode
|
|
|
2374
2347
|
|
|
2375
2348
|
### Model Capabilities
|
|
2376
2349
|
|
|
2377
|
-
| Model | Image Input
|
|
2378
|
-
| --------------------- |
|
|
2379
|
-
| `gpt-5.
|
|
2380
|
-
| `gpt-5.
|
|
2381
|
-
| `gpt-5.
|
|
2382
|
-
| `gpt-5.
|
|
2383
|
-
| `gpt-5.
|
|
2384
|
-
| `gpt-5.
|
|
2385
|
-
| `gpt-5.
|
|
2386
|
-
| `gpt-5.
|
|
2387
|
-
| `gpt-5.
|
|
2388
|
-
| `gpt-5.
|
|
2389
|
-
| `gpt-5.
|
|
2390
|
-
| `gpt-5.
|
|
2391
|
-
| `gpt-5.
|
|
2392
|
-
| `gpt-5-
|
|
2393
|
-
| `gpt-5`
|
|
2394
|
-
| `gpt-5-
|
|
2395
|
-
| `gpt-5
|
|
2396
|
-
| `gpt-5-
|
|
2397
|
-
| `gpt-5
|
|
2398
|
-
| `gpt-
|
|
2399
|
-
| `gpt-
|
|
2400
|
-
| `gpt-
|
|
2401
|
-
| `gpt-
|
|
2402
|
-
| `gpt-
|
|
2350
|
+
| Model | Image Input | Audio Input | Object Generation | Tool Usage |
|
|
2351
|
+
| --------------------- | ----------- | ----------- | ----------------- | ---------- |
|
|
2352
|
+
| `gpt-5.6` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2353
|
+
| `gpt-5.6-luna` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2354
|
+
| `gpt-5.6-sol` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2355
|
+
| `gpt-5.6-terra` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2356
|
+
| `gpt-5.5` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2357
|
+
| `gpt-5.4-pro` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2358
|
+
| `gpt-5.4` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2359
|
+
| `gpt-5.4-mini` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2360
|
+
| `gpt-5.4-nano` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2361
|
+
| `gpt-5.3-chat-latest` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2362
|
+
| `gpt-5.2-pro` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2363
|
+
| `gpt-5.2-chat-latest` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2364
|
+
| `gpt-5.2` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2365
|
+
| `gpt-5.1-codex-mini` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2366
|
+
| `gpt-5.1-codex` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2367
|
+
| `gpt-5.1-chat-latest` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2368
|
+
| `gpt-5.1` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2369
|
+
| `gpt-5-pro` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2370
|
+
| `gpt-5` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2371
|
+
| `gpt-5-mini` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2372
|
+
| `gpt-5-nano` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2373
|
+
| `gpt-5-codex` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2374
|
+
| `gpt-5-chat-latest` | <Check /> | <Cross /> | <Cross /> | <Cross /> |
|
|
2375
|
+
| `gpt-4.1` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2376
|
+
| `gpt-4.1-mini` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2377
|
+
| `gpt-4.1-nano` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2378
|
+
| `gpt-4o` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2379
|
+
| `gpt-4o-mini` | <Check /> | <Cross /> | <Check /> | <Check /> |
|
|
2403
2380
|
|
|
2404
2381
|
<Note>
|
|
2405
2382
|
The table above lists popular models. Please see the [OpenAI
|
|
@@ -2475,11 +2452,11 @@ The following optional provider options are available for OpenAI embedding model
|
|
|
2475
2452
|
|
|
2476
2453
|
### Model Capabilities
|
|
2477
2454
|
|
|
2478
|
-
| Model | Default Dimensions | Custom Dimensions
|
|
2479
|
-
| ------------------------ | ------------------ |
|
|
2480
|
-
| `text-embedding-3-large` | 3072 | <Check
|
|
2481
|
-
| `text-embedding-3-small` | 1536 | <Check
|
|
2482
|
-
| `text-embedding-ada-002` | 1536 | <Cross
|
|
2455
|
+
| Model | Default Dimensions | Custom Dimensions |
|
|
2456
|
+
| ------------------------ | ------------------ | ----------------- |
|
|
2457
|
+
| `text-embedding-3-large` | 3072 | <Check /> |
|
|
2458
|
+
| `text-embedding-3-small` | 1536 | <Check /> |
|
|
2459
|
+
| `text-embedding-ada-002` | 1536 | <Cross /> |
|
|
2483
2460
|
|
|
2484
2461
|
## Image Models
|
|
2485
2462
|
|
|
@@ -2709,12 +2686,12 @@ The following provider options are available:
|
|
|
2709
2686
|
|
|
2710
2687
|
### Model Capabilities
|
|
2711
2688
|
|
|
2712
|
-
| Model | Transcription
|
|
2713
|
-
| ------------------------ |
|
|
2714
|
-
| `whisper-1` | <Check
|
|
2715
|
-
| `gpt-4o-mini-transcribe` | <Check
|
|
2716
|
-
| `gpt-4o-transcribe` | <Check
|
|
2717
|
-
| `gpt-realtime-whisper` | <Cross
|
|
2689
|
+
| Model | Transcription | Streaming | Duration | Segments | Language |
|
|
2690
|
+
| ------------------------ | ------------- | --------- | --------- | --------- | --------- |
|
|
2691
|
+
| `whisper-1` | <Check /> | <Cross /> | <Check /> | <Check /> | <Check /> |
|
|
2692
|
+
| `gpt-4o-mini-transcribe` | <Check /> | <Cross /> | <Cross /> | <Cross /> | <Cross /> |
|
|
2693
|
+
| `gpt-4o-transcribe` | <Check /> | <Cross /> | <Cross /> | <Cross /> | <Cross /> |
|
|
2694
|
+
| `gpt-realtime-whisper` | <Cross /> | <Check /> | <Cross /> | <Cross /> | <Cross /> |
|
|
2718
2695
|
|
|
2719
2696
|
## Speech Models
|
|
2720
2697
|
|
|
@@ -2771,8 +2748,8 @@ const result = await generateSpeech({
|
|
|
2771
2748
|
|
|
2772
2749
|
### Model Capabilities
|
|
2773
2750
|
|
|
2774
|
-
| Model | Instructions
|
|
2775
|
-
| ----------------- |
|
|
2776
|
-
| `tts-1` | <Check
|
|
2777
|
-
| `tts-1-hd` | <Check
|
|
2778
|
-
| `gpt-4o-mini-tts` | <Check
|
|
2751
|
+
| Model | Instructions |
|
|
2752
|
+
| ----------------- | ------------ |
|
|
2753
|
+
| `tts-1` | <Check /> |
|
|
2754
|
+
| `tts-1-hd` | <Check /> |
|
|
2755
|
+
| `gpt-4o-mini-tts` | <Check /> |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ai-sdk/openai",
|
|
3
|
-
"version": "4.0.
|
|
3
|
+
"version": "4.0.10",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"sideEffects": false,
|
|
@@ -35,8 +35,8 @@
|
|
|
35
35
|
}
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@ai-sdk/provider": "
|
|
39
|
-
"@ai-sdk/provider
|
|
38
|
+
"@ai-sdk/provider-utils": "5.0.7",
|
|
39
|
+
"@ai-sdk/provider": "4.0.3"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
42
|
"@types/node": "22.19.19",
|
|
@@ -66,6 +66,10 @@ export type OpenAIChatModelId =
|
|
|
66
66
|
| 'gpt-5.4-pro-2026-03-05'
|
|
67
67
|
| 'gpt-5.5'
|
|
68
68
|
| 'gpt-5.5-2026-04-23'
|
|
69
|
+
| 'gpt-5.6'
|
|
70
|
+
| 'gpt-5.6-luna'
|
|
71
|
+
| 'gpt-5.6-sol'
|
|
72
|
+
| 'gpt-5.6-terra'
|
|
69
73
|
| (string & {});
|
|
70
74
|
|
|
71
75
|
export const openaiLanguageModelChatOptions = lazySchema(() =>
|
|
@@ -42,7 +42,8 @@ export function getOpenAILanguageModelCapabilities(
|
|
|
42
42
|
modelId.startsWith('gpt-5.2') ||
|
|
43
43
|
modelId.startsWith('gpt-5.3') ||
|
|
44
44
|
modelId.startsWith('gpt-5.4') ||
|
|
45
|
-
modelId.startsWith('gpt-5.5')
|
|
45
|
+
modelId.startsWith('gpt-5.5') ||
|
|
46
|
+
modelId.startsWith('gpt-5.6');
|
|
46
47
|
|
|
47
48
|
const systemMessageMode = isReasoningModel ? 'developer' : 'system';
|
|
48
49
|
|
|
@@ -53,6 +53,10 @@ export const openaiResponsesReasoningModelIds = [
|
|
|
53
53
|
'gpt-5.4-pro-2026-03-05',
|
|
54
54
|
'gpt-5.5',
|
|
55
55
|
'gpt-5.5-2026-04-23',
|
|
56
|
+
'gpt-5.6',
|
|
57
|
+
'gpt-5.6-luna',
|
|
58
|
+
'gpt-5.6-sol',
|
|
59
|
+
'gpt-5.6-terra',
|
|
56
60
|
] as const;
|
|
57
61
|
|
|
58
62
|
export const openaiResponsesModelIds = [
|
|
@@ -121,6 +125,10 @@ export type OpenAIResponsesModelId =
|
|
|
121
125
|
| 'gpt-5.4-pro-2026-03-05'
|
|
122
126
|
| 'gpt-5.5'
|
|
123
127
|
| 'gpt-5.5-2026-04-23'
|
|
128
|
+
| 'gpt-5.6'
|
|
129
|
+
| 'gpt-5.6-luna'
|
|
130
|
+
| 'gpt-5.6-sol'
|
|
131
|
+
| 'gpt-5.6-terra'
|
|
124
132
|
| 'gpt-5-2025-08-07'
|
|
125
133
|
| 'gpt-5-chat-latest'
|
|
126
134
|
| 'gpt-5-codex'
|