ai 7.0.92 → 7.0.94

package/docs/07-reference/02-ai-sdk-ui/40-create-ui-message-stream.mdx

@@ -20,6 +20,9 @@ const existingMessages: UIMessage[] = [
 
 const stream = createUIMessageStream({
   async execute({ writer }) {
+    // The outer stream owns the assistant message lifecycle.
+    writer.write({ type: 'start' });
+
     // Start a text message
     // Note: The id must be consistent across text-start, text-delta, and text-end steps
     // This allows the system to correctly identify they belong to the same text block
@@ -50,6 +53,7 @@ const stream = createUIMessageStream({
     writer.merge(
       toUIMessageStream({
         stream: result.stream,
+        sendStart: false,
         onEnd: ({ outcome }) => {
           // The composer decides that the model stream outcome is also the
           // aggregate stream outcome.

package/docs/07-reference/02-ai-sdk-ui/41-create-ui-message-stream-response.mdx

@@ -33,6 +33,9 @@ const response = createUIMessageStreamResponse({
   },
   stream: createUIMessageStream({
     execute({ writer }) {
+      // The outer stream owns the assistant message lifecycle.
+      writer.write({ type: 'start' });
+
       // Write custom data (type must be 'data-<name>')
       writer.write({
         type: 'data-message',
@@ -68,7 +71,9 @@ const response = createUIMessageStreamResponse({
         prompt: 'Say hello',
       });
 
-      writer.merge(toUIMessageStream({ stream: result.stream }));
+      writer.merge(
+        toUIMessageStream({ stream: result.stream, sendStart: false }),
+      );
     },
   }),
 });

package/docs/07-reference/04-ai-sdk-workflow/01-workflow-agent.mdx

@@ -99,7 +99,7 @@ To see `WorkflowAgent` in action, check out [these examples](#examples).
       type: 'StopCondition | StopCondition[]',
       isOptional: true,
       description:
-        'Default stop condition for the agent loop. Per-stream values override this default. Use `isLoopFinished()` to let the agent run until all tool calls have completed, but beware of potential runaway loops. See https://ai-sdk.dev/v7/docs/reference/ai-sdk-core/loop-finished#isloopfinished.',
+        'Default stop condition for the agent loop. When omitted, WorkflowAgent has no maximum step count and continues until natural completion. Use `isStepCount()` to bound execution. Per-stream values override this default.',
     },
     {
       name: 'activeTools',
@@ -268,24 +268,24 @@ To see `WorkflowAgent` in action, check out [these examples](#examples).
     },
     {
       name: 'onToolExecutionStart',
-      type: 'WorkflowAgentonToolExecutionStartCallback',
+      type: 'WorkflowAgentOnToolExecutionStartCallback',
       isOptional: true,
       description:
         "Callback called right before a tool's execute function runs. If also specified in `stream()`, both callbacks fire (constructor first). Experimental (can break in patch releases).",
       properties: [
         {
-          type: 'ToolExecutionStartEvent',
+          type: 'WorkflowAgentToolExecutionStartEvent',
           parameters: [
             {
-              name: 'callId',
-              type: 'string',
+              name: 'toolCall',
+              type: '{ type: "tool-call"; toolCallId: string; toolName: string; input: unknown }',
               description:
-                'Unique identifier for this generation call, used to correlate events.',
+                'The tool call being executed. For concrete tool sets, the tool name and input are correlated.',
             },
             {
-              name: 'toolCall',
-              type: '{ type: "tool-call"; toolCallId: string; toolName: string; input: unknown }',
-              description: 'The tool call being executed.',
+              name: 'stepNumber',
+              type: 'number',
+              description: 'The current step number, starting at zero.',
             },
             {
               name: 'messages',
@@ -295,9 +295,9 @@ To see `WorkflowAgent` in action, check out [these examples](#examples).
             },
             {
               name: 'toolContext',
-              type: 'InferToolContext<TOOLS[toolName]>',
+              type: 'InferToolContext<TOOLS[NAME]> | undefined',
               description:
-                'Tool-specific context object for the tool call that is about to execute. Narrowed to the context type of the individual tool, not the entire tool set.',
+                'The validated context for the tool call. For concrete tool sets, each event union member pairs it with the corresponding tool name.',
             },
           ],
         },
@@ -305,24 +305,24 @@ To see `WorkflowAgent` in action, check out [these examples](#examples).
     },
     {
       name: 'onToolExecutionEnd',
-      type: 'WorkflowAgentonToolExecutionEndCallback',
+      type: 'WorkflowAgentOnToolExecutionEndCallback',
       isOptional: true,
       description:
-        "Callback called right after a tool's execute function completes or errors. The `toolOutput` field is a discriminated union: check `toolOutput.type` to determine whether the result is `'tool-result'` or `'tool-error'`. If also specified in `stream()`, both callbacks fire (constructor first). Experimental (can break in patch releases).",
+        "Callback called right after a tool's execute function completes or errors. Check `success` to determine whether `output` or `error` is available. If also specified in `stream()`, both callbacks fire (constructor first). Experimental (can break in patch releases).",
       properties: [
         {
-          type: 'ToolExecutionEndEvent',
+          type: 'WorkflowAgentToolExecutionEndEvent',
           parameters: [
             {
-              name: 'callId',
-              type: 'string',
+              name: 'toolCall',
+              type: '{ type: "tool-call"; toolCallId: string; toolName: string; input: unknown }',
               description:
-                'Unique identifier for this generation call, used to correlate events.',
+                'The tool call that was executed. For concrete tool sets, the tool name and input are correlated.',
             },
             {
-              name: 'toolCall',
-              type: '{ type: "tool-call"; toolCallId: string; toolName: string; input: unknown }',
-              description: 'The tool call that was executed.',
+              name: 'stepNumber',
+              type: 'number',
+              description: 'The current step number, starting at zero.',
             },
             {
               name: 'durationMs',
@@ -338,15 +338,29 @@ To see `WorkflowAgent` in action, check out [these examples](#examples).
             },
             {
               name: 'toolContext',
-              type: 'InferToolContext<TOOLS[toolName]>',
+              type: 'InferToolContext<TOOLS[NAME]> | undefined',
+              description:
+                'The validated context for the tool call. For concrete tool sets, each event union member pairs it with the corresponding tool name.',
+            },
+            {
+              name: 'success',
+              type: 'boolean',
+              description:
+                'Whether the tool execution succeeded. Discriminates between the output and error event variants.',
+            },
+            {
+              name: 'output',
+              type: 'InferToolOutput<TOOLS[NAME]>',
+              isOptional: true,
               description:
-                'Tool-specific context object for the tool call that just completed. Narrowed to the context type of the individual tool, not the entire tool set.',
+                'The tool output. Available when `success` is `true` and correlated with the configured tool.',
             },
             {
-              name: 'toolOutput',
-              type: 'ToolOutput<TOOLS>',
+              name: 'error',
+              type: 'unknown',
+              isOptional: true,
               description:
-                "Discriminated union representing the tool execution result. When `type` is `'tool-result'`, the `output` field contains the tool's return value. When `type` is `'tool-error'`, the `error` field contains the error.",
+                'The tool execution error. Available when `success` is `false`.',
             },
           ],
         },
@@ -509,7 +523,7 @@ const result = await agent.stream({
       name: 'stopWhen',
       type: 'StopCondition | StopCondition[]',
       isOptional: true,
-      description: 'Condition(s) for ending the agent loop. Use `isLoopFinished()` to let the agent run until all tool calls have completed, but beware of potential runaway loops. See https://ai-sdk.dev/v7/docs/reference/ai-sdk-core/loop-finished#isloopfinished.',
+      description: 'Condition(s) for ending the agent loop. When omitted and no constructor-level condition is configured, WorkflowAgent has no maximum step count and continues until natural completion. Use `isStepCount()` to bound execution.',
     },
 
     {
@@ -644,14 +658,14 @@ const result = await agent.stream({
     },
     {
       name: 'onToolExecutionStart',
-      type: 'WorkflowAgentonToolExecutionStartCallback',
+      type: 'WorkflowAgentOnToolExecutionStartCallback',
       isOptional: true,
       description:
         'Per-call onToolExecutionStart callback. If also specified in the constructor, both fire (constructor first).',
     },
     {
       name: 'onToolExecutionEnd',
-      type: 'WorkflowAgentonToolExecutionEndCallback',
+      type: 'WorkflowAgentOnToolExecutionEndCallback',
       isOptional: true,
       description:
         'Per-call onToolExecutionEnd callback. If also specified in the constructor, both fire (constructor first).',

package/docs/07-reference/05-ai-sdk-errors/ai-no-image-generated-error.mdx

@@ -14,6 +14,7 @@ It can arise due to the following reasons:
 ## Properties
 
 - `message`: The error message (optional, defaults to `'No image generated.'`).
+- `calls`: Results from the underlying image model calls, including generated images, provider metadata, response metadata, warnings, and usage (optional).
 - `responses`: Metadata about the image model responses, including timestamp, model, and headers (optional).
 - `cause`: The cause of the error. You can use this for more detailed error handling (optional).
 
@@ -31,6 +32,12 @@ try {
     console.log('NoImageGeneratedError');
     console.log('Cause:', error.cause);
     console.log('Responses:', error.responses);
+
+    for (const call of error.calls ?? []) {
+      console.log('Provider metadata:', call.providerMetadata);
+      console.log('Warnings:', call.warnings);
+      console.log('Usage:', call.usage);
+    }
   }
 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "7.0.92",
+  "version": "7.0.94",
   "type": "module",
   "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.",
   "license": "Apache-2.0",
@@ -42,20 +42,20 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/gateway": "4.0.74",
-    "@ai-sdk/provider": "4.0.10",
-    "@ai-sdk/provider-utils": "5.0.36"
+    "@ai-sdk/gateway": "4.0.76",
+    "@ai-sdk/provider": "4.0.11",
+    "@ai-sdk/provider-utils": "5.0.37"
   },
   "devDependencies": {
-    "@ai-sdk/amazon-bedrock": "5.0.74",
-    "@ai-sdk/deepseek": "3.0.39",
-    "@ai-sdk/google": "4.0.63",
-    "@ai-sdk/groq": "4.0.37",
-    "@ai-sdk/huggingface": "2.0.43",
-    "@ai-sdk/moonshotai": "3.0.45",
-    "@ai-sdk/openai": "4.0.58",
+    "@ai-sdk/amazon-bedrock": "5.0.77",
+    "@ai-sdk/deepseek": "3.0.40",
+    "@ai-sdk/google": "4.0.65",
+    "@ai-sdk/groq": "4.0.38",
+    "@ai-sdk/huggingface": "2.0.45",
+    "@ai-sdk/moonshotai": "3.0.46",
+    "@ai-sdk/openai": "4.0.61",
     "@ai-sdk/test-server": "2.0.1",
-    "@ai-sdk/xai": "4.0.54",
+    "@ai-sdk/xai": "4.0.55",
     "@edge-runtime/vm": "^5.0.0",
     "@smithy/eventstream-codec": "^4.3.3",
     "@smithy/util-utf8": "^4.3.3",

package/src/agent/tool-loop-agent-settings.ts

@@ -17,6 +17,10 @@ import type {
   GenerateTextOnStepStartCallback,
 } from '../generate-text/generate-text-events';
 import type { GenerateTextInclude } from '../generate-text/generate-text';
+import type {
+  OnLanguageModelCallEndCallback,
+  OnLanguageModelCallStartCallback,
+} from '../generate-text/language-model-events';
 import type { Output } from '../generate-text/output';
 import type { PrepareStepFunction } from '../generate-text/prepare-step';
 import type { StopCondition } from '../generate-text/stop-condition';
@@ -212,6 +216,17 @@ export type ToolLoopAgentSettings<
       NoInfer<OUTPUT>
     >;
 
+    /**
+     * Callback that is called immediately before the provider model call begins.
+     */
+    onLanguageModelCallStart?: OnLanguageModelCallStartCallback;
+
+    /**
+     * Callback that is called after the model response has been normalized and parsed,
+     * but before any client-side tool execution begins.
+     */
+    onLanguageModelCallEnd?: OnLanguageModelCallEndCallback<NoInfer<TOOLS>>;
+
     /**
      * Callback that is called before each tool execution begins.
      */

package/src/batch/batch-types.ts

@@ -1,8 +1,10 @@
 import type {
+  Experimental_BatchV4 as BatchV4,
   Experimental_BatchV4Error as BatchV4Error,
+  Experimental_BatchV4ModelIds as BatchV4ModelIds,
   Experimental_BatchV4StartResult as BatchV4StartResult,
   Experimental_BatchV4Status as BatchV4Status,
-  Experimental_BatchLanguageModelV4 as BatchLanguageModelV4,
+  ProviderV4,
 } from '@ai-sdk/provider';
 import type {
   InferToolSetContext,
@@ -13,40 +15,31 @@ import type { ContentPart } from '../generate-text/content-part';
 import type { ToolOrder } from '../generate-text/tool-order';
 import type { LanguageModelCallOptions } from '../prompt/language-model-call-options';
 import type { Prompt } from '../prompt/prompt';
-import type {
-  FinishReason,
-  GlobalProviderModelId,
-  ToolChoice,
-} from '../types/language-model';
+import type { FinishReason, ToolChoice } from '../types/language-model';
 import type { ProviderMetadata } from '../types/provider-metadata';
 import type { LanguageModelUsage } from '../types/usage';
 
 /**
- * Language model input that can be used for durable batch processing.
- *
- * String model IDs are resolved through the global provider and checked for
- * batch support at runtime.
+ * Provider or lower-level batch interface used for batch processing.
  */
-export type BatchLanguageModel = GlobalProviderModelId | BatchLanguageModelV4;
+export type BatchProvider = ProviderV4 | BatchV4;
+
+type InferBatchModelIds<PROVIDER extends BatchProvider> =
+  PROVIDER extends BatchV4<infer MODEL_IDS>
+    ? MODEL_IDS
+    : PROVIDER extends { experimental_batch(): BatchV4<infer MODEL_IDS> }
+      ? MODEL_IDS
+      : BatchV4ModelIds;
 
 /**
- * The persisted reference for a text batch.
+ * The persisted reference for a batch.
  */
-export type TextBatchReference = {
-  readonly version: 1;
-  readonly type: 'text';
+export type BatchReference = {
+  readonly version: 2;
   readonly id: string;
   readonly provider: string;
-  readonly modelId: string;
 };
 
-/**
- * Persisted reference for any supported batch type.
- *
- * Additional modality-specific references can be added to this union.
- */
-export type BatchReference = TextBatchReference;
-
 /**
  * Serializable error information for a batch or batch item.
  */
@@ -58,55 +51,55 @@ export type BatchError = BatchV4Error;
 export type BatchStatus = BatchV4Status;
 
 /**
- * A text batch and its latest normalized lifecycle status.
+ * A batch and its latest normalized lifecycle status.
  */
-export type TextBatch = TextBatchReference & BatchStatus;
+export type Batch = BatchReference & BatchStatus;
 
 /**
  * One text generation request within a batch.
  */
-export type TextBatchRequest = Prompt &
+export type TextBatchRequest<
+  ModelId extends string = string,
+  TOOLS extends ToolSet = ToolSet,
+> = Prompt &
   LanguageModelCallOptions & {
     id: string;
+    type: 'text';
+    model: ModelId;
+    tools?: TOOLS;
+    toolChoice?: ToolChoice<NoInfer<TOOLS>>;
+    toolOrder?: ToolOrder<TOOLS>;
+    toolsContext?: InferToolSetContext<TOOLS>;
     providerOptions?: ProviderOptions;
   };
 
-type BatchRequestOptions = {
+/**
+ * One request within a batch, discriminated by modality.
+ */
+export type BatchRequest<
+  ModelIds extends BatchV4ModelIds = BatchV4ModelIds,
+  TOOLS extends ToolSet = ToolSet,
+> = TextBatchRequest<ModelIds['text'], TOOLS>;
+
+type BatchCallOptions = {
   abortSignal?: AbortSignal;
   headers?: Record<string, string | undefined>;
   timeout?: number | { totalMs?: number };
 };
 
 /**
- * Options for starting a text batch.
+ * Options for starting a batch.
  */
-export type StartTextBatchOptions<TOOLS extends ToolSet = ToolSet> = {
-  model: BatchLanguageModel;
-  requests: ReadonlyArray<TextBatchRequest>;
-
-  /**
-   * Tools that the model can call for every request in the batch.
-   *
-   * Tool definitions are sent to the provider, but their `execute` functions
-   * are never invoked by batch processing.
-   */
-  tools?: TOOLS;
-
-  /**
-   * The tool choice strategy. Default: 'auto'.
-   */
-  toolChoice?: ToolChoice<NoInfer<TOOLS>>;
-
+export type StartBatchOptions<
+  TOOLS extends ToolSet = ToolSet,
+  PROVIDER extends BatchProvider = BatchProvider,
+> = {
   /**
-   * Controls the order in which tools are sent to the provider. Tools not
-   * listed are appended alphabetically.
+   * Provider used to process the batch. Defaults to the global provider, or
+   * the Vercel AI Gateway when no global provider is configured.
    */
-  toolOrder?: ToolOrder<TOOLS>;
-
-  /**
-   * Context used when resolving dynamic tool descriptions.
-   */
-  toolsContext?: InferToolSetContext<TOOLS>;
+  provider?: PROVIDER;
+  requests: ReadonlyArray<BatchRequest<InferBatchModelIds<PROVIDER>, TOOLS>>;
 
   providerOptions?: ProviderOptions;
 
@@ -116,33 +109,42 @@ export type StartTextBatchOptions<TOOLS extends ToolSet = ToolSet> = {
    * unsupported warning.
    */
   webhookUrl?: string;
-} & BatchRequestOptions;
+} & BatchCallOptions;
 
 /**
- * The acknowledged text batch and warnings produced while starting it.
+ * The acknowledged batch and warnings produced while starting it.
  */
-export type StartTextBatchResult = TextBatch & {
+export type StartBatchResult = Batch & {
   readonly warnings: BatchV4StartResult['warnings'];
 };
 
 /**
- * Options shared by batch status and result retrieval operations.
+ * Options for retrieving batch status.
  */
-export type BatchOperationOptions<TOOLS extends ToolSet = ToolSet> = {
-  model: BatchLanguageModel;
-  batch: BatchReference;
-
+export type GetBatchStatusOptions = {
   /**
-   * Definitions for client tools that were provided to `startTextBatch`.
-   *
-   * The definitions are used only to validate and normalize returned tool
-   * calls. Their `execute` functions are never invoked.
+   * Provider used to access the batch. Defaults to the global provider, or
+   * the Vercel AI Gateway when no global provider is configured.
    */
-  tools?: TOOLS;
-
+  provider?: BatchProvider;
+  batch: BatchReference;
   providerOptions?: ProviderOptions;
   maxRetries?: number;
-} & BatchRequestOptions;
+} & BatchCallOptions;
+
+/**
+ * Options for retrieving batch results.
+ */
+export type GetBatchResultsOptions<TOOLS extends ToolSet = ToolSet> =
+  GetBatchStatusOptions & {
+    /**
+     * Definitions for client tools that were provided to `startBatch` requests.
+     *
+     * The definitions are used only to validate and normalize returned tool
+     * calls. Their `execute` functions are never invoked.
+     */
+    tools?: TOOLS;
+  };
 
 /**
  * A normalized result for a successful text batch item.
@@ -182,3 +184,9 @@ export type TextBatchItemResult<TOOLS extends ToolSet = ToolSet> =
       readonly error?: BatchError;
       readonly providerMetadata?: ProviderMetadata;
     };
+
+/**
+ * A complete terminal result for one request in a batch.
+ */
+export type BatchItemResult<TOOLS extends ToolSet = ToolSet> =
+  TextBatchItemResult<TOOLS>;