ai 6.0.32 → 6.0.34

package/src/telemetry/stringify-for-telemetry.test.ts

@@ -0,0 +1,114 @@
+import { stringifyForTelemetry } from './stringify-for-telemetry';
+import { LanguageModelV3Prompt } from '@ai-sdk/provider';
+import { describe, it, expect } from 'vitest';
+
+describe('stringifyForTelemetry', () => {
+  it('should stringify a prompt with text parts', () => {
+    const prompt: LanguageModelV3Prompt = [
+      { role: 'system', content: 'You are a helpful assistant.' },
+      {
+        role: 'user',
+        content: [{ type: 'text', text: 'Hello!' }],
+      },
+    ];
+
+    const result = stringifyForTelemetry(prompt);
+
+    expect(result).toMatchInlineSnapshot(
+      `"[{"role":"system","content":"You are a helpful assistant."},{"role":"user","content":[{"type":"text","text":"Hello!"}]}]"`,
+    );
+  });
+
+  it('should convert Uint8Array images to base64 strings', () => {
+    const result = stringifyForTelemetry([
+      {
+        role: 'user',
+        content: [
+          {
+            type: 'file',
+            data: new Uint8Array([0x89, 0x50, 0x4e, 0x47, 0xff, 0xff]),
+            mediaType: 'image/png',
+          },
+        ],
+      },
+    ]);
+
+    expect(result).toMatchInlineSnapshot(
+      `"[{"role":"user","content":[{"type":"file","data":"iVBOR///","mediaType":"image/png"}]}]"`,
+    );
+  });
+
+  it('should preserve the file name and provider options', () => {
+    const result = stringifyForTelemetry([
+      {
+        role: 'user',
+        content: [
+          {
+            type: 'file',
+            filename: 'image.png',
+            data: new Uint8Array([0x89, 0x50, 0x4e, 0x47, 0xff, 0xff]),
+            mediaType: 'image/png',
+            providerOptions: {
+              anthropic: {
+                key: 'value',
+              },
+            },
+          },
+        ],
+      },
+    ]);
+
+    expect(result).toMatchInlineSnapshot(
+      `"[{"role":"user","content":[{"type":"file","filename":"image.png","data":"iVBOR///","mediaType":"image/png","providerOptions":{"anthropic":{"key":"value"}}}]}]"`,
+    );
+  });
+
+  it('should keep URL images as is', () => {
+    const result = stringifyForTelemetry([
+      {
+        role: 'user',
+        content: [
+          { type: 'text', text: 'Check this image:' },
+          {
+            type: 'file',
+            data: new URL('https://example.com/image.jpg'),
+            mediaType: 'image/jpeg',
+          },
+        ],
+      },
+    ]);
+
+    expect(result).toMatchInlineSnapshot(
+      `"[{"role":"user","content":[{"type":"text","text":"Check this image:"},{"type":"file","data":"https://example.com/image.jpg","mediaType":"image/jpeg"}]}]"`,
+    );
+  });
+
+  it('should handle a mixed prompt with various content types', () => {
+    const result = stringifyForTelemetry([
+      { role: 'system', content: 'You are a helpful assistant.' },
+      {
+        role: 'user',
+        content: [
+          {
+            type: 'file',
+            data: new Uint8Array([0x89, 0x50, 0x4e, 0x47, 0xff, 0xff]),
+            mediaType: 'image/png',
+          },
+          {
+            type: 'file',
+            data: new URL('https://example.com/image.jpg'),
+            mediaType: 'image/jpeg',
+          },
+        ],
+      },
+      {
+        role: 'assistant',
+        content: [{ type: 'text', text: 'I see the images!' }],
+      },
+    ]);
+
+    expect(result).toMatchInlineSnapshot(
+      `"[{"role":"system","content":"You are a helpful assistant."},{"role":"user","content":[{"type":"file","data":"iVBOR///","mediaType":"image/png"},{"type":"file","data":"https://example.com/image.jpg","mediaType":"image/jpeg"}]},{"role":"assistant","content":[{"type":"text","text":"I see the images!"}]}]"`,
+    );
+  });
+});

package/src/telemetry/stringify-for-telemetry.ts

