@ai-sdk/openai 1.2.0 → 1.2.2
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 +15 -0
- package/dist/index.d.mts +31 -0
- package/dist/index.d.ts +31 -0
- package/dist/index.js +817 -24
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +824 -21
- package/dist/index.mjs.map +1 -1
- package/internal/dist/index.d.mts +16 -1
- package/internal/dist/index.d.ts +16 -1
- package/internal/dist/index.js +780 -16
- package/internal/dist/index.js.map +1 -1
- package/internal/dist/index.mjs +789 -16
- package/internal/dist/index.mjs.map +1 -1
- package/package.json +5 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,20 @@
|
|
|
1
1
|
# @ai-sdk/openai
|
|
2
2
|
|
|
3
|
+
## 1.2.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- e3a389e: feat (provider/openai): support responses api
|
|
8
|
+
|
|
9
|
+
## 1.2.1
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- e1d3d42: feat (ai): expose raw response body in generateText and generateObject
|
|
14
|
+
- Updated dependencies [e1d3d42]
|
|
15
|
+
- @ai-sdk/provider@1.0.10
|
|
16
|
+
- @ai-sdk/provider-utils@2.1.11
|
|
17
|
+
|
|
3
18
|
## 1.2.0
|
|
4
19
|
|
|
5
20
|
### Minor Changes
|
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { LanguageModelV1, ProviderV1, EmbeddingModelV1, ImageModelV1 } from '@ai-sdk/provider';
|
|
2
2
|
import { FetchFunction } from '@ai-sdk/provider-utils';
|
|
3
|
+
import { z } from 'zod';
|
|
3
4
|
|
|
4
5
|
type OpenAIChatModelId = 'o1' | 'o1-2024-12-17' | 'o1-mini' | 'o1-mini-2024-09-12' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o3-mini' | 'o3-mini-2025-01-31' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4.5-preview' | 'gpt-4.5-preview-2025-02-27' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | (string & {});
|
|
5
6
|
interface OpenAIChatSettings {
|
|
@@ -176,6 +177,28 @@ interface OpenAIImageSettings {
|
|
|
176
177
|
maxImagesPerCall?: number;
|
|
177
178
|
}
|
|
178
179
|
|
|
180
|
+
type OpenAIResponsesModelId = 'o1' | 'o1-2024-12-17' | 'o1-mini' | 'o1-mini-2024-09-12' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o3-mini' | 'o3-mini-2025-01-31' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4.5-preview' | 'gpt-4.5-preview-2025-02-27' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | (string & {});
|
|
181
|
+
|
|
182
|
+
declare const WebSearchPreviewParameters: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
|
|
183
|
+
declare function webSearchPreviewTool({ searchContextSize, userLocation, }?: {
|
|
184
|
+
searchContextSize?: 'low' | 'medium' | 'high';
|
|
185
|
+
userLocation?: {
|
|
186
|
+
type?: 'approximate';
|
|
187
|
+
city?: string;
|
|
188
|
+
region?: string;
|
|
189
|
+
country?: string;
|
|
190
|
+
timezone?: string;
|
|
191
|
+
};
|
|
192
|
+
}): {
|
|
193
|
+
type: 'provider-defined';
|
|
194
|
+
id: 'openai.web_search_preview';
|
|
195
|
+
args: {};
|
|
196
|
+
parameters: typeof WebSearchPreviewParameters;
|
|
197
|
+
};
|
|
198
|
+
declare const openaiTools: {
|
|
199
|
+
webSearchPreview: typeof webSearchPreviewTool;
|
|
200
|
+
};
|
|
201
|
+
|
|
179
202
|
interface OpenAIProvider extends ProviderV1 {
|
|
180
203
|
(modelId: 'gpt-3.5-turbo-instruct', settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
|
|
181
204
|
(modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): LanguageModelV1;
|
|
@@ -189,6 +212,10 @@ interface OpenAIProvider extends ProviderV1 {
|
|
|
189
212
|
*/
|
|
190
213
|
chat(modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): LanguageModelV1;
|
|
191
214
|
/**
|
|
215
|
+
Creates an OpenAI responses API model for text generation.
|
|
216
|
+
*/
|
|
217
|
+
responses(modelId: OpenAIResponsesModelId): LanguageModelV1;
|
|
218
|
+
/**
|
|
192
219
|
Creates an OpenAI completion model for text generation.
|
|
193
220
|
*/
|
|
194
221
|
completion(modelId: OpenAICompletionModelId, settings?: OpenAICompletionSettings): LanguageModelV1;
|
|
@@ -214,6 +241,10 @@ interface OpenAIProvider extends ProviderV1 {
|
|
|
214
241
|
Creates a model for image generation.
|
|
215
242
|
*/
|
|
216
243
|
imageModel(modelId: OpenAIImageModelId, settings?: OpenAIImageSettings): ImageModelV1;
|
|
244
|
+
/**
|
|
245
|
+
OpenAI-specific tools.
|
|
246
|
+
*/
|
|
247
|
+
tools: typeof openaiTools;
|
|
217
248
|
}
|
|
218
249
|
interface OpenAIProviderSettings {
|
|
219
250
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { LanguageModelV1, ProviderV1, EmbeddingModelV1, ImageModelV1 } from '@ai-sdk/provider';
|
|
2
2
|
import { FetchFunction } from '@ai-sdk/provider-utils';
|
|
3
|
+
import { z } from 'zod';
|
|
3
4
|
|
|
4
5
|
type OpenAIChatModelId = 'o1' | 'o1-2024-12-17' | 'o1-mini' | 'o1-mini-2024-09-12' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o3-mini' | 'o3-mini-2025-01-31' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4.5-preview' | 'gpt-4.5-preview-2025-02-27' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | (string & {});
|
|
5
6
|
interface OpenAIChatSettings {
|
|
@@ -176,6 +177,28 @@ interface OpenAIImageSettings {
|
|
|
176
177
|
maxImagesPerCall?: number;
|
|
177
178
|
}
|
|
178
179
|
|
|
180
|
+
type OpenAIResponsesModelId = 'o1' | 'o1-2024-12-17' | 'o1-mini' | 'o1-mini-2024-09-12' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o3-mini' | 'o3-mini-2025-01-31' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4.5-preview' | 'gpt-4.5-preview-2025-02-27' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | (string & {});
|
|
181
|
+
|
|
182
|
+
declare const WebSearchPreviewParameters: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
|
|
183
|
+
declare function webSearchPreviewTool({ searchContextSize, userLocation, }?: {
|
|
184
|
+
searchContextSize?: 'low' | 'medium' | 'high';
|
|
185
|
+
userLocation?: {
|
|
186
|
+
type?: 'approximate';
|
|
187
|
+
city?: string;
|
|
188
|
+
region?: string;
|
|
189
|
+
country?: string;
|
|
190
|
+
timezone?: string;
|
|
191
|
+
};
|
|
192
|
+
}): {
|
|
193
|
+
type: 'provider-defined';
|
|
194
|
+
id: 'openai.web_search_preview';
|
|
195
|
+
args: {};
|
|
196
|
+
parameters: typeof WebSearchPreviewParameters;
|
|
197
|
+
};
|
|
198
|
+
declare const openaiTools: {
|
|
199
|
+
webSearchPreview: typeof webSearchPreviewTool;
|
|
200
|
+
};
|
|
201
|
+
|
|
179
202
|
interface OpenAIProvider extends ProviderV1 {
|
|
180
203
|
(modelId: 'gpt-3.5-turbo-instruct', settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
|
|
181
204
|
(modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): LanguageModelV1;
|
|
@@ -189,6 +212,10 @@ interface OpenAIProvider extends ProviderV1 {
|
|
|
189
212
|
*/
|
|
190
213
|
chat(modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): LanguageModelV1;
|
|
191
214
|
/**
|
|
215
|
+
Creates an OpenAI responses API model for text generation.
|
|
216
|
+
*/
|
|
217
|
+
responses(modelId: OpenAIResponsesModelId): LanguageModelV1;
|
|
218
|
+
/**
|
|
192
219
|
Creates an OpenAI completion model for text generation.
|
|
193
220
|
*/
|
|
194
221
|
completion(modelId: OpenAICompletionModelId, settings?: OpenAICompletionSettings): LanguageModelV1;
|
|
@@ -214,6 +241,10 @@ interface OpenAIProvider extends ProviderV1 {
|
|
|
214
241
|
Creates a model for image generation.
|
|
215
242
|
*/
|
|
216
243
|
imageModel(modelId: OpenAIImageModelId, settings?: OpenAIImageSettings): ImageModelV1;
|
|
244
|
+
/**
|
|
245
|
+
OpenAI-specific tools.
|
|
246
|
+
*/
|
|
247
|
+
tools: typeof openaiTools;
|
|
217
248
|
}
|
|
218
249
|
interface OpenAIProviderSettings {
|
|
219
250
|
/**
|