ai 3.1.6 → 3.1.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "3.1.6",
+  "version": "3.1.7",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",

package/prompts/dist/index.d.mts

@@ -1,3 +1,45 @@
+/**
+Typed tool call that is returned by generateText and streamText.
+It contains the tool call ID, the tool name, and the tool arguments.
+ */
+interface ToolCall$1<NAME extends string, ARGS> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that is being called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+}
+
+/**
+Typed tool result that is returned by generateText and streamText.
+It contains the tool call ID, the tool name, the tool arguments, and the tool result.
+ */
+interface ToolResult<NAME extends string, ARGS, RESULT> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that was called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+    /**
+  Result of the tool call. This is the result of the tool's execution.
+     */
+    result: RESULT;
+}
+
 interface FunctionCall {
     /**
      * The arguments to call the function with, as generated by the model in JSON
@@ -22,6 +64,12 @@ interface ToolCall {
         arguments: string;
     };
 }
+/**
+Tool invocations are either tool calls or tool results. For each assistant tool call,
+there is one tool invocation. While the call is in progress, the invocation is a tool call.
+Once the call is complete, the invocation is a tool result.
+ */
+type ToolInvocation = ToolCall$1<string, any> | ToolResult<string, any, any>;
 /**
  * Shared types between the API and UI packages.
  */
@@ -57,6 +105,11 @@ interface Message {
      * Additional message-specific information added on the server via StreamData
      */
     annotations?: JSONValue[] | undefined;
+    /**
+  Tool invocations (that can be tool calls or tool results, depending on whether or not the invocation has finished)
+  that the assistant made as part of this message.
+     */
+    toolInvocations?: Array<ToolInvocation>;
 }
 type JSONValue = null | string | number | boolean | {
     [x: string]: JSONValue;

package/prompts/dist/index.d.ts

@@ -1,3 +1,45 @@
+/**
+Typed tool call that is returned by generateText and streamText.
+It contains the tool call ID, the tool name, and the tool arguments.
+ */
+interface ToolCall$1<NAME extends string, ARGS> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that is being called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+}
+
+/**
+Typed tool result that is returned by generateText and streamText.
+It contains the tool call ID, the tool name, the tool arguments, and the tool result.
+ */
+interface ToolResult<NAME extends string, ARGS, RESULT> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that was called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+    /**
+  Result of the tool call. This is the result of the tool's execution.
+     */
+    result: RESULT;
+}
+
 interface FunctionCall {
     /**
      * The arguments to call the function with, as generated by the model in JSON
@@ -22,6 +64,12 @@ interface ToolCall {
         arguments: string;
     };
 }
+/**
+Tool invocations are either tool calls or tool results. For each assistant tool call,
+there is one tool invocation. While the call is in progress, the invocation is a tool call.
+Once the call is complete, the invocation is a tool result.
+ */
+type ToolInvocation = ToolCall$1<string, any> | ToolResult<string, any, any>;
 /**
  * Shared types between the API and UI packages.
  */
@@ -57,6 +105,11 @@ interface Message {
      * Additional message-specific information added on the server via StreamData
      */
     annotations?: JSONValue[] | undefined;
+    /**
+  Tool invocations (that can be tool calls or tool results, depending on whether or not the invocation has finished)
+  that the assistant made as part of this message.
+     */
+    toolInvocations?: Array<ToolInvocation>;
 }
 type JSONValue = null | string | number | boolean | {
     [x: string]: JSONValue;

package/react/dist/index.d.mts

@@ -1,3 +1,45 @@
+/**
+Typed tool call that is returned by generateText and streamText.
+It contains the tool call ID, the tool name, and the tool arguments.
+ */
+interface ToolCall$1<NAME extends string, ARGS> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that is being called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+}
+
+/**
+Typed tool result that is returned by generateText and streamText.
+It contains the tool call ID, the tool name, the tool arguments, and the tool result.
+ */
+interface ToolResult<NAME extends string, ARGS, RESULT> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that was called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+    /**
+  Result of the tool call. This is the result of the tool's execution.
+     */
+    result: RESULT;
+}
+
 interface FunctionCall {
     /**
      * The arguments to call the function with, as generated by the model in JSON
@@ -66,6 +108,12 @@ interface Function {
     description?: string;
 }
 type IdGenerator = () => string;
+/**
+Tool invocations are either tool calls or tool results. For each assistant tool call,
+there is one tool invocation. While the call is in progress, the invocation is a tool call.
+Once the call is complete, the invocation is a tool result.
+ */
+type ToolInvocation = ToolCall$1<string, any> | ToolResult<string, any, any>;
 /**
  * Shared types between the API and UI packages.
  */
@@ -101,6 +149,11 @@ interface Message {
      * Additional message-specific information added on the server via StreamData
      */
     annotations?: JSONValue[] | undefined;
+    /**
+  Tool invocations (that can be tool calls or tool results, depending on whether or not the invocation has finished)
+  that the assistant made as part of this message.
+     */
+    toolInvocations?: Array<ToolInvocation>;
 }
 type CreateMessage = Omit<Message, 'id'> & {
     id?: Message['id'];
@@ -368,7 +421,12 @@ type StreamingReactResponseAction = (payload: {
 declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, experimental_onToolCall, streamMode, onResponse, onFinish, onError, credentials, headers, body, generateId, }?: Omit<UseChatOptions, 'api'> & {
     api?: string | StreamingReactResponseAction;
     key?: string;
-}): UseChatHelpers;
+}): UseChatHelpers & {
+    experimental_addToolResult: ({ toolCallId, result, }: {
+        toolCallId: string;
+        result: any;
+    }) => void;
+};
 
 type UseCompletionHelpers = {
     /** The current completion result */

package/react/dist/index.d.ts

@@ -1,3 +1,45 @@
+/**
+Typed tool call that is returned by generateText and streamText.
+It contains the tool call ID, the tool name, and the tool arguments.
+ */
+interface ToolCall$1<NAME extends string, ARGS> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that is being called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+}
+
+/**
+Typed tool result that is returned by generateText and streamText.
+It contains the tool call ID, the tool name, the tool arguments, and the tool result.
+ */
+interface ToolResult<NAME extends string, ARGS, RESULT> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that was called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+    /**
+  Result of the tool call. This is the result of the tool's execution.
+     */
+    result: RESULT;
+}
+
 interface FunctionCall {
     /**
      * The arguments to call the function with, as generated by the model in JSON
@@ -66,6 +108,12 @@ interface Function {
     description?: string;
 }
 type IdGenerator = () => string;
+/**
+Tool invocations are either tool calls or tool results. For each assistant tool call,
+there is one tool invocation. While the call is in progress, the invocation is a tool call.
+Once the call is complete, the invocation is a tool result.
+ */
+type ToolInvocation = ToolCall$1<string, any> | ToolResult<string, any, any>;
 /**
  * Shared types between the API and UI packages.
  */
@@ -101,6 +149,11 @@ interface Message {
      * Additional message-specific information added on the server via StreamData
      */
     annotations?: JSONValue[] | undefined;
+    /**
+  Tool invocations (that can be tool calls or tool results, depending on whether or not the invocation has finished)
+  that the assistant made as part of this message.
+     */
+    toolInvocations?: Array<ToolInvocation>;
 }
 type CreateMessage = Omit<Message, 'id'> & {
     id?: Message['id'];
@@ -368,7 +421,12 @@ type StreamingReactResponseAction = (payload: {
 declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, experimental_onToolCall, streamMode, onResponse, onFinish, onError, credentials, headers, body, generateId, }?: Omit<UseChatOptions, 'api'> & {
     api?: string | StreamingReactResponseAction;
     key?: string;
-}): UseChatHelpers;
+}): UseChatHelpers & {
+    experimental_addToolResult: ({ toolCallId, result, }: {
+        toolCallId: string;
+        result: any;
+    }) => void;
+};
 
 type UseCompletionHelpers = {
     /** The current completion result */

package/react/dist/index.js

@@ -42,6 +42,13 @@ module.exports = __toCommonJS(react_exports);
 var import_react = require("react");
 var import_swr = __toESM(require("swr"));
 
+// shared/generate-id.ts
+var import_non_secure = require("nanoid/non-secure");
+var generateId = (0, import_non_secure.customAlphabet)(
+  "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz",
+  7
+);
+
 // shared/stream-parts.ts
 var textStreamPart = {
   code: "0",
@@ -138,7 +145,7 @@ var dataMessageStreamPart = {
     };
   }
 };
