ai 7.0.127 → 7.0.129

package/src/logger/deprecations.ts

@@ -0,0 +1,72 @@
+// These codes are stable identifiers. Do not rename or reuse an existing code.
+const deprecationCodes = new Map<string, string>([
+  ['generateObject', 'AISDK_DEP_GENERATE_OBJECT'],
+  ['streamObject', 'AISDK_DEP_STREAM_OBJECT'],
+  ['experimental_generateSpeech', 'AISDK_DEP_EXPERIMENTAL_GENERATE_SPEECH'],
+  ['experimental_transcribe', 'AISDK_DEP_EXPERIMENTAL_TRANSCRIBE'],
+  ['"image" content part', 'AISDK_DEP_IMAGE_CONTENT_PART'],
+  [
+    '"tool-result" content of type "file-data"',
+    'AISDK_DEP_TOOL_RESULT_FILE_DATA',
+  ],
+  [
+    '"tool-result" content of type "file-url"',
+    'AISDK_DEP_TOOL_RESULT_FILE_URL',
+  ],
+  ['"tool-result" content of type "file-id"', 'AISDK_DEP_TOOL_RESULT_FILE_ID'],
+  [
+    '"tool-result" content of type "file-reference"',
+    'AISDK_DEP_TOOL_RESULT_FILE_REFERENCE',
+  ],
+  [
+    '"tool-result" content of type "image-data"',
+    'AISDK_DEP_TOOL_RESULT_IMAGE_DATA',
+  ],
+  [
+    '"tool-result" content of type "image-url"',
+    'AISDK_DEP_TOOL_RESULT_IMAGE_URL',
+  ],
+  [
+    '"tool-result" content of type "image-file-id"',
+    'AISDK_DEP_TOOL_RESULT_IMAGE_FILE_ID',
+  ],
+  [
+    '"tool-result" content of type "image-file-reference"',
+    'AISDK_DEP_TOOL_RESULT_IMAGE_FILE_REFERENCE',
+  ],
+  [
+    'rawInput in output-error UI message parts',
+    'AISDK_DEP_UI_MESSAGE_RAW_INPUT',
+  ],
+]);
+
+/**
+ * Escape punctuation and UTF-16 code units without losing case or collapsing
+ * distinct settings. Underscores are escaped too, so `__` separates code parts.
+ */
+function encodeCodePart(value: string): string {
+  return value.replace(
+    /[^a-zA-Z0-9]/g,
+    character =>
+      `_${character.charCodeAt(0).toString(16).toUpperCase().padStart(4, '0')}`,
+  );
+}
+
+export function getDeprecationCode({
+  setting,
+  provider,
+}: {
+  setting: string;
+  provider?: string;
+}): string {
+  if (provider == null) {
+    return (
+      deprecationCodes.get(setting) ??
+      `AISDK_DEP_SETTING_${encodeCodePart(setting)}`
+    );
+  }
+
+  // Provider codes are scoped to the provider, but not to a particular model or
+  // message. This works for third-party providers without changing their spec.
+  return `AISDK_DEP_PROVIDER_${encodeCodePart(provider)}__${encodeCodePart(setting)}`;
+}

package/src/logger/log-warnings.ts

@@ -1,4 +1,5 @@
 import type { Warning } from '../types';
