fix (ai)!: move image model settings into generateImage({providerOptions})

packages/ai/core/generate-image/generate-image.test.ts

@@ -64,6 +64,8 @@ describe('generateImage', () => {
       providerOptions: {
         'mock-provider': {
           style: 'vivid',
+          // maxImagesPerCall is not passed to doGenerate
+          maxImagesPerCall: 3,
         },
       },
       headers: { 'custom-request-header': 'request-header-value' },

packages/ai/core/generate-image/generate-image.ts

@@ -110,20 +110,27 @@ Only applicable for HTTP-based providers.
 }): Promise<GenerateImageResult> {
   const { retry } = prepareRetries({ maxRetries: maxRetriesArg });
 
+  // extract maxImagesPerCall from providerOptions as it's not meant to be passed to `doGenerate()`
+  const [
+    [providerName, { maxImagesPerCall, ...generateProviderOptions } = {}] = [],
+  ] = Object.entries(providerOptions ?? {});
+
   // default to 1 if the model has not specified limits on
   // how many images can be generated in a single call
-  const maxImagesPerCall = model.maxImagesPerCall ?? 1;
+  const maxImagesPerCallWithDefault =
+    (maxImagesPerCall as number) ?? model.maxImagesPerCall ?? 1;
 
   // parallelize calls to the model:
-  const callCount = Math.ceil(n / maxImagesPerCall);
+  const callCount = Math.ceil(n / maxImagesPerCallWithDefault);
   const callImageCounts = Array.from({ length: callCount }, (_, i) => {
     if (i < callCount - 1) {
-      return maxImagesPerCall;
+      return maxImagesPerCallWithDefault;
     }
 
-    const remainder = n % maxImagesPerCall;
-    return remainder === 0 ? maxImagesPerCall : remainder;
+    const remainder = n % maxImagesPerCallWithDefault;
+    return remainder === 0 ? maxImagesPerCallWithDefault : remainder;
   });
+
   const results = await Promise.all(
     callImageCounts.map(async callImageCount =>
       retry(() =>
@@ -135,7 +142,9 @@ Only applicable for HTTP-based providers.
           size,
           aspectRatio,
           seed,
-          providerOptions: providerOptions ?? {},
+          providerOptions: providerName
+            ? { [providerName]: generateProviderOptions }
+            : {},
         }),
       ),
     ),

packages/amazon-bedrock/src/bedrock-image-model.test.ts

@@ -34,15 +34,11 @@ describe('doGenerate', () => {
     },
   });
 
