ai 7.0.127 → 7.0.129

package/src/ui/process-ui-message-stream.ts

@@ -120,6 +120,7 @@ export function processUIMessageStream<UI_MESSAGE extends UIMessage>({
   onError,
   onToolCall,
   onData,
+  resetStateOnMessageIdChange = false,
 }: {
   // input stream is not fully typed yet:
   stream: ReadableStream<UIMessageChunk>;
@@ -136,6 +137,8 @@ export function processUIMessageStream<UI_MESSAGE extends UIMessage>({
     }) => Promise<void>,
   ) => Promise<void>;
   onError: ErrorHandler;
+  // During resume, a different message ID identifies a separate response.
+  resetStateOnMessageIdChange?: boolean;
 }): ReadableStream<InferUIMessageChunk<UI_MESSAGE>> {
   return stream.pipeThrough(
     new TransformStream<UIMessageChunk, InferUIMessageChunk<UI_MESSAGE>>({
@@ -953,6 +956,24 @@ export function processUIMessageStream<UI_MESSAGE extends UIMessage>({
             }
 
             case 'start': {
+              if (
+                resetStateOnMessageIdChange &&
+                chunk.messageId != null &&
+                chunk.messageId !== state.message.id
+              ) {
+                // Start the separate response with empty parts and metadata.
+                // Reset the active-part maps too, so earlier chunks stay with
+                // the previous response. Keep the state object for its callers.
+                Object.assign(
+                  state,
+                  createStreamingUIMessageState({
+                    lastMessage: undefined,
+                    messageId: chunk.messageId,
+                  }),
+                  { finishReason: undefined },
+                );
+              }
+
               if (chunk.messageId != null) {
                 state.message.id = chunk.messageId;
               }

package/src/ui/text-stream-chat-transport.ts

@@ -17,7 +17,9 @@ export class TextStreamChatTransport<
     stream: ReadableStream<Uint8Array<ArrayBufferLike>>,
   ): ReadableStream<UIMessageChunk> {
     return transformTextToUiMessageStream({
-      stream: stream.pipeThrough(new TextDecoderStream()),
+      stream: stream.pipeThrough(
+        new TextDecoderStream() as ReadableWritablePair<string, Uint8Array>,
+      ),
     });
   }
 }

package/src/ui/ui-messages.ts

@@ -421,6 +421,14 @@ export type ToolUIPart<TOOLS extends UITools = UITools> = ValueOf<{
 export type DynamicToolUIPart = {
   type: 'dynamic-tool';
 
+  /**
+   * `false` when a static tool part was normalized to a dynamic tool part
+   * because its current tool schema was unavailable or incompatible.
+   *
+   * This preserves its static origin across persistence boundaries.
+   */
+  dynamic?: false;
+
   /**
    * Name of the tool that is being called.
    */

package/src/ui/unavailable-tool.ts

@@ -0,0 +1,17 @@
+import type { DynamicToolUIPart, ToolUIPart } from './ui-messages';
+
+export function markToolPartAsUnavailable(
+  part: DynamicToolUIPart,
+): DynamicToolUIPart {
+  // Preserve the static tool's provenance across persistence boundaries so
+  // model-message conversion never falls back to its unfiltered raw output.
+  part.dynamic = false;
+
+  return part;
+}
+
+export function isToolPartFromUnavailableTool(
+  part: ToolUIPart | DynamicToolUIPart,
+): boolean {
+  return part.type === 'dynamic-tool' && part.dynamic === false;
+}

package/src/ui/validate-ui-messages.ts

@@ -22,6 +22,7 @@ import type {
   ToolUIPart,
   UIMessage,
 } from './ui-messages';
+import { markToolPartAsUnavailable } from './unavailable-tool';
 import { warnIfUIMessageHasDeprecatedRawInput } from './warn-if-ui-message-has-deprecated-raw-input';
 
 const toolMetadataSchema: ZodType<JSONObject> = z.record(
@@ -43,11 +44,11 @@ function isEmptyObject(value: unknown): value is Record<string, never> {
 function asDynamicToolPart(toolPart: ToolUIPart): DynamicToolUIPart {
   const { type, ...part } = toolPart;
 
-  return {
+  return markToolPartAsUnavailable({
     ...part,
     type: 'dynamic-tool',
     toolName: type.slice(5),
-  } as DynamicToolUIPart;
+  } as DynamicToolUIPart);
 }
 
 function getToolPartInputSchemaInput(
@@ -148,6 +149,7 @@ const uiMessagesSchema = lazySchema(() => {
                 }),
                 z.object({
                   type: z.literal('dynamic-tool'),
+                  dynamic: z.literal(false).optional(),
                   toolName: z.string(),
                   toolCallId: z.string(),
                   title: z.string().optional(),
@@ -163,6 +165,7 @@ const uiMessagesSchema = lazySchema(() => {
                 }),
                 z.object({
                   type: z.literal('dynamic-tool'),
+                  dynamic: z.literal(false).optional(),
                   toolName: z.string(),
                   toolCallId: z.string(),
                   title: z.string().optional(),
@@ -177,6 +180,7 @@ const uiMessagesSchema = lazySchema(() => {
                 }),
                 z.object({
                   type: z.literal('dynamic-tool'),
+                  dynamic: z.literal(false).optional(),
                   toolName: z.string(),
                   toolCallId: z.string(),
                   title: z.string().optional(),
@@ -191,6 +195,7 @@ const uiMessagesSchema = lazySchema(() => {
                 }),
                 z.object({
                   type: z.literal('dynamic-tool'),
+                  dynamic: z.literal(false).optional(),
                   toolName: z.string(),
                   toolCallId: z.string(),
                   title: z.string().optional(),
@@ -205,6 +210,7 @@ const uiMessagesSchema = lazySchema(() => {
                 }),
                 z.object({
                   type: z.literal('dynamic-tool'),
+                  dynamic: z.literal(false).optional(),
                   toolName: z.string(),
                   toolCallId: z.string(),
                   title: z.string().optional(),
@@ -221,6 +227,7 @@ const uiMessagesSchema = lazySchema(() => {
                 }),
                 z.object({
                   type: z.literal('dynamic-tool'),
+                  dynamic: z.literal(false).optional(),
                   toolName: z.string(),
                   toolCallId: z.string(),
                   title: z.string().optional(),
@@ -237,6 +244,7 @@ const uiMessagesSchema = lazySchema(() => {
                 }),
                 z.object({
                   type: z.literal('dynamic-tool'),
+                  dynamic: z.literal(false).optional(),
                   toolName: z.string(),
                   toolCallId: z.string(),
                   title: z.string().optional(),

package/docs/07-reference/01-ai-sdk-core/14-evaluate.mdx

@@ -1,74 +0,0 @@
----
-title: experimental_evaluate
-description: Evaluate typed questions against shared state with an evaluation model.
----
-
-# `experimental_evaluate()`
-
-```ts
-import { experimental_evaluate } from 'ai';
-```
-
-Evaluates a nonempty map of `choice`, `score`, and `boolean` questions against one
-state. See [Evaluation](/docs/ai-sdk-core/evaluation) for examples and semantics.
-
-## Parameters
-
-| Parameter         | Type                                               | Description                                                                                                                                 |
-| ----------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
-| `model`           | `Experimental_EvaluationModel`                     | Required experimental v4 model instance or a string ID resolved by Gateway or an explicitly configured evaluation-capable default provider. |
-| `state`           | `string \| object \| array`                        | Required JSON-compatible shared state.                                                                                                      |
-| `questions`       | `Record<string, Experimental_EvaluationQuestion>`  | Required nonempty question map.                                                                                                             |
-| `maxRetries`      | `number`                                           | Nonnegative integer; defaults to 2.                                                                                                         |
-| `abortSignal`     | `AbortSignal`                                      | Cancels evaluation.                                                                                                                         |
-| `headers`         | `Record<string, string>`                           | Additional HTTP headers.                                                                                                                    |
-| `providerOptions` | `ProviderOptions`                                  | Provider-specific options.                                                                                                                  |
-| `telemetry`       | `TelemetryOptions`                                 | Telemetry configuration, including per-call integrations, input/output recording, and a function ID.                                        |
-| `runtimeContext`  | `Record<string, unknown>`                          | Context available to lifecycle callbacks and selectively included in telemetry with `telemetry.includeRuntimeContext`.                      |
-| `onStart`         | `(event: Experimental_EvaluateStartEvent) => void` | Called when the evaluation operation begins.                                                                                                |
-| `onEnd`           | `(event: Experimental_EvaluateEndEvent) => void`   | Called when the evaluation operation completes successfully.                                                                                |
-
-See [Lifecycle Callbacks](/docs/ai-sdk-core/lifecycle-callbacks#experimental_evaluate)
-for the complete `onStart` and `onEnd` event fields.
-
-## Result
-
-Returns `Promise<Experimental_EvaluationResult<QUESTIONS>>`:
-
-- `answers`: One typed answer per question ID, with literal Choice option inference.
-- `usage`: `inputTokens`, `outputTokens`, and `totalTokens`, each possibly undefined.
-- `warnings`: Provider warnings, also passed to the SDK warning logger.
-- `rounding`: Optional provider-declared decimal precision for probabilities and scores.
-- `providerMetadata`: Optional provider-specific metadata.
-- `response`: Timestamp, model ID, and optional response ID, headers, and body.
-
-## Provider specification
-
-`Experimental_EvaluationModelV4` is exported from `@ai-sdk/provider` and declares
-`specificationVersion: 'v4'`, `provider`, `modelId`, `supportedQuestionTypes`, and
-`doEvaluate(options)`. Evaluation is isolated from stable `ProviderV4`.
-
-The public core types are `Experimental_EvaluationModel`,
-`Experimental_EvaluationQuestion`, `Experimental_EvaluationAnswer`, and
-`Experimental_EvaluationResult`. All evaluation-specific classes use the
-`Evaluation` prefix, with `Experimental_` aliases at package boundaries.
-
-## Errors
-
-Unsupported types throw `Experimental_EvaluationUnsupportedQuestionTypeError`
-before provider I/O. Invalid inputs throw `InvalidArgumentError`; malformed
-answers throw `InvalidResponseDataError`. Invalid answers are not retried.
-Neither partial results nor missing probability synthesis are supported.
-
-## Model resolution
-
-Use `registry.evaluationModel('provider:model')` or
-`customProvider({ evaluationModels: { alias: model } }).evaluationModel('alias')`
-to resolve models. Strings passed directly to `experimental_evaluate` use
-`globalThis.AI_SDK_DEFAULT_PROVIDER.evaluationModel(id)`, when available. Evaluation
-never implicitly falls back to Gateway.
-
-Resolution errors use the existing `NoSuchModelError` and `NoSuchProviderError`
-classes with `modelType: 'evaluationModel'`. Model instances and resolved models
-must implement v4; other versions throw `UnsupportedModelVersionError`.
-See [model resolution examples](/docs/ai-sdk-core/evaluation#model-aliases-and-registries).

package/docs/07-reference/05-ai-sdk-errors/ai-evaluation-unsupported-question-type-error.mdx

@@ -1,31 +0,0 @@
----
-title: AI_EvaluationUnsupportedQuestionTypeError
-description: Identify an evaluation question type that a model does not support.
----
-
-# AI_EvaluationUnsupportedQuestionTypeError
-
-This experimental error identifies a question whose type is unsupported by an
-evaluation model. It is exported from `ai` and `@ai-sdk/provider` as
-`Experimental_EvaluationUnsupportedQuestionTypeError`.
-
-## Properties
-
-- `questionId`: The ID of the unsupported question.
-- `questionType`: The requested question type.
-- `provider`: The provider of the evaluation model.
-- `modelId`: The evaluation model ID.
-- `message`: A description of the unsupported question and model. Providers can
-  supply a custom message.
-
-## Checking for this Error
-
-Use the marker-based `isInstance` check, which works across package copies:
-
-```typescript
-import { Experimental_EvaluationUnsupportedQuestionTypeError as EvaluationUnsupportedQuestionTypeError } from 'ai';
-
-if (EvaluationUnsupportedQuestionTypeError.isInstance(error)) {
-  console.log(error.questionId, error.questionType, error.modelId);
-}
-```

package/src/evaluate/evaluate-events.ts

@@ -1,131 +0,0 @@
-import type {
-  Experimental_EvaluationModelV4CallOptions as EvaluationModelV4CallOptions,
-  Experimental_EvaluationModelV4Result as EvaluationModelV4Result,
-} from '@ai-sdk/provider';
-import type { Context, ProviderOptions } from '@ai-sdk/provider-utils';
-import type { EvaluationQuestion, EvaluationResult } from './evaluation-result';
-
-/**
- * Event passed to the `onStart` callback for evaluation operations.
- *
- * Called when the operation begins, before the evaluation model is called.
- */
-export type EvaluateStartEvent<RUNTIME_CONTEXT extends Context = Context> = {
-  /** User-defined runtime context. */
-  readonly runtimeContext: RUNTIME_CONTEXT;
-
-  /** Unique identifier for this evaluation call, used to correlate events. */
-  readonly callId: string;
-
-  /** Identifies the operation type (`ai.evaluate`). */
-  readonly operationId: 'ai.evaluate';
-
-  /** The provider identifier. */
-  readonly provider: string;
-
-  /** The evaluation model identifier. */
-  readonly modelId: string;
-
-  /** The shared state being evaluated. */
-  readonly state: EvaluationModelV4CallOptions['state'];
-
-  /** The questions being evaluated against the shared state. */
-  readonly questions: Readonly<Record<string, EvaluationQuestion>>;
-
-  /** Maximum number of retries for the evaluation model call. */
-  readonly maxRetries: number;
-
-  /** Additional HTTP headers sent with the request. */
-  readonly headers: Record<string, string> | undefined;
-
-  /** Additional provider-specific options. */
-  readonly providerOptions: ProviderOptions;
-};
-
-/**
- * Event passed to the `onEnd` callback for evaluation operations.
- *
- * Called when the operation completes successfully.
- */
-export type EvaluateEndEvent<RUNTIME_CONTEXT extends Context = Context> =
-  EvaluateStartEvent<RUNTIME_CONTEXT> & {
-    /** Exactly one typed answer per question ID. */
-    readonly answers: EvaluationResult<
-      Record<string, EvaluationQuestion>
-    >['answers'];
-
-    /** Token usage for the evaluation operation. */
-    readonly usage: EvaluationResult<
-      Record<string, EvaluationQuestion>
-    >['usage'];
-
-    /** Warnings from the evaluation model. */
-    readonly warnings: EvaluationResult<
-      Record<string, EvaluationQuestion>
-    >['warnings'];
-
-    /** Provider-declared decimal precision for probabilities and scores. */
-    readonly rounding: EvaluationResult<
-      Record<string, EvaluationQuestion>
-    >['rounding'];
-
-    /** Optional provider-specific metadata. */
-    readonly providerMetadata: EvaluationResult<
-      Record<string, EvaluationQuestion>
-    >['providerMetadata'];
-
-    /** Response metadata, including the resolved model ID and timestamp. */
-    readonly response: EvaluationResult<
-      Record<string, EvaluationQuestion>
-    >['response'];
-  };
-
-/**
- * Event fired when the evaluation model call begins.
- *
- * The logical model call includes any provider retries.
- */
-export type EvaluationModelCallStartEvent = {
-  /** Unique identifier for the outer evaluation call. */
-  readonly callId: string;
-
-  /** Identifies the inner operation (`ai.evaluate.doEvaluate`). */
-  readonly operationId: 'ai.evaluate.doEvaluate';
-
-  /** The provider identifier. */
-  readonly provider: string;
-
-  /** The evaluation model identifier. */
-  readonly modelId: string;
-
-  /** The shared state being evaluated. */
-  readonly state: EvaluationModelV4CallOptions['state'];
-
-  /** The questions being evaluated against the shared state. */
-  readonly questions: Readonly<Record<string, EvaluationQuestion>>;
-};
-
-/**
- * Event fired after the evaluation model response has been validated.
- *
- * Contains the result of the logical model call, including any retries.
- */
-export type EvaluationModelCallEndEvent = EvaluationModelCallStartEvent & {
-  /** Exactly one answer per question ID. */
-  readonly answers: EvaluationModelV4Result['answers'];
-
-  /** Token usage reported by the evaluation model. */
-  readonly usage?: EvaluationModelV4Result['usage'];
-
-  /** Warnings from the evaluation model. */
-  readonly warnings: EvaluationModelV4Result['warnings'];
-
-  /** Provider-declared decimal precision for probabilities and scores. */
-  readonly rounding?: EvaluationModelV4Result['rounding'];
-
-  /** Optional provider-specific metadata. */
-  readonly providerMetadata?: EvaluationModelV4Result['providerMetadata'];
-
-  /** Optional raw response metadata from the provider. */
-  readonly response?: EvaluationModelV4Result['response'];
-};

package/src/evaluate/evaluation-provider.ts

@@ -1,6 +0,0 @@
-import type { Experimental_EvaluationModelV4 as EvaluationModelV4 } from '@ai-sdk/provider';
-
-/** Structural extension; evaluation is not part of the stable provider contract. */
-export type EvaluationProvider = {
-  evaluationModel?: (modelId: string) => EvaluationModelV4;
-};

package/src/evaluate/evaluation-result.ts

@@ -1,39 +0,0 @@
-import type {
-  Experimental_EvaluationModelV4 as EvaluationModelV4,
-  Experimental_EvaluationModelV4Question as EvaluationModelV4Question,
-  Experimental_EvaluationModelV4Result as EvaluationModelV4Result,
-} from '@ai-sdk/provider';
-
-export type EvaluationModel = string | EvaluationModelV4;
-export type EvaluationQuestion = EvaluationModelV4Question;
-
-export type EvaluationAnswer<QUESTION extends EvaluationQuestion> =
-  QUESTION extends { type: 'choice'; criteria: infer CRITERIA }
-    ? {
-        type: 'choice';
-        choice: Extract<keyof CRITERIA, string>;
-        probabilities?: Record<Extract<keyof CRITERIA, string>, number>;
-      }
-    : QUESTION extends { type: 'score' }
-      ? { type: 'score'; score: number; probabilities?: Record<string, number> }
-      : { type: 'boolean'; probability: number };
-
-export type EvaluationResult<
-  QUESTIONS extends Record<string, EvaluationQuestion>,
-> = {
-  readonly answers: {
-    [ID in keyof QUESTIONS]: EvaluationAnswer<QUESTIONS[ID]>;
-  };
-  readonly usage: {
-    inputTokens: number | undefined;
-    outputTokens: number | undefined;
-    totalTokens: number | undefined;
-  };
-  readonly warnings: EvaluationModelV4Result['warnings'];
-  readonly rounding: EvaluationModelV4Result['rounding'];
-  readonly providerMetadata: EvaluationModelV4Result['providerMetadata'];
-  readonly response: NonNullable<EvaluationModelV4Result['response']> & {
-    timestamp: Date;
-    modelId: string;
-  };
-};

package/src/evaluate/index.ts

@@ -1,13 +0,0 @@
-export { evaluate as experimental_evaluate } from './evaluate';
-export type {
-  EvaluateStartEvent as Experimental_EvaluateStartEvent,
-  EvaluateEndEvent as Experimental_EvaluateEndEvent,
-  EvaluationModelCallStartEvent as Experimental_EvaluationModelCallStartEvent,
-  EvaluationModelCallEndEvent as Experimental_EvaluationModelCallEndEvent,
-} from './evaluate-events';
-export type {
-  EvaluationModel as Experimental_EvaluationModel,
-  EvaluationQuestion as Experimental_EvaluationQuestion,
-  EvaluationAnswer as Experimental_EvaluationAnswer,
-  EvaluationResult as Experimental_EvaluationResult,
-} from './evaluation-result';

package/src/test/evaluation-mock-model-v4.ts

@@ -1,27 +0,0 @@
-import type { Experimental_EvaluationModelV4 as EvaluationModelV4 } from '@ai-sdk/provider';
-import { notImplemented } from './not-implemented';
-
-export class EvaluationMockModelV4 implements EvaluationModelV4 {
-  readonly specificationVersion = 'v4';
-  readonly provider: string;
-  readonly modelId: string;
-  readonly supportedQuestionTypes: EvaluationModelV4['supportedQuestionTypes'];
-  doEvaluate: EvaluationModelV4['doEvaluate'];
-
-  constructor({
-    provider = 'mock-provider',
-    modelId = 'mock-model-id',
-    supportedQuestionTypes = ['choice', 'score', 'boolean'],
-    doEvaluate = notImplemented,
-  }: {
-    provider?: string;
-    modelId?: string;
-    supportedQuestionTypes?: EvaluationModelV4['supportedQuestionTypes'];
-    doEvaluate?: EvaluationModelV4['doEvaluate'];
-  } = {}) {
-    this.provider = provider;
-    this.modelId = modelId;
-    this.supportedQuestionTypes = supportedQuestionTypes;
-    this.doEvaluate = doEvaluate;
-  }
-}