ai 7.0.110 → 7.0.112

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/dist/index.d.ts +163 -41
  3. package/dist/index.js +262 -73
  4. package/dist/index.js.map +1 -1
  5. package/dist/internal/index.d.ts +141 -2
  6. package/dist/internal/index.js +33 -4
  7. package/dist/internal/index.js.map +1 -1
  8. package/docs/03-ai-sdk-core/40-middleware.mdx +92 -7
  9. package/docs/03-ai-sdk-core/60-telemetry.mdx +56 -3
  10. package/docs/03-ai-sdk-core/65-lifecycle-callbacks.mdx +124 -2
  11. package/docs/06-advanced/02-stopping-streams.mdx +8 -0
  12. package/docs/07-reference/01-ai-sdk-core/02-stream-text.mdx +3 -3
  13. package/docs/07-reference/01-ai-sdk-core/14-evaluate.mdx +16 -9
  14. package/docs/07-reference/02-ai-sdk-ui/40-create-ui-message-stream.mdx +9 -3
  15. package/package.json +12 -12
  16. package/src/batch/batch.ts +18 -3
  17. package/src/evaluate/evaluate-events.ts +131 -0
  18. package/src/evaluate/evaluate.ts +145 -40
  19. package/src/evaluate/index.ts +6 -0
  20. package/src/evaluate/restricted-telemetry-dispatcher.ts +46 -0
  21. package/src/generate-text/convert-language-model-content.ts +15 -6
  22. package/src/generate-text/generate-text.ts +7 -2
  23. package/src/generate-text/prune-messages.ts +3 -1
  24. package/src/generate-text/resolve-generated-file-data.ts +41 -0
  25. package/src/generate-text/stream-language-model-call.ts +5 -4
  26. package/src/prompt/convert-to-language-model-prompt.ts +12 -2
  27. package/src/prompt/file-part-data.ts +11 -1
  28. package/src/telemetry/create-telemetry-dispatcher.ts +12 -0
  29. package/src/telemetry/telemetry.ts +34 -0
  30. package/src/telemetry/tracing-channel.ts +2 -1
  31. package/src/ui/validate-ui-messages.ts +2 -2
  32. package/src/ui-message-stream/handle-ui-message-stream-finish.ts +5 -3
  33. package/src/ui-message-stream/ui-message-stream-on-end-callback.ts +8 -0
  34. package/src/ui-message-stream/ui-message-stream-outcome.ts +4 -0