@@ -0,0 +1,33 @@
+import {
+  LanguageModelV3Message,
+  LanguageModelV3Prompt,
+} from '@ai-sdk/provider';
+import { convertDataContentToBase64String } from '../prompt/data-content';
+
+/**
+ * Helper utility to serialize prompt content for OpenTelemetry tracing.
+ * It is initially created because normalized LanguageModelV1Prompt carries
+ * images as Uint8Arrays, on which JSON.stringify acts weirdly, converting
+ * them to objects with stringified indices as keys, e.g. {"0": 42, "1": 69 }.
+ */
+export function stringifyForTelemetry(prompt: LanguageModelV3Prompt): string {
+  return JSON.stringify(
+    prompt.map((message: LanguageModelV3Message) => ({
+      ...message,
+      content:
+        typeof message.content === 'string'
+          ? message.content
+          : message.content.map(part =>
+              part.type === 'file'
+                ? {
+                    ...part,
+                    data:
+                      part.data instanceof Uint8Array
+                        ? convertDataContentToBase64String(part.data)
+                        : part.data,
+                  }
+                : part,
+            ),
+    })),
+  );
+}

package/src/telemetry/telemetry-settings.ts

@@ -0,0 +1,44 @@
+import { AttributeValue, Tracer } from '@opentelemetry/api';
+
+/**
+ * Telemetry configuration.
+ */
+// This is meant to be both flexible for custom app requirements (metadata)
+// and extensible for standardization (example: functionId, more to come).
+export type TelemetrySettings = {
+  /**
+   * Enable or disable telemetry. Disabled by default while experimental.
+   */
+  isEnabled?: boolean;
+
+  /**
+   * Enable or disable input recording. Enabled by default.
+   *
+   * You might want to disable input recording to avoid recording sensitive
+   * information, to reduce data transfers, or to increase performance.
+   */
+  recordInputs?: boolean;
+
+  /**
+   * Enable or disable output recording. Enabled by default.
+   *
+   * You might want to disable output recording to avoid recording sensitive
+   * information, to reduce data transfers, or to increase performance.
+   */
+  recordOutputs?: boolean;
+
+  /**
+   * Identifier for this function. Used to group telemetry data by function.
+   */
+  functionId?: string;
+
+  /**
+   * Additional information to include in the telemetry data.
+   */
+  metadata?: Record<string, AttributeValue>;
+
+  /**
+   * A custom tracer to use for the telemetry data.
+   */
+  tracer?: Tracer;
+};

package/src/test/mock-embedding-model-v2.ts

@@ -0,0 +1,35 @@
+import { EmbeddingModelV2 } from '@ai-sdk/provider';
+import { notImplemented } from './not-implemented';
+
+export class MockEmbeddingModelV2<VALUE> implements EmbeddingModelV2<VALUE> {
+  readonly specificationVersion = 'v2';
+
+  readonly provider: EmbeddingModelV2<VALUE>['provider'];
+  readonly modelId: EmbeddingModelV2<VALUE>['modelId'];
+  readonly maxEmbeddingsPerCall: EmbeddingModelV2<VALUE>['maxEmbeddingsPerCall'];
+  readonly supportsParallelCalls: EmbeddingModelV2<VALUE>['supportsParallelCalls'];
+
+  doEmbed: EmbeddingModelV2<VALUE>['doEmbed'];
+
+  constructor({
+    provider = 'mock-provider',
+    modelId = 'mock-model-id',
+    maxEmbeddingsPerCall = 1,
+    supportsParallelCalls = false,
+    doEmbed = notImplemented,
+  }: {
+    provider?: EmbeddingModelV2<VALUE>['provider'];
+    modelId?: EmbeddingModelV2<VALUE>['modelId'];
+    maxEmbeddingsPerCall?:
+      | EmbeddingModelV2<VALUE>['maxEmbeddingsPerCall']
+      | null;
+    supportsParallelCalls?: EmbeddingModelV2<VALUE>['supportsParallelCalls'];
+    doEmbed?: EmbeddingModelV2<VALUE>['doEmbed'];
+  } = {}) {
+    this.provider = provider;
+    this.modelId = modelId;
+    this.maxEmbeddingsPerCall = maxEmbeddingsPerCall ?? undefined;
+    this.supportsParallelCalls = supportsParallelCalls;
+    this.doEmbed = doEmbed;
+  }
+}

