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

package/CHANGELOG.md

@@ -1,5 +1,47 @@
 # @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

package/dist/index.d.mts

@@ -31,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, }?: {
@@ -101,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.
      */

package/dist/index.d.ts

@@ -31,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, }?: {
@@ -101,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.
      */

package/dist/index.js

@@ -1426,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;
@@ -2619,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,