Feat: add tools module

packages/tools/asconfig.json

@@ -0,0 +1,22 @@
+{
+  "targets": {
+    "debug": {
+      "outFile": "build/debug.wasm",
+      "textFile": "build/debug.wat",
+      "sourceMap": true,
+      "debug": true
+    },
+    "release": {
+      "outFile": "build/release.wasm",
+      "textFile": "build/release.wat",
+      "sourceMap": true,
+      "optimizeLevel": 3,
+      "shrinkLevel": 0,
+      "converge": false,
+      "noAssert": false
+    }
+  },
+  "options": {
+    "bindings": "esm"
+  }
+}

packages/tools/assembly/base.ts

@@ -0,0 +1,55 @@
+export class ToolParameterProperty {
+  type: string;
+  description: string | null;
+
+  constructor(type: string, description: string | null) {
+    this.type = type;
+    this.description = description;
+  }
+}
+
+export class ToolParameters {
+  type: string;
+  properties: Map<string, ToolParameterProperty>;
+  required: string[] | null;
+
+  constructor(
+    type: string,
+    properties: Map<string, ToolParameterProperty>,
+    required: string[] | null,
+  ) {
+    this.type = type;
+    this.properties = properties;
+    this.required = required;
+  }
+}
+
+export class ToolMetadata {
+  name: string;
+  description: string;
+  parameters: ToolParameters | null;
+  argsKwargs: Map<string, Object> | null;
+
+  constructor(
+    name: string,
+    description: string,
+    parameters: ToolParameters | null,
+    argsKwargs: Map<string, Object> | null,
+  ) {
+    this.name = name;
+    this.description = description;
+    this.parameters = parameters;
+    this.argsKwargs = argsKwargs;
+  }
+}
+
+export class BaseTool {
+  call(_args: Object): Object {
+    return {};
+  }
+  metadata: ToolMetadata | null = null;
+
+  constructor(metadata: ToolMetadata) {
+    this.metadata = metadata;
+  }
+}

packages/tools/assembly/query-engine-tool/index.ts

@@ -0,0 +1,36 @@
+import {
+  BaseTool,
+  ToolMetadata,
+  ToolParameterProperty,
+  ToolParameters,
+} from "../base";
+
+function getDefaultMetadata(): ToolMetadata {
+  const properties = new Map<string, ToolParameterProperty>();
+  const paramProperty = new ToolParameterProperty(
+    "string",
+    "The query to search for",
+  );
+  properties.set("query", paramProperty);
+  return new ToolMetadata(
+    "query_engine_tool",
+    "Useful for running a natural language query against a knowledge base and get back a natural language response.",
+    new ToolParameters("object", properties, ["query"]),
+    null,
+  );
+}
+
+class QueryEngineTool extends BaseTool {
+  call(_args: Object): string {
+    // TODO: Implement this tool later
+    return "QueryEngineTool.call";
+  }
+
+  constructor() {
+    super(getDefaultMetadata());
+  }
+}
+
+export function getInstance(): QueryEngineTool {
+  return new QueryEngineTool();
+}

packages/tools/assembly/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "assemblyscript/std/assembly.json",
+  "include": [
+    "./**/*.ts"
+  ]
+}

packages/tools/assembly/wiki-tool/index.ts

@@ -0,0 +1,36 @@
+import {
+  BaseTool,
+  ToolMetadata,
+  ToolParameterProperty,
+  ToolParameters,
+} from "../base";
+
+function getDefaultMetadata(): ToolMetadata {
+  const properties = new Map<string, ToolParameterProperty>();
+  const paramProperty = new ToolParameterProperty(
+    "string",
+    "The query to search for",
+  );
+  properties.set("query", paramProperty);
+  return new ToolMetadata(
+    "wiki_tool",
+    "Summary of the Wikipedia page for the given query.",
+    new ToolParameters("object", properties, ["query"]),
+    null,
+  );
+}
+
+class WikiTool extends BaseTool {
+  call(_args: Object): string {
+    // TODO: Implement this tool later
+    return "WikiTool.call";
+  }
+
+  constructor() {
+    super(getDefaultMetadata());
+  }
+}
+
+export function getInstance(): WikiTool {
+  return new WikiTool();
+}

packages/tools/index.ts

@@ -0,0 +1,52 @@
+import asc from "assemblyscript/bin/asc";
+import fs from "fs";
+import { BaseTool } from "./assembly/base";
+
+type ToolInfo = {
+  id: string;
+  name: string;
+};
+
+export interface IToolFactory {
+  getToolList(): ToolInfo[];
+  downloadTool(toolId: string, storageDir?: string): void;
+  loadTool(filePath: string): Promise<BaseTool>;
+}
+
+export default class ToolFactory implements IToolFactory {
+  getToolList(): ToolInfo[] {
+    return [
+      {
+        id: "query-engine-tool",
+        name: "Query Engine Tool",
+      },
+      {
+        id: "wiki-tool",
+        name: "Wikipedia Summary",
+      },
+    ];
+  }
+
+  async downloadTool(toolId: string, storageDir: string = "build") {
+    const { error, stdout, stderr } = await asc.main([
+      `assembly/tools/${toolId}/index.ts`,
+      "--outFile",
+      `${storageDir}/${toolId}.wasm`,
+      "--optimize",
+      "--sourceMap",
+      "--stats",
+    ]);
+    if (error) {
+      console.log("Download failed: " + error.message);
+      console.log(stderr.toString());
+    } else {
+      console.log(stdout.toString());
+    }
+  }
+
+  async loadTool(filePath: string): Promise<BaseTool> {
+    const mod = new WebAssembly.Module(fs.readFileSync(filePath));
+    const ins = new WebAssembly.Instance(mod);
+    return ins.exports as unknown as BaseTool;
+  }
+}

packages/tools/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@llamaindex/tools",
+  "version": "0.0.1",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "node tests",
+    "asbuild:debug": "asc assembly/index.ts --target debug",
+    "asbuild:release": "asc assembly/index.ts --target release",
+    "asbuild": "npm run asbuild:debug && npm run asbuild:release",
+    "start": "npx serve ."
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "assemblyscript": "^0.27.24"
+  },
+  "dependencies": {
+    "as-bind": "^0.8.2"
+  },
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/run-llama/LlamaIndexTS.git",
+    "directory": "packages/tools"
+  },
+  "exports": {
+    ".": {
+      "import": "./build/release.js",
+      "types": "./build/release.d.ts"
+    }
+  }
+}

packages/tools/tests/index.js

@@ -0,0 +1,4 @@
+import { getInstance } from "../build/debug.js";
+
+const instance = getInstance();
+console.log(instance);