ai 7.0.97 → 7.0.98

package/src/batch/batch.ts

@@ -4,12 +4,22 @@ import {
   type Experimental_BatchV4ItemResult as BatchV4ItemResult,
   type LanguageModelV4GenerateResult,
   type LanguageModelV4ToolCall,
+  type ImageModelV4Result,
   type ProviderV4,
 } from '@ai-sdk/provider';
 import { gateway } from '@ai-sdk/gateway';
-import { type ToolSet, withUserAgentSuffix } from '@ai-sdk/provider-utils';
+import {
+  detectMediaType,
+  type ToolSet,
+  withUserAgentSuffix,
+} from '@ai-sdk/provider-utils';
 import { InvalidArgumentError } from '../error/invalid-argument-error';
 import { convertLanguageModelContent } from '../generate-text/convert-language-model-content';
+import {
+  getImageProviderMetadata,
+  normalizePrompt as normalizeImagePrompt,
+} from '../generate-image/generate-image';
+import { DefaultGeneratedFile } from '../generate-text/generated-file';
 import { parseToolCall } from '../generate-text/parse-tool-call';
 import { prepareToolChoice } from '../prompt/prepare-tool-choice';
 import { prepareTools } from '../prompt/prepare-tools';
@@ -40,7 +50,7 @@ import type {
   StartBatchOptions,
   StartBatchResult,
   TextBatchGenerationResult,
-  TextBatchItemResult,
+  ImageBatchGenerationResult,
 } from './batch-types';
 
 /**
@@ -167,7 +177,8 @@ export async function startBatch<
   const toolsByName = new Map<string, unknown>();
 
   for (const request of requests) {
-    switch (request.type) {
+    const requestType = request.type;
+    switch (requestType) {
       case 'text': {
         const standardizedPrompt = await standardizePrompt(request);
         const preparedTools = await prepareTools({
@@ -200,6 +211,33 @@ export async function startBatch<
         });
         break;
       }
+      case 'image': {
+        const { prompt, files, mask } = normalizeImagePrompt(request.prompt);
+        normalizedRequests.push({
+          id: request.id,
+          type: request.type,
+          modelId: request.model,
+          options: {
+            prompt,
+            n: request.n ?? 1,
+            size: request.size,
+            aspectRatio: request.aspectRatio,
+            seed: request.seed,
+            files,
+            mask,
+            providerOptions: request.providerOptions ?? {},
+          },
+        });
+        break;
+      }
+      default: {
+        const _exhaustiveCheck: never = requestType;
+        throw new InvalidArgumentError({
+          parameter: 'requests',
+          value: _exhaustiveCheck,
+          message: `Unsupported batch request type "${_exhaustiveCheck}".`,
+        });
+      }
     }
     operationAbortSignal?.throwIfAborted();
   }
@@ -471,18 +509,47 @@ async function convertBatchItemResult<TOOLS extends ToolSet>({
 }: {
   item: BatchV4ItemResult;
   tools: TOOLS | undefined;
-}): Promise<TextBatchItemResult<TOOLS>> {
+}): Promise<BatchItemResult<TOOLS>> {
   switch (item.type) {
     case 'text':
       switch (item.status) {
         case 'succeeded':
           return {
+            type: item.type,
             id: item.id,
             status: item.status,
             ...(await convertGenerateResult({ result: item.result, tools })),
           };
         case 'failed':
           return {
+            type: item.type,
+            id: item.id,
+            status: item.status,
+            error: item.error,
+            providerMetadata: item.providerMetadata,
+          };
+        case 'cancelled':
+        case 'expired':
+          return {
+            type: item.type,
+            id: item.id,
+            status: item.status,
+            error: item.error,
+            providerMetadata: item.providerMetadata,
+          };
+      }
+    case 'image':
+      switch (item.status) {
+        case 'succeeded':
+          return {
+            type: item.type,
+            id: item.id,
+            status: item.status,
+            ...convertImageResult(item.result),
+          };
+        case 'failed':
+          return {
+            type: item.type,
             id: item.id,
             status: item.status,
             error: item.error,
@@ -491,6 +558,7 @@ async function convertBatchItemResult<TOOLS extends ToolSet>({
         case 'cancelled':
         case 'expired':
           return {
+            type: item.type,
             id: item.id,
             status: item.status,
             error: item.error,
@@ -500,6 +568,34 @@ async function convertBatchItemResult<TOOLS extends ToolSet>({
   }
 }
 
+function convertImageResult(
+  result: ImageModelV4Result,
+): ImageBatchGenerationResult {
+  return {
+    images: result.images.map(
+      (image, index) =>
+        new DefaultGeneratedFile({
+          data: image,
+          mediaType:
+            detectMediaType({ data: image, topLevelType: 'image' }) ??
+            'image/png',
+          providerMetadata: getImageProviderMetadata(
+            result.providerMetadata,
+            index,
+          ),
+        }),
+    ),
+    warnings: result.warnings,
+    response: {
+      timestamp: result.response.timestamp,
+      modelId: result.response.modelId,
+      headers: result.response.headers,
+    },
+    providerMetadata: result.providerMetadata,
+    usage: result.usage,
+  };
+}
+
 async function convertGenerateResult<TOOLS extends ToolSet>({
   result,
   tools,

package/src/batch/index.ts

@@ -21,6 +21,9 @@ export type {
   Batch as Experimental_Batch,
   BatchItemResult as Experimental_BatchItemResult,
   BatchRequest as Experimental_BatchRequest,
+  ImageBatchGenerationResult as Experimental_ImageBatchGenerationResult,
+  ImageBatchItemResult as Experimental_ImageBatchItemResult,
+  ImageBatchRequest as Experimental_ImageBatchRequest,
   TextBatchGenerationResult as Experimental_TextBatchGenerationResult,
   TextBatchItemResult as Experimental_TextBatchItemResult,
   TextBatchRequest as Experimental_TextBatchRequest,

package/src/embed/embed-events.ts

@@ -1,4 +1,4 @@
-import type { ProviderOptions } from '@ai-sdk/provider-utils';
+import type { Context, ProviderOptions } from '@ai-sdk/provider-utils';
 import type { Embedding, ProviderMetadata } from '../types';
 import type { EmbeddingModelUsage } from '../types/usage';
 import type { Warning } from '../types/warning';
@@ -8,7 +8,10 @@ import type { Warning } from '../types/warning';
  *
  * Called when the operation begins, before the embedding model is called.
  */