-  const model = new BedrockImageModel(
-    'amazon.nova-canvas-v1:0',
-    {},
-    {
-      baseUrl: () => 'https://bedrock-runtime.us-east-1.amazonaws.com',
-      headers: mockConfigHeaders,
-      fetch: fakeFetchWithAuth,
-    },
-  );
+  const model = new BedrockImageModel('amazon.nova-canvas-v1:0', {
+    baseUrl: () => 'https://bedrock-runtime.us-east-1.amazonaws.com',
+    headers: mockConfigHeaders,
+    fetch: fakeFetchWithAuth,
+  });
 
   it('should pass the model and the settings', async () => {
     await model.doGenerate({
@@ -83,21 +79,17 @@ describe('doGenerate', () => {
       'shared-header': 'options-shared',
     };
 
-    const modelWithHeaders = new BedrockImageModel(
-      'amazon.nova-canvas-v1:0',
-      {},
-      {
-        baseUrl: () => 'https://bedrock-runtime.us-east-1.amazonaws.com',
-        headers: {
-          'model-header': 'model-value',
-          'shared-header': 'model-shared',
-        },
-        fetch: injectFetchHeaders({
-          'signed-header': 'signed-value',
-          authorization: 'AWS4-HMAC-SHA256...',
-        }),
+    const modelWithHeaders = new BedrockImageModel('amazon.nova-canvas-v1:0', {
+      baseUrl: () => 'https://bedrock-runtime.us-east-1.amazonaws.com',
+      headers: {
+        'model-header': 'model-value',
+        'shared-header': 'model-shared',
       },
-    );
+      fetch: injectFetchHeaders({
+        'signed-header': 'signed-value',
+        authorization: 'AWS4-HMAC-SHA256...',
+      }),
+    });
 
     await modelWithHeaders.doGenerate({
       prompt,
@@ -118,11 +110,6 @@ describe('doGenerate', () => {
   });
 
   it('should respect maxImagesPerCall setting', async () => {
-    const customModel = provider.image('amazon.nova-canvas-v1:0', {
-      maxImagesPerCall: 2,
-    });
-    expect(customModel.maxImagesPerCall).toBe(2);
-
     const defaultModel = provider.image('amazon.nova-canvas-v1:0');
     expect(defaultModel.maxImagesPerCall).toBe(5); // 'amazon.nova-canvas-v1:0','s default from settings
 
@@ -166,17 +153,13 @@ describe('doGenerate', () => {
   it('should include response data with timestamp, modelId and headers', async () => {
     const testDate = new Date('2024-03-15T12:00:00Z');
 
-    const customModel = new BedrockImageModel(
-      'amazon.nova-canvas-v1:0',
-      {},
-      {
-        baseUrl: () => 'https://bedrock-runtime.us-east-1.amazonaws.com',
-        headers: () => ({}),
-        _internal: {
-          currentDate: () => testDate,
-        },
+    const customModel = new BedrockImageModel('amazon.nova-canvas-v1:0', {
+      baseUrl: () => 'https://bedrock-runtime.us-east-1.amazonaws.com',
+      headers: () => ({}),
+      _internal: {
+        currentDate: () => testDate,
       },
-    );
+    });
 
     const result = await customModel.doGenerate({
       prompt,

packages/amazon-bedrock/src/bedrock-image-model.ts

@@ -10,7 +10,6 @@ import {
 } from '@ai-sdk/provider-utils';
 import {
   BedrockImageModelId,
-  BedrockImageSettings,
   modelMaxImagesPerCall,
 } from './bedrock-image-settings';
 import { BedrockErrorSchema } from './bedrock-error';
@@ -30,9 +29,7 @@ export class BedrockImageModel implements ImageModelV2 {
   readonly provider = 'amazon-bedrock';
 
   get maxImagesPerCall(): number {
-    return (
-      this.settings.maxImagesPerCall ?? modelMaxImagesPerCall[this.modelId] ?? 1
-    );
+    return modelMaxImagesPerCall[this.modelId] ?? 1;
   }
 
   private getUrl(modelId: string): string {
@@ -42,7 +39,6 @@ export class BedrockImageModel implements ImageModelV2 {
 
   constructor(
     readonly modelId: BedrockImageModelId,
-    private readonly settings: BedrockImageSettings,
     private readonly config: BedrockImageModelConfig,
   ) {}
 

packages/amazon-bedrock/src/bedrock-image-settings.ts

@@ -4,11 +4,3 @@ export type BedrockImageModelId = 'amazon.nova-canvas-v1:0' | (string & {});
 export const modelMaxImagesPerCall: Record<BedrockImageModelId, number> = {
   'amazon.nova-canvas-v1:0': 5,
 };
-
-export interface BedrockImageSettings {
-  /**
-   * Override the maximum number of images per call (default is dependent on the
-   * model, or 1 for an unknown model).
-   */
-  maxImagesPerCall?: number;
-}

packages/amazon-bedrock/src/bedrock-provider.test.ts

@@ -140,27 +140,21 @@ describe('AmazonBedrockProvider', () => {
       const provider = createAmazonBedrock();
       const modelId = 'amazon.titan-image-generator';
 
-      const model = provider.image(modelId, {
-        maxImagesPerCall: 5,
-      });
+      const model = provider.image(modelId);
 
       const constructorCall = BedrockImageModelMock.mock.calls[0];
       expect(constructorCall[0]).toBe(modelId);
-      expect(constructorCall[1]).toEqual({ maxImagesPerCall: 5 });
       expect(model).toBeInstanceOf(BedrockImageModel);
     });
 
     it('should create an image model via imageModel method', () => {
       const provider = createAmazonBedrock();
       const modelId = 'amazon.titan-image-generator';
 
-      const model = provider.imageModel(modelId, {
-        maxImagesPerCall: 5,
-      });
+      const model = provider.imageModel(modelId);
 
       const constructorCall = BedrockImageModelMock.mock.calls[0];
       expect(constructorCall[0]).toBe(modelId);
-      expect(constructorCall[1]).toEqual({ maxImagesPerCall: 5 });
       expect(model).toBeInstanceOf(BedrockImageModel);
     });
   });

packages/amazon-bedrock/src/bedrock-provider.ts

@@ -16,10 +16,7 @@ import { BedrockChatModelId } from './bedrock-chat-options';
 import { BedrockEmbeddingModel } from './bedrock-embedding-model';
 import { BedrockEmbeddingModelId } from './bedrock-embedding-options';
 import { BedrockImageModel } from './bedrock-image-model';
-import {
-  BedrockImageModelId,
-  BedrockImageSettings,
-} from './bedrock-image-settings';
+import { BedrockImageModelId } from './bedrock-image-settings';
 import {
   BedrockCredentials,
   createSigV4FetchFunction,
@@ -85,15 +82,16 @@ export interface AmazonBedrockProvider extends ProviderV2 {
 
   embedding(modelId: BedrockEmbeddingModelId): EmbeddingModelV2<string>;
 
-  image(
-    modelId: BedrockImageModelId,
-    settings?: BedrockImageSettings,
-  ): ImageModelV2;
+  /**
+Creates a model for image generation.
+@deprecated Use `imageModel` instead.
+   */
+  image(modelId: BedrockImageModelId): ImageModelV2;
 
-  imageModel(
-    modelId: BedrockImageModelId,
-    settings?: BedrockImageSettings,
-  ): ImageModelV2;
+  /**
+Creates a model for image generation.
+   */
+  imageModel(modelId: BedrockImageModelId): ImageModelV2;
 }
 
 /**
@@ -173,11 +171,8 @@ export function createAmazonBedrock(
       fetch: sigv4Fetch,
     });
 
-  const createImageModel = (
-    modelId: BedrockImageModelId,
-    settings: BedrockImageSettings = {},
-  ) =>
-    new BedrockImageModel(modelId, settings, {
+  const createImageModel = (modelId: BedrockImageModelId) =>
+    new BedrockImageModel(modelId, {
       baseUrl: getBaseUrl,
       headers: options.headers ?? {},
       fetch: sigv4Fetch,

packages/azure/src/azure-openai-provider.ts

@@ -3,7 +3,6 @@ import {
   OpenAICompletionLanguageModel,
   OpenAIEmbeddingModel,
   OpenAIImageModel,
-  OpenAIImageSettings,
   OpenAIResponsesLanguageModel,
   OpenAITranscriptionModel,
 } from '@ai-sdk/openai/internal';
@@ -48,15 +47,12 @@ Creates an Azure OpenAI completion model for text generation.
    * Creates an Azure OpenAI DALL-E model for image generation.
    * @deprecated Use `imageModel` instead.
    */
-  image(deploymentId: string, settings?: OpenAIImageSettings): ImageModelV2;
+  image(deploymentId: string): ImageModelV2;
 
   /**
    * Creates an Azure OpenAI DALL-E model for image generation.
    */
-  imageModel(
-    deploymentId: string,
-    settings?: OpenAIImageSettings,
-  ): ImageModelV2;
+  imageModel(deploymentId: string): ImageModelV2;
 
   /**
 @deprecated Use `textEmbeddingModel` instead.
@@ -181,11 +177,8 @@ export function createAzure(
       fetch: options.fetch,
     });
 
-  const createImageModel = (
-    modelId: string,
-    settings: OpenAIImageSettings = {},
-  ) =>
-    new OpenAIImageModel(modelId, settings, {
+  const createImageModel = (modelId: string) =>
+    new OpenAIImageModel(modelId, {
       provider: 'azure.image',
       url,
       headers: getHeaders,

packages/deepinfra/src/deepinfra-image-model.test.ts

@@ -1,7 +1,6 @@
 import { createTestServer } from '@ai-sdk/provider-utils/test';
 import { describe, expect, it } from 'vitest';
 import { DeepInfraImageModel } from './deepinfra-image-model';
-import { DeepInfraImageSettings } from './deepinfra-image-settings';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 
 const prompt = 'A cute baby sea otter';
@@ -10,14 +9,12 @@ function createBasicModel({
   headers,
   fetch,
   currentDate,
-  settings,
 }: {
   headers?: () => Record<string, string>;
   fetch?: FetchFunction;
   currentDate?: () => Date;
-  settings?: DeepInfraImageSettings;
 } = {}) {
-  return new DeepInfraImageModel('stability-ai/sdxl', settings ?? {}, {
+  return new DeepInfraImageModel('stability-ai/sdxl', {
     provider: 'deepinfra',
     baseURL: 'https://api.example.com',
     headers: headers ?? (() => ({ 'api-key': 'test-key' })),
@@ -234,21 +231,5 @@ describe('DeepInfraImageModel', () => {
       expect(model.specificationVersion).toBe('v2');
       expect(model.maxImagesPerCall).toBe(1);
     });
-
-    it('should use maxImagesPerCall from settings', () => {
-      const model = createBasicModel({
-        settings: {
-          maxImagesPerCall: 4,
-        },
-      });
-
-      expect(model.maxImagesPerCall).toBe(4);
-    });
-
-    it('should default maxImagesPerCall to 1 when not specified', () => {
-      const model = createBasicModel();
-
-      expect(model.maxImagesPerCall).toBe(1);
-    });
   });
 });

packages/deepinfra/src/deepinfra-image-model.ts

@@ -6,10 +6,7 @@ import {
   createJsonResponseHandler,
   postJsonToApi,
 } from '@ai-sdk/provider-utils';
-import {
-  DeepInfraImageModelId,
-  DeepInfraImageSettings,
-} from './deepinfra-image-settings';
+import { DeepInfraImageModelId } from './deepinfra-image-settings';
 import { z } from 'zod';
 
 interface DeepInfraImageModelConfig {
@@ -24,18 +21,14 @@ interface DeepInfraImageModelConfig {
 
 export class DeepInfraImageModel implements ImageModelV2 {
   readonly specificationVersion = 'v2';
+  readonly maxImagesPerCall = 1;
 
   get provider(): string {
     return this.config.provider;
   }
 
-  get maxImagesPerCall(): number {
-    return this.settings.maxImagesPerCall ?? 1;
-  }
-
   constructor(
     readonly modelId: DeepInfraImageModelId,
-    readonly settings: DeepInfraImageSettings,
     private config: DeepInfraImageModelConfig,
   ) {}
 

packages/deepinfra/src/deepinfra-image-settings.ts

@@ -8,10 +8,3 @@ export type DeepInfraImageModelId =
   | 'stabilityai/sd3.5-medium'
   | 'stabilityai/sdxl-turbo'
   | (string & {});
-
-export interface DeepInfraImageSettings {
-  /**
-   * Override the maximum number of images per call (default 1)
-   */
-  maxImagesPerCall?: number;
-}