feat(embedding-model-v2): add providerOptions (#5698)

Author: samdenty

.changeset/tender-tables-trade.md

@@ -0,0 +1,5 @@
+---
+'@ai-sdk/provider': patch
+---
+
+feat(embedding-model-v2): add providerOptions

packages/ai/core/embed/embed-many.test.ts

@@ -123,6 +123,35 @@ describe('options.headers', () => {
   });
 });
 
+describe('options.providerOptions', () => {
+  it('should pass provider options to model', async () => {
+    const model = new MockEmbeddingModelV2({
+      doEmbed: async ({ providerOptions }) => {
+        return { embeddings: [[1, 2, 3]] };
+      },
+    });
+
+    vi.spyOn(model, 'doEmbed');
+
+    await embedMany({
+      model,
+      values: ['test-input'],
+      providerOptions: {
+        aProvider: { someKey: 'someValue' },
+      },
+    });
+
+    expect(model.doEmbed).toHaveBeenCalledWith({
+      abortSignal: undefined,
+      headers: undefined,
+      providerOptions: {
+        aProvider: { someKey: 'someValue' },
+      },
+      values: ['test-input'],
+    });
+  });
+});
+
 describe('telemetry', () => {
   let tracer: MockTracer;
 

packages/ai/core/embed/embed-many.ts

@@ -5,7 +5,7 @@ import { getTracer } from '../telemetry/get-tracer';
 import { recordSpan } from '../telemetry/record-span';
 import { selectTelemetryAttributes } from '../telemetry/select-telemetry-attributes';
 import { TelemetrySettings } from '../telemetry/telemetry-settings';
-import { Embedding, EmbeddingModel } from '../types';
+import { Embedding, EmbeddingModel, ProviderOptions } from '../types';
 import { splitArray } from '../util/split-array';
 import { EmbedManyResult } from './embed-many-result';
 
@@ -31,6 +31,7 @@ export async function embedMany<VALUE>({
   maxRetries: maxRetriesArg,
   abortSignal,
   headers,
+  providerOptions,
   experimental_telemetry: telemetry,
 }: {
   /**
@@ -65,6 +66,13 @@ Only applicable for HTTP-based providers.
    * Optional telemetry configuration (experimental).
    */
   experimental_telemetry?: TelemetrySettings;
+
+  /**
+  Additional provider-specific options. They are passed through
+  to the provider from the AI SDK and enable provider-specific
+  functionality that can be fully encapsulated in the provider.
+  */
+  providerOptions?: ProviderOptions;
 }): Promise<EmbedManyResult<VALUE>> {
   const { maxRetries, retry } = prepareRetries({ maxRetries: maxRetriesArg });
 
@@ -121,6 +129,7 @@ Only applicable for HTTP-based providers.
                 values,
                 abortSignal,
                 headers,
+                providerOptions,
               });
 
               const embeddings = modelResponse.embeddings;
@@ -192,6 +201,7 @@ Only applicable for HTTP-based providers.
                 values: chunk,
                 abortSignal,
                 headers,
+                providerOptions,
               });
 
               const embeddings = modelResponse.embeddings;

packages/ai/core/embed/embed.test.ts

@@ -68,6 +68,28 @@ describe('options.headers', () => {
   });
 });
 
+describe('options.providerOptions', () => {
+  it('should pass provider options to model', async () => {
+    const result = await embed({
+      model: new MockEmbeddingModelV2({
+        doEmbed: async ({ providerOptions }) => {
+          expect(providerOptions).toStrictEqual({
+            aProvider: { someKey: 'someValue' },
+          });
+
+          return { embeddings: [[1, 2, 3]] };
+        },
+      }),
+      value: 'test-input',
+      providerOptions: {
+        aProvider: { someKey: 'someValue' },
+      },
+    });
+
+    expect(result.embedding).toStrictEqual([1, 2, 3]);
+  });
+});
+
 describe('telemetry', () => {
   let tracer: MockTracer;
 

packages/ai/core/embed/embed.ts

@@ -5,7 +5,7 @@ import { getTracer } from '../telemetry/get-tracer';
 import { recordSpan } from '../telemetry/record-span';
 import { selectTelemetryAttributes } from '../telemetry/select-telemetry-attributes';
 import { TelemetrySettings } from '../telemetry/telemetry-settings';
-import { EmbeddingModel } from '../types';
+import { EmbeddingModel, ProviderOptions } from '../types';
 import { EmbedResult } from './embed-result';
 
 /**
@@ -23,6 +23,7 @@ Embed a value using an embedding model. The type of the value is defined by the
 export async function embed<VALUE>({
   model,
   value,
+  providerOptions,
   maxRetries: maxRetriesArg,
   abortSignal,
   headers,
@@ -56,6 +57,13 @@ Only applicable for HTTP-based providers.
  */
   headers?: Record<string, string>;
 
+  /**
+  Additional provider-specific options. They are passed through
+  to the provider from the AI SDK and enable provider-specific
+  functionality that can be fully encapsulated in the provider.
+  */
+  providerOptions?: ProviderOptions;
+
   /**
    * Optional telemetry configuration (experimental).
    */
@@ -106,6 +114,7 @@ Only applicable for HTTP-based providers.
               values: [value],
               abortSignal,
               headers,
+              providerOptions,
             });
 
             const embedding = modelResponse.embeddings[0];

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

@@ -17,8 +17,7 @@ import { getTracer } from '../telemetry/get-tracer';
 import { recordSpan } from '../telemetry/record-span';
 import { selectTelemetryAttributes } from '../telemetry/select-telemetry-attributes';
 import { TelemetrySettings } from '../telemetry/telemetry-settings';
-import { LanguageModel, ToolChoice } from '../types';
-import { ProviderOptions } from '../types/provider-metadata';
+import { LanguageModel, ToolChoice, ProviderOptions } from '../types';
 import {
   addLanguageModelUsage,
   calculateLanguageModelUsage,

packages/provider/src/embedding-model/v2/embedding-model-v2.ts

@@ -1,3 +1,4 @@
+import { SharedV2ProviderOptions } from '../../shared';
 import { EmbeddingModelV2Embedding } from './embedding-model-v2-embedding';
 
 /**
@@ -55,6 +56,13 @@ Abort signal for cancelling the operation.
      */
     abortSignal?: AbortSignal;
 
+    /**
+Additional provider-specific options. They are passed through
+to the provider from the AI SDK and enable provider-specific
+functionality that can be fully encapsulated in the provider.
+    */
+    providerOptions?: SharedV2ProviderOptions;
+
     /**
   Additional HTTP headers to be sent with the request.
   Only applicable for HTTP-based providers.