package/src/test/mock-embedding-model-v3.ts

@@ -0,0 +1,48 @@
+import { EmbeddingModelV3 } from '@ai-sdk/provider';
+import { notImplemented } from './not-implemented';
+
+export class MockEmbeddingModelV3 implements EmbeddingModelV3 {
+  readonly specificationVersion = 'v3';
+
+  readonly provider: EmbeddingModelV3['provider'];
+  readonly modelId: EmbeddingModelV3['modelId'];
+  readonly maxEmbeddingsPerCall: EmbeddingModelV3['maxEmbeddingsPerCall'];
+  readonly supportsParallelCalls: EmbeddingModelV3['supportsParallelCalls'];
+
+  doEmbed: EmbeddingModelV3['doEmbed'];
+
+  doEmbedCalls: Parameters<EmbeddingModelV3['doEmbed']>[0][] = [];
+
+  constructor({
+    provider = 'mock-provider',
+    modelId = 'mock-model-id',
+    maxEmbeddingsPerCall = 1,
+    supportsParallelCalls = false,
+    doEmbed = notImplemented,
+  }: {
+    provider?: EmbeddingModelV3['provider'];
+    modelId?: EmbeddingModelV3['modelId'];
+    maxEmbeddingsPerCall?: EmbeddingModelV3['maxEmbeddingsPerCall'] | null;
+    supportsParallelCalls?: EmbeddingModelV3['supportsParallelCalls'];
+    doEmbed?:
+      | EmbeddingModelV3['doEmbed']
+      | Awaited<ReturnType<EmbeddingModelV3['doEmbed']>>
+      | Awaited<ReturnType<EmbeddingModelV3['doEmbed']>>[];
+  } = {}) {
+    this.provider = provider;
+    this.modelId = modelId;
+    this.maxEmbeddingsPerCall = maxEmbeddingsPerCall ?? undefined;
+    this.supportsParallelCalls = supportsParallelCalls;
+    this.doEmbed = async options => {
+      this.doEmbedCalls.push(options);
+
+      if (typeof doEmbed === 'function') {
+        return doEmbed(options);
+      } else if (Array.isArray(doEmbed)) {
+        return doEmbed[this.doEmbedCalls.length];
+      } else {
+        return doEmbed;
+      }
+    };
+  }
+}

package/src/test/mock-image-model-v2.ts

@@ -0,0 +1,28 @@
+import { ImageModelV2 } from '@ai-sdk/provider';
+import { notImplemented } from './not-implemented';
+
+export class MockImageModelV2 implements ImageModelV2 {
+  readonly specificationVersion = 'v2';
+  readonly provider: ImageModelV2['provider'];
+  readonly modelId: ImageModelV2['modelId'];
+  readonly maxImagesPerCall: ImageModelV2['maxImagesPerCall'];
+
+  doGenerate: ImageModelV2['doGenerate'];
+
+  constructor({
+    provider = 'mock-provider',
+    modelId = 'mock-model-id',
+    maxImagesPerCall = 1,
+    doGenerate = notImplemented,
+  }: {
+    provider?: ImageModelV2['provider'];
+    modelId?: ImageModelV2['modelId'];
+    maxImagesPerCall?: ImageModelV2['maxImagesPerCall'];
+    doGenerate?: ImageModelV2['doGenerate'];
+  } = {}) {
+    this.provider = provider;
+    this.modelId = modelId;
+    this.maxImagesPerCall = maxImagesPerCall;
+    this.doGenerate = doGenerate;
+  }
+}

package/src/test/mock-image-model-v3.ts

