@ai-sdk/openai 2.0.0-canary.16 → 2.0.0-canary.18

package/CHANGELOG.md

@@ -1,5 +1,55 @@
 # @ai-sdk/openai
 
+## 2.0.0-canary.18
+
+### Major Changes
+
+- 516be5b: ### Move Image Model Settings into generate options
+
+  Image Models no longer have settings. Instead, `maxImagesPerCall` can be passed directly to `generateImage()`. All other image settings can be passed to `providerOptions[provider]`.
+
+  Before
+
+  ```js
+  await generateImage({
+    model: luma.image('photon-flash-1', {
+      maxImagesPerCall: 5,
+      pollIntervalMillis: 500,
+    }),
+    prompt,
+    n: 10,
+  });
+  ```
+
+  After
+
+  ```js
+  await generateImage({
+    model: luma.image('photon-flash-1'),
+    prompt,
+    n: 10,
+    maxImagesPerCall: 5,
+    providerOptions: {
+      luma: { pollIntervalMillis: 5 },
+    },
+  });
+  ```
+
+  Pull Request: https://github.com/vercel/ai/pull/6180
+
+### Patch Changes
+
+- Updated dependencies [ea7a7c9]
+  - @ai-sdk/provider-utils@3.0.0-canary.17
+
+## 2.0.0-canary.17
+
+### Patch Changes
+
+- 52ce942: chore(providers/openai): remove & enable strict compatibility by default
+- Updated dependencies [87b828f]
+  - @ai-sdk/provider-utils@3.0.0-canary.16
+
 ## 2.0.0-canary.16
 
 ### Patch Changes

package/dist/index.d.mts

