ai 5.0.0-canary.1 → 5.0.0-canary.3

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # ai
 
+## 5.0.0-canary.3
+
+### Patch Changes
+
+- Updated dependencies [c57e248]
+- Updated dependencies [33f4a6a]
+  - @ai-sdk/provider@2.0.0-canary.1
+  - @ai-sdk/provider-utils@3.0.0-canary.2
+  - @ai-sdk/ui-utils@2.0.0-canary.2
+
+## 5.0.0-canary.2
+
+### Patch Changes
+
+- bd398e4: fix (core): improve error handling in streamText's consumeStream method
+
 ## 5.0.0-canary.1
 
 ### Minor Changes

package/dist/index.d.mts

@@ -2,7 +2,7 @@ import { IDGenerator } from '@ai-sdk/provider-utils';
 export { CoreToolCall, CoreToolResult, IDGenerator, ToolCall, ToolResult, createIdGenerator, generateId } from '@ai-sdk/provider-utils';
 import { DataStreamString, Message, Schema, DeepPartial, JSONValue as JSONValue$1 } from '@ai-sdk/ui-utils';
 export { Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataStreamPart, DeepPartial, IdGenerator, JSONValue, Message, RequestOptions, Schema, ToolInvocation, UIMessage, formatDataStreamPart, jsonSchema, parseDataStreamPart, processDataStream, processTextStream, zodSchema } from '@ai-sdk/ui-utils';