-export type EmbedStartEvent = {
+export type EmbedStartEvent<RUNTIME_CONTEXT extends Context = Context> = {
+  /** User-defined runtime context. */
+  readonly runtimeContext: RUNTIME_CONTEXT;
+
   /** Unique identifier for this embed call, used to correlate events. */
   readonly callId: string;
 
@@ -39,7 +42,10 @@ export type EmbedStartEvent = {
  *
  * Called when the operation completes, after the embedding model returns.
  */
-export type EmbedEndEvent = {
+export type EmbedEndEvent<RUNTIME_CONTEXT extends Context = Context> = {
+  /** User-defined runtime context. */
+  readonly runtimeContext: RUNTIME_CONTEXT;
+
   /** Unique identifier for this embed call, used to correlate events. */
   readonly callId: string;
 

package/src/embed/embed-many.ts

@@ -1,13 +1,14 @@
 import { InvalidResponseDataError } from '@ai-sdk/provider';
 import {
   createIdGenerator,
+  type Context,
   withUserAgentSuffix,
   type ProviderOptions,
 } from '@ai-sdk/provider-utils';
 import { logWarnings } from '../logger/log-warnings';
 import { getEmbeddingModelMaxInputBytesPerCall } from '../model/get-embedding-model-max-input-bytes-per-call';
 import { resolveEmbeddingModel } from '../model/resolve-model';
-import { createTelemetryDispatcher } from '../telemetry/create-telemetry-dispatcher';
+import { createRestrictedTelemetryDispatcher } from './restricted-telemetry-dispatcher';
 import type { TelemetryOptions } from '../telemetry/telemetry-options';
 import type { Embedding, EmbeddingModel, ProviderMetadata } from '../types';
 import type { Warning } from '../types/warning';
@@ -42,6 +43,7 @@ const originalGenerateCallId = createIdGenerator({
  * @param maxParallelCalls - Maximum number of concurrent requests. Default: Infinity.
  *
  * @param telemetry - Optional telemetry configuration.
+ * @param runtimeContext - User-defined runtime context passed to callbacks and, when explicitly included, telemetry.
  *
  * @param providerOptions - Additional provider-specific options. They are passed through
  * to the provider from the AI SDK and enable provider-specific
@@ -49,7 +51,7 @@ const originalGenerateCallId = createIdGenerator({
  *
  * @returns A result object that contains the embeddings, the value, and additional information.
  */
-export async function embedMany({
+export async function embedMany<RUNTIME_CONTEXT extends Context = Context>({
   model: modelArg,
   values,
   maxParallelCalls = Infinity,
@@ -59,6 +61,7 @@ export async function embedMany({
   providerOptions,
   experimental_telemetry,
   telemetry = experimental_telemetry,
+  runtimeContext = {} as RUNTIME_CONTEXT,
   onStart,
   experimental_onStart,
   onEnd,
@@ -96,14 +99,19 @@ export async function embedMany({
   /**
    * Optional telemetry configuration.
    */
-  telemetry?: TelemetryOptions;
+  telemetry?: TelemetryOptions<RUNTIME_CONTEXT>;
 
   /**
    * Optional telemetry configuration.
    *
    * @deprecated Use `telemetry` instead. This alias will be removed in a future major release.
    */
-  experimental_telemetry?: TelemetryOptions;
+  experimental_telemetry?: TelemetryOptions<RUNTIME_CONTEXT>;
+
+  /**
+   * User-defined runtime context. Treat runtime context as immutable.
+   */
+  runtimeContext?: RUNTIME_CONTEXT;
 
   /**
    * Additional provider-specific options. They are passed through
@@ -123,7 +131,7 @@ export async function embedMany({
    * Callback that is called when the embedMany operation begins,
    * before the embedding model is called.
    */
-  onStart?: Callback<EmbedStartEvent>;
+  onStart?: Callback<EmbedStartEvent<RUNTIME_CONTEXT>>;
 
   /**
    * Callback that is called when the embedMany operation begins,
@@ -131,13 +139,13 @@ export async function embedMany({
    *
    * @deprecated Use `onStart` instead.
    */
-  experimental_onStart?: Callback<EmbedStartEvent>;
+  experimental_onStart?: Callback<EmbedStartEvent<RUNTIME_CONTEXT>>;
 
   /**
    * Callback that is called when the embedMany operation completes,
    * after all embedding model calls return.
    */
-  onEnd?: Callback<EmbedEndEvent>;
+  onEnd?: Callback<EmbedEndEvent<RUNTIME_CONTEXT>>;
 
   /**
    * Callback that is called when the embedMany operation completes,
@@ -145,7 +153,7 @@ export async function embedMany({
    *
    * @deprecated Use `onEnd` instead.
    */
-  experimental_onEnd?: Callback<EmbedEndEvent>;
+  experimental_onEnd?: Callback<EmbedEndEvent<RUNTIME_CONTEXT>>;
 
   /**
    * Internal. For test use only. May change without notice.
@@ -170,7 +178,7 @@ export async function embedMany({
 
   const callId = generateCallId();
 
-  const telemetryDispatcher = createTelemetryDispatcher({
+  const telemetryDispatcher = createRestrictedTelemetryDispatcher({
     telemetry,
   });
 
@@ -182,6 +190,7 @@ export async function embedMany({
   const startEvent = {
     callId,
     operationId: 'ai.embedMany',
+    runtimeContext,
     provider: model.provider,
     modelId: model.modelId,
     value: values,
@@ -277,6 +286,7 @@ export async function embedMany({
             event: {
               callId,
               operationId: 'ai.embedMany',
+              runtimeContext,
               provider: model.provider,
               modelId: model.modelId,
               value: values,
@@ -418,6 +428,7 @@ export async function embedMany({
           event: {
             callId,
             operationId: 'ai.embedMany',
+            runtimeContext,
             provider: model.provider,
             modelId: model.modelId,
             value: values,

package/src/embed/embed.ts

@@ -1,12 +1,13 @@
 import {
   createIdGenerator,
+  type Context,
   withUserAgentSuffix,
   type ProviderOptions,
 } from '@ai-sdk/provider-utils';
 import { InvalidResponseDataError } from '../error';
 import { logWarnings } from '../logger/log-warnings';
 import { resolveEmbeddingModel } from '../model/resolve-model';
-import { createTelemetryDispatcher } from '../telemetry/create-telemetry-dispatcher';
+import { createRestrictedTelemetryDispatcher } from './restricted-telemetry-dispatcher';
 import type { TelemetryOptions } from '../telemetry/telemetry-options';
 import type { EmbeddingModel } from '../types';
 import type { Callback } from '../util/callback';
@@ -32,6 +33,7 @@ const originalGenerateCallId = createIdGenerator({
  * @param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
  *
  * @param telemetry - Optional telemetry configuration.
+ * @param runtimeContext - User-defined runtime context passed to callbacks and, when explicitly included, telemetry.
  *
  * @param providerOptions - Additional provider-specific options. They are passed through
  * to the provider from the AI SDK and enable provider-specific
@@ -39,7 +41,7 @@ const originalGenerateCallId = createIdGenerator({
  *
  * @returns A result object that contains the embedding, the value, and additional information.
  */
-export async function embed({
+export async function embed<RUNTIME_CONTEXT extends Context = Context>({
   model: modelArg,
   value,
   providerOptions,
@@ -48,6 +50,7 @@ export async function embed({
   headers,
   experimental_telemetry,
   telemetry = experimental_telemetry,
+  runtimeContext = {} as RUNTIME_CONTEXT,
   onStart,
   experimental_onStart,
   onEnd,
@@ -92,20 +95,25 @@ export async function embed({
   /**
    * Optional telemetry configuration.
    */
-  telemetry?: TelemetryOptions;
+  telemetry?: TelemetryOptions<RUNTIME_CONTEXT>;
 
   /**
    * Optional telemetry configuration.
    *
    * @deprecated Use `telemetry` instead. This alias will be removed in a future major release.
    */
-  experimental_telemetry?: TelemetryOptions;
+  experimental_telemetry?: TelemetryOptions<RUNTIME_CONTEXT>;
+
+  /**
+   * User-defined runtime context. Treat runtime context as immutable.
+   */
+  runtimeContext?: RUNTIME_CONTEXT;
 
   /**
    * Callback that is called when the embed operation begins,
    * before the embedding model is called.
    */
-  onStart?: Callback<EmbedStartEvent>;
+  onStart?: Callback<EmbedStartEvent<RUNTIME_CONTEXT>>;
 
   /**
    * Callback that is called when the embed operation begins,
@@ -113,13 +121,13 @@ export async function embed({
    *
    * @deprecated Use `onStart` instead.
    */
-  experimental_onStart?: Callback<EmbedStartEvent>;
+  experimental_onStart?: Callback<EmbedStartEvent<RUNTIME_CONTEXT>>;
 
   /**
    * Callback that is called when the embed operation completes,
    * after the embedding model returns.
    */
-  onEnd?: Callback<EmbedEndEvent>;
+  onEnd?: Callback<EmbedEndEvent<RUNTIME_CONTEXT>>;
 
   /**
    * Callback that is called when the embed operation completes,
@@ -127,7 +135,7 @@ export async function embed({
    *
    * @deprecated Use `onEnd` instead.
    */
-  experimental_onEnd?: Callback<EmbedEndEvent>;
+  experimental_onEnd?: Callback<EmbedEndEvent<RUNTIME_CONTEXT>>;
 
   /**
    * Internal. For test use only. May change without notice.
@@ -152,7 +160,7 @@ export async function embed({
 
   const callId = generateCallId();
 
-  const telemetryDispatcher = createTelemetryDispatcher({
+  const telemetryDispatcher = createRestrictedTelemetryDispatcher({
     telemetry,
   });
 
@@ -164,6 +172,7 @@ export async function embed({
   const startEvent = {
     callId,
     operationId: 'ai.embed',
+    runtimeContext,
     provider: model.provider,
     modelId: model.modelId,
     value,
@@ -248,6 +257,7 @@ export async function embed({
           event: {
             callId,
             operationId: 'ai.embed',
+            runtimeContext,
             provider: model.provider,
             modelId: model.modelId,
             value,

package/src/embed/restricted-telemetry-dispatcher.ts

@@ -0,0 +1,44 @@
+import type { Context } from '@ai-sdk/provider-utils';
+import { createTelemetryDispatcher } from '../telemetry/create-telemetry-dispatcher';
+import { filterIncludedContext } from '../telemetry/filter-included-context';
+import type { TelemetryDispatcher } from '../telemetry/telemetry';
+import type { TelemetryOptions } from '../telemetry/telemetry-options';
+import type { Callback } from '../util/callback';
+import type { EmbedStartEvent, EmbedEndEvent } from './embed-events';
+
+/**
+ * Filters runtime context before sending operation events to telemetry integrations.
+ * User callbacks continue to receive the original context.
+ */
+export function createRestrictedTelemetryDispatcher<
+  RUNTIME_CONTEXT extends Context,
+>({
+  telemetry,
+}: {
+  telemetry?: TelemetryOptions<RUNTIME_CONTEXT>;
+}): Omit<TelemetryDispatcher, 'onStart' | 'onEnd'> & {
+  onStart: Callback<EmbedStartEvent<RUNTIME_CONTEXT>>;
+  onEnd: Callback<EmbedEndEvent<RUNTIME_CONTEXT>>;
+} {
+  const dispatcher = createTelemetryDispatcher({ telemetry });
+
+  return {
+    ...dispatcher,
+    onStart: event =>
+      dispatcher.onStart?.({
+        ...event,
+        runtimeContext: filterIncludedContext({
+          context: event.runtimeContext,
+          includeContext: telemetry?.includeRuntimeContext,
+        }),
+      }),
+    onEnd: event =>
+      dispatcher.onEnd?.({
+        ...event,
+        runtimeContext: filterIncludedContext({
+          context: event.runtimeContext,
+          includeContext: telemetry?.includeRuntimeContext,
+        }),
+      }),
+  };
+}

package/src/generate-image/generate-image.ts

@@ -381,7 +381,7 @@ class DefaultGenerateImageResult implements GenerateImageResult {
 /**
  * Extracts per-image metadata from the legacy `providerMetadata.<provider>.images` result shape.
  */
-function getImageProviderMetadata(
+export function getImageProviderMetadata(
   providerMetadata: ImageModelV4ProviderMetadata | undefined,
   imageIndex: number,
 ): Record<string, JSONObject> | undefined {
@@ -442,7 +442,7 @@ function addDecimalStrings(
       )}`.replace(/\.?0+$/, '');
 }
 
-function normalizePrompt(
+export function normalizePrompt(
   prompt: GenerateImagePrompt,
 ): Pick<ImageModelV4CallOptions, 'prompt' | 'files' | 'mask'> {
   if (typeof prompt === 'string') {

package/src/generate-text/restricted-telemetry-dispatcher.ts

@@ -4,6 +4,7 @@ import type {
   InferToolSetContext,
   ToolSet,
 } from '@ai-sdk/provider-utils';
+import { filterIncludedContext } from '../telemetry/filter-included-context';
 import { createTelemetryDispatcher } from '../telemetry/create-telemetry-dispatcher';
 import type { TelemetryDispatcher } from '../telemetry/telemetry';
 import type {
@@ -56,28 +57,6 @@ export type RestrictedTelemetryDispatcher<
   onToolExecutionEnd?: OnToolExecutionEndCallback<TOOLS>;
 };
 
-/**
- * Returns a shallow copy of the runtime context with only top-level
- * properties marked for telemetry inclusion.
- */
-function filterIncludedContext<CONTEXT extends Context>({
-  context,
-  includeContext,
-}: {
-  context: CONTEXT;
-  includeContext: IncludedContext<CONTEXT>;
-}): Context {
-  if (context == null) {
-    return {};
-  }
-
-  return Object.fromEntries(
-    Object.entries(context).filter(
-      ([key]) => includeContext?.[key as keyof CONTEXT] === true,
-    ),
-  );
-}
-
 /**
  * Creates a copy of a step result whose runtime context only contains
  * top-level properties marked for telemetry inclusion.

package/src/rerank/rerank-events.ts

@@ -1,5 +1,5 @@
 import type { JSONObject } from '@ai-sdk/provider';
-import type { ProviderOptions } from '@ai-sdk/provider-utils';
+import type { Context, ProviderOptions } from '@ai-sdk/provider-utils';
 import type { ProviderMetadata } from '../types';
 import type { Warning } from '../types/warning';
 
@@ -8,7 +8,10 @@ import type { Warning } from '../types/warning';
  *
  * Called when the operation begins, before the reranking model is called.
  */
-export type RerankStartEvent = {
+export type RerankStartEvent<RUNTIME_CONTEXT extends Context = Context> = {
+  /** User-defined runtime context. */
+  readonly runtimeContext: RUNTIME_CONTEXT;
+
   /** Unique identifier for this rerank call, used to correlate events. */
   readonly callId: string;
 
@@ -43,7 +46,10 @@ export type RerankStartEvent = {
  *
  * Called when the operation completes, after the reranking model returns.
  */
-export type RerankEndEvent = {
+export type RerankEndEvent<RUNTIME_CONTEXT extends Context = Context> = {
+  /** User-defined runtime context. */
+  readonly runtimeContext: RUNTIME_CONTEXT;
+
   /** Unique identifier for this rerank call, used to correlate events. */
   readonly callId: string;