@xsai/shared-chat 0.1.2 → 0.2.0-beta.1

package/dist/index.d.ts

@@ -70,6 +70,8 @@ interface UserMessage extends CommonMessage<'user', UserMessagePart> {
 type UserMessagePart = AudioPart | ImagePart | TextPart;
 type Optional<T, K extends keyof T> = Omit<T, K> & Pick<Partial<T>, K>;
 
+type StepType = 'continue' | 'done' | 'initial' | 'tool-result';
+
 interface CompletionToolCall {
     args: string;
     toolCallId: string;
@@ -83,11 +85,13 @@ interface CompletionToolResult {
     toolName: string;
 }
 interface Tool {
-    execute: (input: unknown, options: ToolExecuteOptions) => (object | string | unknown[]) | Promise<object | string | unknown[]>;
+    execute: (input: unknown, options: ToolExecuteOptions) => Promise<ToolExecuteResult> | ToolExecuteResult;
     function: {
         description?: string;
         name: string;
         parameters: Record<string, unknown>;
+        /** @experimental */
+        returns?: Record<string, unknown>;
         strict?: boolean;
     };
     type: 'function';
@@ -97,6 +101,7 @@ interface ToolExecuteOptions {
     messages: Message[];
     toolCallId: string;
 }
+type ToolExecuteResult = object | string | unknown[];
 
 type ToolChoice = 'auto' | 'none' | 'required' | {
     function: {
@@ -139,6 +144,26 @@ interface ChatOptions extends CommonRequestOptions {
 }
 declare const chat: <T extends ChatOptions>(options: T) => Promise<Response>;
 
-declare const wrapToolResult: (result: object | string | unknown[]) => string | ToolMessagePart[];
+interface DetermineStepTypeOptions {
+    finishReason: FinishReason;
+    maxSteps: number;
+    stepsLength: number;
+    toolCallsLength: number;
+}
+/** @internal */
+declare const determineStepType: ({ finishReason, maxSteps, stepsLength, toolCallsLength }: DetermineStepTypeOptions) => StepType;
+
+interface ExecuteToolOptions {
+    abortSignal?: AbortSignal;
+    messages: Message[];
+    toolCall: ToolCall;
+    tools?: Tool[];
+}
+interface ExecuteToolResult {
+    parsedArgs: Record<string, unknown>;
+    result: string | ToolMessagePart[];
+    toolName: string;
+}
+declare const executeTool: ({ abortSignal, messages, toolCall, tools }: ExecuteToolOptions) => Promise<ExecuteToolResult>;
 
-export { type AssistantMessage, type AssistantMessagePart, type AssistantMessageResponse, type AudioBase64, type AudioPart, type ChatOptions, type CommonMessage, type CommonPart, type CompletionToolCall, type CompletionToolResult, type FinishReason, type ImagePart, type ImageURLorBase64, type Message, type Part, type RefusalPart, type SystemMessage, type SystemMessagePart, type TextPart, type Tool, type ToolCall, type ToolChoice, type ToolExecuteOptions, type ToolMessage, type ToolMessagePart, type Usage, type UserMessage, type UserMessagePart, chat, wrapToolResult };
+export { type AssistantMessage, type AssistantMessagePart, type AssistantMessageResponse, type AudioBase64, type AudioPart, type ChatOptions, type CommonMessage, type CommonPart, type CompletionToolCall, type CompletionToolResult, type DetermineStepTypeOptions, type ExecuteToolOptions, type ExecuteToolResult, type FinishReason, type ImagePart, type ImageURLorBase64, type Message, type Part, type RefusalPart, type StepType, type SystemMessage, type SystemMessagePart, type TextPart, type Tool, type ToolCall, type ToolChoice, type ToolExecuteOptions, type ToolExecuteResult, type ToolMessage, type ToolMessagePart, type Usage, type UserMessage, type UserMessagePart, chat, determineStepType, executeTool };

package/dist/index.js

@@ -1,10 +1,13 @@
 // src/utils/chat.ts
-import { requestBody, requestHeaders, requestURL, responseCatch } from "@xsai/shared";
+import { clean, requestBody, requestHeaders, requestURL, responseCatch } from "@xsai/shared";
 var chat = async (options) => (options.fetch ?? globalThis.fetch)(requestURL("chat/completions", options.baseURL), {
   body: requestBody({
     ...options,
     tools: options.tools?.map((tool) => ({
-      function: tool.function,
+      function: clean({
+        ...tool.function,
+        returns: void 0
+      }),
       type: "function"
     }))
   }),
@@ -16,7 +19,20 @@ var chat = async (options) => (options.fetch ?? globalThis.fetch)(requestURL("ch
   signal: options.abortSignal
 }).then(responseCatch);
 
-// src/utils/wrap-tool-result.ts
+// src/utils/determine-step-type.ts
+var determineStepType = ({ finishReason, maxSteps, stepsLength, toolCallsLength }) => {
+  if (stepsLength === 0) {
+    return "initial";
+  } else if (stepsLength < maxSteps) {
+    if (toolCallsLength > 0 && finishReason === "tool_calls")
+      return "tool-result";
+    else if (!["error", "length"].includes(finishReason))
+      return "continue";
+  }
+  return "done";
+};
+
+// src/utils/internal/wrap-tool-result.ts
 var wrapToolResult = (result) => {
   if (typeof result === "string")
     return result;
@@ -27,7 +43,25 @@ var wrapToolResult = (result) => {
   }
   return JSON.stringify(result);
 };
+
+// src/utils/execute-tool.ts
+var executeTool = async ({ abortSignal, messages, toolCall, tools }) => {
+  const tool = tools?.find((tool2) => tool2.function.name === toolCall.function.name);
+  if (!tool) {
+    const availableTools = tools?.map((tool2) => tool2.function.name);
+    const availableToolsErrorMsg = availableTools == null || availableTools.length === 0 ? "No tools are available." : `Available tools: ${availableTools.join(", ")}.`;
+    throw new Error(`Model tried to call unavailable tool '${toolCall.function.name}. ${availableToolsErrorMsg}.`);
+  }
+  const parsedArgs = JSON.parse(toolCall.function.arguments);
+  const result = wrapToolResult(await tool.execute(parsedArgs, {
+    abortSignal,
+    messages,
+    toolCallId: toolCall.id
+  }));
+  return { parsedArgs, result, toolName: toolCall.function.name };
+};
 export {
   chat,
-  wrapToolResult
+  determineStepType,
+  executeTool
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xsai/shared-chat",
   "type": "module",
-  "version": "0.1.2",
+  "version": "0.2.0-beta.1",
   "description": "extra-small AI SDK for Browser, Node.js, Deno, Bun or Edge Runtime.",
   "author": "Moeru AI",
   "license": "MIT",