-var toolCallStreamPart = {
+var toolCallsStreamPart = {
   code: "7",
   name: "tool_calls",
   parse: (value) => {
@@ -165,6 +172,36 @@ var messageAnnotationsStreamPart = {
     return { type: "message_annotations", value };
   }
 };
+var toolCallStreamPart = {
+  code: "9",
+  name: "tool_call",
+  parse: (value) => {
+    if (value == null || typeof value !== "object" || !("toolCallId" in value) || typeof value.toolCallId !== "string" || !("toolName" in value) || typeof value.toolName !== "string" || !("args" in value) || typeof value.args !== "object") {
+      throw new Error(
+        '"tool_call" parts expect an object with a "toolCallId", "toolName", and "args" property.'
+      );
+    }
+    return {
+      type: "tool_call",
+      value
+    };
+  }
+};
+var toolResultStreamPart = {
+  code: "a",
+  name: "tool_result",
+  parse: (value) => {
+    if (value == null || typeof value !== "object" || !("toolCallId" in value) || typeof value.toolCallId !== "string" || !("toolName" in value) || typeof value.toolName !== "string" || !("args" in value) || typeof value.args !== "object" || !("result" in value)) {
+      throw new Error(
+        '"tool_result" parts expect an object with a "toolCallId", "toolName", "args", and "result" property.'
+      );
+    }
+    return {
+      type: "tool_result",
+      value
+    };
+  }
+};
 var streamParts = [
   textStreamPart,
   functionCallStreamPart,
@@ -173,8 +210,10 @@ var streamParts = [
   assistantMessageStreamPart,
   assistantControlDataStreamPart,
   dataMessageStreamPart,
+  toolCallsStreamPart,
+  messageAnnotationsStreamPart,
   toolCallStreamPart,
-  messageAnnotationsStreamPart
+  toolResultStreamPart
 ];
 var streamPartsByCode = {
   [textStreamPart.code]: textStreamPart,
@@ -184,8 +223,10 @@ var streamPartsByCode = {
   [assistantMessageStreamPart.code]: assistantMessageStreamPart,
   [assistantControlDataStreamPart.code]: assistantControlDataStreamPart,
   [dataMessageStreamPart.code]: dataMessageStreamPart,
+  [toolCallsStreamPart.code]: toolCallsStreamPart,
+  [messageAnnotationsStreamPart.code]: messageAnnotationsStreamPart,
   [toolCallStreamPart.code]: toolCallStreamPart,
-  [messageAnnotationsStreamPart.code]: messageAnnotationsStreamPart
+  [toolResultStreamPart.code]: toolResultStreamPart
 };
 var StreamStringPrefixes = {
   [textStreamPart.name]: textStreamPart.code,
@@ -195,8 +236,10 @@ var StreamStringPrefixes = {
   [assistantMessageStreamPart.name]: assistantMessageStreamPart.code,
   [assistantControlDataStreamPart.name]: assistantControlDataStreamPart.code,
   [dataMessageStreamPart.name]: dataMessageStreamPart.code,
+  [toolCallsStreamPart.name]: toolCallsStreamPart.code,
+  [messageAnnotationsStreamPart.name]: messageAnnotationsStreamPart.code,
   [toolCallStreamPart.name]: toolCallStreamPart.code,
-  [messageAnnotationsStreamPart.name]: messageAnnotationsStreamPart.code
+  [toolResultStreamPart.name]: toolResultStreamPart.code
 };
 var validCodes = streamParts.map((part) => part.code);
 var parseStreamPart = (line) => {
@@ -257,13 +300,6 @@ async function* readDataStream(reader, {
   }
 }
 
-// shared/generate-id.ts
-var import_non_secure = require("nanoid/non-secure");
-var generateId = (0, import_non_secure.customAlphabet)(
-  "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz",
-  7
-);
-
 // shared/parse-complex-response.ts
 function assignAnnotationsToMessage(message, annotations) {
   if (!message || !annotations || !annotations.length)
@@ -301,6 +337,40 @@ async function parseComplexResponse({
         };
       }
     }
+    if (type === "tool_call") {
+      if (prefixMap.text == null) {
+        prefixMap.text = {
+          id: generateId2(),
+          role: "assistant",
+          content: "",
+          createdAt
+        };
+      }
+      if (prefixMap.text.toolInvocations == null) {
+        prefixMap.text.toolInvocations = [];
+      }
+      prefixMap.text.toolInvocations.push(value);
+    } else if (type === "tool_result") {
+      if (prefixMap.text == null) {
+        prefixMap.text = {
+          id: generateId2(),
+          role: "assistant",
+          content: "",
+          createdAt
+        };
+      }
+      if (prefixMap.text.toolInvocations == null) {
+        prefixMap.text.toolInvocations = [];
+      }
+      const toolInvocationIndex = prefixMap.text.toolInvocations.findIndex(
+        (invocation) => invocation.toolCallId === value.toolCallId
+      );
+      if (toolInvocationIndex !== -1) {
+        prefixMap.text.toolInvocations[toolInvocationIndex] = value;
+      } else {
+        prefixMap.text.toolInvocations.push(value);
+      }
+    }
     let functionCallMessage = null;
     if (type === "function_call") {
       prefixMap["function_call"] = {
@@ -610,17 +680,23 @@ var getStreamedResponse = async (api, chatRequest, mutate, mutateStreamData, exi
   const previousMessages = messagesRef.current;
   mutate(chatRequest.messages, false);
   const constructedMessagesPayload = sendExtraMessageFields ? chatRequest.messages : chatRequest.messages.map(
-    ({ role, content, name, function_call, tool_calls, tool_call_id }) => ({
+    ({
+      role,
+      content,
+      name,
+      toolInvocations,
+      function_call,
+      tool_calls,
+      tool_call_id
+    }) => ({
       role,
       content,
-      tool_call_id,
       ...name !== void 0 && { name },
-      ...function_call !== void 0 && {
-        function_call
-      },
-      ...tool_calls !== void 0 && {
-        tool_calls
-      }
+      ...toolInvocations !== void 0 && { toolInvocations },
+      // outdated function/tool call handling (TODO deprecate):
+      tool_call_id,
+      ...function_call !== void 0 && { function_call },
+      ...tool_calls !== void 0 && { tool_calls }
     })
   );
   if (typeof api !== "string") {
@@ -919,7 +995,30 @@ function useChat({
     handleInputChange,
     handleSubmit,
     isLoading,
-    data: streamData
+    data: streamData,
+    experimental_addToolResult: ({
+      toolCallId,
+      result
+    }) => {
+      const updatedMessages = messagesRef.current.map(
+        (message, index, arr) => (
+          // update the tool calls in the last assistant message:
+          index === arr.length - 1 && message.role === "assistant" && message.toolInvocations ? {
+            ...message,
+            toolInvocations: message.toolInvocations.map(
+              (toolInvocation) => toolInvocation.toolCallId === toolCallId ? { ...toolInvocation, result } : toolInvocation
+            )
+          } : message
+        )
+      );
+      mutate(updatedMessages, false);
+      const lastMessage = updatedMessages[updatedMessages.length - 1];
+      if (lastMessage.role === "assistant" && lastMessage.toolInvocations && lastMessage.toolInvocations.length > 0 && lastMessage.toolInvocations.every(
+        (toolInvocation) => "result" in toolInvocation
+      )) {
+        triggerRequest({ messages: updatedMessages });
+      }
+    }
   };
 }