ai 3.1.5 → 3.1.7

package/solid/dist/index.d.mts

@@ -1,5 +1,47 @@
 import { Resource, Accessor, Setter } from 'solid-js';
 
+/**
+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
@@ -68,6 +110,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.
  */
@@ -76,9 +124,13 @@ interface Message {
     tool_call_id?: string;
     createdAt?: Date;
     content: string;
+    /**
+  @deprecated Use AI SDK RSC instead: https://sdk.vercel.ai/docs/ai-sdk-rsc
+   */
     ui?: string | JSX.Element | JSX.Element[] | null | undefined;
     role: 'system' | 'user' | 'assistant' | 'function' | 'data' | 'tool';
     /**
+     *
      * If the message has a role of `function`, the `name` field is the name of the function.
      * Otherwise, the name field should not be set.
      */
@@ -99,6 +151,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'];

package/solid/dist/index.d.ts

@@ -1,5 +1,47 @@
 import { Resource, Accessor, Setter } from 'solid-js';
 
+/**
+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
@@ -68,6 +110,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.
  */
@@ -76,9 +124,13 @@ interface Message {
     tool_call_id?: string;
     createdAt?: Date;
     content: string;
+    /**
+  @deprecated Use AI SDK RSC instead: https://sdk.vercel.ai/docs/ai-sdk-rsc
+   */
     ui?: string | JSX.Element | JSX.Element[] | null | undefined;
     role: 'system' | 'user' | 'assistant' | 'function' | 'data' | 'tool';
     /**
+     *
      * If the message has a role of `function`, the `name` field is the name of the function.
      * Otherwise, the name field should not be set.
      */
@@ -99,6 +151,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'];

package/solid/dist/index.js

@@ -30,6 +30,13 @@ var import_solid_js = require("solid-js");
 var import_solid_swr_store = require("solid-swr-store");
 var import_swr_store = require("swr-store");
 
+// 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",
@@ -126,7 +133,7 @@ var dataMessageStreamPart = {
     };
   }
 };
-var toolCallStreamPart = {
+var toolCallsStreamPart = {
   code: "7",
   name: "tool_calls",
   parse: (value) => {
@@ -153,6 +160,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,
@@ -161,8 +198,10 @@ var streamParts = [
   assistantMessageStreamPart,
   assistantControlDataStreamPart,
   dataMessageStreamPart,
+  toolCallsStreamPart,
+  messageAnnotationsStreamPart,
   toolCallStreamPart,
-  messageAnnotationsStreamPart
+  toolResultStreamPart
 ];
 var streamPartsByCode = {
   [textStreamPart.code]: textStreamPart,
@@ -172,8 +211,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,
@@ -183,8 +224,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) => {
@@ -245,13 +288,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)
@@ -289,6 +325,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"] = {