chore(providers/openai): update embedding model to use providerOptions (#5867)

samdenty · web-flow · commit 3bd3c0bd3614 · 2025-04-21T11:21:48.000+01:00
diff --git a/.changeset/cool-gifts-film.md b/.changeset/cool-gifts-film.md
@@ -0,0 +1,5 @@
+---
+'@ai-sdk/openai': patch
+---
+
+chore(providers/openai): update embedding model to use providerOptions
diff --git a/content/providers/01-ai-sdk-providers/02-openai.mdx b/content/providers/01-ai-sdk-providers/02-openai.mdx
@@ -796,17 +796,23 @@ using the `.embedding()` factory method.
 const model = openai.embedding('text-embedding-3-large');
 ```
 
-OpenAI embedding models support several additional settings.
+OpenAI embedding models support several additional provider options.
 You can pass them as an options argument:
 
 ```ts
-const model = openai.embedding('text-embedding-3-large', {
-  dimensions: 512 // optional, number of dimensions for the embedding
-  user: 'test-user' // optional unique user identifier
-})
+const model = openai.embedding('text-embedding-3-large');
+
+await model.doEmbed({
+  providerOptions: {
+    openai: {
+      dimensions: 512 // optional, number of dimensions for the embedding
+      user: 'test-user' // optional unique user identifier
+    }
+  }
+});
 ```
 
-The following optional settings are available for OpenAI embedding models:
+The following optional provider options are available for OpenAI embedding models:
 
 - **dimensions**: _number_
 
diff --git a/content/providers/01-ai-sdk-providers/03-azure.mdx b/content/providers/01-ai-sdk-providers/03-azure.mdx
@@ -443,13 +443,19 @@ Azure OpenAI embedding models support several aditional settings.
 You can pass them as an options argument:
 
 ```ts
-const model = azure.embedding('your-embedding-deployment', {
-  dimensions: 512 // optional, number of dimensions for the embedding
-  user: 'test-user' // optional unique user identifier
+const model = azure.embedding('your-embedding-deployment');
+
+await model.doEmbed({
+  providerOptions: {
+    'azure-openai': {
+      dimensions: 512 // optional, number of dimensions for the embedding
+      user: 'test-user' // optional unique user identifier
+    }
+  }
 })
 ```
 
-The following optional settings are available for Azure OpenAI embedding models:
+The following optional provider options are available for Azure OpenAI embedding models:
 
 - **dimensions**: _number_
 
diff --git a/packages/openai/src/internal/index.ts b/packages/openai/src/internal/index.ts
@@ -3,7 +3,7 @@ export * from '../openai-chat-options';
 export * from '../openai-completion-language-model';
 export * from '../openai-completion-settings';
 export * from '../openai-embedding-model';
-export * from '../openai-embedding-settings';
+export * from '../openai-embedding-options';
 export * from '../openai-image-model';
 export * from '../openai-image-settings';
 export * from '../openai-transcription-model';
diff --git a/packages/openai/src/openai-embedding-model.test.ts b/packages/openai/src/openai-embedding-model.test.ts
@@ -94,9 +94,10 @@ describe('doEmbed', () => {
   it('should pass the dimensions setting', async () => {
     prepareJsonResponse();
 
-    await provider
-      .embedding('text-embedding-3-large', { dimensions: 64 })
-      .doEmbed({ values: testValues });
+    await provider.embedding('text-embedding-3-large').doEmbed({
+      values: testValues,
+      providerOptions: { openai: { dimensions: 64 } },
+    });
 
     expect(await server.calls[0].requestBody).toStrictEqual({
       model: 'text-embedding-3-large',
diff --git a/packages/openai/src/openai-embedding-model.ts b/packages/openai/src/openai-embedding-model.ts
@@ -5,14 +5,16 @@ import {
 import {
   combineHeaders,
   createJsonResponseHandler,
+  parseProviderOptions,
   postJsonToApi,
 } from '@ai-sdk/provider-utils';
 import { z } from 'zod';
 import { OpenAIConfig } from './openai-config';
 import {
   OpenAIEmbeddingModelId,
+  openaiEmbeddingProviderOptions,
   OpenAIEmbeddingSettings,
-} from './openai-embedding-settings';
+} from './openai-embedding-options';
 import { openaiFailedResponseHandler } from './openai-error';
 
 export class OpenAIEmbeddingModel implements EmbeddingModelV2<string> {
@@ -48,6 +50,7 @@ export class OpenAIEmbeddingModel implements EmbeddingModelV2<string> {
     values,
     headers,
     abortSignal,
+    providerOptions,
   }: Parameters<EmbeddingModelV2<string>['doEmbed']>[0]): Promise<
     Awaited<ReturnType<EmbeddingModelV2<string>['doEmbed']>>
   > {
@@ -60,6 +63,14 @@ export class OpenAIEmbeddingModel implements EmbeddingModelV2<string> {
       });
     }
 
+    // Parse provider options
+    const openaiOptions =
+      parseProviderOptions({
+        provider: 'openai',
+        providerOptions,
+        schema: openaiEmbeddingProviderOptions,
+      }) ?? {};
+
     const {
       responseHeaders,
       value: response,
@@ -74,8 +85,8 @@ export class OpenAIEmbeddingModel implements EmbeddingModelV2<string> {
         model: this.modelId,
         input: values,
         encoding_format: 'float',
-        dimensions: this.settings.dimensions,
-        user: this.settings.user,
+        dimensions: openaiOptions.dimensions,
+        user: openaiOptions.user,
       },
       failedResponseHandler: openaiFailedResponseHandler,
       successfulResponseHandler: createJsonResponseHandler(
diff --git a/packages/openai/src/openai-embedding-options.ts b/packages/openai/src/openai-embedding-options.ts
@@ -1,3 +1,5 @@
+import { z } from 'zod';
+
 export type OpenAIEmbeddingModelId =
   | 'text-embedding-3-small'
   | 'text-embedding-3-large'
@@ -14,16 +16,22 @@ Override the maximum number of embeddings per call.
 Override the parallelism of embedding calls.
     */
   supportsParallelCalls?: boolean;
+}
 
+export const openaiEmbeddingProviderOptions = z.object({
   /**
 The number of dimensions the resulting output embeddings should have.
 Only supported in text-embedding-3 and later models.
    */
-  dimensions?: number;
+  dimensions: z.number().optional(),
 
   /**
 A unique identifier representing your end-user, which can help OpenAI to
 monitor and detect abuse. Learn more.
 */
-  user?: string;
-}
+  user: z.string().optional(),
+});
+
+export type OpenAIEmbeddingProviderOptions = z.infer<
+  typeof openaiEmbeddingProviderOptions
+>;
diff --git a/packages/openai/src/openai-provider.ts b/packages/openai/src/openai-provider.ts
@@ -22,7 +22,7 @@ import { OpenAIEmbeddingModel } from './openai-embedding-model';
 import {
   OpenAIEmbeddingModelId,
   OpenAIEmbeddingSettings,
-} from './openai-embedding-settings';
+} from './openai-embedding-options';
 import { OpenAIImageModel } from './openai-image-model';
 import {
   OpenAIImageModelId,

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@ai-sdk/openai': patch
 +---
++
 +chore(providers/openai): update embedding model to use providerOptions