chore(embedding-model): add v2 interface (#5696)

Author: samdenty

.changeset/heavy-pens-destroy.md

@@ -0,0 +1,16 @@
+---
+'@ai-sdk/openai-compatible': patch
+'@ai-sdk/amazon-bedrock': patch
+'@ai-sdk/google-vertex': patch
+'@ai-sdk/togetherai': patch
+'@ai-sdk/deepinfra': patch
+'@ai-sdk/fireworks': patch
+'@ai-sdk/provider': patch
+'@ai-sdk/mistral': patch
+'@ai-sdk/cohere': patch
+'@ai-sdk/google': patch
+'@ai-sdk/openai': patch
+'ai': patch
+---
+
+chore(embedding-model): add v2 interface

content/docs/03-ai-sdk-core/55-testing.mdx

@@ -11,7 +11,7 @@ and calling them is slow and expensive.
 To enable you to unit test your code that uses the AI SDK, the AI SDK Core
 includes mock providers and test helpers. You can import the following helpers from `ai/test`:
 
-- `MockEmbeddingModelV1`: A mock embedding model using the [embedding model v1 specification](https://github.com/vercel/ai/blob/main/packages/provider/src/embedding-model/v1/embedding-model-v1.ts).
+- `MockEmbeddingModelV2`: A mock embedding model using the [embedding model v1 specification](https://github.com/vercel/ai/blob/main/packages/provider/src/embedding-model/v1/embedding-model-v1.ts).
 - `MockLanguageModelV1`: A mock language model using the [language model v1 specification](https://github.com/vercel/ai/blob/main/packages/provider/src/language-model/v1/language-model-v1.ts).
 - `mockId`: Provides an incrementing integer ID.
 - `mockValues`: Iterates over an array of values with each call. Returns the last value when the array is exhausted.

content/docs/07-reference/01-ai-sdk-core/42-custom-provider.mdx

@@ -49,7 +49,7 @@ export const myOpenAI = customProvider({
     },
     {
       name: 'textEmbeddingModels',
-      type: 'Record<string, EmbeddingModelV1<string>>',
+      type: 'Record<string, EmbeddingModelV2<string>>',
       isOptional: true,
       description:
         'A record of text embedding models, where keys are model IDs and values are EmbeddingModel<string> instances.',

content/docs/09-troubleshooting/30-model-is-not-assignable-to-type.mdx

@@ -9,7 +9,7 @@ description: Troubleshooting errors related to incompatible models.
 
 I have updated the AI SDK and now I get the following error: `Type 'SomeModel' is not assignable to type 'LanguageModelV1'.`
 
-<Note>Similar errors can occur with `EmbeddingModelV1` as well.</Note>
+<Note>Similar errors can occur with `EmbeddingModelV2` as well.</Note>
 
 ## Background
 

content/providers/02-openai-compatible-providers/01-custom-providers.mdx

@@ -47,7 +47,7 @@ The completion, embedding, and image settings are implemented similarly to the c
 2. **example-provider.ts** - Main provider implementation:
 
 ```ts
-import { LanguageModelV1, EmbeddingModelV1 } from '@ai-sdk/provider';
+import { LanguageModelV1, EmbeddingModelV2 } from '@ai-sdk/provider';
 import {
   OpenAICompatibleChatLanguageModel,
   OpenAICompatibleCompletionLanguageModel,
@@ -116,7 +116,7 @@ Creates a text embedding model for text generation.
   textEmbeddingModel(
     modelId: ExampleEmbeddingModelId,
     settings?: ExampleEmbeddingSettings,
-  ): EmbeddingModelV1<string>;
+  ): EmbeddingModelV2<string>;
 
   /**
 Creates an image model for image generation.

examples/ai-core/src/e2e/feature-test-suite.ts

@@ -1,6 +1,6 @@
 import type { GoogleGenerativeAIProviderMetadata } from '@ai-sdk/google';
 import type {
-  EmbeddingModelV1,
+  EmbeddingModelV2,
   ImageModelV1,
   LanguageModelV2,
 } from '@ai-sdk/provider';
@@ -57,9 +57,9 @@ export const createLanguageModelWithCapabilities = (
 });
 
 export const createEmbeddingModelWithCapabilities = (
-  model: EmbeddingModelV1<string>,
+  model: EmbeddingModelV2<string>,
   capabilities: ModelCapabilities = ['embedding'],
-): ModelWithCapabilities<EmbeddingModelV1<string>> => ({
+): ModelWithCapabilities<EmbeddingModelV2<string>> => ({
   model,
   capabilities,
 });
@@ -75,7 +75,7 @@ export const createImageModelWithCapabilities = (
 export interface ModelVariants {
   invalidModel?: LanguageModelV2;
   languageModels?: ModelWithCapabilities<LanguageModelV2>[];
-  embeddingModels?: ModelWithCapabilities<EmbeddingModelV1<string>>[];
+  embeddingModels?: ModelWithCapabilities<EmbeddingModelV2<string>>[];
   invalidImageModel?: ImageModelV1;
   imageModels?: ModelWithCapabilities<ImageModelV1>[];
 }

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

@@ -1,8 +1,8 @@
 import assert from 'node:assert';
 import {
-  MockEmbeddingModelV1,
+  MockEmbeddingModelV2,
   mockEmbed,
-} from '../test/mock-embedding-model-v1';
+} from '../test/mock-embedding-model-v2';
 import { MockTracer } from '../test/mock-tracer';
 import { embedMany } from './embed-many';
 
@@ -21,7 +21,7 @@ const testValues = [
 describe('result.embedding', () => {
   it('should generate embeddings', async () => {
     const result = await embedMany({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         maxEmbeddingsPerCall: 5,
         doEmbed: mockEmbed(testValues, dummyEmbeddings),
       }),
@@ -35,7 +35,7 @@ describe('result.embedding', () => {
     let callCount = 0;
 
     const result = await embedMany({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         maxEmbeddingsPerCall: 2,
         doEmbed: async ({ values }) => {
           switch (callCount++) {
@@ -60,7 +60,7 @@ describe('result.embedding', () => {
 describe('result.values', () => {
   it('should include values in the result', async () => {
     const result = await embedMany({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         maxEmbeddingsPerCall: 5,
         doEmbed: mockEmbed(testValues, dummyEmbeddings),
       }),
@@ -76,7 +76,7 @@ describe('result.usage', () => {
     let callCount = 0;
 
     const result = await embedMany({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         maxEmbeddingsPerCall: 2,
         doEmbed: async () => {
           switch (callCount++) {
@@ -105,7 +105,7 @@ describe('result.usage', () => {
 describe('options.headers', () => {
   it('should set headers', async () => {
     const result = await embedMany({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         maxEmbeddingsPerCall: 5,
         doEmbed: async ({ headers }) => {
           assert.deepStrictEqual(headers, {
@@ -132,7 +132,7 @@ describe('telemetry', () => {
 
   it('should not record any telemetry data when not explicitly enabled', async () => {
     await embedMany({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         maxEmbeddingsPerCall: 5,
         doEmbed: mockEmbed(testValues, dummyEmbeddings),
       }),
@@ -146,7 +146,7 @@ describe('telemetry', () => {
     let callCount = 0;
 
     await embedMany({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         maxEmbeddingsPerCall: 2,
         doEmbed: async ({ values }) => {
           switch (callCount++) {
@@ -184,7 +184,7 @@ describe('telemetry', () => {
 
   it('should record telemetry data when enabled (single call path)', async () => {
     await embedMany({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         maxEmbeddingsPerCall: null,
         doEmbed: mockEmbed(testValues, dummyEmbeddings, { tokens: 10 }),
       }),
@@ -205,7 +205,7 @@ describe('telemetry', () => {
 
   it('should not record telemetry inputs / outputs when disabled', async () => {
     await embedMany({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         maxEmbeddingsPerCall: null,
         doEmbed: mockEmbed(testValues, dummyEmbeddings, { tokens: 10 }),
       }),

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

@@ -1,8 +1,8 @@
 import assert from 'node:assert';
 import {
-  MockEmbeddingModelV1,
+  MockEmbeddingModelV2,
   mockEmbed,
-} from '../test/mock-embedding-model-v1';
+} from '../test/mock-embedding-model-v2';
 import { MockTracer } from '../test/mock-tracer';
 import { embed } from './embed';
 
@@ -12,7 +12,7 @@ const testValue = 'sunny day at the beach';
 describe('result.embedding', () => {
   it('should generate embedding', async () => {
     const result = await embed({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         doEmbed: mockEmbed([testValue], [dummyEmbedding]),
       }),
       value: testValue,
@@ -25,7 +25,7 @@ describe('result.embedding', () => {
 describe('result.value', () => {
   it('should include value in the result', async () => {
     const result = await embed({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         doEmbed: mockEmbed([testValue], [dummyEmbedding]),
       }),
       value: testValue,
@@ -38,7 +38,7 @@ describe('result.value', () => {
 describe('result.usage', () => {
   it('should include usage in the result', async () => {
     const result = await embed({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         doEmbed: mockEmbed([testValue], [dummyEmbedding], { tokens: 10 }),
       }),
       value: testValue,
@@ -51,7 +51,7 @@ describe('result.usage', () => {
 describe('options.headers', () => {
   it('should set headers', async () => {
     const result = await embed({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         doEmbed: async ({ headers }) => {
           assert.deepStrictEqual(headers, {
             'custom-request-header': 'request-header-value',
@@ -77,7 +77,7 @@ describe('telemetry', () => {
 
   it('should not record any telemetry data when not explicitly enabled', async () => {
     await embed({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         doEmbed: mockEmbed([testValue], [dummyEmbedding]),
       }),
       value: testValue,
@@ -89,7 +89,7 @@ describe('telemetry', () => {
 
   it('should record telemetry data when enabled', async () => {
     await embed({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         doEmbed: mockEmbed([testValue], [dummyEmbedding], { tokens: 10 }),
       }),
       value: testValue,
@@ -109,7 +109,7 @@ describe('telemetry', () => {
 
   it('should not record telemetry inputs / outputs when disabled', async () => {
     await embed({
-      model: new MockEmbeddingModelV1({
+      model: new MockEmbeddingModelV2({
         doEmbed: mockEmbed([testValue], [dummyEmbedding], { tokens: 10 }),
       }),
       value: testValue,

packages/ai/core/registry/custom-provider.test.ts

@@ -1,12 +1,12 @@
 import { NoSuchModelError } from '@ai-sdk/provider';
 import { describe, expect, it, vi } from 'vitest';
-import { MockEmbeddingModelV1 } from '../test/mock-embedding-model-v1';
+import { MockEmbeddingModelV2 } from '../test/mock-embedding-model-v2';
 import { MockImageModelV1 } from '../test/mock-image-model-v1';
 import { MockLanguageModelV2 } from '../test/mock-language-model-v1';
 import { customProvider } from './custom-provider';
 
 const mockLanguageModel = new MockLanguageModelV2();
-const mockEmbeddingModel = new MockEmbeddingModelV1();
+const mockEmbeddingModel = new MockEmbeddingModelV2();
 const mockFallbackProvider = {
   languageModel: vi.fn(),
   textEmbeddingModel: vi.fn(),

packages/ai/core/registry/provider-registry.test.ts

@@ -1,5 +1,5 @@
 import { NoSuchModelError } from '@ai-sdk/provider';
-import { MockEmbeddingModelV1 } from '../test/mock-embedding-model-v1';
+import { MockEmbeddingModelV2 } from '../test/mock-embedding-model-v2';
 import { MockLanguageModelV2 } from '../test/mock-language-model-v1';
 import { NoSuchProviderError } from './no-such-provider-error';
 import { createProviderRegistry } from './provider-registry';
@@ -113,7 +113,7 @@ describe('languageModel', () => {
 
 describe('textEmbeddingModel', () => {
   it('should return embedding model from provider using textEmbeddingModel', () => {
-    const model = new MockEmbeddingModelV1<string>();
+    const model = new MockEmbeddingModelV2<string>();
 
     const modelRegistry = createProviderRegistry({
       provider: {
@@ -172,7 +172,7 @@ describe('textEmbeddingModel', () => {
   });
 
   it('should support custom separator', () => {
-    const model = new MockEmbeddingModelV1<string>();
+    const model = new MockEmbeddingModelV2<string>();
 
     const modelRegistry = createProviderRegistry(
       {