ai 2.2.28 → 2.2.30

package/solid/dist/index.d.ts

@@ -13,6 +13,38 @@ interface FunctionCall {
      */
     name?: string;
 }
+/**
+ * The tool calls generated by the model, such as function calls.
+ */
+interface ToolCall {
+    id: string;
+    type: string;
+    function: {
+        name: string;
+        arguments: string;
+    };
+}
+/**
+ * Controls which (if any) function is called by the model.
+ * - none means the model will not call a function and instead generates a message.
+ * - auto means the model can pick between generating a message or calling a function.
+ * - Specifying a particular function via {"type: "function", "function": {"name": "my_function"}} forces the model to call that function.
+ * none is the default when no functions are present. auto is the default if functions are present.
+ */
+type ToolChoice = 'none' | 'auto' | {
+    type: 'function';
+    function: {
+        name: string;
+    };
+};
+/**
+ * A list of tools the model may call. Currently, only functions are supported as a tool.
+ * Use this to provide a list of functions the model may generate JSON inputs for.
+ */
+interface Tool {
+    type: 'function';
+    function: Function;
+}
 interface Function {
     /**
      * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
@@ -41,10 +73,11 @@ type IdGenerator = () => string;
  */
 interface Message {
     id: string;
+    tool_call_id?: string;
     createdAt?: Date;
     content: string;
     ui?: string | JSX.Element | JSX.Element[] | null | undefined;
-    role: 'system' | 'user' | 'assistant' | 'function' | 'data';
+    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.
@@ -53,10 +86,15 @@ interface Message {
     /**
      * If the assistant role makes a function call, the `function_call` field
      * contains the function call name and arguments. Otherwise, the field should
-     * not be set.
+     * not be set. (Deprecated and replaced by tool_calls.)
      */
     function_call?: string | FunctionCall;
     data?: JSONValue;
+    /**
+     * If the assistant role makes a tool call, the `tool_calls` field contains
+     * the tool call name and arguments. Otherwise, the field should not be set.
+     */
+    tool_calls?: string | ToolCall[];
 }
 type CreateMessage = Omit<Message, 'id'> & {
     id?: Message['id'];
@@ -67,12 +105,23 @@ type ChatRequest = {
     functions?: Array<Function>;
     function_call?: FunctionCall;
     data?: Record<string, string>;
+    tools?: Array<Tool>;
+    tool_choice?: ToolChoice;
 };
 type FunctionCallHandler = (chatMessages: Message[], functionCall: FunctionCall) => Promise<ChatRequest | void>;
+type ToolCallHandler = (chatMessages: Message[], toolCalls: ToolCall[]) => Promise<ChatRequest | void>;
 type RequestOptions = {
     headers?: Record<string, string> | Headers;
     body?: object;
 };
+type ChatRequestOptions = {
+    options?: RequestOptions;
+    functions?: Array<Function>;
+    function_call?: FunctionCall;
+    tools?: Array<Tool>;
+    tool_choice?: ToolChoice;
+    data?: Record<string, string>;
+};
 type UseChatOptions = {
     /**
      * The API endpoint that accepts a `{ messages: Message[] }` object and returns
@@ -99,6 +148,12 @@ type UseChatOptions = {
      * automatically to the API and will be used to update the chat.
      */
     experimental_onFunctionCall?: FunctionCallHandler;
+    /**
+     * Callback function to be called when a tool call is received.
+     * If the function returns a `ChatRequest` object, the request will be sent
+     * automatically to the API and will be used to update the chat.
+     */
+    experimental_onToolCall?: ToolCallHandler;
     /**
      * Callback function to be called when the API response is received.
      */
@@ -217,13 +272,13 @@ type UseChatHelpers = {
      * @param message The message to append
      * @param options Additional options to pass to the API call
      */
-    append: (message: Message | CreateMessage, options?: RequestOptions) => Promise<string | null | undefined>;
+    append: (message: Message | CreateMessage, chatRequestOptions?: ChatRequestOptions) => Promise<string | null | undefined>;
     /**
      * Reload the last AI chat response for the given chat history. If the last
      * message isn't from the assistant, it will request the API to generate a
      * new response.
      */
-    reload: (options?: RequestOptions) => Promise<string | null | undefined>;
+    reload: (chatRequestOptions?: ChatRequestOptions) => Promise<string | null | undefined>;
     /**
      * Abort the current request immediately, keep the generated tokens if any.
      */
@@ -238,8 +293,8 @@ type UseChatHelpers = {
     input: Accessor<string>;
     /** Signal setter to update the input value */
     setInput: Setter<string>;
-    /** Form submission handler to automatically reset input and append a user message  */
-    handleSubmit: (e: any) => void;
+    /** Form submission handler to automatically reset input and append a user message */
+    handleSubmit: (e: any, chatRequestOptions?: ChatRequestOptions) => void;
     /** Whether the API request is in progress */
     isLoading: Accessor<boolean>;
     /** Additional data added on the server via StreamData */

package/solid/dist/index.js

@@ -126,6 +126,23 @@ var dataMessageStreamPart = {
     };
   }
 };
+var toolCallStreamPart = {
+  code: "7",
+  name: "tool_calls",
+  parse: (value) => {
+    if (value == null || typeof value !== "object" || !("tool_calls" in value) || typeof value.tool_calls !== "object" || value.tool_calls == null || !Array.isArray(value.tool_calls) || value.tool_calls.some((tc) => {
+      tc == null || typeof tc !== "object" || !("id" in tc) || typeof tc.id !== "string" || !("type" in tc) || typeof tc.type !== "string" || !("function" in tc) || tc.function == null || typeof tc.function !== "object" || !("arguments" in tc.function) || typeof tc.function.name !== "string" || typeof tc.function.arguments !== "string";
+    })) {
+      throw new Error(
+        '"tool_calls" parts expect an object with a ToolCallPayload.'
+      );
+    }
+    return {
+      type: "tool_calls",
+      value
+    };
+  }
+};
 var streamParts = [
   textStreamPart,
   functionCallStreamPart,
@@ -133,7 +150,8 @@ var streamParts = [
   errorStreamPart,
   assistantMessageStreamPart,
   assistantControlDataStreamPart,
-  dataMessageStreamPart
+  dataMessageStreamPart,
+  toolCallStreamPart
 ];
 var streamPartsByCode = {
   [textStreamPart.code]: textStreamPart,
@@ -142,7 +160,8 @@ var streamPartsByCode = {
   [errorStreamPart.code]: errorStreamPart,
   [assistantMessageStreamPart.code]: assistantMessageStreamPart,
   [assistantControlDataStreamPart.code]: assistantControlDataStreamPart,
-  [dataMessageStreamPart.code]: dataMessageStreamPart
+  [dataMessageStreamPart.code]: dataMessageStreamPart,
+  [toolCallStreamPart.code]: toolCallStreamPart
 };
 var StreamStringPrefixes = {
   [textStreamPart.name]: textStreamPart.code,
@@ -151,7 +170,8 @@ var StreamStringPrefixes = {
   [errorStreamPart.name]: errorStreamPart.code,
   [assistantMessageStreamPart.name]: assistantMessageStreamPart.code,
   [assistantControlDataStreamPart.name]: assistantControlDataStreamPart.code,
-  [dataMessageStreamPart.name]: dataMessageStreamPart.code
+  [dataMessageStreamPart.name]: dataMessageStreamPart.code,
+  [toolCallStreamPart.name]: toolCallStreamPart.code
 };
 var validCodes = streamParts.map((part) => part.code);
 var parseStreamPart = (line) => {
@@ -277,20 +297,35 @@ async function parseComplexResponse({
       };
       functionCallMessage = prefixMap["function_call"];
     }
+    let toolCallMessage = null;
+    if (type === "tool_calls") {
+      prefixMap["tool_calls"] = {
+        id: generateId(),
+        role: "assistant",
+        content: "",
+        tool_calls: value.tool_calls,
+        createdAt
+      };
+      toolCallMessage = prefixMap["tool_calls"];
+    }
     if (type === "data") {
       prefixMap["data"].push(...value);
     }
     const responseMessage = prefixMap["text"];
-    const merged = [functionCallMessage, responseMessage].filter(
-      Boolean
-    );
+    const merged = [
+      functionCallMessage,
+      toolCallMessage,
+      responseMessage
+    ].filter(Boolean);
     update(merged, [...prefixMap["data"]]);
   }
   onFinish == null ? void 0 : onFinish(prefixMap);
   return {
-    messages: [prefixMap.text, prefixMap.function_call].filter(
-      Boolean
-    ),
+    messages: [
+      prefixMap.text,
+      prefixMap.function_call,
+      prefixMap.tool_calls
+    ].filter(Boolean),
     data: prefixMap.data
   };
 }
@@ -376,6 +411,8 @@ async function callChatApi({
       streamedResponse += decode(value);
       if (streamedResponse.startsWith('{"function_call":')) {
         responseMessage["function_call"] = streamedResponse;
+      } else if (streamedResponse.startsWith('{"tool_calls":')) {
+        responseMessage["tool_calls"] = streamedResponse;
       } else {
         responseMessage["content"] = streamedResponse;
       }
@@ -390,6 +427,11 @@ async function callChatApi({
       responseMessage["function_call"] = parsedFunctionCall;
       appendMessage({ ...responseMessage });
     }
+    if (streamedResponse.startsWith('{"tool_calls":')) {
+      const parsedToolCalls = JSON.parse(streamedResponse).tool_calls;
+      responseMessage["tool_calls"] = parsedToolCalls;
+      appendMessage({ ...responseMessage });
+    }
     if (onFinish) {
       onFinish(responseMessage);
     }
@@ -401,6 +443,7 @@ async function callChatApi({
 async function processChatStream({
   getStreamedResponse,
   experimental_onFunctionCall,
+  experimental_onToolCall,
   updateChatRequest,
   getCurrentMessages
 }) {
@@ -409,12 +452,18 @@ async function processChatStream({
     if ("messages" in messagesAndDataOrJustMessage) {
       let hasFollowingResponse = false;
       for (const message of messagesAndDataOrJustMessage.messages) {
-        if (message.function_call === void 0 || typeof message.function_call === "string") {
+        if ((message.function_call === void 0 || typeof message.function_call === "string") && (message.tool_calls === void 0 || typeof message.tool_calls === "string")) {
           continue;
         }
         hasFollowingResponse = true;
         if (experimental_onFunctionCall) {
           const functionCall = message.function_call;
+          if (typeof functionCall !== "object") {
+            console.warn(
+              "experimental_onFunctionCall should not be defined when using tools"
+            );
+            continue;
+          }
           const functionCallResponse = await experimental_onFunctionCall(
             getCurrentMessages(),
             functionCall
@@ -425,22 +474,83 @@ async function processChatStream({
           }
           updateChatRequest(functionCallResponse);
         }
+        if (experimental_onToolCall) {
+          const toolCalls = message.tool_calls;
+          if (!Array.isArray(toolCalls) || toolCalls.some((toolCall) => typeof toolCall !== "object")) {
+            console.warn(
+              "experimental_onToolCall should not be defined when using tools"
+            );
+            continue;
+          }
+          const toolCallResponse = await experimental_onToolCall(getCurrentMessages(), toolCalls);
+          if (toolCallResponse === void 0) {
+            hasFollowingResponse = false;
+            break;
+          }
+          updateChatRequest(toolCallResponse);
+        }
       }
       if (!hasFollowingResponse) {
         break;
       }
     } else {
+      let fixFunctionCallArguments2 = function(response) {
+        for (const message of response.messages) {
+          if (message.tool_calls !== void 0) {
+            for (const toolCall of message.tool_calls) {
+              if (typeof toolCall === "object") {
+                if (toolCall.function.arguments && typeof toolCall.function.arguments !== "string") {
+                  toolCall.function.arguments = JSON.stringify(
+                    toolCall.function.arguments
+                  );
+                }
+              }
+            }
+          }
+          if (message.function_call !== void 0) {
+            if (typeof message.function_call === "object") {
+              if (message.function_call.arguments && typeof message.function_call.arguments !== "string") {
+                message.function_call.arguments = JSON.stringify(
+                  message.function_call.arguments
+                );
+              }
+            }
+          }
+        }
+      };
+      var fixFunctionCallArguments = fixFunctionCallArguments2;
       const streamedResponseMessage = messagesAndDataOrJustMessage;
-      if (streamedResponseMessage.function_call === void 0 || typeof streamedResponseMessage.function_call === "string") {
+      if ((streamedResponseMessage.function_call === void 0 || typeof streamedResponseMessage.function_call === "string") && (streamedResponseMessage.tool_calls === void 0 || typeof streamedResponseMessage.tool_calls === "string")) {
         break;
       }
       if (experimental_onFunctionCall) {
         const functionCall = streamedResponseMessage.function_call;
+        if (!(typeof functionCall === "object")) {
+          console.warn(
+            "experimental_onFunctionCall should not be defined when using tools"
+          );
+          continue;
+        }
         const functionCallResponse = await experimental_onFunctionCall(getCurrentMessages(), functionCall);
         if (functionCallResponse === void 0)
           break;
+        fixFunctionCallArguments2(functionCallResponse);
         updateChatRequest(functionCallResponse);
       }
+      if (experimental_onToolCall) {
+        const toolCalls = streamedResponseMessage.tool_calls;
+        if (!(typeof toolCalls === "object")) {
+          console.warn(
+            "experimental_onToolCall should not be defined when using functions"
+          );
+          continue;
+        }
+        const toolCallResponse = await experimental_onToolCall(getCurrentMessages(), toolCalls);
+        if (toolCallResponse === void 0)
+          break;
+        fixFunctionCallArguments2(toolCallResponse);
+        updateChatRequest(toolCallResponse);
+      }
     }
   }
 }
@@ -487,7 +597,7 @@ function useChat({
   );
   const [isLoading, setIsLoading] = (0, import_solid_js.createSignal)(false);
   let abortController = null;
-  async function triggerRequest(messagesSnapshot, options) {
+  async function triggerRequest(messagesSnapshot, { options, data } = {}) {
     try {
       setError(void 0);
       setIsLoading(true);
@@ -499,7 +609,8 @@ function useChat({
       mutate(messagesSnapshot);
       let chatRequest = {
         messages: messagesSnapshot,
-        options
+        options,
+        data
       };
       await processChatStream({
         getStreamedResponse: async () => {
@@ -518,6 +629,7 @@ function useChat({
               })
             ),
             body: {
+              data: chatRequest.data,
               ...body,
               ...options == null ? void 0 : options.body
             },
@@ -528,9 +640,9 @@ function useChat({
             abortController: () => abortController,
             credentials,
             onResponse,
-            onUpdate(merged, data) {
+            onUpdate(merged, data2) {
               mutate([...chatRequest.messages, ...merged]);
-              setStreamData([...existingData, ...data != null ? data : []]);
+              setStreamData([...existingData, ...data2 != null ? data2 : []]);
             },
             onFinish,
             appendMessage(message) {
@@ -594,16 +706,19 @@ function useChat({
     mutate(messages2);
   };
   const [input, setInput] = (0, import_solid_js.createSignal)(initialInput);
-  const handleSubmit = (e) => {
+  const handleSubmit = (e, options = {}) => {
     e.preventDefault();
     const inputValue = input();
     if (!inputValue)
       return;
-    append({
-      content: inputValue,
-      role: "user",
-      createdAt: /* @__PURE__ */ new Date()
-    });
+    append(
+      {
+        content: inputValue,
+        role: "user",
+        createdAt: /* @__PURE__ */ new Date()
+      },
+      options
+    );
     setInput("");
   };
   return {