@@ -8,7 +8,6 @@ type OpenAICompletionModelId = 'gpt-3.5-turbo-instruct' | (string & {});
 
 type OpenAICompletionConfig = {
     provider: string;
-    compatibility: 'strict' | 'compatible';
     headers: () => Record<string, string | undefined>;
     url: (options: {
         modelId: string;
@@ -32,13 +31,6 @@ declare class OpenAICompletionLanguageModel implements LanguageModelV2 {
 type OpenAIEmbeddingModelId = 'text-embedding-3-small' | 'text-embedding-3-large' | 'text-embedding-ada-002' | (string & {});
 
 type OpenAIImageModelId = 'gpt-image-1' | 'dall-e-3' | 'dall-e-2' | (string & {});
-interface OpenAIImageSettings {
-    /**
-  Override the maximum number of images per call (default is dependent on the
-  model, or 1 for an unknown model).
-     */
-    maxImagesPerCall?: number;
-}
 
 declare const WebSearchPreviewParameters: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
 declare function webSearchPreviewTool({ searchContextSize, userLocation, }?: {
@@ -102,12 +94,13 @@ interface OpenAIProvider extends ProviderV2 {
     textEmbeddingModel(modelId: OpenAIEmbeddingModelId): EmbeddingModelV2<string>;
     /**
   Creates a model for image generation.
+  @deprecated Use `imageModel` instead.
      */
-    image(modelId: OpenAIImageModelId, settings?: OpenAIImageSettings): ImageModelV2;
+    image(modelId: OpenAIImageModelId): ImageModelV2;
     /**
   Creates a model for image generation.
      */
-    imageModel(modelId: OpenAIImageModelId, settings?: OpenAIImageSettings): ImageModelV2;
+    imageModel(modelId: OpenAIImageModelId): ImageModelV2;
     /**
   Creates a model for transcription.
      */
@@ -143,12 +136,6 @@ interface OpenAIProviderSettings {
        */
     headers?: Record<string, string>;
     /**
-  OpenAI compatibility mode. Should be set to `strict` when using the OpenAI API,
-  and `compatible` when using 3rd party providers. In `compatible` mode, newer
-  information such as streamOptions are not being sent. Defaults to 'compatible'.
-     */
-    compatibility?: 'strict' | 'compatible';
-    /**
   Provider name. Overrides the `openai` default name for 3rd party providers.
      */
     name?: string;
@@ -163,7 +150,7 @@ Create an OpenAI provider instance.
  */
 declare function createOpenAI(options?: OpenAIProviderSettings): OpenAIProvider;
 /**
-Default OpenAI provider instance. It uses 'strict' compatibility mode.
+Default OpenAI provider instance.
  */
 declare const openai: OpenAIProvider;
 

package/dist/index.d.ts

@@ -8,7 +8,6 @@ type OpenAICompletionModelId = 'gpt-3.5-turbo-instruct' | (string & {});
 
 type OpenAICompletionConfig = {
     provider: string;
-    compatibility: 'strict' | 'compatible';
     headers: () => Record<string, string | undefined>;
     url: (options: {
         modelId: string;
@@ -32,13 +31,6 @@ declare class OpenAICompletionLanguageModel implements LanguageModelV2 {
 type OpenAIEmbeddingModelId = 'text-embedding-3-small' | 'text-embedding-3-large' | 'text-embedding-ada-002' | (string & {});
 
 type OpenAIImageModelId = 'gpt-image-1' | 'dall-e-3' | 'dall-e-2' | (string & {});
-interface OpenAIImageSettings {
-    /**
-  Override the maximum number of images per call (default is dependent on the
-  model, or 1 for an unknown model).
-     */
-    maxImagesPerCall?: number;
-}
 
 declare const WebSearchPreviewParameters: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
 declare function webSearchPreviewTool({ searchContextSize, userLocation, }?: {
@@ -102,12 +94,13 @@ interface OpenAIProvider extends ProviderV2 {
     textEmbeddingModel(modelId: OpenAIEmbeddingModelId): EmbeddingModelV2<string>;
     /**
   Creates a model for image generation.
+  @deprecated Use `imageModel` instead.
      */
-    image(modelId: OpenAIImageModelId, settings?: OpenAIImageSettings): ImageModelV2;
+    image(modelId: OpenAIImageModelId): ImageModelV2;
     /**
   Creates a model for image generation.
      */
-    imageModel(modelId: OpenAIImageModelId, settings?: OpenAIImageSettings): ImageModelV2;
+    imageModel(modelId: OpenAIImageModelId): ImageModelV2;
     /**
   Creates a model for transcription.
      */
@@ -143,12 +136,6 @@ interface OpenAIProviderSettings {
        */
     headers?: Record<string, string>;
     /**
-  OpenAI compatibility mode. Should be set to `strict` when using the OpenAI API,
-  and `compatible` when using 3rd party providers. In `compatible` mode, newer
-  information such as streamOptions are not being sent. Defaults to 'compatible'.
-     */
-    compatibility?: 'strict' | 'compatible';
-    /**
   Provider name. Overrides the `openai` default name for 3rd party providers.
      */
     name?: string;
@@ -163,7 +150,7 @@ Create an OpenAI provider instance.
  */
 declare function createOpenAI(options?: OpenAIProviderSettings): OpenAIProvider;
 /**
-Default OpenAI provider instance. It uses 'strict' compatibility mode.
+Default OpenAI provider instance.
  */
 declare const openai: OpenAIProvider;
 

package/dist/index.js

@@ -617,8 +617,9 @@ var OpenAIChatLanguageModel = class {
     const body = {
       ...args,
       stream: true,
-      // only include stream_options when in strict compatibility mode:
-      stream_options: this.config.compatibility === "strict" ? { include_usage: true } : void 0
+      stream_options: {
+        include_usage: true
+      }
     };
     const { responseHeaders, value: response } = await (0, import_provider_utils3.postJsonToApi)({
       url: this.config.url({
@@ -1194,8 +1195,9 @@ var OpenAICompletionLanguageModel = class {
     const body = {
       ...args,
       stream: true,
-      // only include stream_options when in strict compatibility mode:
-      stream_options: this.config.compatibility === "strict" ? { include_usage: true } : void 0
+      stream_options: {
+        include_usage: true
+      }
     };
     const { responseHeaders, value: response } = await (0, import_provider_utils4.postJsonToApi)({
       url: this.config.url({
@@ -1424,15 +1426,14 @@ var hasDefaultResponseFormat = /* @__PURE__ */ new Set(["gpt-image-1"]);
 
 // src/openai-image-model.ts
 var OpenAIImageModel = class {
-  constructor(modelId, settings, config) {
+  constructor(modelId, config) {
     this.modelId = modelId;
-    this.settings = settings;
     this.config = config;
     this.specificationVersion = "v2";
   }
   get maxImagesPerCall() {
-    var _a, _b;
-    return (_b = (_a = this.settings.maxImagesPerCall) != null ? _a : modelMaxImagesPerCall[this.modelId]) != null ? _b : 1;
+    var _a;
+    return (_a = modelMaxImagesPerCall[this.modelId]) != null ? _a : 1;
   }
   get provider() {
     return this.config.provider;
@@ -2586,10 +2587,9 @@ var OpenAISpeechModel = class {
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {
-  var _a, _b, _c;
+  var _a, _b;
   const baseURL = (_a = (0, import_provider_utils10.withoutTrailingSlash)(options.baseURL)) != null ? _a : "https://api.openai.com/v1";
-  const compatibility = (_b = options.compatibility) != null ? _b : "compatible";
-  const providerName = (_c = options.name) != null ? _c : "openai";
+  const providerName = (_b = options.name) != null ? _b : "openai";
   const getHeaders = () => ({
     Authorization: `Bearer ${(0, import_provider_utils10.loadApiKey)({
       apiKey: options.apiKey,
@@ -2604,14 +2604,12 @@ function createOpenAI(options = {}) {
     provider: `${providerName}.chat`,
     url: ({ path }) => `${baseURL}${path}`,
     headers: getHeaders,
-    compatibility,
     fetch: options.fetch
   });
   const createCompletionModel = (modelId) => new OpenAICompletionLanguageModel(modelId, {
     provider: `${providerName}.completion`,
     url: ({ path }) => `${baseURL}${path}`,
     headers: getHeaders,
-    compatibility,
     fetch: options.fetch
   });
   const createEmbeddingModel = (modelId) => new OpenAIEmbeddingModel(modelId, {
@@ -2620,7 +2618,7 @@ function createOpenAI(options = {}) {
     headers: getHeaders,
     fetch: options.fetch
   });
-  const createImageModel = (modelId, settings = {}) => new OpenAIImageModel(modelId, settings, {
+  const createImageModel = (modelId) => new OpenAIImageModel(modelId, {
     provider: `${providerName}.image`,
     url: ({ path }) => `${baseURL}${path}`,
     headers: getHeaders,
@@ -2676,10 +2674,7 @@ function createOpenAI(options = {}) {
   provider.tools = openaiTools;
   return provider;
 }
-var openai = createOpenAI({
-  compatibility: "strict"
-  // strict for OpenAI API
-});
+var openai = createOpenAI();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   createOpenAI,