ai 3.1.27 → 3.1.29

package/dist/index.d.mts

@@ -582,7 +582,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing the partial object stream and additional information.
  */
-declare function streamObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, ...settings }: CallSettings & Prompt & {
+declare function streamObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, onFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -606,6 +606,36 @@ Please note that most providers do not support all modes.
 Default and recommended: 'auto' (best mode for the model).
      */
     mode?: 'auto' | 'json' | 'tool' | 'grammar';
+    /**
+Callback that is called when the LLM response and the final object validation are finished.
+     */
+    onFinish?: (event: {
+        /**
+  The token usage of the generated response.
+  */
+        usage: TokenUsage;
+        /**
+  The generated object (typed according to the schema). Can be undefined if the final object does not match the schema.
+     */
+        object: T | undefined;
+        /**
+  Optional error object. This is e.g. a TypeValidationError when the final object does not match the schema.
+     */
+        error: unknown | undefined;
+        /**
+  Optional raw response data.
+     */
+        rawResponse?: {
+            /**
+    Response headers.
+         */
+            headers?: Record<string, string>;
+        };
+        /**
+  Warnings from the model provider (e.g. unsupported settings).
+         */
+        warnings?: CallWarning[];
+    }) => Promise<void> | void;
 }): Promise<StreamObjectResult<T>>;
 type ObjectStreamInputPart = {
     type: 'error';
@@ -628,12 +658,16 @@ type ObjectStreamPart<T> = ObjectStreamInputPart | {
 The result of a `streamObject` call that contains the partial object stream and additional information.
  */
 declare class StreamObjectResult<T> {
-    readonly originalStream: ReadableStream<ObjectStreamPart<T>>;
+    private readonly originalStream;
     /**
   Warnings from the model provider (e.g. unsupported settings)
      */
     readonly warnings: CallWarning[] | undefined;
     /**
+  The generated object (typed according to the schema). Resolved when the response is finished.
+     */
+    readonly object: Promise<T>;
+    /**
   The token usage of the generated response. Resolved when the response is finished.
      */
     readonly usage: Promise<TokenUsage>;
@@ -646,12 +680,14 @@ declare class StreamObjectResult<T> {
      */
         headers?: Record<string, string>;
     };
-    constructor({ stream, warnings, rawResponse, }: {
+    constructor({ stream, warnings, rawResponse, schema, onFinish, }: {
         stream: ReadableStream<string | ObjectStreamInputPart>;
         warnings: CallWarning[] | undefined;
         rawResponse?: {
             headers?: Record<string, string>;
         };
+        schema: z.Schema<T>;
+        onFinish: Parameters<typeof streamObject<T>>[0]['onFinish'];
     });
     get partialObjectStream(): AsyncIterableStream<DeepPartial<T>>;
     get fullStream(): AsyncIterableStream<ObjectStreamPart<T>>;

package/dist/index.d.ts

@@ -582,7 +582,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing the partial object stream and additional information.
  */
-declare function streamObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, ...settings }: CallSettings & Prompt & {
+declare function streamObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, onFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -606,6 +606,36 @@ Please note that most providers do not support all modes.
 Default and recommended: 'auto' (best mode for the model).
      */
     mode?: 'auto' | 'json' | 'tool' | 'grammar';
+    /**
+Callback that is called when the LLM response and the final object validation are finished.
+     */
+    onFinish?: (event: {
+        /**
+  The token usage of the generated response.
+  */
+        usage: TokenUsage;
+        /**
+  The generated object (typed according to the schema). Can be undefined if the final object does not match the schema.
+     */
+        object: T | undefined;
+        /**
+  Optional error object. This is e.g. a TypeValidationError when the final object does not match the schema.
+     */
+        error: unknown | undefined;
+        /**
+  Optional raw response data.
+     */
+        rawResponse?: {
+            /**
+    Response headers.
+         */
+            headers?: Record<string, string>;
+        };
+        /**
+  Warnings from the model provider (e.g. unsupported settings).
+         */
+        warnings?: CallWarning[];
+    }) => Promise<void> | void;
 }): Promise<StreamObjectResult<T>>;
 type ObjectStreamInputPart = {
     type: 'error';
@@ -628,12 +658,16 @@ type ObjectStreamPart<T> = ObjectStreamInputPart | {
 The result of a `streamObject` call that contains the partial object stream and additional information.
  */
 declare class StreamObjectResult<T> {
-    readonly originalStream: ReadableStream<ObjectStreamPart<T>>;
+    private readonly originalStream;
     /**
   Warnings from the model provider (e.g. unsupported settings)
      */
     readonly warnings: CallWarning[] | undefined;
     /**
+  The generated object (typed according to the schema). Resolved when the response is finished.
+     */
+    readonly object: Promise<T>;
+    /**
   The token usage of the generated response. Resolved when the response is finished.
      */
     readonly usage: Promise<TokenUsage>;
@@ -646,12 +680,14 @@ declare class StreamObjectResult<T> {
      */
         headers?: Record<string, string>;
     };
-    constructor({ stream, warnings, rawResponse, }: {
+    constructor({ stream, warnings, rawResponse, schema, onFinish, }: {
         stream: ReadableStream<string | ObjectStreamInputPart>;
         warnings: CallWarning[] | undefined;
         rawResponse?: {
             headers?: Record<string, string>;
         };
+        schema: z.Schema<T>;
+        onFinish: Parameters<typeof streamObject<T>>[0]['onFinish'];
     });
     get partialObjectStream(): AsyncIterableStream<DeepPartial<T>>;
     get fullStream(): AsyncIterableStream<ObjectStreamPart<T>>;

package/dist/index.js

@@ -1080,6 +1080,7 @@ function parsePartialJson(jsonText) {
 }
 
 // core/generate-object/stream-object.ts
+var import_provider_utils4 = require("@ai-sdk/provider-utils");
 async function streamObject({
   model,
   schema,
@@ -1089,6 +1090,7 @@ async function streamObject({
   messages,
   maxRetries,
   abortSignal,
+  onFinish,
   ...settings
 }) {
   const retry = retryWithExponentialBackoff({ maxRetries });
@@ -1203,22 +1205,34 @@ async function streamObject({
   return new StreamObjectResult({
     stream: result.stream.pipeThrough(new TransformStream(transformer)),
     warnings: result.warnings,
-    rawResponse: result.rawResponse
+    rawResponse: result.rawResponse,
+    schema,
+    onFinish
   });
 }
 var StreamObjectResult = class {
   constructor({
     stream,
     warnings,
-    rawResponse
+    rawResponse,
+    schema,
+    onFinish
   }) {
     this.warnings = warnings;
     this.rawResponse = rawResponse;
+    let resolveObject;
+    let rejectObject;
+    this.object = new Promise((resolve, reject) => {
+      resolveObject = resolve;
+      rejectObject = reject;
+    });
     let resolveUsage;
     this.usage = new Promise((resolve) => {
       resolveUsage = resolve;
     });
     let usage;
+    let object;
+    let error;
     let accumulatedText = "";
     let latestObject = void 0;
     this.originalStream = stream.pipeThrough(
@@ -1238,11 +1252,19 @@ var StreamObjectResult = class {
           switch (chunk.type) {
             case "finish": {
               usage = calculateTokenUsage(chunk.usage);
-              controller.enqueue({
-                ...chunk,
-                usage
-              });
+              controller.enqueue({ ...chunk, usage });
               resolveUsage(usage);
+              const validationResult = (0, import_provider_utils4.safeValidateTypes)({
+                value: latestObject,
+                schema
+              });
+              if (validationResult.success) {
+                object = validationResult.value;
+                resolveObject(object);
+              } else {
+                error = validationResult.error;
+                rejectObject(error);
+              }
               break;
             }
             default: {
@@ -1250,6 +1272,24 @@ var StreamObjectResult = class {
               break;
             }
           }
+        },
+        // invoke onFinish callback and resolve toolResults promise when the stream is about to close:
+        async flush(controller) {
+          try {
+            await (onFinish == null ? void 0 : onFinish({
+              usage: usage != null ? usage : {
+                promptTokens: NaN,
+                completionTokens: NaN,
+                totalTokens: NaN
+              },
+              object,
+              error,
+              rawResponse,
+              warnings
+            }));
+          } catch (error2) {
+            controller.error(error2);
+          }
         }
       })
     );
@@ -1313,7 +1353,7 @@ function prepareToolsAndToolChoice({
 
 // core/generate-text/tool-call.ts
 var import_provider6 = require("@ai-sdk/provider");
-var import_provider_utils4 = require("@ai-sdk/provider-utils");
+var import_provider_utils5 = require("@ai-sdk/provider-utils");
 function parseToolCall({
   toolCall,
   tools
@@ -1329,7 +1369,7 @@ function parseToolCall({
       availableTools: Object.keys(tools)
     });
   }
-  const parseResult = (0, import_provider_utils4.safeParseJSON)({
+  const parseResult = (0, import_provider_utils5.safeParseJSON)({
     text: toolCall.args,
     schema: tool2.parameters
   });