@@ -0,0 +1,28 @@
+import { ImageModelV3 } from '@ai-sdk/provider';
+import { notImplemented } from './not-implemented';
+
+export class MockImageModelV3 implements ImageModelV3 {
+  readonly specificationVersion = 'v3';
+  readonly provider: ImageModelV3['provider'];
+  readonly modelId: ImageModelV3['modelId'];
+  readonly maxImagesPerCall: ImageModelV3['maxImagesPerCall'];
+
+  doGenerate: ImageModelV3['doGenerate'];
+
+  constructor({
+    provider = 'mock-provider',
+    modelId = 'mock-model-id',
+    maxImagesPerCall = 1,
+    doGenerate = notImplemented,
+  }: {
+    provider?: ImageModelV3['provider'];
+    modelId?: ImageModelV3['modelId'];
+    maxImagesPerCall?: ImageModelV3['maxImagesPerCall'];
+    doGenerate?: ImageModelV3['doGenerate'];
+  } = {}) {
+    this.provider = provider;
+    this.modelId = modelId;
+    this.maxImagesPerCall = maxImagesPerCall;
+    this.doGenerate = doGenerate;
+  }
+}

package/src/test/mock-language-model-v2.ts

@@ -0,0 +1,72 @@
+import { LanguageModelV2 } from '@ai-sdk/provider';
+import { notImplemented } from './not-implemented';
+
+export class MockLanguageModelV2 implements LanguageModelV2 {
+  readonly specificationVersion = 'v2';
+
+  private _supportedUrls: () => LanguageModelV2['supportedUrls'];
+
+  readonly provider: LanguageModelV2['provider'];
+  readonly modelId: LanguageModelV2['modelId'];
+
+  doGenerate: LanguageModelV2['doGenerate'];
+  doStream: LanguageModelV2['doStream'];
+
+  doGenerateCalls: Parameters<LanguageModelV2['doGenerate']>[0][] = [];
+  doStreamCalls: Parameters<LanguageModelV2['doStream']>[0][] = [];
+
+  constructor({
+    provider = 'mock-provider',
+    modelId = 'mock-model-id',
+    supportedUrls = {},
+    doGenerate = notImplemented,
+    doStream = notImplemented,
+  }: {
+    provider?: LanguageModelV2['provider'];
+    modelId?: LanguageModelV2['modelId'];
+    supportedUrls?:
+      | LanguageModelV2['supportedUrls']
+      | (() => LanguageModelV2['supportedUrls']);
+    doGenerate?:
+      | LanguageModelV2['doGenerate']
+      | Awaited<ReturnType<LanguageModelV2['doGenerate']>>
+      | Awaited<ReturnType<LanguageModelV2['doGenerate']>>[];
+    doStream?:
+      | LanguageModelV2['doStream']
+      | Awaited<ReturnType<LanguageModelV2['doStream']>>
+      | Awaited<ReturnType<LanguageModelV2['doStream']>>[];
+  } = {}) {
+    this.provider = provider;
+    this.modelId = modelId;
+    this.doGenerate = async options => {
+      this.doGenerateCalls.push(options);
+
+      if (typeof doGenerate === 'function') {
+        return doGenerate(options);
+      } else if (Array.isArray(doGenerate)) {
+        return doGenerate[this.doGenerateCalls.length];
+      } else {
+        return doGenerate;
+      }
+    };
+    this.doStream = async options => {
+      this.doStreamCalls.push(options);
+
+      if (typeof doStream === 'function') {
+        return doStream(options);
+      } else if (Array.isArray(doStream)) {
+        return doStream[this.doStreamCalls.length];
+      } else {
+        return doStream;
+      }
+    };
+    this._supportedUrls =
+      typeof supportedUrls === 'function'
+        ? supportedUrls
+        : async () => supportedUrls;
+  }
+
+  get supportedUrls() {
+    return this._supportedUrls();
+  }
+}

package/src/test/mock-language-model-v3.ts

