@ai-sdk/openai 2.1.0-beta.1 → 2.1.0-beta.10

package/CHANGELOG.md

@@ -1,5 +1,93 @@
 # @ai-sdk/openai
 
+## 2.1.0-beta.10
+
+### Patch Changes
+
+- d64ece9: enables image_generation capabilities in the Azure provider through the Responses API.
+
+## 2.1.0-beta.9
+
+### Patch Changes
+
+- 9a51b92: support OPENAI_BASE_URL env
+
+## 2.1.0-beta.8
+
+### Patch Changes
+
+- 4122d2a: feat(provider/openai): add gpt-5-codex model id
+- 3997a42: feat(provider/openai): local shell tool
+- cb4d238: The built in Code Interpreter tool input code is streamed in `tool-input-<start/delta/end>` chunks.
+
+## 2.1.0-beta.7
+
+### Patch Changes
+
+- 77f2b20: enables code_interpreter and file_search capabilities in the Azure provider through the Responses API
+- 8dac895: feat: `LanguageModelV3`
+- 10c1322: fix: moved dependency `@ai-sdk/test-server` to devDependencies
+- Updated dependencies [8dac895]
+  - @ai-sdk/provider-utils@3.1.0-beta.5
+  - @ai-sdk/provider@2.1.0-beta.3
+
+## 2.1.0-beta.6
+
+### Patch Changes
+
+- fe49278: feat(provider/openai): only send item references for reasoning when store: true
+
+## 2.1.0-beta.5
+
+### Patch Changes
+
+- 4616b86: chore: update zod peer depenedency version
+- Updated dependencies [4616b86]
+  - @ai-sdk/provider-utils@3.1.0-beta.4
+
+## 2.1.0-beta.4
+
+### Patch Changes
+
+- ed329cb: feat: `Provider-V3`
+- 522f6b8: feat: `ImageModelV3`
+- Updated dependencies [ed329cb]
+- Updated dependencies [522f6b8]
+  - @ai-sdk/provider@2.1.0-beta.2
+  - @ai-sdk/provider-utils@3.1.0-beta.3
+
+## 2.1.0-beta.3
+
+### Patch Changes
+
+- 2e86082: feat(provider/openai): `OpenAIChatLanguageModelOptions` type
+
+  ```ts
+  import { openai, type OpenAIChatLanguageModelOptions } from '@ai-sdk/openai';
+  import { generateText } from 'ai';
+
+  await generateText({
+    model: openai.chat('gpt-4o'),
+    prompt: 'Invent a new holiday and describe its traditions.',
+    providerOptions: {
+      openai: {
+        user: 'user-123',
+      } satisfies OpenAIChatLanguageModelOptions,
+    },
+  });
+  ```
+
+## 2.1.0-beta.2
+
+### Patch Changes
+
+- 4920119: fix the "incomplete_details" key from nullable to nullish for openai compatibility
+- 0c4822d: feat: `EmbeddingModelV3`
+- 1cad0ab: feat: add provider version to user-agent header
+- Updated dependencies [0c4822d]
+  - @ai-sdk/provider@2.1.0-beta.1
+  - @ai-sdk/provider-utils@3.1.0-beta.2
+
 ## 2.1.0-beta.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,9 +1,40 @@
-import { ProviderV2, LanguageModelV2, EmbeddingModelV2, ImageModelV2, TranscriptionModelV2, SpeechModelV2 } from '@ai-sdk/provider';
+import { ProviderV3, LanguageModelV3, EmbeddingModelV3, ImageModelV3, TranscriptionModelV2, SpeechModelV2 } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 
 type OpenAIChatModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | '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' | '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' | 'chatgpt-4o-latest' | 'gpt-5' | 'gpt-5-2025-08-07' | 'gpt-5-mini' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | (string & {});