+import { getDeprecationCode } from './deprecations';
 
 /**
  * A function for logging warnings.
@@ -87,21 +88,24 @@ export const FIRST_WARNING_INFO_MESSAGE =
   'AI SDK Warning System: To turn off warning logging, set the AI_SDK_LOG_WARNINGS global to false.';
 
 let hasLoggedBefore = false;
+const emittedDeprecationCodes = new Set<string>();
 
 function emitWarning({
   message,
   type,
+  code,
 }: {
   message: string;
   type: 'DeprecationWarning' | 'Warning';
+  code?: string;
 }) {
   if (
     typeof process !== 'undefined' &&
     typeof process.emitWarning === 'function'
   ) {
-    process.emitWarning(message, { type });
+    process.emitWarning(message, code == null ? { type } : { type, code });
   } else {
-    console.warn(message);
+    console.warn(code == null ? message : `[${code}] ${message}`);
   }
 }
 
@@ -111,7 +115,9 @@ function emitWarning({
  * The behavior can be customized via the `AI_SDK_LOG_WARNINGS` global variable:
  * - If set to `false`, warnings are suppressed.
  * - If set to a function, that function is called with the warnings.
- * - Otherwise, warnings are logged to the console using `console.warn`.
+ * - Otherwise, warnings use `process.emitWarning` when available, falling back
+ *   to `console.warn`. Deprecations have stable codes and are emitted once per
+ *   code by the default logger. Custom loggers receive every warning.
  *
  * @param options - The options containing warnings and context.
  * @param options.warnings - The warnings to log.
@@ -148,6 +154,20 @@ export const logWarnings: LogWarningsFunction = options => {
 
   // default behavior: log warnings via process.emitWarning if available, otherwise console.warn
   for (const warning of options.warnings) {
+    const code =
+      warning.type === 'deprecated'
+        ? getDeprecationCode({
+            setting: warning.setting,
+            provider: options.provider,
+          })
+        : undefined;
+    if (code != null) {
+      if (emittedDeprecationCodes.has(code)) {
+        continue;
+      }
+      emittedDeprecationCodes.add(code);
+    }
+
     const message = formatWarning({
       warning,
       provider: options.provider,
@@ -156,6 +176,7 @@ export const logWarnings: LogWarningsFunction = options => {
     emitWarning({
       message,
       type: warning.type === 'deprecated' ? 'DeprecationWarning' : 'Warning',
+      code,
     });
   }
 };
@@ -165,4 +186,5 @@ export const logWarnings: LogWarningsFunction = options => {
  */
 export const resetLogWarningsState = () => {
   hasLoggedBefore = false;
+  emittedDeprecationCodes.clear();
 };

package/src/middleware/extract-reasoning-middleware.ts

@@ -3,14 +3,16 @@ import type {
   LanguageModelV4StreamPart,
 } from '@ai-sdk/provider';
 import type { LanguageModelMiddleware } from '../types/language-model-middleware';
+import { InvalidArgumentError } from '../error/invalid-argument-error';
 import { createIdMap } from '../util/create-id-map';
 import { getPotentialStartIndex } from '../util/get-potential-start-index';
 
 /**
- * Extracts an XML-tagged reasoning section from the generated text and exposes it
+ * Extracts a delimited reasoning section from the generated text and exposes it
  * as a `reasoning` property on the result.
  *
- * @param tagName - The name of the XML tag to extract reasoning from.
+ * @param tagName - An XML tag name (without angle brackets), or literal opening
+ * and closing delimiters for formats such as Gemma's thought channel.
  * @param separator - The separator to use between reasoning and text sections.
  * @param startWithReasoning - Whether to start with reasoning tokens.
  */
