refactor!: type definitions and usages of @xsai/tool

.vscode/settings.json

@@ -47,9 +47,4 @@
     "pcss",
     "postcss"
   ],
-
-  // Enable unstable_ts_config
-  "eslint.options": {
-    "flags": ["unstable_ts_config"]
-  }
 }

packages/generate-object/src/index.ts

@@ -8,8 +8,8 @@ export interface GenerateObjectOptions<T extends Schema> extends GenerateTextOpt
   schemaName?: string
 }
 
-// TODO: toolCalls, toolResults
-export interface GenerateObjectResult<T extends Schema> extends Omit<GenerateTextResult, 'text' | 'toolCalls' | 'toolResults'> {
+// TODO: toolCalls
+export interface GenerateObjectResult<T extends Schema> extends Omit<GenerateTextResult, 'text' | 'toolCalls'> {
   object: Infer<T>
 }
 

packages/generate-text/package.json

@@ -32,7 +32,8 @@
     "test:watch": "vitest"
   },
   "dependencies": {
-    "@xsai/shared-chat": "workspace:"
+    "@xsai/shared-chat": "workspace:",
+    "@xsai/tool": "workspace:"
   },
   "devDependencies": {
     "@xsai/providers": "workspace:"

packages/generate-text/src/index.ts

@@ -1,12 +1,13 @@
-import {
-  type AssistantMessageResponse,
-  chat,
-  type ChatOptions,
-  type FinishReason,
-  type Message,
-  type Tool,
-  type Usage,
+import type {
+  AssistantMessageResponse,
+  ChatOptions,
+  FinishReason,
+  Message,
+  Usage,
 } from '@xsai/shared-chat'
+import type { ToolCall } from '@xsai/tool'
+
+import { chat } from '@xsai/shared-chat'
 
 export interface GenerateTextOptions extends ChatOptions {
   /** @default 1 */
@@ -37,7 +38,6 @@ export interface GenerateTextResult {
   steps: StepResult[]
   text?: string
   toolCalls: ToolCall[]
-  toolResults: ToolResult[]
   usage: Usage
 }
 
@@ -46,24 +46,9 @@ export interface StepResult {
   // TODO: step type
   // type: 'continue' | 'initial' | 'tool-result'
   toolCalls: ToolCall[]
-  toolResults: ToolResult[]
   usage: Usage
 }
 
-export interface ToolCall {
-  args: string
-  toolCallId: string
-  toolCallType: 'function'
-  toolName: string
-}
-
-export interface ToolResult {
-  args: Record<string, unknown>
-  result: string
-  toolCallId: string
-  toolName: string
-}
-
 /** @internal */
 type RawGenerateText = (options: GenerateTextOptions) => RawGenerateTextTrampoline<GenerateTextResult>
 
@@ -84,15 +69,13 @@ const rawGenerateText: RawGenerateText = async (options: GenerateTextOptions) =>
       const messages: Message[] = options.messages
       const steps: StepResult[] = options.steps ?? []
       const toolCalls: ToolCall[] = []
-      const toolResults: ToolResult[] = []
 
       const { finish_reason: finishReason, message } = choices[0]
 
       if (message.content || !message.tool_calls || steps.length >= (options.maxSteps ?? 1)) {
         const step: StepResult = {
           text: message.content,
           toolCalls,
-          toolResults,
           usage,
         }
 
@@ -115,22 +98,21 @@ const rawGenerateText: RawGenerateText = async (options: GenerateTextOptions) =>
         id: toolCallId,
         type: toolCallType,
       } of message.tool_calls) {
-        const tool = (options.tools as Tool[]).find(tool => tool.function.name === toolName)!
+        const tool = options.tools?.find(tool => tool.function.name === toolName)
+        if (!tool) {
+          continue
+        }
+
         const parsedArgs: Record<string, unknown> = JSON.parse(toolArgs)
-        const result = await tool.execute(parsedArgs)
+        const result = await tool.execute(parsedArgs as never)
 
         toolCalls.push({
-          args: toolArgs,
-          toolCallId,
-          toolCallType,
-          toolName,
-        })
-
-        toolResults.push({
-          args: parsedArgs,
+          id: toolCallId,
+          name: toolName,
+          parameters: toolArgs,
+          parsedParameters: parsedArgs,
           result,
-          toolCallId,
-          toolName,
+          type: toolCallType,
         })
 
         messages.push({
@@ -143,7 +125,6 @@ const rawGenerateText: RawGenerateText = async (options: GenerateTextOptions) =>
       const step: StepResult = {
         text: message.content,
         toolCalls,
-        toolResults,
         usage,
       }
 

packages/generate-text/test/index.test.ts

@@ -7,7 +7,7 @@ describe('@xsai/generate-text', () => {
   it('basic', async () => {
     let step: StepResult | undefined
 
-    const { finishReason, steps, text, toolCalls, toolResults } = await generateText({
+    const { finishReason, steps, text, toolCalls } = await generateText({
       ...ollama.chat('llama3.2'),
       messages: [
         {
@@ -27,7 +27,6 @@ describe('@xsai/generate-text', () => {
     expect(text).toStrictEqual('YES')
     expect(finishReason).toBe('stop')
     expect(toolCalls.length).toBe(0)
-    expect(toolResults.length).toBe(0)
     expect(steps).toMatchSnapshot()
 
     expect(steps[0]).toStrictEqual(step)

packages/shared-chat/package.json

@@ -30,6 +30,7 @@
     "build:watch": "pkgroll --watch"
   },
   "dependencies": {
-    "@xsai/shared": "workspace:"
+    "@xsai/shared": "workspace:",
+    "@xsai/tool": "workspace:"
   }
 }

packages/shared-chat/src/types/chat-options.ts

@@ -1,4 +1,5 @@
 import type { CommonRequestOptions } from '@xsai/shared'
+import type { Tool } from '@xsai/tool'
 
 import type { Message } from './message'
 import type { ToolChoice } from './tool-choice'
@@ -7,4 +8,5 @@ export interface ChatOptions extends CommonRequestOptions {
   [key: string]: unknown
   messages: Message[]
   toolChoice?: ToolChoice
+  tools?: Tool<never>[]
 }

packages/shared-chat/src/types/index.ts

@@ -2,6 +2,5 @@ export type * from './chat-options'
 export type * from './finish-reason'
 export type * from './message'
 export type * from './message-part'
-export type * from './tool'
 export type * from './tool-choice'
 export type * from './usage'

packages/shared-chat/src/utils/chat.ts

@@ -1,12 +1,12 @@
 import { requestBody, requestHeaders, requestURL, responseCatch } from '@xsai/shared'
 
-import type { ChatOptions, Tool } from '../types'
+import type { ChatOptions } from '../types'
 
 export const chat = async <T extends ChatOptions>(options: T) =>
   await (options.fetch ?? globalThis.fetch)(requestURL('chat/completions', options.baseURL), {
     body: requestBody({
       ...options,
-      tools: (options.tools as Tool[] | undefined)?.map(tool => ({
+      tools: options.tools?.map(tool => ({
         function: tool.function,
         type: 'function',
       })),

packages/tool/package.json

@@ -20,9 +20,6 @@
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
-    },
-    "./generate-text": {
-      "types": "./dist/generate-text.d.ts"
     }
   },
   "files": [

packages/tool/src/index.ts

@@ -3,26 +3,35 @@ import type { InferIn, Schema } from '@typeschema/main'
 import { toJSONSchema } from '@typeschema/main'
 import { clean } from '@xsai/shared'
 
-export interface ToolOptions<T extends Schema> {
-  description?: string
-  execute: (input: InferIn<T>) => Promise<string> | string
-  name: string
-  parameters: T
-  strict?: boolean
-}
-
-export interface ToolResult<T extends Schema> {
-  execute: (input: InferIn<T>) => Promise<string> | string
+export interface Tool<T extends Schema> {
+  execute: (input: unknown extends InferIn<T> ? never : InferIn<T>) => Promise<string> | string
   function: {
     description?: string
     name: string
-    parameters: Record<string, unknown>
+    parameters: InferIn<T>
     strict?: boolean
   }
   type: 'function'
 }
 
-export const tool = async <T extends Schema>(options: ToolOptions<T>): Promise<ToolResult<T>> => ({
+export interface ToolCall {
+  id: string
+  name: string
+  parameters: string
+  parsedParameters: Record<string, unknown>
+  result: string
+  type: 'function'
+}
+
+export interface ToolOptions<T extends Schema> {
+  description?: string
+  execute: (input: InferIn<T>) => Promise<string> | string
+  name: string
+  parameters: T
+  strict?: boolean
+}
+
+export const tool = async <T extends Schema>(options: ToolOptions<T>): Promise<Tool<T>> => ({
   execute: options.execute,
   function: {
     description: options.description,

packages/tool/test/index.test.ts

@@ -70,13 +70,11 @@ describe('@xsai/tool', () => {
 
     expect(text).toMatchSnapshot()
 
-    const { toolCalls, toolResults } = steps[0]
+    const { toolCalls } = steps[0]
 
-    expect(toolCalls[0].toolName).toBe('weather')
-    expect(toolCalls[0].args).toBe('{"location":"San Francisco"}')
-
-    expect(toolCalls[0].toolName).toBe('weather')
-    expect(toolResults[0].args).toStrictEqual({ location: 'San Francisco' })
-    expect(toolResults[0].result).toBe('{"location":"San Francisco","temperature":42}')
+    expect(toolCalls[0].name).toBe('weather')
+    expect(toolCalls[0].parameters).toBe('{"location":"San Francisco"}')
+    expect(toolCalls[0].parsedParameters).toStrictEqual({ location: 'San Francisco' })
+    expect(toolCalls[0].result).toBe('{"location":"San Francisco","temperature":42}')
   }, 20000)
 })

packages/xsai/src/index.ts

@@ -13,4 +13,4 @@ export { listModels, type ListModelsOptions, type ListModelsResponse, type Model
 export * from '@xsai/shared-chat'
 export { streamObject, type StreamObjectOptions, type StreamObjectResult } from '@xsai/stream-object'
 export { type ChunkResult, streamText, type StreamTextOptions, type StreamTextResult } from '@xsai/stream-text'
-export { tool, type ToolOptions, type ToolResult } from '@xsai/tool'
+export { tool, type Tool, type ToolCall, type ToolOptions } from '@xsai/tool'