modelfusion 0.8.0 → 0.9.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
   "description": "Build AI applications, chatbots, and agents with JavaScript and TypeScript.",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [

package/tool/Tool.cjs

@@ -1,32 +1,52 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Tool = void 0;
+/**
+ * A tool is a function with a name, description and defined inputs that can be used
+ * by agents and chatbots.
+ */
 class Tool {
     constructor(options) {
+        /**
+         * The name of the tool. Should be understandable for language models and unique among the tools that they know.
+         */
         Object.defineProperty(this, "name", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /**
+         * A description of what the tool does. Will be used by the language model to decide whether to use the tool.
+         */
         Object.defineProperty(this, "description", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /**
+         * The schema of the input that the tool expects. The language model will use this to generate the input.
+         * Use descriptions to make the input understandable for the language model.
+         */
         Object.defineProperty(this, "inputSchema", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /**
+         * An optional schema of the output that the tool produces. This will be used to validate the output.
+         */
         Object.defineProperty(this, "outputSchema", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /**
+         * The actual execution function of the tool.
+         */
         Object.defineProperty(this, "execute", {
             enumerable: true,
             configurable: true,
@@ -39,6 +59,10 @@ class Tool {
         this.outputSchema = options.outputSchema;
         this.execute = options.execute;
     }
+    /**
+     * Provdes a schema definition with the name, description and schema of the input.
+     * This is used by `useTool`.
+     */
     get inputSchemaDefinition() {
         return {
             name: this.name,

package/tool/Tool.d.ts

@@ -1,11 +1,31 @@
 import { z } from "zod";
 import { SchemaDefinition } from "../model-function/generate-json/SchemaDefinition.js";
 import { RunFunction } from "../run/RunFunction.js";
+/**
+ * A tool is a function with a name, description and defined inputs that can be used
+ * by agents and chatbots.
+ */
 export declare class Tool<NAME extends string, INPUT, OUTPUT> {
+    /**
+     * The name of the tool. Should be understandable for language models and unique among the tools that they know.
+     */
     readonly name: NAME;
+    /**
+     * A description of what the tool does. Will be used by the language model to decide whether to use the tool.
+     */
     readonly description: string;
+    /**
+     * The schema of the input that the tool expects. The language model will use this to generate the input.
+     * Use descriptions to make the input understandable for the language model.
+     */
     readonly inputSchema: z.ZodSchema<INPUT>;
+    /**
+     * An optional schema of the output that the tool produces. This will be used to validate the output.
+     */
     readonly outputSchema?: z.ZodSchema<OUTPUT>;
+    /**
+     * The actual execution function of the tool.
+     */
     readonly execute: RunFunction<INPUT, OUTPUT>;
     constructor(options: {
         name: NAME;
@@ -14,5 +34,9 @@ export declare class Tool<NAME extends string, INPUT, OUTPUT> {
         outputSchema?: z.ZodSchema<OUTPUT>;
         execute(input: INPUT): Promise<OUTPUT>;
     });
+    /**
+     * Provdes a schema definition with the name, description and schema of the input.
+     * This is used by `useTool`.
+     */
     get inputSchemaDefinition(): SchemaDefinition<NAME, INPUT>;
 }

package/tool/Tool.js

@@ -1,29 +1,49 @@
+/**
+ * A tool is a function with a name, description and defined inputs that can be used
+ * by agents and chatbots.
+ */
 export class Tool {
     constructor(options) {
+        /**
+         * The name of the tool. Should be understandable for language models and unique among the tools that they know.
+         */
         Object.defineProperty(this, "name", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /**
+         * A description of what the tool does. Will be used by the language model to decide whether to use the tool.
+         */
         Object.defineProperty(this, "description", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /**
+         * The schema of the input that the tool expects. The language model will use this to generate the input.
+         * Use descriptions to make the input understandable for the language model.
+         */
         Object.defineProperty(this, "inputSchema", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /**
+         * An optional schema of the output that the tool produces. This will be used to validate the output.
+         */
         Object.defineProperty(this, "outputSchema", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /**
+         * The actual execution function of the tool.
+         */
         Object.defineProperty(this, "execute", {
             enumerable: true,
             configurable: true,
@@ -36,6 +56,10 @@ export class Tool {
         this.outputSchema = options.outputSchema;
         this.execute = options.execute;
     }
+    /**
+     * Provdes a schema definition with the name, description and schema of the input.
+     * This is used by `useTool`.
+     */
     get inputSchemaDefinition() {
         return {
             name: this.name,

package/tool/WebSearchTool.cjs

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSearchTool = void 0;
+const zod_1 = require("zod");
+const Tool_js_1 = require("./Tool.cjs");
+const INPUT_SCHEMA = zod_1.z.object({
+    query: zod_1.z.string(),
+});
+const OUTPUT_SCHEMA = zod_1.z.object({
+    results: zod_1.z.array(zod_1.z.object({
+        title: zod_1.z.string(),
+        link: zod_1.z.string().url(),
+        snippet: zod_1.z.string(),
+    })),
+});
+/**
+ * @see https://serpapi.com/search-api
+ */
+class WebSearchTool extends Tool_js_1.Tool {
+    constructor(options) {
+        super({
+            name: options.name,
+            description: options.description,
+            inputSchema: INPUT_SCHEMA,
+            outputSchema: OUTPUT_SCHEMA,
+            execute: options.execute,
+        });
+    }
+}
+exports.WebSearchTool = WebSearchTool;
+// expose the schemas to library consumers:
+Object.defineProperty(WebSearchTool, "INPUT_SCHEMA", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: INPUT_SCHEMA
+});
+Object.defineProperty(WebSearchTool, "OUTPUT_SCHEMA", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: OUTPUT_SCHEMA
+});

package/tool/WebSearchTool.d.ts

@@ -0,0 +1,81 @@
+import { z } from "zod";
+import { Tool } from "./Tool.js";
+declare const INPUT_SCHEMA: z.ZodObject<{
+    query: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    query: string;
+}, {
+    query: string;
+}>;
+declare const OUTPUT_SCHEMA: z.ZodObject<{
+    results: z.ZodArray<z.ZodObject<{
+        title: z.ZodString;
+        link: z.ZodString;
+        snippet: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        link: string;
+        title: string;
+        snippet: string;
+    }, {
+        link: string;
+        title: string;
+        snippet: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    results: {
+        link: string;
+        title: string;
+        snippet: string;
+    }[];
+}, {
+    results: {
+        link: string;
+        title: string;
+        snippet: string;
+    }[];
+}>;
+/**
+ * @see https://serpapi.com/search-api
+ */
+export declare class WebSearchTool<NAME extends string> extends Tool<NAME, z.infer<typeof INPUT_SCHEMA>, z.infer<typeof OUTPUT_SCHEMA>> {
+    static readonly INPUT_SCHEMA: z.ZodObject<{
+        query: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        query: string;
+    }, {
+        query: string;
+    }>;
+    static readonly OUTPUT_SCHEMA: z.ZodObject<{
+        results: z.ZodArray<z.ZodObject<{
+            title: z.ZodString;
+            link: z.ZodString;
+            snippet: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            link: string;
+            title: string;
+            snippet: string;
+        }, {
+            link: string;
+            title: string;
+            snippet: string;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        results: {
+            link: string;
+            title: string;
+            snippet: string;
+        }[];
+    }, {
+        results: {
+            link: string;
+            title: string;
+            snippet: string;
+        }[];
+    }>;
+    constructor(options: {
+        name: NAME;
+        description: string;
+        execute(input: z.infer<typeof INPUT_SCHEMA>): Promise<z.infer<typeof OUTPUT_SCHEMA>>;
+    });
+}
+export {};

package/tool/WebSearchTool.js

@@ -0,0 +1,39 @@
+import { z } from "zod";
+import { Tool } from "./Tool.js";
+const INPUT_SCHEMA = z.object({
+    query: z.string(),
+});
+const OUTPUT_SCHEMA = z.object({
+    results: z.array(z.object({
+        title: z.string(),
+        link: z.string().url(),
+        snippet: z.string(),
+    })),
+});
+/**
+ * @see https://serpapi.com/search-api
+ */
+export class WebSearchTool extends Tool {
+    constructor(options) {
+        super({
+            name: options.name,
+            description: options.description,
+            inputSchema: INPUT_SCHEMA,
+            outputSchema: OUTPUT_SCHEMA,
+            execute: options.execute,
+        });
+    }
+}
+// expose the schemas to library consumers:
+Object.defineProperty(WebSearchTool, "INPUT_SCHEMA", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: INPUT_SCHEMA
+});
+Object.defineProperty(WebSearchTool, "OUTPUT_SCHEMA", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: OUTPUT_SCHEMA
+});

package/tool/executeTool.d.ts

@@ -9,6 +9,9 @@ export type ExecuteToolMetadata = {
     startEpochSeconds: number;
     durationInMs: number;
 };
+/**
+ * `executeTool` directly executes a tool with the given parameters.
+ */
 export declare function executeTool<INPUT, OUTPUT>(tool: Tool<string, INPUT, OUTPUT>, input: INPUT, options: FunctionOptions<undefined> & {
     fullResponse: true;
 }): Promise<{

package/tool/index.cjs

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./NoSuchToolError.cjs"), exports);
 __exportStar(require("./Tool.cjs"), exports);
 __exportStar(require("./ToolExecutionError.cjs"), exports);
+__exportStar(require("./WebSearchTool.cjs"), exports);
 __exportStar(require("./executeTool.cjs"), exports);
 __exportStar(require("./useTool.cjs"), exports);
 __exportStar(require("./useToolOrGenerateText.cjs"), exports);

package/tool/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./NoSuchToolError.js";
 export * from "./Tool.js";
 export * from "./ToolExecutionError.js";
+export * from "./WebSearchTool.js";
 export * from "./executeTool.js";
 export * from "./useTool.js";
 export * from "./useToolOrGenerateText.js";

package/tool/index.js

@@ -1,6 +1,7 @@
 export * from "./NoSuchToolError.js";
 export * from "./Tool.js";
 export * from "./ToolExecutionError.js";
+export * from "./WebSearchTool.js";
 export * from "./executeTool.js";
 export * from "./useTool.js";
 export * from "./useToolOrGenerateText.js";