+declare const openaiChatLanguageModelOptions: z.ZodObject<{
+    logitBias: z.ZodOptional<z.ZodRecord<z.ZodCoercedNumber<string>, z.ZodNumber>>;
+    logprobs: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber]>>;
+    parallelToolCalls: z.ZodOptional<z.ZodBoolean>;
+    user: z.ZodOptional<z.ZodString>;
+    reasoningEffort: z.ZodOptional<z.ZodEnum<{
+        minimal: "minimal";
+        low: "low";
+        medium: "medium";
+        high: "high";
+    }>>;
+    maxCompletionTokens: z.ZodOptional<z.ZodNumber>;
+    store: z.ZodOptional<z.ZodBoolean>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    prediction: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    structuredOutputs: z.ZodOptional<z.ZodBoolean>;
+    serviceTier: z.ZodOptional<z.ZodEnum<{
+        auto: "auto";
+        flex: "flex";
+        priority: "priority";
+    }>>;
+    strictJsonSchema: z.ZodOptional<z.ZodBoolean>;
+    textVerbosity: z.ZodOptional<z.ZodEnum<{
+        low: "low";
+        medium: "medium";
+        high: "high";
+    }>>;
+    promptCacheKey: z.ZodOptional<z.ZodString>;
+    safetyIdentifier: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type OpenAIChatLanguageModelOptions = z.infer<typeof openaiChatLanguageModelOptions>;
 
 type OpenAICompletionModelId = 'gpt-3.5-turbo-instruct' | (string & {});
 
@@ -173,6 +204,26 @@ declare const openaiTools: {
     }) => _ai_sdk_provider_utils.Tool<{}, {
         result: string;
     }>;
+    /**
+     * Local shell is a tool that allows agents to run shell commands locally
+     * on a machine you or the user provides.
+     *
+     * Supported models: `gpt-5-codex` and `codex-mini-latest`
+     *
+     * Must have name `local_shell`.
+     */
+    localShell: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{
+        action: {
+            type: "exec";
+            command: string[];
+            timeoutMs?: number;
+            user?: string;
+            workingDirectory?: string;
+            env?: Record<string, string>;
+        };
+    }, {
+        output: string;
+    }, {}>;
     /**
      * Web search allows models to access up-to-date information from the internet
      * and provide answers with sourced citations.
@@ -207,50 +258,50 @@ declare const openaiTools: {
     webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
 };
 
-type OpenAIResponsesModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'gpt-5' | 'gpt-5-2025-08-07' | 'gpt-5-mini' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | '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' | 'gpt-4-0613' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});
+type OpenAIResponsesModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'gpt-5' | 'gpt-5-2025-08-07' | 'gpt-5-mini' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-5-codex' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | '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' | 'gpt-4-0613' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});
 
 type OpenAISpeechModelId = 'tts-1' | 'tts-1-hd' | 'gpt-4o-mini-tts' | (string & {});
 
 type OpenAITranscriptionModelId = 'whisper-1' | 'gpt-4o-mini-transcribe' | 'gpt-4o-transcribe' | (string & {});
 
-interface OpenAIProvider extends ProviderV2 {
-    (modelId: OpenAIResponsesModelId): LanguageModelV2;
+interface OpenAIProvider extends ProviderV3 {
+    (modelId: OpenAIResponsesModelId): LanguageModelV3;
     /**
   Creates an OpenAI model for text generation.
      */
-    languageModel(modelId: OpenAIResponsesModelId): LanguageModelV2;
+    languageModel(modelId: OpenAIResponsesModelId): LanguageModelV3;
     /**
   Creates an OpenAI chat model for text generation.
      */
-    chat(modelId: OpenAIChatModelId): LanguageModelV2;
+    chat(modelId: OpenAIChatModelId): LanguageModelV3;
     /**
   Creates an OpenAI responses API model for text generation.
      */
-    responses(modelId: OpenAIResponsesModelId): LanguageModelV2;
+    responses(modelId: OpenAIResponsesModelId): LanguageModelV3;
     /**
   Creates an OpenAI completion model for text generation.
      */