-import { LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2LogProbs, LanguageModelV2CallWarning, LanguageModelV2Source, JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV2ProviderMetadata, LanguageModelV2CallOptions, AISDKError, LanguageModelV2FunctionToolCall, JSONSchema7, JSONParseError, TypeValidationError, LanguageModelV2Middleware, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
+import { LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2LogProbs, LanguageModelV2CallWarning, LanguageModelV2Source, JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV2ProviderMetadata, LanguageModelV2CallOptions, AISDKError, LanguageModelV2FunctionToolCall, JSONSchema7, JSONParseError, TypeValidationError, LanguageModelV2ProviderOptions, LanguageModelV2Middleware, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
 export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Prompt, LanguageModelV2StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
 import { ServerResponse } from 'node:http';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
@@ -2539,6 +2539,9 @@ type DataStreamOptions = {
      */
     experimental_sendStart?: boolean;
 };
+type ConsumeStreamOptions = {
+    onError?: (error: unknown) => void;
+};
 /**
 A result object for accessing different stream types and additional information.
  */
@@ -2659,8 +2662,10 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
   This is useful to force the stream to finish.
   It effectively removes the backpressure and allows the stream to finish,
   triggering the `onFinish` callback and the promise resolution.
+  
+  If an error occurs, it is passed to the optional `onError` callback.
     */
-    consumeStream(): Promise<void>;
+    consumeStream(options?: ConsumeStreamOptions): Promise<void>;
     /**
     Converts the result to a data stream.
   
@@ -3792,7 +3797,7 @@ Callback that is called when the LLM response and the final object validation ar
  */
 declare function defaultSettingsMiddleware({ settings, }: {
     settings: Partial<LanguageModelV2CallOptions & {
-        providerMetadata?: LanguageModelV2ProviderMetadata;
+        providerOptions?: LanguageModelV2ProviderOptions;
     }>;
 }): LanguageModelV2Middleware;
 
@@ -4249,7 +4254,7 @@ The following streams are supported:
 - `LangChainAIMessageChunk` streams (LangChain `model.stream` output)
 - `string` streams (LangChain `StringOutputParser` output)
  */
-declare function toDataStream$1(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array>;
+declare function toDataStream$1(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array<ArrayBufferLike>>;
 declare function toDataStreamResponse$1(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, options?: {
     init?: ResponseInit;
     data?: StreamData;
@@ -4271,7 +4276,7 @@ declare namespace langchainAdapter {
 type EngineResponse = {
     delta: string;
 };
-declare function toDataStream(stream: AsyncIterable<EngineResponse>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array>;
+declare function toDataStream(stream: AsyncIterable<EngineResponse>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array<ArrayBufferLike>>;
 declare function toDataStreamResponse(stream: AsyncIterable<EngineResponse>, options?: {
     init?: ResponseInit;
     data?: StreamData;

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import { IDGenerator } from '@ai-sdk/provider-utils';
 export { CoreToolCall, CoreToolResult, IDGenerator, ToolCall, ToolResult, createIdGenerator, generateId } from '@ai-sdk/provider-utils';
 import { DataStreamString, Message, Schema, DeepPartial, JSONValue as JSONValue$1 } from '@ai-sdk/ui-utils';
 export { Attachment, ChatRequest, ChatRequestOptions, CreateMessage, DataStreamPart, DeepPartial, IdGenerator, JSONValue, Message, RequestOptions, Schema, ToolInvocation, UIMessage, formatDataStreamPart, jsonSchema, parseDataStreamPart, processDataStream, processTextStream, zodSchema } from '@ai-sdk/ui-utils';
-import { LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2LogProbs, LanguageModelV2CallWarning, LanguageModelV2Source, JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV2ProviderMetadata, LanguageModelV2CallOptions, AISDKError, LanguageModelV2FunctionToolCall, JSONSchema7, JSONParseError, TypeValidationError, LanguageModelV2Middleware, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
+import { LanguageModelV2, LanguageModelV2FinishReason, LanguageModelV2LogProbs, LanguageModelV2CallWarning, LanguageModelV2Source, JSONValue, EmbeddingModelV1, EmbeddingModelV1Embedding, ImageModelV1, ImageModelV1CallWarning, LanguageModelV2ProviderMetadata, LanguageModelV2CallOptions, AISDKError, LanguageModelV2FunctionToolCall, JSONSchema7, JSONParseError, TypeValidationError, LanguageModelV2ProviderOptions, LanguageModelV2Middleware, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
 export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Prompt, LanguageModelV2StreamPart, LoadAPIKeyError, NoContentGeneratedError, NoSuchModelError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
 import { ServerResponse } from 'node:http';
 import { AttributeValue, Tracer } from '@opentelemetry/api';
@@ -2539,6 +2539,9 @@ type DataStreamOptions = {
      */
     experimental_sendStart?: boolean;
 };
+type ConsumeStreamOptions = {
+    onError?: (error: unknown) => void;
+};
 /**
 A result object for accessing different stream types and additional information.
  */
@@ -2659,8 +2662,10 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
   This is useful to force the stream to finish.
   It effectively removes the backpressure and allows the stream to finish,
   triggering the `onFinish` callback and the promise resolution.
+  
+  If an error occurs, it is passed to the optional `onError` callback.
     */
-    consumeStream(): Promise<void>;
+    consumeStream(options?: ConsumeStreamOptions): Promise<void>;
     /**
     Converts the result to a data stream.
   
@@ -3792,7 +3797,7 @@ Callback that is called when the LLM response and the final object validation ar
  */
 declare function defaultSettingsMiddleware({ settings, }: {
     settings: Partial<LanguageModelV2CallOptions & {
-        providerMetadata?: LanguageModelV2ProviderMetadata;
+        providerOptions?: LanguageModelV2ProviderOptions;
     }>;
 }): LanguageModelV2Middleware;
 
@@ -4249,7 +4254,7 @@ The following streams are supported:
 - `LangChainAIMessageChunk` streams (LangChain `model.stream` output)
 - `string` streams (LangChain `StringOutputParser` output)
  */
-declare function toDataStream$1(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array>;
+declare function toDataStream$1(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array<ArrayBufferLike>>;
 declare function toDataStreamResponse$1(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, options?: {
     init?: ResponseInit;
     data?: StreamData;
@@ -4271,7 +4276,7 @@ declare namespace langchainAdapter {
 type EngineResponse = {
     delta: string;
 };
-declare function toDataStream(stream: AsyncIterable<EngineResponse>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array>;
+declare function toDataStream(stream: AsyncIterable<EngineResponse>, callbacks?: StreamCallbacks): ReadableStream<Uint8Array<ArrayBufferLike>>;
 declare function toDataStreamResponse(stream: AsyncIterable<EngineResponse>, options?: {
     init?: ResponseInit;
     data?: StreamData;

package/dist/index.js

@@ -1321,7 +1321,7 @@ function convertToLanguageModelMessage(message, downloadedAssets) {
       return {
         role: "system",
         content: message.content,
-        providerMetadata: (_a17 = message.providerOptions) != null ? _a17 : message.experimental_providerMetadata
+        providerOptions: (_a17 = message.providerOptions) != null ? _a17 : message.experimental_providerMetadata
       };
     }
     case "user": {
@@ -1329,13 +1329,13 @@ function convertToLanguageModelMessage(message, downloadedAssets) {
         return {
           role: "user",
           content: [{ type: "text", text: message.content }],
-          providerMetadata: (_b = message.providerOptions) != null ? _b : message.experimental_providerMetadata
+          providerOptions: (_b = message.providerOptions) != null ? _b : message.experimental_providerMetadata
         };
       }
       return {
         role: "user",
         content: message.content.map((part) => convertPartToLanguageModelPart(part, downloadedAssets)).filter((part) => part.type !== "text" || part.text !== ""),
-        providerMetadata: (_c = message.providerOptions) != null ? _c : message.experimental_providerMetadata
+        providerOptions: (_c = message.providerOptions) != null ? _c : message.experimental_providerMetadata
       };
     }
     case "assistant": {
@@ -1343,7 +1343,7 @@ function convertToLanguageModelMessage(message, downloadedAssets) {
         return {
           role: "assistant",
           content: [{ type: "text", text: message.content }],
-          providerMetadata: (_d = message.providerOptions) != null ? _d : message.experimental_providerMetadata
+          providerOptions: (_d = message.providerOptions) != null ? _d : message.experimental_providerMetadata
         };
       }
       return {
@@ -1361,7 +1361,7 @@ function convertToLanguageModelMessage(message, downloadedAssets) {
                 data: part.data instanceof URL ? part.data : convertDataContentToBase64String(part.data),
                 filename: part.filename,
                 mimeType: part.mimeType,
-                providerMetadata: providerOptions
+                providerOptions
               };
             }
             case "reasoning": {
@@ -1369,21 +1369,21 @@ function convertToLanguageModelMessage(message, downloadedAssets) {
                 type: "reasoning",
                 text: part.text,
                 signature: part.signature,
-                providerMetadata: providerOptions
+                providerOptions
               };
             }
             case "redacted-reasoning": {
               return {
                 type: "redacted-reasoning",
                 data: part.data,
-                providerMetadata: providerOptions
+                providerOptions
               };
             }
             case "text": {
               return {
                 type: "text",
                 text: part.text,
-                providerMetadata: providerOptions
+                providerOptions
               };
             }
             case "tool-call": {
@@ -1392,12 +1392,12 @@ function convertToLanguageModelMessage(message, downloadedAssets) {
                 toolCallId: part.toolCallId,
                 toolName: part.toolName,
                 args: part.args,
-                providerMetadata: providerOptions
+                providerOptions
               };
             }
           }
         }),
-        providerMetadata: (_e = message.providerOptions) != null ? _e : message.experimental_providerMetadata
+        providerOptions: (_e = message.providerOptions) != null ? _e : message.experimental_providerMetadata
       };
     }
     case "tool": {
@@ -1412,10 +1412,10 @@ function convertToLanguageModelMessage(message, downloadedAssets) {
             result: part.result,
             content: part.experimental_content,
             isError: part.isError,
-            providerMetadata: (_a18 = part.providerOptions) != null ? _a18 : part.experimental_providerMetadata
+            providerOptions: (_a18 = part.providerOptions) != null ? _a18 : part.experimental_providerMetadata
           };
         }),
-        providerMetadata: (_f = message.providerOptions) != null ? _f : message.experimental_providerMetadata
+        providerOptions: (_f = message.providerOptions) != null ? _f : message.experimental_providerMetadata
       };
     }
     default: {
@@ -1453,7 +1453,7 @@ function convertPartToLanguageModelPart(part, downloadedAssets) {
     return {
       type: "text",
       text: part.text,
-      providerMetadata: (_a17 = part.providerOptions) != null ? _a17 : part.experimental_providerMetadata
+      providerOptions: (_a17 = part.providerOptions) != null ? _a17 : part.experimental_providerMetadata
     };
   }
   let mimeType = part.mimeType;
@@ -1507,7 +1507,7 @@ function convertPartToLanguageModelPart(part, downloadedAssets) {
         type: "image",
         image: normalizedData,
         mimeType,
-        providerMetadata: (_c = part.providerOptions) != null ? _c : part.experimental_providerMetadata
+        providerOptions: (_c = part.providerOptions) != null ? _c : part.experimental_providerMetadata
       };
     }
     case "file": {
@@ -1519,7 +1519,7 @@ function convertPartToLanguageModelPart(part, downloadedAssets) {
         data: normalizedData instanceof Uint8Array ? convertDataContentToBase64String(normalizedData) : normalizedData,
         filename: part.filename,
         mimeType,
-        providerMetadata: (_d = part.providerOptions) != null ? _d : part.experimental_providerMetadata
+        providerOptions: (_d = part.providerOptions) != null ? _d : part.experimental_providerMetadata
       };
     }
   }
@@ -2758,8 +2758,8 @@ async function generateObject({
               fn: async (span2) => {
                 var _a18, _b2, _c2, _d2, _e, _f;
                 const result2 = await model.doGenerate({
-                  mode: {
-                    type: "object-json",
+                  responseFormat: {
+                    type: "json",
                     schema: outputStrategy.jsonSchema,
                     name: schemaName,
                     description: schemaDescription
@@ -2767,7 +2767,7 @@ async function generateObject({
                   ...prepareCallSettings(settings),
                   inputFormat: standardizedPrompt.type,
                   prompt: promptMessages,
-                  providerMetadata: providerOptions,
+                  providerOptions,
                   abortSignal,
                   headers
                 });
@@ -2864,19 +2864,19 @@ async function generateObject({
               fn: async (span2) => {
                 var _a18, _b2, _c2, _d2, _e, _f, _g, _h;
                 const result2 = await model.doGenerate({
-                  mode: {
-                    type: "object-tool",
-                    tool: {
+                  tools: [
+                    {
                       type: "function",
                       name: schemaName != null ? schemaName : "json",
                       description: schemaDescription != null ? schemaDescription : "Respond with a JSON object.",
                       parameters: outputStrategy.jsonSchema
                     }
-                  },
+                  ],
+                  toolChoice: { type: "required" },
                   ...prepareCallSettings(settings),
                   inputFormat,
                   prompt: promptMessages,
-                  providerMetadata: providerOptions,
+                  providerOptions,
                   abortSignal,
                   headers
                 });
@@ -3339,8 +3339,8 @@ var DefaultStreamObjectResult = class {
               tools: void 0
             });
             callOptions = {
-              mode: {
-                type: "object-json",
+              responseFormat: {
+                type: "json",
                 schema: outputStrategy.jsonSchema,
                 name: schemaName,
                 description: schemaDescription
@@ -3353,7 +3353,7 @@ var DefaultStreamObjectResult = class {
                 modelSupportsUrl: (_a17 = model.supportsUrl) == null ? void 0 : _a17.bind(model)
                 // support 'this' context
               }),
-              providerMetadata: providerOptions,
+              providerOptions,
               abortSignal,
               headers
             };
@@ -3379,15 +3379,15 @@ var DefaultStreamObjectResult = class {
               tools: void 0
             });
             callOptions = {
-              mode: {
-                type: "object-tool",
-                tool: {
+              tools: [
+                {
                   type: "function",
                   name: schemaName != null ? schemaName : "json",
                   description: schemaDescription != null ? schemaDescription : "Respond with a JSON object.",
                   parameters: outputStrategy.jsonSchema
                 }
-              },
+              ],
+              toolChoice: { type: "required" },
               ...prepareCallSettings(settings),
               inputFormat: standardizedPrompt.type,
               prompt: await convertToLanguageModelPrompt({
@@ -3396,7 +3396,7 @@ var DefaultStreamObjectResult = class {
                 modelSupportsUrl: (_b = model.supportsUrl) == null ? void 0 : _b.bind(model)
                 // support 'this' context,
               }),
-              providerMetadata: providerOptions,
+              providerOptions,
               abortSignal,
               headers
             };
@@ -4153,8 +4153,7 @@ async function generateText({
     tracer,
     fn: async (span) => {
       var _a18, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k;
-      const mode = {
-        type: "regular",
+      const toolsAndToolChoice = {
         ...prepareToolsAndToolChoice({ tools, toolChoice, activeTools })
       };
       const callSettings = prepareCallSettings(settings);
@@ -4208,11 +4207,11 @@ async function generateText({
                   // convert the language model level tools:
                   input: () => {
                     var _a19;
-                    return (_a19 = mode.tools) == null ? void 0 : _a19.map((tool2) => JSON.stringify(tool2));
+                    return (_a19 = toolsAndToolChoice.tools) == null ? void 0 : _a19.map((tool2) => JSON.stringify(tool2));
                   }
                 },
                 "ai.prompt.toolChoice": {
-                  input: () => mode.toolChoice != null ? JSON.stringify(mode.toolChoice) : void 0
+                  input: () => toolsAndToolChoice.toolChoice != null ? JSON.stringify(toolsAndToolChoice.toolChoice) : void 0
                 },
                 // standardized gen-ai llm span attributes:
                 "gen_ai.system": model.provider,
@@ -4230,12 +4229,12 @@ async function generateText({
             fn: async (span2) => {
               var _a19, _b2, _c2, _d2, _e2, _f2;
               const result = await model.doGenerate({
-                mode,
                 ...callSettings,
+                ...toolsAndToolChoice,
                 inputFormat: promptFormat,
                 responseFormat: output == null ? void 0 : output.responseFormat({ model }),
                 prompt: promptMessages,
-                providerMetadata: providerOptions,
+                providerOptions,
                 abortSignal,
                 headers
               });
@@ -4751,6 +4750,25 @@ function asArray(value) {
   return value === void 0 ? [] : Array.isArray(value) ? value : [value];
 }
 
+// util/consume-stream.ts
+async function consumeStream({
+  stream,
+  onError
+}) {
+  const reader = stream.getReader();
+  try {
+    while (true) {
+      const { done } = await reader.read();
+      if (done)
+        break;
+    }
+  } catch (error) {
+    onError == null ? void 0 : onError(error);
+  } finally {
+    reader.releaseLock();
+  }
+}
+
 // core/util/merge-streams.ts
 function mergeStreams(stream1, stream2) {
   const reader1 = stream1.getReader();
@@ -5506,8 +5524,7 @@ var DefaultStreamTextResult = class {
             modelSupportsUrl: (_a18 = model.supportsUrl) == null ? void 0 : _a18.bind(model)
             // support 'this' context
           });
-          const mode = {
-            type: "regular",
+          const toolsAndToolChoice = {
             ...prepareToolsAndToolChoice({ tools, toolChoice, activeTools })
           };
           const {
@@ -5535,11 +5552,13 @@ var DefaultStreamTextResult = class {
                     // convert the language model level tools:
                     input: () => {
                       var _a19;
-                      return (_a19 = mode.tools) == null ? void 0 : _a19.map((tool2) => JSON.stringify(tool2));
+                      return (_a19 = toolsAndToolChoice.tools) == null ? void 0 : _a19.map(
+                        (tool2) => JSON.stringify(tool2)
+                      );
                     }
                   },
                   "ai.prompt.toolChoice": {
-                    input: () => mode.toolChoice != null ? JSON.stringify(mode.toolChoice) : void 0
+                    input: () => toolsAndToolChoice.toolChoice != null ? JSON.stringify(toolsAndToolChoice.toolChoice) : void 0
                   },
                   // standardized gen-ai llm span attributes:
                   "gen_ai.system": model.provider,
@@ -5560,12 +5579,12 @@ var DefaultStreamTextResult = class {
                 // get before the call
                 doStreamSpan: doStreamSpan2,
                 result: await model.doStream({
-                  mode,
                   ...prepareCallSettings(settings),
+                  ...toolsAndToolChoice,
                   inputFormat: promptFormat,
                   responseFormat: output == null ? void 0 : output.responseFormat({ model }),
                   prompt: promptMessages,
-                  providerMetadata: providerOptions,
+                  providerOptions,
                   abortSignal,
                   headers
                 })
@@ -5992,9 +6011,15 @@ var DefaultStreamTextResult = class {
       )
     );
   }
-  async consumeStream() {
-    const stream = this.fullStream;
-    for await (const part of stream) {
+  async consumeStream(options) {
+    var _a17;
+    try {
+      await consumeStream({
+        stream: this.fullStream,
+        onError: options == null ? void 0 : options.onError
+      });
+    } catch (error) {
+      (_a17 = options == null ? void 0 : options.onError) == null ? void 0 : _a17.call(options, error);
     }
   }
   get experimental_partialOutputStream() {
@@ -6309,9 +6334,9 @@ function defaultSettingsMiddleware({
       return {
         ...settings,
         ...params,
-        providerMetadata: mergeObjects(
-          settings.providerMetadata,
-          params.providerMetadata
+        providerOptions: mergeObjects(
+          settings.providerOptions,
+          params.providerOptions
         ),
         // special case for temperature 0
         // TODO remove when temperature defaults to undefined