@@ -19,12 +21,26 @@ export function extractReasoningMiddleware({
   separator = '\n',
   startWithReasoning = false,
 }: {
-  tagName: string;
+  tagName: string | { opening: string; closing: string };
   separator?: string;
   startWithReasoning?: boolean;
 }): LanguageModelMiddleware {
-  const openingTag = `<${tagName}>`;
-  const closingTag = `</${tagName}>`;
+  const openingTag =
+    typeof tagName === 'string' ? `<${tagName}>` : tagName.opening;
+  const closingTag =
+    typeof tagName === 'string' ? `</${tagName}>` : tagName.closing;
+
+  if (openingTag.length === 0 || closingTag.length === 0) {
+    throw new InvalidArgumentError({
+      parameter: 'tagName',
+      value: tagName,
+      message: 'Reasoning delimiters must not be empty.',
+    });
+  }
+
+  // Delimiters are literal strings, including regex metacharacters such as `|`.
+  const escapedOpeningTag = openingTag.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+  const escapedClosingTag = closingTag.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
 
   return {
     specificationVersion: 'v4',
@@ -40,7 +56,10 @@ export function extractReasoningMiddleware({
 
         const text = startWithReasoning ? openingTag + part.text : part.text;
 
-        const regexp = new RegExp(`${openingTag}(.*?)${closingTag}`, 'gs');
+        const regexp = new RegExp(
+          `${escapedOpeningTag}(.*?)${escapedClosingTag}`,
+          'gs',
+        );
         const matches = Array.from(text.matchAll(regexp));
 
         if (!matches.length) {

package/src/model/as-language-model-v3.ts

@@ -99,5 +99,9 @@ function convertV2UsageToV3(usage: LanguageModelV2Usage): LanguageModelV3Usage {
       text: undefined,
       reasoning: usage.reasoningTokens,
     },
+    raw:
+      usage.totalTokens == null
+        ? undefined
+        : { totalTokens: usage.totalTokens },
   };
 }

package/src/model/resolve-model.ts

@@ -1,7 +1,7 @@
 import { gateway } from '@ai-sdk/gateway';
 import {
   NoSuchModelError,
-  type Experimental_EvaluationModelV4 as EvaluationModelV4,
+  type Experimental_DecisionModelV4 as DecisionModelV4,
   type EmbeddingModelV4,
   type Experimental_SpeechTranslationModelV4,
   type Experimental_VideoModelV4,
@@ -12,8 +12,8 @@ import {
   type SpeechModelV4,
   type TranscriptionModelV4,
 } from '@ai-sdk/provider';
-import type { EvaluationModel } from '../evaluate/evaluation-result';
-import type { EvaluationProvider } from '../evaluate/evaluation-provider';
+import type { DecisionModel } from '../decide/decision-result';
+import type { DecisionProvider } from '../decide/decision-provider';
 import { UnsupportedModelVersionError } from '../error';
 import type { EmbeddingModel } from '../types/embedding-model';
 import type { LanguageModel } from '../types/language-model';
@@ -217,29 +217,30 @@ export function resolveRerankingModel(model: RerankingModel): RerankingModelV4 {
   return asRerankingModelV4(model);
 }
 
-export function resolveEvaluationModel(
-  model: EvaluationModel,
-): EvaluationModelV4 {
+export function resolveDecisionModel(model: DecisionModel): DecisionModelV4 {
   if (typeof model === 'string') {
     // Use the original provider so experimental methods and their receiver survive.
     const provider = (globalThis.AI_SDK_DEFAULT_PROVIDER ??
-      gateway) as EvaluationProvider;
+      gateway) as DecisionProvider;
 
-    if (typeof provider?.evaluationModel !== 'function') {
+    const factory:
+      | ((modelId: string) => Exclude<DecisionModel, string>)
+      | undefined = provider.decisionModel ?? provider.evaluationModel;
+    if (typeof factory !== 'function') {
       throw new NoSuchModelError({
         modelId: model,
-        modelType: 'evaluationModel',
+        modelType: 'decisionModel',
         message:
-          'The default provider does not support evaluation models. ' +
-          'Pass an evaluation model instance or configure AI_SDK_DEFAULT_PROVIDER with an evaluationModel method.',
+          'The default provider does not support decision models. ' +
+          'Pass a decision model instance or configure AI_SDK_DEFAULT_PROVIDER with a decisionModel method.',
       });
     }
 
-    const resolvedModel = provider.evaluationModel(model);
+    const resolvedModel = factory.call(provider, model);
     if (resolvedModel == null) {
       throw new NoSuchModelError({
         modelId: model,
-        modelType: 'evaluationModel',
+        modelType: 'decisionModel',
       });
     }
     model = resolvedModel;
@@ -253,10 +254,40 @@ export function resolveEvaluationModel(
     });
   }
 
-  return model;
+  if ('doDecide' in model) {
+    return model;
+  }
+
+  const legacyModel = model;
+  return {
+    specificationVersion: legacyModel.specificationVersion,
+    provider: legacyModel.provider,
+    modelId: legacyModel.modelId,
+    supportedQuestionTypes: legacyModel.supportedQuestionTypes,
+    doDecide: options => legacyModel.doEvaluate(options),
+  };
 }
 
 function getGlobalProvider(): ProviderV4 {
   const provider = globalThis.AI_SDK_DEFAULT_PROVIDER ?? gateway;
   return asProviderV4(provider);
 }
+
+/** Internal adapter for deprecated provider factories. */
+export function asEvaluationModel(model: DecisionModelV4): DecisionModelV4 & {
+  doEvaluate: DecisionModelV4['doDecide'];
+} {
+  if ('doEvaluate' in model && typeof model.doEvaluate === 'function') {
+    return model as DecisionModelV4 & {
+      doEvaluate: DecisionModelV4['doDecide'];
+    };
+  }
+  return {
+    specificationVersion: model.specificationVersion,
+    provider: model.provider,
+    modelId: model.modelId,
+    supportedQuestionTypes: model.supportedQuestionTypes,
+    doDecide: options => model.doDecide(options),
+    doEvaluate: options => model.doDecide(options),
+  };
+}

package/src/prompt/convert-to-language-model-prompt.ts

@@ -123,7 +123,13 @@ export async function convertToLanguageModelPrompt({
       }
 
       lastCombinedMessage.content.push(...message.content);
-      lastCombinedMessage.providerOptions = message.providerOptions;
+      lastCombinedMessage.providerOptions =
+        lastContentPart == null
+          ? mergeObjects(
+              lastCombinedMessage.providerOptions,
+              message.providerOptions,
+            )
+          : message.providerOptions;
     } else {
       combinedMessages.push(message);
     }

package/src/realtime/encode-realtime-frame.ts

@@ -3,14 +3,19 @@ export const REALTIME_MAX_FRAME_BYTES = 128 * 1024;
 export const REALTIME_MAX_BUFFERED_BYTES = 128 * 1024;
 
 export type EncodedRealtimeFrame = {
-  data: string | ArrayBuffer | ArrayBufferView | Blob;
+  data: string | ArrayBuffer | ArrayBufferView<ArrayBuffer> | Blob;
   byteLength: number;
 };
 
 /** Serialize once, measuring the exact payload passed to the browser. */
 export function encodeRealtimeFrame(value: unknown): EncodedRealtimeFrame {
-  if (value instanceof ArrayBuffer || ArrayBuffer.isView(value))
+  if (value instanceof ArrayBuffer)
     return { data: value, byteLength: value.byteLength };
+  if (ArrayBuffer.isView(value))
+    return {
+      data: value as ArrayBufferView<ArrayBuffer>,
+      byteLength: value.byteLength,
+    };
   if (value instanceof Blob) return { data: value, byteLength: value.size };
   const data = typeof value === 'string' ? value : JSON.stringify(value);
   if (data === undefined)

package/src/registry/custom-provider.ts

@@ -1,5 +1,5 @@
 import {
-  type Experimental_EvaluationModelV4 as EvaluationModelV4,
+  type Experimental_DecisionModelV4 as DecisionModelV4,
   type EmbeddingModelV4,
   type Experimental_VideoModelV3,
   type Experimental_VideoModelV4,
@@ -15,8 +15,8 @@ import {
   type SpeechModelV4,
   type TranscriptionModelV4,
 } from '@ai-sdk/provider';
-import type { EvaluationModel } from '../evaluate/evaluation-result';
-import type { EvaluationProvider } from '../evaluate/evaluation-provider';
+import type { DecisionModel } from '../decide/decision-result';
+import type { DecisionProvider } from '../decide/decision-provider';
 import { asProviderV4 } from '../model/as-provider-v4';
 import {
   resolveEmbeddingModel,
@@ -26,7 +26,8 @@ import {
   resolveSpeechModel,
   resolveTranscriptionModel,
   resolveVideoModel,
-  resolveEvaluationModel,
+  resolveDecisionModel,
+  asEvaluationModel,
 } from '../model/resolve-model';
 import type { EmbeddingModel } from '../types/embedding-model';
 import type { ImageModel } from '../types/image-model';
@@ -53,7 +54,7 @@ type ProviderWithOptionalVideoModel = {
  * @param {Record<string, SpeechModel>} [options.speechModels] - A record of speech models, where keys are model IDs and values are speech model instances.
  * @param {Record<string, RerankingModel>} [options.rerankingModels] - A record of reranking models, where keys are model IDs and values are reranking model instances.
  * @param {Record<string, VideoModel>} [options.videoModels] - A record of video models, where keys are model IDs and values are video model instances.
- * @param {Record<string, EvaluationModel>} [options.evaluationModels] - Experimental evaluation models or default-provider model IDs, keyed by alias.
+ * @param {Record<string, DecisionModel>} [options.decisionModels] - Experimental decision models or default-provider model IDs, keyed by alias.
  * @param {FilesV4} [options.files] - A files interface for uploading files.
  * @param {SkillsV4} [options.skills] - A skills interface for uploading skills.
  * @param {ProviderV2 | ProviderV3 | ProviderV4} [options.fallbackProvider] - An optional fallback provider to use when a requested model is not found in the custom provider.
@@ -72,9 +73,9 @@ export function customProvider<
   FILES extends FilesV4 | undefined = undefined,
   SKILLS extends SkillsV4 | undefined = undefined,
   FALLBACK extends ProviderV2 | ProviderV3 | ProviderV4 | undefined = undefined,
-  EVALUATION_MODELS extends Record<string, EvaluationModel> = Record<
+  DECISION_MODELS extends Record<string, DecisionModel> = Record<
     string,
-    EvaluationModel
+    DecisionModel
   >,
 >({
   languageModels,
@@ -84,6 +85,7 @@ export function customProvider<
   speechModels,
   rerankingModels,
   videoModels,
+  decisionModels: decisionModelsArg,
   evaluationModels,
   files,
   skills,
@@ -96,7 +98,9 @@ export function customProvider<
   speechModels?: SPEECH_MODELS;
   rerankingModels?: RERANKING_MODELS;
   videoModels?: VIDEO_MODELS;
-  evaluationModels?: EVALUATION_MODELS;
+  decisionModels?: DECISION_MODELS;
+  /** @deprecated Use `decisionModels` instead. When both are set, `decisionModels` takes precedence. */
+  evaluationModels?: DECISION_MODELS;
   files?: FILES;
   skills?: SKILLS;
   fallbackProvider?: FALLBACK;
@@ -110,9 +114,11 @@ export function customProvider<
   rerankingModel(modelId: ExtractModelId<RERANKING_MODELS>): RerankingModelV4;
   speechModel(modelId: ExtractModelId<SPEECH_MODELS>): SpeechModelV4;
   videoModel(modelId: ExtractModelId<VIDEO_MODELS>): Experimental_VideoModelV4;
-  evaluationModel(
-    modelId: ExtractModelId<EVALUATION_MODELS>,
-  ): EvaluationModelV4;
+  decisionModel(modelId: ExtractModelId<DECISION_MODELS>): DecisionModelV4;
+  /** @deprecated Use `decisionModel` instead. */
+  evaluationModel(modelId: ExtractModelId<DECISION_MODELS>): DecisionModelV4 & {
+    doEvaluate: DecisionModelV4['doDecide'];
+  };
 } & (FILES extends FilesV4
     ? { files(): FilesV4 }
     : [FALLBACK] extends [{ files: () => FilesV4 }]
@@ -123,6 +129,7 @@ export function customProvider<
     : [FALLBACK] extends [{ skills: () => SkillsV4 }]
       ? { skills(): SkillsV4 }
       : { skills?(): SkillsV4 }) {
+  const decisionModels = decisionModelsArg ?? evaluationModels;
   const fallbackProvider =
     fallbackProviderArg == null ? undefined : asProviderV4(fallbackProviderArg);
 
@@ -138,9 +145,13 @@ export function customProvider<
     videoModel(
       modelId: ExtractModelId<VIDEO_MODELS>,
     ): Experimental_VideoModelV4;
+    decisionModel(modelId: ExtractModelId<DECISION_MODELS>): DecisionModelV4;
+    /** @deprecated Use `decisionModel` instead. */
     evaluationModel(
-      modelId: ExtractModelId<EVALUATION_MODELS>,
-    ): EvaluationModelV4;
+      modelId: ExtractModelId<DECISION_MODELS>,
+    ): DecisionModelV4 & {
+      doEvaluate: DecisionModelV4['doDecide'];
+    };
   } = {
     specificationVersion: 'v4',
     languageModel(modelId: ExtractModelId<LANGUAGE_MODELS>): LanguageModelV4 {
@@ -227,25 +238,26 @@ export function customProvider<
 
       throw new NoSuchModelError({ modelId, modelType: 'rerankingModel' });
     },
-    evaluationModel(
-      modelId: ExtractModelId<EVALUATION_MODELS>,
-    ): EvaluationModelV4 {
-      if (
-        evaluationModels != null &&
-        Object.hasOwn(evaluationModels, modelId)
-      ) {
-        return resolveEvaluationModel(evaluationModels[modelId]);
+    decisionModel(modelId: ExtractModelId<DECISION_MODELS>): DecisionModelV4 {
+      if (decisionModels != null && Object.hasOwn(decisionModels, modelId)) {
+        return resolveDecisionModel(decisionModels[modelId]);
       }
 
-      const provider = fallbackProviderArg as EvaluationProvider | undefined;
-      if (typeof provider?.evaluationModel === 'function') {
-        const model = provider.evaluationModel(modelId);
+      const provider = fallbackProviderArg as DecisionProvider | undefined;
+      const factory:
+        | ((modelId: string) => Exclude<DecisionModel, string>)
+        | undefined = provider?.decisionModel ?? provider?.evaluationModel;
+      if (typeof factory === 'function') {
+        const model = factory.call(provider, modelId);
         if (model != null) {
-          return resolveEvaluationModel(model);
+          return resolveDecisionModel(model);
         }
       }
 
-      throw new NoSuchModelError({ modelId, modelType: 'evaluationModel' });
+      throw new NoSuchModelError({ modelId, modelType: 'decisionModel' });
+    },
+    evaluationModel(modelId: ExtractModelId<DECISION_MODELS>) {
+      return asEvaluationModel(this.decisionModel(modelId));
     },
     videoModel(
       modelId: ExtractModelId<VIDEO_MODELS>,

package/src/registry/index.ts

@@ -1,3 +1,6 @@
+import type { ProviderV3, ProviderV4 } from '@ai-sdk/provider';
+import type { DecisionProviderRegistry } from './provider-registry';
+
 export { customProvider } from './custom-provider';
 export { NoSuchProviderError } from './no-such-provider-error';
 export {
@@ -6,4 +9,13 @@ export {
 } from './provider-registry';
 export type { ProviderRegistryProvider } from './provider-registry';
 
-export type { EvaluationProviderRegistry as Experimental_EvaluationProviderRegistry } from './provider-registry';
+export type { DecisionProviderRegistry as Experimental_DecisionProviderRegistry } from './provider-registry';
+
+/** @deprecated Use `Experimental_DecisionProviderRegistry` instead. */
+export type Experimental_EvaluationProviderRegistry<
+  PROVIDERS extends Record<string, ProviderV4 | ProviderV3> = Record<
+    string,
+    ProviderV4 | ProviderV3
+  >,
+  SEPARATOR extends string = ':',
+> = DecisionProviderRegistry<PROVIDERS, SEPARATOR>;

package/src/registry/no-such-provider-error.ts

@@ -26,6 +26,8 @@ export class NoSuchProviderError extends NoSuchModelError {
       | 'speechModel'
       | 'rerankingModel'
       | 'videoModel'
+      | 'decisionModel'
+      /** @deprecated Use `decisionModel` instead. */
       | 'evaluationModel';
     providerId: string;
     availableProviders: string[];