ai 3.1.28 → 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';
@@ -650,13 +680,14 @@ declare class StreamObjectResult<T> {
      */
         headers?: Record<string, string>;
     };
-    constructor({ stream, warnings, rawResponse, schema, }: {
+    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';
@@ -650,13 +680,14 @@ declare class StreamObjectResult<T> {
      */
         headers?: Record<string, string>;
     };
-    constructor({ stream, warnings, rawResponse, schema, }: {
+    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

@@ -1090,6 +1090,7 @@ async function streamObject({
   messages,
   maxRetries,
   abortSignal,
+  onFinish,
   ...settings
 }) {
   const retry = retryWithExponentialBackoff({ maxRetries });
@@ -1205,7 +1206,8 @@ async function streamObject({
     stream: result.stream.pipeThrough(new TransformStream(transformer)),
     warnings: result.warnings,
     rawResponse: result.rawResponse,
-    schema
+    schema,
+    onFinish
   });
 }
 var StreamObjectResult = class {
@@ -1213,7 +1215,8 @@ var StreamObjectResult = class {
     stream,
     warnings,
     rawResponse,
-    schema
+    schema,
+    onFinish
   }) {
     this.warnings = warnings;
     this.rawResponse = rawResponse;
@@ -1228,6 +1231,8 @@ var StreamObjectResult = class {
       resolveUsage = resolve;
     });
     let usage;
+    let object;
+    let error;
     let accumulatedText = "";
     let latestObject = void 0;
     this.originalStream = stream.pipeThrough(
@@ -1254,9 +1259,11 @@ var StreamObjectResult = class {
                 schema
               });
               if (validationResult.success) {
-                resolveObject(validationResult.value);
+                object = validationResult.value;
+                resolveObject(object);
               } else {
-                rejectObject(validationResult.error);
+                error = validationResult.error;
+                rejectObject(error);
               }
               break;
             }
@@ -1265,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);
+          }
         }
       })
     );