ai 4.2.11 → 4.3.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # ai
 
+## 4.3.1
+
+### Patch Changes
+
+- 3d1bd38: feat(smooth-stream): chunking callbacks
+
+## 4.3.0
+
+### Minor Changes
+
+- 772a2d7: feat (core): Add finishReason field to NoObjectGeneratedError
+
+### Patch Changes
+
+- Updated dependencies [2c19b9a]
+  - @ai-sdk/provider-utils@2.2.4
+  - @ai-sdk/react@1.2.6
+  - @ai-sdk/ui-utils@1.2.5
+
 ## 4.2.11
 
 ### Patch Changes

package/dist/index.d.mts

@@ -2254,6 +2254,7 @@ interface Output<OUTPUT, PARTIAL> {
     }, context: {
         response: LanguageModelResponseMetadata;
         usage: LanguageModelUsage;
+        finishReason: FinishReason;
     }): OUTPUT;
 }
 declare const text: () => Output<string, string>;
@@ -2805,6 +2806,14 @@ type TextStreamPart<TOOLS extends ToolSet> = {
     error: unknown;
 };
 
+/**
+ * Detects the first chunk in a buffer.
+ *
+ * @param buffer - The buffer to detect the first chunk in.
+ *
+ * @returns The first detected chunk, or `undefined` if no chunk was detected.
+ */
+type ChunkDetector = (buffer: string) => string | undefined | null;
 /**
  * Smooths text streaming output.
  *
@@ -2815,7 +2824,7 @@ type TextStreamPart<TOOLS extends ToolSet> = {
  */
 declare function smoothStream<TOOLS extends ToolSet>({ delayInMs, chunking, _internal: { delay }, }?: {
     delayInMs?: number | null;
-    chunking?: 'word' | 'line' | RegExp;
+    chunking?: 'word' | 'line' | RegExp | ChunkDetector;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -4114,12 +4123,17 @@ declare class NoObjectGeneratedError extends AISDKError {
     The usage of the model.
      */
     readonly usage: LanguageModelUsage | undefined;
-    constructor({ message, cause, text, response, usage, }: {
+    /**
+    Reason why the model finished generating a response.
+     */
+    readonly finishReason: FinishReason | undefined;
+    constructor({ message, cause, text, response, usage, finishReason, }: {
         message?: string;
         cause?: Error;
         text?: string;
         response: LanguageModelResponseMetadata;
         usage: LanguageModelUsage;
+        finishReason: FinishReason;
     });
     static isInstance(error: unknown): error is NoObjectGeneratedError;
 }
@@ -4376,4 +4390,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamOptions, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MCPClientError, MCPTransport, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, ProviderRegistryProvider, RepairTextFunction, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, createProviderRegistry, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, tool, wrapLanguageModel };
+export { AssistantContent, AssistantResponse, CallWarning, ChunkDetector, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamOptions, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MCPClientError, MCPTransport, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, ProviderRegistryProvider, RepairTextFunction, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, createProviderRegistry, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, tool, wrapLanguageModel };

package/dist/index.d.ts

@@ -2254,6 +2254,7 @@ interface Output<OUTPUT, PARTIAL> {
     }, context: {
         response: LanguageModelResponseMetadata;
         usage: LanguageModelUsage;
+        finishReason: FinishReason;
     }): OUTPUT;
 }
 declare const text: () => Output<string, string>;
@@ -2805,6 +2806,14 @@ type TextStreamPart<TOOLS extends ToolSet> = {
     error: unknown;
 };
 
+/**
+ * Detects the first chunk in a buffer.
+ *
+ * @param buffer - The buffer to detect the first chunk in.
+ *
+ * @returns The first detected chunk, or `undefined` if no chunk was detected.
+ */
+type ChunkDetector = (buffer: string) => string | undefined | null;
 /**
  * Smooths text streaming output.
  *
@@ -2815,7 +2824,7 @@ type TextStreamPart<TOOLS extends ToolSet> = {
  */
 declare function smoothStream<TOOLS extends ToolSet>({ delayInMs, chunking, _internal: { delay }, }?: {
     delayInMs?: number | null;
-    chunking?: 'word' | 'line' | RegExp;
+    chunking?: 'word' | 'line' | RegExp | ChunkDetector;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -4114,12 +4123,17 @@ declare class NoObjectGeneratedError extends AISDKError {
     The usage of the model.
      */
     readonly usage: LanguageModelUsage | undefined;
-    constructor({ message, cause, text, response, usage, }: {
+    /**
+    Reason why the model finished generating a response.
+     */
+    readonly finishReason: FinishReason | undefined;
+    constructor({ message, cause, text, response, usage, finishReason, }: {
         message?: string;
         cause?: Error;
         text?: string;
         response: LanguageModelResponseMetadata;
         usage: LanguageModelUsage;
+        finishReason: FinishReason;
     });
     static isInstance(error: unknown): error is NoObjectGeneratedError;
 }
@@ -4376,4 +4390,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamOptions, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MCPClientError, MCPTransport, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, ProviderRegistryProvider, RepairTextFunction, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, createProviderRegistry, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, tool, wrapLanguageModel };
+export { AssistantContent, AssistantResponse, CallWarning, ChunkDetector, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolCallUnion, CoreToolChoice, CoreToolMessage, CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamOptions, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedFile, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelResponseMetadata, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolArgumentsError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LanguageModelV1Middleware, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MCPClientError, MCPTransport, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, ProviderRegistryProvider, RepairTextFunction, RetryError, StepResult, StreamData, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextPart, TextStreamPart, Tool, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, ToolResultUnion, ToolSet, UserContent, appendClientMessage, appendResponseMessages, convertToCoreMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDataStream, createDataStreamResponse, createProviderRegistry, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, extractReasoningMiddleware, generateObject, generateText, pipeDataStreamToResponse, simulateReadableStream, simulateStreamingMiddleware, smoothStream, streamObject, streamText, tool, wrapLanguageModel };

package/dist/index.js

@@ -1115,13 +1115,15 @@ var NoObjectGeneratedError = class extends import_provider5.AISDKError {
     cause,
     text: text2,
     response,
-    usage
+    usage,
+    finishReason
   }) {
     super({ name: name4, message, cause });
     this[_a4] = true;
     this.text = text2;
     this.response = response;
     this.usage = usage;
+    this.finishReason = finishReason;
   }
   static isInstance(error) {
     return import_provider5.AISDKError.hasMarker(error, marker4);
@@ -2283,7 +2285,8 @@ var noSchemaOutputStrategy = {
         message: "No object generated: response did not match schema.",
         text: context.text,
         response: context.response,
-        usage: context.usage
+        usage: context.usage,
+        finishReason: context.finishReason
       })
     } : { success: true, value };
   },
@@ -2780,7 +2783,8 @@ async function generateObject({
                   throw new NoObjectGeneratedError({
                     message: "No object generated: the model did not return a response.",
                     response: responseData,
-                    usage: calculateLanguageModelUsage(result2.usage)
+                    usage: calculateLanguageModelUsage(result2.usage),
+                    finishReason: result2.finishReason
                   });
                 }
                 span2.setAttributes(
@@ -2889,7 +2893,8 @@ async function generateObject({
                   throw new NoObjectGeneratedError({
                     message: "No object generated: the tool was not called.",
                     response: responseData,
-                    usage: calculateLanguageModelUsage(result2.usage)
+                    usage: calculateLanguageModelUsage(result2.usage),
+                    finishReason: result2.finishReason
                   });
                 }
                 span2.setAttributes(
@@ -2945,7 +2950,8 @@ async function generateObject({
             cause: parseResult.error,
             text: result2,
             response,
-            usage: calculateLanguageModelUsage(usage)
+            usage: calculateLanguageModelUsage(usage),
+            finishReason
           });
         }
         const validationResult = outputStrategy.validateFinalResult(
@@ -2962,7 +2968,8 @@ async function generateObject({
             cause: validationResult.error,
             text: result2,
             response,
-            usage: calculateLanguageModelUsage(usage)
+            usage: calculateLanguageModelUsage(usage),
+            finishReason
           });
         }
         return validationResult.value;
@@ -3567,7 +3574,8 @@ var DefaultStreamObjectResult = class {
                       cause: validationResult.error,
                       text: accumulatedText,
                       response,
-                      usage
+                      usage,
+                      finishReason
                     });
                     self.objectPromise.reject(error);
                   }
@@ -4395,7 +4403,11 @@ async function generateText({
           }
           return output.parseOutput(
             { text: text2 },
-            { response: currentModelResponse.response, usage }
+            {
+              response: currentModelResponse.response,
+              usage,
+              finishReason: currentModelResponse.finishReason
+            }
           );
         },
         toolCalls: currentToolCalls,
@@ -4640,7 +4652,8 @@ var object = ({
           cause: parseResult.error,
           text: text2,
           response: context.response,
-          usage: context.usage
+          usage: context.usage,
+          finishReason: context.finishReason
         });
       }
       const validationResult = (0, import_provider_utils10.safeValidateTypes)({
@@ -4653,7 +4666,8 @@ var object = ({
           cause: validationResult.error,
           text: text2,
           response: context.response,
-          usage: context.usage
+          usage: context.usage,
+          finishReason: context.finishReason
         });
       }
       return validationResult.value;
@@ -4662,23 +4676,49 @@ var object = ({
 };
 
 // core/generate-text/smooth-stream.ts
-var import_provider21 = require("@ai-sdk/provider");
 var import_provider_utils11 = require("@ai-sdk/provider-utils");
+var import_provider21 = require("@ai-sdk/provider");
 var CHUNKING_REGEXPS = {
-  word: /\s*\S+\s+/m,
-  line: /[^\n]*\n/m
+  word: /\S+\s+/m,
+  line: /\n+/m
 };
 function smoothStream({
   delayInMs = 10,
   chunking = "word",
   _internal: { delay: delay2 = import_provider_utils11.delay } = {}
 } = {}) {
-  const chunkingRegexp = typeof chunking === "string" ? CHUNKING_REGEXPS[chunking] : chunking;
-  if (chunkingRegexp == null) {
-    throw new import_provider21.InvalidArgumentError({
-      argument: "chunking",
-      message: `Chunking must be "word" or "line" or a RegExp. Received: ${chunking}`
-    });
+  let detectChunk;
+  if (typeof chunking === "function") {
+    detectChunk = (buffer) => {
+      const match = chunking(buffer);
+      if (match == null) {
+        return null;
+      }
+      if (!match.length) {
+        throw new Error(`Chunking function must return a non-empty string.`);
+      }
+      if (!buffer.startsWith(match)) {
+        throw new Error(
+          `Chunking function must return a match that is a prefix of the buffer. Received: "${match}" expected to start with "${buffer}"`
+        );
+      }
+      return match;
+    };
+  } else {
+    const chunkingRegex = typeof chunking === "string" ? CHUNKING_REGEXPS[chunking] : chunking;
+    if (chunkingRegex == null) {
+      throw new import_provider21.InvalidArgumentError({
+        argument: "chunking",
+        message: `Chunking must be "word" or "line" or a RegExp. Received: ${chunking}`
+      });
+    }
+    detectChunk = (buffer) => {
+      const match = chunkingRegex.exec(buffer);
+      if (!match) {
+        return null;
+      }
+      return buffer.slice(0, match.index) + (match == null ? void 0 : match[0]);
+    };
   }
   return () => {
     let buffer = "";
@@ -4694,10 +4734,9 @@ function smoothStream({
         }
         buffer += chunk.textDelta;
         let match;
-        while ((match = chunkingRegexp.exec(buffer)) != null) {
-          const chunk2 = match[0];
-          controller.enqueue({ type: "text-delta", textDelta: chunk2 });
-          buffer = buffer.slice(chunk2.length);
+        while ((match = detectChunk(buffer)) != null) {
+          controller.enqueue({ type: "text-delta", textDelta: match });
+          buffer = buffer.slice(match.length);
           await delay2(delayInMs);
         }
       }