-    completion(modelId: OpenAICompletionModelId): LanguageModelV2;
+    completion(modelId: OpenAICompletionModelId): LanguageModelV3;
     /**
   Creates a model for text embeddings.
      */
-    embedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV2<string>;
+    embedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3<string>;
     /**
   Creates a model for text embeddings.
      */
-    textEmbedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV2<string>;
+    textEmbedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3<string>;
     /**
   Creates a model for text embeddings.
      */
-    textEmbeddingModel(modelId: OpenAIEmbeddingModelId): EmbeddingModelV2<string>;
+    textEmbeddingModel(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3<string>;
     /**
   Creates a model for image generation.
      */
-    image(modelId: OpenAIImageModelId): ImageModelV2;
+    image(modelId: OpenAIImageModelId): ImageModelV3;
     /**
   Creates a model for image generation.
      */
-    imageModel(modelId: OpenAIImageModelId): ImageModelV2;
+    imageModel(modelId: OpenAIImageModelId): ImageModelV3;
     /**
   Creates a model for transcription.
      */
@@ -336,4 +387,6 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
 }, z.core.$strip>;
 type OpenAIResponsesProviderOptions = z.infer<typeof openaiResponsesProviderOptionsSchema>;
 
-export { type OpenAIProvider, type OpenAIProviderSettings, type OpenAIResponsesProviderOptions, createOpenAI, openai };
+declare const VERSION: string;
+
+export { type OpenAIChatLanguageModelOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAIResponsesProviderOptions, VERSION, createOpenAI, openai };

package/dist/index.d.ts

@@ -1,9 +1,40 @@
-import { ProviderV2, LanguageModelV2, EmbeddingModelV2, ImageModelV2, TranscriptionModelV2, SpeechModelV2 } from '@ai-sdk/provider';
+import { ProviderV3, LanguageModelV3, EmbeddingModelV3, ImageModelV3, TranscriptionModelV2, SpeechModelV2 } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 
 type OpenAIChatModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | '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' | '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' | 'chatgpt-4o-latest' | 'gpt-5' | 'gpt-5-2025-08-07' | 'gpt-5-mini' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | (string & {});
+declare const openaiChatLanguageModelOptions: z.ZodObject<{
+    logitBias: z.ZodOptional<z.ZodRecord<z.ZodCoercedNumber<string>, z.ZodNumber>>;
+    logprobs: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber]>>;
+    parallelToolCalls: z.ZodOptional<z.ZodBoolean>;
+    user: z.ZodOptional<z.ZodString>;
+    reasoningEffort: z.ZodOptional<z.ZodEnum<{
+        minimal: "minimal";
+        low: "low";
+        medium: "medium";
+        high: "high";
+    }>>;
+    maxCompletionTokens: z.ZodOptional<z.ZodNumber>;
+    store: z.ZodOptional<z.ZodBoolean>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    prediction: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    structuredOutputs: z.ZodOptional<z.ZodBoolean>;
+    serviceTier: z.ZodOptional<z.ZodEnum<{
+        auto: "auto";
+        flex: "flex";
+        priority: "priority";
+    }>>;
+    strictJsonSchema: z.ZodOptional<z.ZodBoolean>;
+    textVerbosity: z.ZodOptional<z.ZodEnum<{
+        low: "low";
+        medium: "medium";
+        high: "high";
+    }>>;
+    promptCacheKey: z.ZodOptional<z.ZodString>;
+    safetyIdentifier: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type OpenAIChatLanguageModelOptions = z.infer<typeof openaiChatLanguageModelOptions>;
 
 type OpenAICompletionModelId = 'gpt-3.5-turbo-instruct' | (string & {});
 
@@ -173,6 +204,26 @@ declare const openaiTools: {
     }) => _ai_sdk_provider_utils.Tool<{}, {
         result: string;
     }>;