@@ -0,0 +1,77 @@
+import {
+  LanguageModelV3,
+  LanguageModelV3CallOptions,
+  LanguageModelV3GenerateResult,
+  LanguageModelV3StreamResult,
+} from '@ai-sdk/provider';
+import { notImplemented } from './not-implemented';
+
+export class MockLanguageModelV3 implements LanguageModelV3 {
+  readonly specificationVersion = 'v3';
+
+  private _supportedUrls: () => LanguageModelV3['supportedUrls'];
+
+  readonly provider: LanguageModelV3['provider'];
+  readonly modelId: LanguageModelV3['modelId'];
+
+  doGenerate: LanguageModelV3['doGenerate'];
+  doStream: LanguageModelV3['doStream'];
+
+  doGenerateCalls: LanguageModelV3CallOptions[] = [];
+  doStreamCalls: LanguageModelV3CallOptions[] = [];
+
+  constructor({
+    provider = 'mock-provider',
+    modelId = 'mock-model-id',
+    supportedUrls = {},
+    doGenerate = notImplemented,
+    doStream = notImplemented,
+  }: {
+    provider?: LanguageModelV3['provider'];
+    modelId?: LanguageModelV3['modelId'];
+    supportedUrls?:
+      | LanguageModelV3['supportedUrls']
+      | (() => LanguageModelV3['supportedUrls']);
+    doGenerate?:
+      | LanguageModelV3['doGenerate']
+      | LanguageModelV3GenerateResult
+      | LanguageModelV3GenerateResult[];
+    doStream?:
+      | LanguageModelV3['doStream']
+      | LanguageModelV3StreamResult
+      | LanguageModelV3StreamResult[];
+  } = {}) {
+    this.provider = provider;
+    this.modelId = modelId;
+    this.doGenerate = async options => {
+      this.doGenerateCalls.push(options);
+
+      if (typeof doGenerate === 'function') {
+        return doGenerate(options);
+      } else if (Array.isArray(doGenerate)) {
+        return doGenerate[this.doGenerateCalls.length];
+      } else {
+        return doGenerate;
+      }
+    };
+    this.doStream = async options => {
+      this.doStreamCalls.push(options);
+
+      if (typeof doStream === 'function') {
+        return doStream(options);
+      } else if (Array.isArray(doStream)) {
+        return doStream[this.doStreamCalls.length];
+      } else {
+        return doStream;
+      }
+    };
+    this._supportedUrls =
+      typeof supportedUrls === 'function'
+        ? supportedUrls
+        : async () => supportedUrls;
+  }
+
+  get supportedUrls() {
+    return this._supportedUrls();
+  }
+}

package/src/test/mock-provider-v2.ts

@@ -0,0 +1,68 @@
+import {
+  EmbeddingModelV2,
+  ImageModelV2,
+  LanguageModelV2,
+  NoSuchModelError,
+  ProviderV2,
+  SpeechModelV2,
+  TranscriptionModelV2,
+} from '@ai-sdk/provider';
+
+export class MockProviderV2 implements ProviderV2 {
+  languageModel: ProviderV2['languageModel'];
+  textEmbeddingModel: ProviderV2['textEmbeddingModel'];
+  imageModel: ProviderV2['imageModel'];
+  transcriptionModel: ProviderV2['transcriptionModel'];
+  speechModel: ProviderV2['speechModel'];
+
+  constructor({
+    languageModels,
+    embeddingModels,
+    imageModels,
+    transcriptionModels,
+    speechModels,
+  }: {
+    languageModels?: Record<string, LanguageModelV2>;
+    embeddingModels?: Record<string, EmbeddingModelV2<string>>;
+    imageModels?: Record<string, ImageModelV2>;
+    transcriptionModels?: Record<string, TranscriptionModelV2>;
+    speechModels?: Record<string, SpeechModelV2>;
+  } = {}) {
+    this.languageModel = (modelId: string) => {
+      if (!languageModels?.[modelId]) {
+        throw new NoSuchModelError({ modelId, modelType: 'languageModel' });
+      }
+      return languageModels[modelId];
+    };
+    this.textEmbeddingModel = (modelId: string) => {
+      if (!embeddingModels?.[modelId]) {
+        throw new NoSuchModelError({
+          modelId,
+          modelType: 'textEmbeddingModel' as any, // backwards compatibility
+        });
+      }
+      return embeddingModels[modelId];
+    };
+    this.imageModel = (modelId: string) => {
+      if (!imageModels?.[modelId]) {
+        throw new NoSuchModelError({ modelId, modelType: 'imageModel' });
+      }
+      return imageModels[modelId];
+    };
+    this.transcriptionModel = (modelId: string) => {
+      if (!transcriptionModels?.[modelId]) {
+        throw new NoSuchModelError({
+          modelId,
+          modelType: 'transcriptionModel',
+        });
+      }
+      return transcriptionModels[modelId];
+    };
+    this.speechModel = (modelId: string) => {
+      if (!speechModels?.[modelId]) {
+        throw new NoSuchModelError({ modelId, modelType: 'speechModel' });
+      }
+      return speechModels[modelId];
+    };
+  }
+}

