ai 3.2.0 → 3.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -59,11 +59,11 @@
   "dependencies": {
     "@ai-sdk/provider": "0.0.10",
     "@ai-sdk/provider-utils": "0.0.15",
-    "@ai-sdk/react": "0.0.3",
-    "@ai-sdk/solid": "0.0.3",
-    "@ai-sdk/svelte": "0.0.3",
-    "@ai-sdk/ui-utils": "0.0.3",
-    "@ai-sdk/vue": "0.0.3",
+    "@ai-sdk/react": "0.0.4",
+    "@ai-sdk/solid": "0.0.4",
+    "@ai-sdk/svelte": "0.0.4",
+    "@ai-sdk/ui-utils": "0.0.4",
+    "@ai-sdk/vue": "0.0.4",
     "eventsource-parser": "1.1.2",
     "jsondiffpatch": "0.6.0",
     "json-schema": "0.4.0",

package/rsc/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { ReactNode } from 'react';
 import OpenAI from 'openai';
 import { z } from 'zod';
-import { LanguageModelV1 } from '@ai-sdk/provider';
+import { LanguageModelV1FinishReason, LanguageModelV1CallWarning, LanguageModelV1 } from '@ai-sdk/provider';
 
 type AIAction<T = any, R = any> = (...args: T[]) => Promise<R>;
 type AIActions<T = any, R = any> = Record<string, AIAction<T, R>>;
@@ -422,6 +422,23 @@ type Prompt = {
     messages?: Array<CoreMessage>;
 };
 
+/**
+Reason why a language model finished generating a response.
+
+Can be one of the following:
+- `stop`: model generated stop sequence
+- `length`: model generated maximum number of tokens
+- `content-filter`: content filter violation stopped the model
+- `tool-calls`: model triggered tool calls
+- `error`: model stopped because of an error
+- `other`: model stopped for other reasons
+*/
+type FinishReason = LanguageModelV1FinishReason;
+/**
+Warning from the model provider for this call. The call will proceed, but e.g.
+some settings might not be supported, which can lead to suboptimal results.
+*/
+type CallWarning = LanguageModelV1CallWarning;
 /**
 Tool choice for the generation. It supports the following settings:
 
@@ -435,6 +452,24 @@ type CoreToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | '
     toolName: keyof TOOLS;
 };
 
+/**
+Represents the number of tokens used in a prompt and completion.
+ */
+type TokenUsage = {
+    /**
+  The number of tokens used in the prompt
+     */
+    promptTokens: number;
+    /**
+  The number of tokens used in the completion.
+   */
+    completionTokens: number;
+    /**
+  The total number of tokens used (promptTokens + completionTokens).
+     */
+    totalTokens: number;
+};
+
 type Streamable = ReactNode | Promise<ReactNode>;
 type Renderer<T extends Array<any>> = (...args: T) => Streamable | Generator<Streamable, Streamable, void> | AsyncGenerator<Streamable, Streamable, void>;
 type RenderTool<PARAMETERS extends z.ZodTypeAny = any> = {
@@ -473,7 +508,7 @@ type RenderResult = {
  */
 declare function streamUI<TOOLS extends {
     [name: string]: z.ZodTypeAny;
-} = {}>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, initial, text, ...settings }: CallSettings & Prompt & {
+} = {}>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, initial, text, onFinish, ...settings }: CallSettings & Prompt & {
     /**
      * The language model to use.
      */
@@ -485,11 +520,41 @@ declare function streamUI<TOOLS extends {
         [name in keyof TOOLS]: RenderTool<TOOLS[name]>;
     };
     /**
-The tool choice strategy. Default: 'auto'.
+     * The tool choice strategy. Default: 'auto'.
      */
     toolChoice?: CoreToolChoice<TOOLS>;
     text?: RenderText;
     initial?: ReactNode;
+    /**
+     * Callback that is called when the LLM response and the final object validation are finished.
+     */
+    onFinish?: (event: {
+        /**
+         * The reason why the generation finished.
+         */
+        finishReason: FinishReason;
+        /**
+         * The token usage of the generated response.
+         */
+        usage: TokenUsage;
+        /**
+         * The final ui node that was generated.
+         */
+        value: ReactNode;
+        /**
+         * Warnings from the model provider (e.g. unsupported settings)
+         */
+        warnings?: CallWarning[];
+        /**
+         * Optional raw response data.
+         */
+        rawResponse?: {
+            /**
+             * Response headers.
+             */
+            headers?: Record<string, string>;
+        };
+    }) => Promise<void> | void;
 }): Promise<RenderResult>;
 
 declare function createAI<AIState = any, UIState = any, Actions extends AIActions = {}>({ actions, initialAIState, initialUIState, onSetAIState, onGetUIState, }: {

package/rsc/dist/rsc-server.d.mts

@@ -1,7 +1,7 @@
 import { ReactNode } from 'react';
 import OpenAI from 'openai';
 import { z } from 'zod';
-import { LanguageModelV1 } from '@ai-sdk/provider';
+import { LanguageModelV1FinishReason, LanguageModelV1CallWarning, LanguageModelV1 } from '@ai-sdk/provider';
 
 type AIAction<T = any, R = any> = (...args: T[]) => Promise<R>;
 type AIActions<T = any, R = any> = Record<string, AIAction<T, R>>;
@@ -420,6 +420,23 @@ type Prompt = {
     messages?: Array<CoreMessage>;
 };
 
+/**
+Reason why a language model finished generating a response.
+
+Can be one of the following:
+- `stop`: model generated stop sequence
+- `length`: model generated maximum number of tokens
+- `content-filter`: content filter violation stopped the model
+- `tool-calls`: model triggered tool calls
+- `error`: model stopped because of an error
+- `other`: model stopped for other reasons
+*/
+type FinishReason = LanguageModelV1FinishReason;
+/**
+Warning from the model provider for this call. The call will proceed, but e.g.
+some settings might not be supported, which can lead to suboptimal results.
+*/
+type CallWarning = LanguageModelV1CallWarning;
 /**
 Tool choice for the generation. It supports the following settings:
 
@@ -433,6 +450,24 @@ type CoreToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | '
     toolName: keyof TOOLS;
 };
 
+/**
+Represents the number of tokens used in a prompt and completion.
+ */
+type TokenUsage = {
+    /**
+  The number of tokens used in the prompt
+     */
+    promptTokens: number;
+    /**
+  The number of tokens used in the completion.
+   */
+    completionTokens: number;
+    /**
+  The total number of tokens used (promptTokens + completionTokens).
+     */
+    totalTokens: number;
+};
+
 type Streamable = ReactNode | Promise<ReactNode>;
 type Renderer<T extends Array<any>> = (...args: T) => Streamable | Generator<Streamable, Streamable, void> | AsyncGenerator<Streamable, Streamable, void>;
 type RenderTool<PARAMETERS extends z.ZodTypeAny = any> = {
@@ -471,7 +506,7 @@ type RenderResult = {
  */
 declare function streamUI<TOOLS extends {
     [name: string]: z.ZodTypeAny;
-} = {}>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, initial, text, ...settings }: CallSettings & Prompt & {
+} = {}>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, initial, text, onFinish, ...settings }: CallSettings & Prompt & {
     /**
      * The language model to use.
      */
@@ -483,11 +518,41 @@ declare function streamUI<TOOLS extends {
         [name in keyof TOOLS]: RenderTool<TOOLS[name]>;
     };
     /**
-The tool choice strategy. Default: 'auto'.
+     * The tool choice strategy. Default: 'auto'.
      */
     toolChoice?: CoreToolChoice<TOOLS>;
     text?: RenderText;
     initial?: ReactNode;
+    /**
+     * Callback that is called when the LLM response and the final object validation are finished.
+     */
+    onFinish?: (event: {
+        /**
+         * The reason why the generation finished.
+         */
+        finishReason: FinishReason;
+        /**
+         * The token usage of the generated response.
+         */
+        usage: TokenUsage;
+        /**
+         * The final ui node that was generated.
+         */
+        value: ReactNode;
+        /**
+         * Warnings from the model provider (e.g. unsupported settings)
+         */
+        warnings?: CallWarning[];
+        /**
+         * Optional raw response data.
+         */
+        rawResponse?: {
+            /**
+             * Response headers.
+             */
+            headers?: Record<string, string>;
+        };
+    }) => Promise<void> | void;
 }): Promise<RenderResult>;
 
 declare function createAI<AIState = any, UIState = any, Actions extends AIActions = {}>({ actions, initialAIState, initialUIState, onSetAIState, onGetUIState, }: {

package/rsc/dist/rsc-server.mjs

@@ -210,6 +210,15 @@ async function _retryWithExponentialBackoff(f, {
   }
 }
 
+// core/generate-text/token-usage.ts
+function calculateTokenUsage(usage) {
+  return {
+    promptTokens: usage.promptTokens,
+    completionTokens: usage.completionTokens,
+    totalTokens: usage.promptTokens + usage.completionTokens
+  };
+}
+
 // core/util/detect-image-mimetype.ts
 var mimeTypeSignatures = [
   { mimeType: "image/gif", bytes: [71, 73, 70] },
@@ -1429,6 +1438,7 @@ async function streamUI({
   abortSignal,
   initial,
   text,
+  onFinish,
   ...settings
 }) {
   if (typeof model === "string") {
@@ -1591,6 +1601,13 @@ async function streamUI({
             throw value.error;
           }
           case "finish": {
+            onFinish == null ? void 0 : onFinish({
+              finishReason: value.finishReason,
+              usage: calculateTokenUsage(value.usage),
+              value: ui.value,
+              warnings: result.warnings,
+              rawResponse: result.rawResponse
+            });
           }
         }
       }