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

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @ai-sdk/openai
 
+## 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 { ProviderV2, LanguageModelV2, EmbeddingModelV3, ImageModelV2, 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 & {});
 
@@ -234,15 +265,15 @@ interface OpenAIProvider extends ProviderV2 {
     /**
   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.
      */
@@ -336,4 +367,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 { ProviderV2, LanguageModelV2, EmbeddingModelV3, ImageModelV2, 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 & {});
 
@@ -234,15 +265,15 @@ interface OpenAIProvider extends ProviderV2 {
     /**
   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.
      */
@@ -336,4 +367,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.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  VERSION: () => VERSION,
   createOpenAI: () => createOpenAI,
   openai: () => openai
 });
@@ -262,7 +263,7 @@ function mapOpenAIFinishReason(finishReason) {
 
 // src/chat/openai-chat-options.ts
 var import_v42 = require("zod/v4");
-var openaiProviderOptions = import_v42.z.object({
+var openaiChatLanguageModelOptions = import_v42.z.object({
   /**
    * Modify the likelihood of specified tokens appearing in the completion.
    *
@@ -444,7 +445,7 @@ var OpenAIChatLanguageModel = class {
     const openaiOptions = (_a = await (0, import_provider_utils3.parseProviderOptions)({
       provider: "openai",
       providerOptions,
-      schema: openaiProviderOptions
+      schema: openaiChatLanguageModelOptions
     })) != null ? _a : {};
     const structuredOutputs = (_b = openaiOptions.structuredOutputs) != null ? _b : true;
     if (topK != null) {
@@ -1516,7 +1517,7 @@ var openaiEmbeddingProviderOptions = import_v46.z.object({
 // src/embedding/openai-embedding-model.ts
 var OpenAIEmbeddingModel = class {
   constructor(modelId, config) {
-    this.specificationVersion = "v2";
+    this.specificationVersion = "v3";
     this.maxEmbeddingsPerCall = 2048;
     this.supportsParallelCalls = true;
     this.modelId = modelId;
@@ -2658,7 +2659,7 @@ var OpenAIResponsesLanguageModel = class {
             ])
           ),
           service_tier: import_v415.z.string().nullish(),
-          incomplete_details: import_v415.z.object({ reason: import_v415.z.string() }).nullable(),
+          incomplete_details: import_v415.z.object({ reason: import_v415.z.string() }).nullish(),
           usage: usageSchema2
         })
       ),
@@ -3868,21 +3869,27 @@ var openaiTranscriptionResponseSchema = import_v418.z.object({
   ).nullish()
 });
 
+// src/version.ts
+var VERSION = true ? "2.1.0-beta.3" : "0.0.0-test";
+
 // src/openai-provider.ts
 function createOpenAI(options = {}) {
   var _a, _b;
   const baseURL = (_a = (0, import_provider_utils16.withoutTrailingSlash)(options.baseURL)) != null ? _a : "https://api.openai.com/v1";
   const providerName = (_b = options.name) != null ? _b : "openai";
-  const getHeaders = () => ({
-    Authorization: `Bearer ${(0, import_provider_utils16.loadApiKey)({
-      apiKey: options.apiKey,
-      environmentVariableName: "OPENAI_API_KEY",
-      description: "OpenAI"
-    })}`,
-    "OpenAI-Organization": options.organization,
-    "OpenAI-Project": options.project,
-    ...options.headers
-  });
+  const getHeaders = () => (0, import_provider_utils16.withUserAgentSuffix)(
+    {
+      Authorization: `Bearer ${(0, import_provider_utils16.loadApiKey)({
+        apiKey: options.apiKey,
+        environmentVariableName: "OPENAI_API_KEY",
+        description: "OpenAI"
+      })}`,
+      "OpenAI-Organization": options.organization,
+      "OpenAI-Project": options.project,
+      ...options.headers
+    },
+    `ai-sdk/openai/${VERSION}`
+  );
   const createChatModel = (modelId) => new OpenAIChatLanguageModel(modelId, {
     provider: `${providerName}.chat`,
     url: ({ path }) => `${baseURL}${path}`,
@@ -3958,6 +3965,7 @@ function createOpenAI(options = {}) {
 var openai = createOpenAI();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  VERSION,
   createOpenAI,
   openai
 });