+    /**
+     * Local shell is a tool that allows agents to run shell commands locally
+     * on a machine you or the user provides.
+     *
+     * Supported models: `gpt-5-codex` and `codex-mini-latest`
+     *
+     * Must have name `local_shell`.
+     */
+    localShell: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{
+        action: {
+            type: "exec";
+            command: string[];
+            timeoutMs?: number;
+            user?: string;
+            workingDirectory?: string;
+            env?: Record<string, string>;
+        };
+    }, {
+        output: string;
+    }, {}>;
     /**
      * Web search allows models to access up-to-date information from the internet
      * and provide answers with sourced citations.
@@ -207,50 +258,50 @@ declare const openaiTools: {
     webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
 };
 
-type OpenAIResponsesModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'gpt-5' | 'gpt-5-2025-08-07' | 'gpt-5-mini' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | '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' | 'gpt-4-0613' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});
+type OpenAIResponsesModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'gpt-5' | 'gpt-5-2025-08-07' | 'gpt-5-mini' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-5-codex' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | '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' | 'gpt-4-0613' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});
 
 type OpenAISpeechModelId = 'tts-1' | 'tts-1-hd' | 'gpt-4o-mini-tts' | (string & {});
 
 type OpenAITranscriptionModelId = 'whisper-1' | 'gpt-4o-mini-transcribe' | 'gpt-4o-transcribe' | (string & {});
 
-interface OpenAIProvider extends ProviderV2 {
-    (modelId: OpenAIResponsesModelId): LanguageModelV2;
+interface OpenAIProvider extends ProviderV3 {
+    (modelId: OpenAIResponsesModelId): LanguageModelV3;
     /**
   Creates an OpenAI model for text generation.
      */
-    languageModel(modelId: OpenAIResponsesModelId): LanguageModelV2;
+    languageModel(modelId: OpenAIResponsesModelId): LanguageModelV3;
     /**
   Creates an OpenAI chat model for text generation.
      */
-    chat(modelId: OpenAIChatModelId): LanguageModelV2;
+    chat(modelId: OpenAIChatModelId): LanguageModelV3;
     /**
   Creates an OpenAI responses API model for text generation.
      */
-    responses(modelId: OpenAIResponsesModelId): LanguageModelV2;
+    responses(modelId: OpenAIResponsesModelId): LanguageModelV3;
     /**
   Creates an OpenAI completion model for text generation.
      */
-    completion(modelId: OpenAICompletionModelId): LanguageModelV2;
+    completion(modelId: OpenAICompletionModelId): LanguageModelV3;
     /**
   Creates a model for text embeddings.
      */
-    embedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV2<string>;
+    embedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3<string>;
     /**
   Creates a model for text embeddings.
      */
-    textEmbedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV2<string>;
+    textEmbedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3<string>;
     /**
   Creates a model for text embeddings.
      */
-    textEmbeddingModel(modelId: OpenAIEmbeddingModelId): EmbeddingModelV2<string>;
+    textEmbeddingModel(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3<string>;
     /**
   Creates a model for image generation.
      */
-    image(modelId: OpenAIImageModelId): ImageModelV2;
+    image(modelId: OpenAIImageModelId): ImageModelV3;
     /**
   Creates a model for image generation.
      */
-    imageModel(modelId: OpenAIImageModelId): ImageModelV2;
+    imageModel(modelId: OpenAIImageModelId): ImageModelV3;
     /**
   Creates a model for transcription.
      */
@@ -336,4 +387,6 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
 }, z.core.$strip>;
 type OpenAIResponsesProviderOptions = z.infer<typeof openaiResponsesProviderOptionsSchema>;
 
-export { type OpenAIProvider, type OpenAIProviderSettings, type OpenAIResponsesProviderOptions, createOpenAI, openai };
+declare const VERSION: string;
+
+export { type OpenAIChatLanguageModelOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAIResponsesProviderOptions, VERSION, createOpenAI, openai };