@@ -310,6 +310,9 @@ You can implement any of the following three function to modify the behavior of
310
310
  3. `wrapStream`: Wraps the `doStream` method of the [language model](https://github.com/vercel/ai/blob/main/packages/provider/src/language-model/v4/language-model-v4.ts).
311
311
  You can modify the parameters, call the language model, and modify the result.
312
312
 
313
+ Every `LanguageModelV4Middleware` object must set
314
+ `specificationVersion: 'v4'`.
315
+
313
316
  Here are some examples of how to implement language model middleware:
314
317
 
315
318
  ## Examples
@@ -330,6 +333,8 @@ import type {
330
333
  } from '@ai-sdk/provider';
331
334
 
332
335
  export const yourLogMiddleware: LanguageModelV4Middleware = {
336
+ specificationVersion: 'v4',
337
+
333
338
  wrapGenerate: async ({ doGenerate, params }) => {
334
339
  console.log('doGenerate called');
335
340
  console.log(`params: ${JSON.stringify(params, null, 2)}`);
@@ -407,6 +412,8 @@ import type { LanguageModelV4Middleware } from '@ai-sdk/provider';
407
412
  const cache = new Map<string, any>();
408
413
 
409
414
  export const yourCacheMiddleware: LanguageModelV4Middleware = {
415
+ specificationVersion: 'v4',
416
+
410
417
  wrapGenerate: async ({ doGenerate, params }) => {
411
418
  const cacheKey = JSON.stringify(params);
412
419
 
@@ -439,6 +446,8 @@ This example shows how to use RAG as middleware.
439
446
  import type { LanguageModelV4Middleware } from '@ai-sdk/provider';
440
447
 
441
448
  export const yourRagMiddleware: LanguageModelV4Middleware = {
449
+ specificationVersion: 'v4',
450
+
442
451
  transformParams: async ({ params }) => {
443
452
  const lastUserMessageText = getLastUserMessageText({
444
453
  prompt: params.prompt,
@@ -465,28 +474,102 @@ Guard rails are a way to ensure that the generated text of a language model call
465
474
  is safe and appropriate. This example shows how to use guardrails as middleware.
466
475
 
467
476
  ```ts
468
- import type { LanguageModelV4Middleware } from '@ai-sdk/provider';
477
+ import type {
478
+ LanguageModelV4Middleware,
479
+ LanguageModelV4StreamPart,
480
+ } from '@ai-sdk/provider';
481
+
482
+ const redactText = (text: string) => text.replace(/badword/g, '<REDACTED>');
469
483
 
470
484
  export const yourGuardrailMiddleware: LanguageModelV4Middleware = {
485
+ specificationVersion: 'v4',
486
+
471
487
  wrapGenerate: async ({ doGenerate }) => {
472
488
  const result = await doGenerate();
473
489
 
474
490
  // filtering approach, e.g. for PII or other sensitive information:
475
491
  const content = result.content.map(part =>
476
- part.type === 'text'
477
- ? { ...part, text: part.text.replace(/badword/g, '<REDACTED>') }
478
- : part,
492
+ part.type === 'text' ? { ...part, text: redactText(part.text) } : part,
479
493
  );
480
494
 
481
495
  return { ...result, content };
482
496
  },
483
497
 
484
- // here you would implement the guardrail logic for streaming
485
- // Note: streaming guardrails are difficult to implement, because
486
- // you do not know the full content of the stream until it's finished.
498
+ wrapStream: async ({ doStream }) => {
499
+ const { stream, ...rest } = await doStream();
500
+
501
+ // Keep a separate buffer for each text block in the stream.
502
+ const buffers = new Map<string, string>();
503
+
504
+ const transformStream = new TransformStream<
505
+ LanguageModelV4StreamPart,
506
+ LanguageModelV4StreamPart
507
+ >({
508
+ transform(chunk, controller) {
509
+ if (chunk.type === 'text-start') {
510
+ buffers.set(chunk.id, '');
511
+ controller.enqueue(chunk);
512
+ return;
513
+ }
514
+
515
+ if (chunk.type === 'text-delta') {
516
+ buffers.set(chunk.id, (buffers.get(chunk.id) ?? '') + chunk.delta);
517
+ return;
518
+ }
519
+
520
+ if (chunk.type === 'text-end') {
521
+ const bufferedText = buffers.get(chunk.id);
522
+
523
+ if (bufferedText != null) {
524
+ const redactedText = redactText(bufferedText);
525
+
526
+ if (redactedText) {
527
+ controller.enqueue({
528
+ type: 'text-delta',
529
+ id: chunk.id,
530
+ delta: redactedText,
531
+ });
532
+ }
533
+
534
+ buffers.delete(chunk.id);
535
+ }
536
+ }
537
+
538
+ controller.enqueue(chunk);
539
+ },
540
+
541
+ flush(controller) {
542
+ for (const [id, bufferedText] of buffers) {
543
+ const redactedText = redactText(bufferedText);
544
+
545
+ if (redactedText) {
546
+ controller.enqueue({
547
+ type: 'text-delta',
548
+ id,
549
+ delta: redactedText,
550
+ });
551
+ }
552
+ }
553
+ },
554
+ });
555
+
556
+ return {
557
+ stream: stream.pipeThrough(transformStream),
558
+ ...rest,
559
+ };
560
+ },
487
561
  };
488
562
  ```
489
563
 
564
+ <Note>
565
+ The streaming example buffers each text block until `text-end` so matches
566
+ split across `text-delta` chunks cannot leak through. This delays output and
567
+ uses memory proportional to the text block size. Do not redact each delta
568
+ independently. An incremental implementation must retain every possible
569
+ incomplete match, and a fixed-size buffer alone is not safe for unbounded
570
+ variable-length patterns.
571
+ </Note>
572
+
490
573
  ## Configuring Per Request Custom Metadata
491
574
 
492
575
  To send and access custom metadata in Middleware, you can use `providerOptions`. This is useful when building logging middleware where you want to pass additional context like user IDs, timestamps, or other contextual data that can help with tracking and debugging.
@@ -497,6 +580,8 @@ __PROVIDER_IMPORT__;
497
580
  import type { LanguageModelV4Middleware } from '@ai-sdk/provider';
498
581
 
499
582
  export const yourLogMiddleware: LanguageModelV4Middleware = {
583
+ specificationVersion: 'v4',
584
+
500
585
  wrapGenerate: async ({ doGenerate, params }) => {
501
586
  console.log('METADATA', params?.providerMetadata?.yourLogMiddleware);
502
587
  const result = await doGenerate();
@@ -126,7 +126,7 @@ const result = await generateText({
126
126
  });
127
127
  ```
128
128
 
129
- In this example, telemetry integrations receive `runtimeContext` as `{ requestId: 'req_abc' }`. Properties set to `false` or omitted are excluded. If `telemetry.includeRuntimeContext` is omitted, no runtime context properties are included. `telemetry.includeRuntimeContext` is supported by `generateText`, `streamText`, `ToolLoopAgent`, `embed`, `embedMany`, and `rerank`.
129
+ In this example, telemetry integrations receive `runtimeContext` as `{ requestId: 'req_abc' }`. Properties set to `false` or omitted are excluded. If `telemetry.includeRuntimeContext` is omitted, no runtime context properties are included. `telemetry.includeRuntimeContext` is supported by `generateText`, `streamText`, `ToolLoopAgent`, `embed`, `embedMany`, `rerank`, and `experimental_evaluate`.
130
130
 
131
131
  <Note>
132
132
  `telemetry.includeRuntimeContext` only filters telemetry integrations,
@@ -383,6 +383,29 @@ export function myIntegration(): Telemetry {
383
383
  type: '(event: RerankingModelCallEndEvent) => void | PromiseLike<void>',
384
384
  description: 'Called when an individual reranking model call completes.',
385
385
  },
386
+ {
387
+ name: 'experimental_onEvaluateStart',
388
+ type: '(event: Experimental_EvaluateStartEvent) => void | PromiseLike<void>',
389
+ description: 'Called when an experimental evaluation operation begins.',
390
+ },
391
+ {
392
+ name: 'experimental_onEvaluationModelCallStart',
393
+ type: '(event: Experimental_EvaluationModelCallStartEvent) => void | PromiseLike<void>',
394
+ description:
395
+ 'Called when the logical evaluation model call begins. The call includes any provider retries.',
396
+ },
397
+ {
398
+ name: 'experimental_onEvaluationModelCallEnd',
399
+ type: '(event: Experimental_EvaluationModelCallEndEvent) => void | PromiseLike<void>',
400
+ description:
401
+ 'Called when the logical evaluation model call, including any retries, completes.',
402
+ },
403
+ {
404
+ name: 'experimental_onEvaluateEnd',
405
+ type: '(event: Experimental_EvaluateEndEvent) => void | PromiseLike<void>',
406
+ description:
407
+ 'Called when an experimental evaluation operation completes.',
408
+ },
386
409
  {
387
410
  name: 'onEnd',
388
411
  type: '(event: GenerateTextEndEvent) => void | PromiseLike<void>',
@@ -398,6 +421,9 @@ export function myIntegration(): Telemetry {
398
421
  ]}
399
422
  />
400
423
 
424
+ Experimental evaluation events use the four `experimental_*` callbacks above.
425
+ They are not included in the stable `onStart` and `onEnd` event unions.
426
+
401
427
  The event types for each method are the same as the corresponding [lifecycle callbacks](/docs/ai-sdk-core/lifecycle-callbacks). See the lifecycle callbacks documentation for the full property reference of each event.
402
428
 
403
429
  ## Collected Data
@@ -524,6 +550,31 @@ For `rerank`, the integration records spans with `CLIENT` kind:
524
550
  - `gen_ai.provider.name`: the provider
525
551
  - `gen_ai.request.model`: the model ID
526
552
 
553
+ #### experimental_evaluate
554
+
555
+ For `experimental_evaluate`, the integration records two spans with `CLIENT`
556
+ kind: an **`evaluate {modelId}`** root span for the whole operation and one
557
+ **`evaluate {modelId}`** child span for evaluation model work, including
558
+ retries. Both include the provider and requested model with
559
+ `gen_ai.operation.name: "evaluate"`. Token
560
+ usage is recorded on the child span. When evaluation attributes are enabled,
561
+ answers are recorded on both spans so the operation span contains its output.
562
+
563
+ `evaluate` is an AI SDK-defined custom operation name, not a well-known
564
+ OpenTelemetry GenAI operation. OpenTelemetry permits custom operation names
565
+ when no well-known value describes the operation.
566
+
567
+ OpenTelemetry's `gen_ai.evaluation.result` event describes the result of
568
+ evaluating a GenAI output for quality or other characteristics. In contrast,
569
+ `experimental_evaluate` can evaluate arbitrary JSON state for classification,
570
+ routing, scoring, and similar tasks. The integration therefore does not emit a
571
+ `gen_ai.evaluation.result` event.
572
+
573
+ Evaluation state, questions, and answers also do not have applicable GenAI
574
+ semantic-convention attributes. Enable the `experimental_evaluation`
575
+ supplemental option to record them under AI SDK-specific
576
+ `ai.evaluation.*` attributes.
577
+
527
578
  #### GenAI span details
528
579
 
529
580
  ##### GenAI message format
@@ -579,10 +630,10 @@ registerTelemetry(
579
630
 
580
631
  The callback runs when each span is created and receives:
581
632
 
582
- - `spanType`: the type of span being created (`operation`, `step`, `languageModel`, `tool`, `embedding`, or `reranking`).
633
+ - `spanType`: the type of span being created (`operation`, `step`, `languageModel`, `tool`, `embedding`, `reranking`, or `experimental_evaluation`).
583
634
  - `operationId`: the AI SDK operation ID for the current call, such as `ai.generateText` or `ai.streamText`.
584
635
  - `callId`: the unique ID for the current AI SDK call.
585
- - `runtimeContext`: the telemetry-filtered runtime context for text generation, embedding, and reranking spans. Text generation spans also reflect updates from `prepareStep`.
636
+ - `runtimeContext`: the telemetry-filtered runtime context for text generation, embedding, reranking, and evaluation spans. Text generation spans also reflect updates from `prepareStep`.
586
637
 
587
638
  Custom attributes are merged with AI SDK attributes on the span. AI SDK-owned
588
639
  attributes take precedence when a custom attribute uses the same key.
@@ -642,6 +693,7 @@ registerTelemetry(
642
693
  providerMetadata: true,
643
694
  embedding: true,
644
695
  reranking: true,
696
+ experimental_evaluation: true,
645
697
  runtimeContext: true,
646
698
  headers: true,
647
699
  toolChoice: true,
@@ -656,6 +708,7 @@ The available options are:
656
708
  - `providerMetadata`: `ai.response.providerMetadata` on operation, step, and model-call spans.
657
709
  - `embedding`: embedding inputs and outputs.
658
710
  - `reranking`: rerank input documents and ranking output.
711
+ - `experimental_evaluation`: experimental evaluation state, questions, and answers.
659
712
  - `runtimeContext`: `ai.settings.context.*`.
660
713
  - `headers`: `ai.request.headers.*`.
661
714
  - `toolChoice`: `ai.prompt.toolChoice`.
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  title: Lifecycle Callbacks
3
- description: Observe AI SDK lifecycle events in generateText, streamText, embed, embedMany, and rerank calls
3
+ description: Observe AI SDK lifecycle events in generateText, streamText, embed, embedMany, rerank, and experimental_evaluate calls
4
4
  ---
5
5
 
6
6
  # Lifecycle Callbacks
7
7
 
8
8
  Event callbacks let you run your own code at important points in an AI SDK call.
9
- You can attach them directly to `generateText`, `streamText`, `embed`, `embedMany`, and `rerank` calls to observe what happened, record usage, debug multi-step generations, and monitor tool execution.
9
+ You can attach them directly to `generateText`, `streamText`, `embed`, `embedMany`, `rerank`, and `experimental_evaluate` calls to observe what happened, record usage, debug multi-step generations, and monitor tool execution.
10
10
 
11
11
  They are especially useful when you want application-specific logic close to the call site:
12
12
 
@@ -449,6 +449,25 @@ const result = await generateText({
449
449
  ]}
450
450
  />
451
451
 
452
+ ### `experimental_evaluate`
453
+
454
+ <PropertiesTable
455
+ content={[
456
+ {
457
+ name: 'onStart',
458
+ type: '(event: Experimental_EvaluateStartEvent) => void | Promise<void>',
459
+ description:
460
+ 'Called when the evaluation operation begins, before the evaluation model is called.',
461
+ },
462
+ {
463
+ name: 'onEnd',
464
+ type: '(event: Experimental_EvaluateEndEvent) => void | Promise<void>',
465
+ description:
466
+ 'Called when the evaluation operation completes successfully.',
467
+ },
468
+ ]}
469
+ />
470
+
452
471
  ## Event Data Reference
453
472
 
454
473
  The exact event data depends on the callback. The tables below summarize the fields you will most commonly use.
@@ -1151,3 +1170,106 @@ For `embed`, `value` is a single string. For `embedMany`, `value` is an array of
1151
1170
  },
1152
1171
  ]}
1153
1172
  />
1173
+
1174
+ ### Evaluation Events
1175
+
1176
+ Evaluation callbacks are experimental. Their exported types are
1177
+ `Experimental_EvaluateStartEvent` and `Experimental_EvaluateEndEvent`.
1178
+
1179
+ #### onStart
1180
+
1181
+ <PropertiesTable
1182
+ content={[
1183
+ {
1184
+ name: 'callId',
1185
+ type: 'string',
1186
+ description: 'Unique identifier for this evaluation call.',
1187
+ },
1188
+ {
1189
+ name: 'operationId',
1190
+ type: "'ai.evaluate'",
1191
+ description: 'Evaluation operation identifier.',
1192
+ },
1193
+ {
1194
+ name: 'runtimeContext',
1195
+ type: 'RUNTIME_CONTEXT',
1196
+ description: 'Full user-defined runtime context.',
1197
+ },
1198
+ {
1199
+ name: 'provider',
1200
+ type: 'string',
1201
+ description: 'Provider identifier for the evaluation model.',
1202
+ },
1203
+ {
1204
+ name: 'modelId',
1205
+ type: 'string',
1206
+ description: 'Evaluation model identifier.',
1207
+ },
1208
+ {
1209
+ name: 'state',
1210
+ type: 'string | object | array',
1211
+ description: 'Shared state being evaluated.',
1212
+ },
1213
+ {
1214
+ name: 'questions',
1215
+ type: 'Readonly<Record<string, Experimental_EvaluationQuestion>>',
1216
+ description: 'Questions being evaluated against the shared state.',
1217
+ },
1218
+ {
1219
+ name: 'maxRetries',
1220
+ type: 'number',
1221
+ description: 'Maximum number of retries for the model call.',
1222
+ },
1223
+ {
1224
+ name: 'headers',
1225
+ type: 'Record<string, string> | undefined',
1226
+ description: 'Additional HTTP headers sent with the request.',
1227
+ },
1228
+ {
1229
+ name: 'providerOptions',
1230
+ type: 'ProviderOptions',
1231
+ description: 'Provider-specific options.',
1232
+ },
1233
+ ]}
1234
+ />
1235
+
1236
+ #### onEnd
1237
+
1238
+ Includes every `onStart` field plus:
1239
+
1240
+ <PropertiesTable
1241
+ content={[
1242
+ {
1243
+ name: 'answers',
1244
+ type: 'Record<string, Experimental_EvaluationAnswer>',
1245
+ description: 'Exactly one typed answer per question ID.',
1246
+ },
1247
+ {
1248
+ name: 'usage',
1249
+ type: '{ inputTokens: number | undefined; outputTokens: number | undefined; totalTokens: number | undefined }',
1250
+ description: 'Token usage for the evaluation operation.',
1251
+ },
1252
+ {
1253
+ name: 'warnings',
1254
+ type: 'Array<Warning>',
1255
+ description: 'Warnings from the evaluation model.',
1256
+ },
1257
+ {
1258
+ name: 'rounding',
1259
+ type: '{ probabilityDecimals?: number; scoreDecimals?: number } | undefined',
1260
+ description:
1261
+ 'Provider-declared decimal precision for probabilities and scores.',
1262
+ },
1263
+ {
1264
+ name: 'providerMetadata',
1265
+ type: 'ProviderMetadata | undefined',
1266
+ description: 'Optional provider-specific metadata.',
1267
+ },
1268
+ {
1269
+ name: 'response',
1270
+ type: '{ id?: string; timestamp: Date; modelId: string; headers?: Record<string, string>; body?: unknown }',
1271
+ description:
1272
+ 'Response metadata including the resolved model and timestamp.',
1273
+ },
1274
+ ]}
1275
+ />
@@ -205,6 +205,14 @@ export async function POST(req: Request) {
205
205
 
206
206
  The `consumeStream` function is necessary for proper abort handling in UI message streams. It ensures that the stream is properly consumed even when aborted, preventing potential memory leaks or hanging connections.
207
207
 
208
+ The `onEnd` callback distinguishes consumer cancellation from an observed
209
+ abort. When the consumer cancels the UI message stream before an outcome is
210
+ declared, such as during a client disconnect, `isCancelled` is `true`,
211
+ `outcome.status` remains `'unknown'`, and `isAborted` remains `false`. When the
212
+ stream observes an `abort` part first, `outcome.status` is `'aborted'`,
213
+ `isAborted` is `true`, and `isCancelled` is absent. Check both flags when the
214
+ same cleanup should run for either case.
215
+
208
216
  ## AI SDK RSC
209
217
 
210
218
  <Note type="warning">
@@ -4082,13 +4082,13 @@ To see `streamText` in action, check out [these examples](#examples).
4082
4082
  },
4083
4083
  {
4084
4084
  name: 'onEnd',
4085
- type: '(options: { messages: UIMessage[]; isContinuation: boolean; responseMessage: UIMessage; isAborted: boolean; outcome: UIMessageStreamOutcome; finishReason?: FinishReason; }) => PromiseLike<void> | void',
4085
+ type: '(options: { messages: UIMessage[]; isContinuation: boolean; responseMessage: UIMessage; isAborted: boolean; isCancelled?: true; outcome: UIMessageStreamOutcome; finishReason?: FinishReason; }) => PromiseLike<void> | void',
4086
4086
  isOptional: true,
4087
- description: 'Callback function called when the stream ends. Provides the updated messages, continuation and abort state, model finish reason, and operation-level outcome.',
4087
+ description: 'Callback function called when the stream ends. Provides the updated messages, continuation, abort and consumer-cancellation state, model finish reason, and operation-level outcome.',
4088
4088
  },
4089
4089
  {
4090
4090
  name: 'onFinish',
4091
- type: '(options: { messages: UIMessage[]; isContinuation: boolean; responseMessage: UIMessage; isAborted: boolean; outcome: UIMessageStreamOutcome; finishReason?: FinishReason; }) => PromiseLike<void> | void',
4091
+ type: '(options: { messages: UIMessage[]; isContinuation: boolean; responseMessage: UIMessage; isAborted: boolean; isCancelled?: true; outcome: UIMessageStreamOutcome; finishReason?: FinishReason; }) => PromiseLike<void> | void',
4092
4092
  isOptional: true,
4093
4093
  description: 'Deprecated alias for `onEnd`.',
4094
4094
  },
@@ -14,15 +14,22 @@ state. See [Evaluation](/docs/ai-sdk-core/evaluation) for examples and semantics
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | ----------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | `model` | `Experimental_EvaluationModel` | Required experimental v4 model instance or a string ID resolved by Gateway or an explicitly configured evaluation-capable default provider. |
20
- | `state` | `string \| object \| array` | Required JSON-compatible shared state. |
21
- | `questions` | `Record<string, Experimental_EvaluationQuestion>` | Required nonempty question map. |
22
- | `maxRetries` | `number` | Nonnegative integer; defaults to 2. |
23
- | `abortSignal` | `AbortSignal` | Cancels evaluation. |
24
- | `headers` | `Record<string, string>` | Additional HTTP headers. |
25
- | `providerOptions` | `ProviderOptions` | Provider-specific options. |
17
+ | Parameter | Type | Description |
18
+ | ----------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
19
+ | `model` | `Experimental_EvaluationModel` | Required experimental v4 model instance or a string ID resolved by Gateway or an explicitly configured evaluation-capable default provider. |
20
+ | `state` | `string \| object \| array` | Required JSON-compatible shared state. |
21
+ | `questions` | `Record<string, Experimental_EvaluationQuestion>` | Required nonempty question map. |
22
+ | `maxRetries` | `number` | Nonnegative integer; defaults to 2. |
23
+ | `abortSignal` | `AbortSignal` | Cancels evaluation. |
24
+ | `headers` | `Record<string, string>` | Additional HTTP headers. |
25
+ | `providerOptions` | `ProviderOptions` | Provider-specific options. |
26
+ | `telemetry` | `TelemetryOptions` | Telemetry configuration, including per-call integrations, input/output recording, and a function ID. |
27
+ | `runtimeContext` | `Record<string, unknown>` | Context available to lifecycle callbacks and selectively included in telemetry with `telemetry.includeRuntimeContext`. |
28
+ | `onStart` | `(event: Experimental_EvaluateStartEvent) => void` | Called when the evaluation operation begins. |
29
+ | `onEnd` | `(event: Experimental_EvaluateEndEvent) => void` | Called when the evaluation operation completes successfully. |
30
+
31
+ See [Lifecycle Callbacks](/docs/ai-sdk-core/lifecycle-callbacks#experimental_evaluate)
32
+ for the complete `onStart` and `onEnd` event fields.
26
33
 
27
34
  ## Result
28
35
 
@@ -134,7 +134,7 @@ outcomes and call `setOutcome` once.
134
134
  },
135
135
  {
136
136
  name: 'onEnd',
137
- type: '(options: { messages: UIMessage[]; isContinuation: boolean; isAborted: boolean; outcome: UIMessageStreamOutcome; responseMessage: UIMessage; finishReason?: FinishReason }) => PromiseLike<void> | void',
137
+ type: '(options: { messages: UIMessage[]; isContinuation: boolean; isAborted: boolean; isCancelled?: true; outcome: UIMessageStreamOutcome; responseMessage: UIMessage; finishReason?: FinishReason }) => PromiseLike<void> | void',
138
138
  description: 'A callback function that is called when the stream ends.',
139
139
  properties: [
140
140
  {
@@ -156,11 +156,17 @@ outcomes and call `setOutcome` once.
156
156
  type: 'boolean',
157
157
  description: 'Indicates whether the stream was aborted.',
158
158
  },
159
+ {
160
+ name: 'isCancelled',
161
+ type: 'true | undefined',
162
+ description:
163
+ 'Present and true when the consumer cancelled the stream before an outcome was declared, for example because the client disconnected.',
164
+ },
159
165
  {
160
166
  name: 'outcome',
161
167
  type: "UIMessageStreamOutcome = { status: 'completed' } | { status: 'failed'; error?: unknown } | { status: 'aborted' } | { status: 'unknown' }",
162
168
  description:
163
- 'The operation-level outcome of the stream. It reflects the stream owner declaration unless a fatal stream-processing failure occurs, and is separate from model finish reasons and individual error chunks.',
169
+ "The operation-level outcome of the stream. It reflects the stream owner declaration unless a fatal stream-processing failure occurs, and is separate from model finish reasons and individual error chunks. It remains 'unknown' when the consumer cancels before an outcome is declared; check isCancelled to distinguish that case from normal closure without a declared outcome.",
164
170
  },
165
171
  {
166
172
  name: 'responseMessage',
@@ -180,7 +186,7 @@ outcomes and call `setOutcome` once.
180
186
  },
181
187
  {
182
188
  name: 'onFinish',
183
- type: '(options: { messages: UIMessage[]; isContinuation: boolean; isAborted: boolean; outcome: UIMessageStreamOutcome; responseMessage: UIMessage; finishReason?: FinishReason }) => PromiseLike<void> | void',
189
+ type: '(options: { messages: UIMessage[]; isContinuation: boolean; isAborted: boolean; isCancelled?: true; outcome: UIMessageStreamOutcome; responseMessage: UIMessage; finishReason?: FinishReason }) => PromiseLike<void> | void',
184
190
  description: 'Deprecated alias for `onEnd`.',
185
191
  },
186
192
  {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ai",
3
- "version": "7.0.110",
3
+ "version": "7.0.112",
4
4
  "type": "module",
5
5
  "description": "AI SDK by Vercel - build apps like ChatGPT, Claude, Gemini, and more with a single interface for any model using the Vercel AI Gateway or go direct to OpenAI, Anthropic, Google, or any other model provider.",
6
6
  "license": "Apache-2.0",
@@ -42,20 +42,20 @@
42
42
  }
43
43
  },
44
44
  "dependencies": {
45
- "@ai-sdk/gateway": "4.0.89",
46
- "@ai-sdk/provider": "4.0.17",
47
- "@ai-sdk/provider-utils": "5.0.45"
45
+ "@ai-sdk/gateway": "4.0.90",
46
+ "@ai-sdk/provider": "4.0.18",
47
+ "@ai-sdk/provider-utils": "5.0.46"
48
48
  },
49
49
  "devDependencies": {
50
- "@ai-sdk/amazon-bedrock": "5.0.91",
51
- "@ai-sdk/deepseek": "3.0.50",
52
- "@ai-sdk/google": "4.0.77",
53
- "@ai-sdk/groq": "4.0.46",
54
- "@ai-sdk/huggingface": "2.0.53",
55
- "@ai-sdk/moonshotai": "3.0.54",
56
- "@ai-sdk/openai": "4.0.72",
50
+ "@ai-sdk/amazon-bedrock": "5.0.92",
51
+ "@ai-sdk/deepseek": "3.0.51",
52
+ "@ai-sdk/google": "4.0.78",
53
+ "@ai-sdk/groq": "4.0.47",
54
+ "@ai-sdk/huggingface": "2.0.54",
55
+ "@ai-sdk/moonshotai": "3.0.55",
56
+ "@ai-sdk/openai": "4.0.73",
57
57
  "@ai-sdk/test-server": "2.0.1",
58
- "@ai-sdk/xai": "5.0.5",
58
+ "@ai-sdk/xai": "5.0.6",
59
59
  "@edge-runtime/vm": "^5.0.0",
60
60
  "@smithy/eventstream-codec": "^4.3.3",
61
61
  "@smithy/util-utf8": "^4.3.3",
@@ -374,7 +374,13 @@ export function getBatchResults<TOOLS extends ToolSet>({
374
374
  cancel?: (reason?: unknown) => void;
375
375
  } = {
376
376
  async transform(item, controller) {
377
- controller.enqueue(await convertBatchItemResult({ item, tools }));
377
+ controller.enqueue(
378
+ await convertBatchItemResult({
379
+ item,
380
+ tools,
381
+ abortSignal: operationAbortSignal,
382
+ }),
383
+ );
378
384
  },
379
385
 
380
386
  cancel(reason) {
@@ -507,9 +513,11 @@ function validateBatchReference({
507
513
  async function convertBatchItemResult<TOOLS extends ToolSet>({
508
514
  item,
509
515
  tools,
516
+ abortSignal,
510
517
  }: {
511
518
  item: BatchV4ItemResult;
512
519
  tools: TOOLS | undefined;
520
+ abortSignal: AbortSignal | undefined;
513
521
  }): Promise<BatchItemResult<TOOLS>> {
514
522
  switch (item.type) {
515
523
  case 'text':
@@ -519,7 +527,11 @@ async function convertBatchItemResult<TOOLS extends ToolSet>({
519
527
  type: item.type,
520
528
  id: item.id,
521
529
  status: item.status,
522
- ...(await convertGenerateResult({ result: item.result, tools })),
530
+ ...(await convertGenerateResult({
531
+ result: item.result,
532
+ tools,
533
+ abortSignal,
534
+ })),
523
535
  };
524
536
  case 'failed':
525
537
  return {
@@ -600,9 +612,11 @@ function convertImageResult(
600
612
  async function convertGenerateResult<TOOLS extends ToolSet>({
601
613
  result,
602
614
  tools,
615
+ abortSignal,
603
616
  }: {
604
617
  result: LanguageModelV4GenerateResult;
605
618
  tools: TOOLS | undefined;
619
+ abortSignal: AbortSignal | undefined;
606
620
  }): Promise<TextBatchGenerationResult<TOOLS>> {
607
621
  const toolCalls = await Promise.all(
608
622
  result.content
@@ -620,13 +634,14 @@ async function convertGenerateResult<TOOLS extends ToolSet>({
620
634
  }),
621
635
  ),
622
636
  );
623
- const content = convertLanguageModelContent<TOOLS>({
637
+ const content = await convertLanguageModelContent<TOOLS>({
624
638
  content: result.content,
625
639
  toolCalls,
626
640
  toolOutputs: [],
627
641
  toolApprovalRequests: [],
628
642
  toolApprovalResponses: [],
629
643
  tools,
644
+ abortSignal,
630
645
  });
631
646
 
632
647
  return {