package/src/test/mock-provider-v3.ts

@@ -0,0 +1,80 @@
+import {
+  EmbeddingModelV3,
+  ImageModelV3,
+  LanguageModelV3,
+  NoSuchModelError,
+  ProviderV3,
+  SpeechModelV3,
+  TranscriptionModelV3,
+  RerankingModelV3,
+} from '@ai-sdk/provider';
+
+export class MockProviderV3 implements ProviderV3 {
+  readonly specificationVersion = 'v3' as const;
+
+  languageModel: ProviderV3['languageModel'];
+  embeddingModel: ProviderV3['embeddingModel'];
+  imageModel: ProviderV3['imageModel'];
+  transcriptionModel: ProviderV3['transcriptionModel'];
+  speechModel: ProviderV3['speechModel'];
+  rerankingModel: ProviderV3['rerankingModel'];
+
+  constructor({
+    languageModels,
+    embeddingModels,
+    imageModels,
+    transcriptionModels,
+    speechModels,
+    rerankingModels,
+  }: {
+    languageModels?: Record<string, LanguageModelV3>;
+    embeddingModels?: Record<string, EmbeddingModelV3>;
+    imageModels?: Record<string, ImageModelV3>;
+    transcriptionModels?: Record<string, TranscriptionModelV3>;
+    speechModels?: Record<string, SpeechModelV3>;
+    rerankingModels?: Record<string, RerankingModelV3>;
+  } = {}) {
+    this.languageModel = (modelId: string) => {
+      if (!languageModels?.[modelId]) {
+        throw new NoSuchModelError({ modelId, modelType: 'languageModel' });
+      }
+      return languageModels[modelId];
+    };
+    this.embeddingModel = (modelId: string) => {
+      if (!embeddingModels?.[modelId]) {
+        throw new NoSuchModelError({
+          modelId,
+          modelType: 'embeddingModel',
+        });
+      }
+      return embeddingModels[modelId];
+    };
+    this.imageModel = (modelId: string) => {
+      if (!imageModels?.[modelId]) {
+        throw new NoSuchModelError({ modelId, modelType: 'imageModel' });
+      }
+      return imageModels[modelId];
+    };
+    this.transcriptionModel = (modelId: string) => {
+      if (!transcriptionModels?.[modelId]) {
+        throw new NoSuchModelError({
+          modelId,
+          modelType: 'transcriptionModel',
+        });
+      }
+      return transcriptionModels[modelId];
+    };
+    this.speechModel = (modelId: string): SpeechModelV3 => {
+      if (!speechModels?.[modelId]) {
+        throw new NoSuchModelError({ modelId, modelType: 'speechModel' });
+      }
+      return speechModels[modelId];
+    };
+    this.rerankingModel = (modelId: string) => {
+      if (!rerankingModels?.[modelId]) {
+        throw new NoSuchModelError({ modelId, modelType: 'rerankingModel' });
+      }
+      return rerankingModels[modelId];
+    };
+  }
+}

package/src/test/mock-reranking-model-v3.ts

@@ -0,0 +1,25 @@
+import { RerankingModelV3 } from '@ai-sdk/provider';
+import { notImplemented } from './not-implemented';
+
+export class MockRerankingModelV3 implements RerankingModelV3 {
+  readonly specificationVersion = 'v3';
+
+  readonly provider: RerankingModelV3['provider'];
+  readonly modelId: RerankingModelV3['modelId'];
+
+  doRerank: RerankingModelV3['doRerank'];
+
+  constructor({
+    provider = 'mock-provider',
+    modelId = 'mock-model-id',
+    doRerank = notImplemented,
+  }: {
+    provider?: RerankingModelV3['provider'];
+    modelId?: RerankingModelV3['modelId'];
+    doRerank?: RerankingModelV3['doRerank'];
+  } = {}) {
+    this.provider = provider;
+    this.modelId = modelId;
+    this.doRerank = doRerank;
+  }
+}