modelfusion 0.71.0 → 0.73.0

package/tool/Tool.d.ts

@@ -1,12 +1,12 @@
 import { FunctionOptions } from "../core/FunctionOptions.js";
 import { JsonSchemaProducer } from "../core/schema/JsonSchemaProducer.js";
 import { Schema } from "../core/schema/Schema.js";
-import { StructureDefinition } from "../core/schema/StructureDefinition.js";
+import { ToolDefinition } from "./ToolDefinition.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> {
+export declare class Tool<NAME extends string, PARAMETERS, RESULT> implements ToolDefinition<NAME, PARAMETERS> {
     /**
      * The name of the tool.
      * It has to be a function name that matches the regular expression pattern '^[a-zA-Z0-9_-]{1,64}$'.
@@ -21,25 +21,20 @@ export declare class Tool<NAME extends string, INPUT, OUTPUT> {
      * 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: Schema<INPUT> & JsonSchemaProducer;
+    readonly parameters: Schema<PARAMETERS> & JsonSchemaProducer;
     /**
      * An optional schema of the output that the tool produces. This will be used to validate the output.
      */
-    readonly outputSchema?: Schema<OUTPUT>;
+    readonly returnType?: Schema<RESULT>;
     /**
      * The actual execution function of the tool.
      */
-    readonly execute: (input: INPUT, options?: FunctionOptions) => PromiseLike<OUTPUT>;
-    constructor({ name, description, inputSchema, outputSchema, execute, }: {
+    readonly execute: (args: PARAMETERS, options?: FunctionOptions) => PromiseLike<RESULT>;
+    constructor({ name, description, parameters, returnType, execute, }: {
         name: NAME;
         description: string;
-        inputSchema: Schema<INPUT> & JsonSchemaProducer;
-        outputSchema?: Schema<OUTPUT>;
-        execute(input: INPUT, options?: FunctionOptions): PromiseLike<OUTPUT>;
+        parameters: Schema<PARAMETERS> & JsonSchemaProducer;
+        returnType?: Schema<RESULT>;
+        execute(args: PARAMETERS, options?: FunctionOptions): PromiseLike<RESULT>;
     });
-    /**
-     * Provides a structure definition with the name, description and schema of the input.
-     * This is used by `useTool`.
-     */
-    get inputStructureDefinition(): StructureDefinition<NAME, INPUT>;
 }

package/tool/Tool.js

@@ -5,7 +5,7 @@ const namePattern = /^[a-zA-Z0-9_-]{1,64}$/;
  * by agents and chatbots.
  */
 export class Tool {
-    constructor({ name, description, inputSchema, outputSchema, execute, }) {
+    constructor({ name, description, parameters, returnType, execute, }) {
         /**
          * The name of the tool.
          * It has to be a function name that matches the regular expression pattern '^[a-zA-Z0-9_-]{1,64}$'.
@@ -30,7 +30,7 @@ export class Tool {
          * 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", {
+        Object.defineProperty(this, "parameters", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -39,7 +39,7 @@ export class Tool {
         /**
          * An optional schema of the output that the tool produces. This will be used to validate the output.
          */
-        Object.defineProperty(this, "outputSchema", {
+        Object.defineProperty(this, "returnType", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -63,19 +63,8 @@ export class Tool {
         }
         this.name = name;
         this.description = description;
-        this.inputSchema = inputSchema;
-        this.outputSchema = outputSchema;
+        this.parameters = parameters;
+        this.returnType = returnType;
         this.execute = execute;
     }
-    /**
-     * Provides a structure definition with the name, description and schema of the input.
-     * This is used by `useTool`.
-     */
-    get inputStructureDefinition() {
-        return {
-            name: this.name,
-            description: this.description,
-            schema: this.inputSchema,
-        };
-    }
 }

package/tool/ToolCall.d.ts

@@ -0,0 +1,15 @@
+/**
+ * A tool call contains all information required to execute a tool.
+ * It can be generated by a language model.
+ *
+ * @template NAME - The name of the tool as a string.
+ * @template PARAMETERS - The parameters for the tool.
+ */
+export interface ToolCall<NAME extends string, PARAMETERS> {
+    /** The id of the tool call. */
+    id: string;
+    /** The name of the tool. */
+    name: NAME;
+    /** The arguments for the tool. */
+    args: PARAMETERS;
+}

package/tool/ToolCallArgumentsValidationError.cjs

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolCallArgumentsValidationError = void 0;
+const getErrorMessage_js_1 = require("../util/getErrorMessage.cjs");
+/**
+ * Thrown when the arguments of a tool call are invalid.
+ *
+ * This typically means they don't match the parameters schema that is expected the tool.
+ */
+class ToolCallArgumentsValidationError extends Error {
+    constructor({ toolName, args, cause, }) {
+        super(`Argument validation failed for tool '${toolName}'.\n` +
+            `Arguments: ${JSON.stringify(args)}.\n` +
+            `Error message: ${(0, getErrorMessage_js_1.getErrorMessage)(cause)}`);
+        Object.defineProperty(this, "toolName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "cause", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "args", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.name = "ToolCallArgumentsValidationError";
+        this.toolName = toolName;
+        this.cause = cause;
+        this.args = args;
+    }
+    toJSON() {
+        return {
+            name: this.name,
+            message: this.message,
+            cause: this.cause,
+            stack: this.stack,
+            toolName: this.toolName,
+            args: this.args,
+        };
+    }
+}
+exports.ToolCallArgumentsValidationError = ToolCallArgumentsValidationError;

package/tool/ToolCallArgumentsValidationError.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Thrown when the arguments of a tool call are invalid.
+ *
+ * This typically means they don't match the parameters schema that is expected the tool.
+ */
+export declare class ToolCallArgumentsValidationError extends Error {
+    readonly toolName: string;
+    readonly cause: unknown;
+    readonly args: unknown;
+    constructor({ toolName, args, cause, }: {
+        toolName: string;
+        args: unknown;
+        cause: unknown;
+    });
+    toJSON(): {
+        name: string;
+        message: string;
+        cause: unknown;
+        stack: string | undefined;
+        toolName: string;
+        args: unknown;
+    };
+}

package/tool/ToolCallArgumentsValidationError.js

@@ -0,0 +1,45 @@
+import { getErrorMessage } from "../util/getErrorMessage.js";
+/**
+ * Thrown when the arguments of a tool call are invalid.
+ *
+ * This typically means they don't match the parameters schema that is expected the tool.
+ */
+export class ToolCallArgumentsValidationError extends Error {
+    constructor({ toolName, args, cause, }) {
+        super(`Argument validation failed for tool '${toolName}'.\n` +
+            `Arguments: ${JSON.stringify(args)}.\n` +
+            `Error message: ${getErrorMessage(cause)}`);
+        Object.defineProperty(this, "toolName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "cause", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "args", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.name = "ToolCallArgumentsValidationError";
+        this.toolName = toolName;
+        this.cause = cause;
+        this.args = args;
+    }
+    toJSON() {
+        return {
+            name: this.name,
+            message: this.message,
+            cause: this.cause,
+            stack: this.stack,
+            toolName: this.toolName,
+            args: this.args,
+        };
+    }
+}

package/tool/ToolCallError.cjs

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolCallError = void 0;
+const getErrorMessage_js_1 = require("../util/getErrorMessage.cjs");
+class ToolCallError extends Error {
+    constructor({ cause, toolCall, message = (0, getErrorMessage_js_1.getErrorMessage)(cause), }) {
+        super(`Tool call for tool '${toolCall.name}' failed: ${message}`);
+        Object.defineProperty(this, "toolCall", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "cause", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.name = "ToolCallError";
+        this.toolCall = toolCall;
+        this.cause = cause;
+    }
+    toJSON() {
+        return {
+            name: this.name,
+            cause: this.cause,
+            message: this.message,
+            stack: this.stack,
+            toolCall: this.toolCall,
+        };
+    }
+}
+exports.ToolCallError = ToolCallError;

package/tool/ToolCallError.d.ts

@@ -0,0 +1,17 @@
+import { ToolCall } from "./ToolCall.js";
+export declare class ToolCallError extends Error {
+    readonly toolCall: ToolCall<string, unknown>;
+    readonly cause: unknown | undefined;
+    constructor({ cause, toolCall, message, }: {
+        toolCall: ToolCall<string, unknown>;
+        cause?: unknown;
+        message?: string;
+    });
+    toJSON(): {
+        name: string;
+        cause: unknown;
+        message: string;
+        stack: string | undefined;
+        toolCall: ToolCall<string, unknown>;
+    };
+}

package/tool/ToolCallError.js

@@ -0,0 +1,30 @@
+import { getErrorMessage } from "../util/getErrorMessage.js";
+export class ToolCallError extends Error {
+    constructor({ cause, toolCall, message = getErrorMessage(cause), }) {
+        super(`Tool call for tool '${toolCall.name}' failed: ${message}`);
+        Object.defineProperty(this, "toolCall", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "cause", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.name = "ToolCallError";
+        this.toolCall = toolCall;
+        this.cause = cause;
+    }
+    toJSON() {
+        return {
+            name: this.name,
+            cause: this.cause,
+            message: this.message,
+            stack: this.stack,
+            toolCall: this.toolCall,
+        };
+    }
+}

package/{model-function/generate-tool-call → tool}/ToolCallGenerationError.cjs

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ToolCallsGenerationError = void 0;
-const getErrorMessage_js_1 = require("../../util/getErrorMessage.cjs");
-class ToolCallsGenerationError extends Error {
+exports.ToolCallGenerationError = void 0;
+const getErrorMessage_js_1 = require("../util/getErrorMessage.cjs");
+class ToolCallGenerationError extends Error {
     constructor({ toolName, cause }) {
         super(`Tool call generation failed for tool '${toolName}'. ` +
             `Error message: ${(0, getErrorMessage_js_1.getErrorMessage)(cause)}`);
@@ -32,4 +32,4 @@ class ToolCallsGenerationError extends Error {
         };
     }
 }
-exports.ToolCallsGenerationError = ToolCallsGenerationError;
+exports.ToolCallGenerationError = ToolCallGenerationError;

package/{model-function/generate-tool-call → tool}/ToolCallGenerationError.d.ts

@@ -1,4 +1,4 @@
-export declare class ToolCallsGenerationError extends Error {
+export declare class ToolCallGenerationError extends Error {
     readonly toolName: string;
     readonly cause: unknown;
     constructor({ toolName, cause }: {

package/{model-function/generate-tool-call → tool}/ToolCallGenerationError.js

@@ -1,5 +1,5 @@
-import { getErrorMessage } from "../../util/getErrorMessage.js";
-export class ToolCallsGenerationError extends Error {
+import { getErrorMessage } from "../util/getErrorMessage.js";
+export class ToolCallGenerationError extends Error {
     constructor({ toolName, cause }) {
         super(`Tool call generation failed for tool '${toolName}'. ` +
             `Error message: ${getErrorMessage(cause)}`);

package/{model-function/generate-tool-call/ToolCallParametersValidationError.cjs → tool/ToolCallParseError.cjs}

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ToolCallParametersValidationError = void 0;
-const getErrorMessage_js_1 = require("../../util/getErrorMessage.cjs");
-class ToolCallParametersValidationError extends Error {
-    constructor({ toolName, parameters, cause, }) {
-        super(`Parameter validation failed for tool '${toolName}'. ` +
-            `Parameters: ${JSON.stringify(parameters)}.\n` +
+exports.ToolCallParseError = void 0;
+const getErrorMessage_js_1 = require("../util/getErrorMessage.cjs");
+class ToolCallParseError extends Error {
+    constructor({ toolName, valueText, cause, }) {
+        super(`Tool call parsing failed for '${toolName}'. ` +
+            `Value: ${valueText}.\n` +
             `Error message: ${(0, getErrorMessage_js_1.getErrorMessage)(cause)}`);
         Object.defineProperty(this, "toolName", {
             enumerable: true,
@@ -13,32 +13,32 @@ class ToolCallParametersValidationError extends Error {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "cause", {
+        Object.defineProperty(this, "valueText", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "parameters", {
+        Object.defineProperty(this, "cause", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        this.name = "ToolCallParametersValidationError";
+        this.name = "ToolCallParseError";
         this.toolName = toolName;
         this.cause = cause;
-        this.parameters = parameters;
+        this.valueText = valueText;
     }
     toJSON() {
         return {
             name: this.name,
-            message: this.message,
             cause: this.cause,
+            message: this.message,
             stack: this.stack,
             toolName: this.toolName,
-            parameter: this.parameters,
+            valueText: this.valueText,
         };
     }
 }
-exports.ToolCallParametersValidationError = ToolCallParametersValidationError;
+exports.ToolCallParseError = ToolCallParseError;

package/{model-function/generate-tool-call/ToolCallParametersValidationError.d.ts → tool/ToolCallParseError.d.ts}

@@ -1,18 +1,18 @@
-export declare class ToolCallParametersValidationError extends Error {
+export declare class ToolCallParseError extends Error {
     readonly toolName: string;
+    readonly valueText: string;
     readonly cause: unknown;
-    readonly parameters: unknown;
-    constructor({ toolName, parameters, cause, }: {
+    constructor({ toolName, valueText, cause, }: {
         toolName: string;
-        parameters: unknown;
+        valueText: string;
         cause: unknown;
     });
     toJSON(): {
         name: string;
-        message: string;
         cause: unknown;
+        message: string;
         stack: string | undefined;
         toolName: string;
-        parameter: unknown;
+        valueText: string;
     };
 }

package/{model-function/generate-tool-call/ToolCallParametersValidationError.js → tool/ToolCallParseError.js}

@@ -1,8 +1,8 @@
-import { getErrorMessage } from "../../util/getErrorMessage.js";
-export class ToolCallParametersValidationError extends Error {
-    constructor({ toolName, parameters, cause, }) {
-        super(`Parameter validation failed for tool '${toolName}'. ` +
-            `Parameters: ${JSON.stringify(parameters)}.\n` +
+import { getErrorMessage } from "../util/getErrorMessage.js";
+export class ToolCallParseError extends Error {
+    constructor({ toolName, valueText, cause, }) {
+        super(`Tool call parsing failed for '${toolName}'. ` +
+            `Value: ${valueText}.\n` +
             `Error message: ${getErrorMessage(cause)}`);
         Object.defineProperty(this, "toolName", {
             enumerable: true,
@@ -10,31 +10,31 @@ export class ToolCallParametersValidationError extends Error {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "cause", {
+        Object.defineProperty(this, "valueText", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "parameters", {
+        Object.defineProperty(this, "cause", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        this.name = "ToolCallParametersValidationError";
+        this.name = "ToolCallParseError";
         this.toolName = toolName;
         this.cause = cause;
-        this.parameters = parameters;
+        this.valueText = valueText;
     }
     toJSON() {
         return {
             name: this.name,
-            message: this.message,
             cause: this.cause,
+            message: this.message,
             stack: this.stack,
             toolName: this.toolName,
-            parameter: this.parameters,
+            valueText: this.valueText,
         };
     }
 }

package/tool/ToolCallResult.d.ts

@@ -0,0 +1,13 @@
+import { ToolCall } from "./ToolCall.js";
+import { ToolCallError } from "./ToolCallError.js";
+export type ToolCallResult<NAME extends string, PARAMETERS, RETURN_TYPE> = {
+    tool: NAME;
+    toolCall: ToolCall<NAME, PARAMETERS>;
+    args: PARAMETERS;
+} & ({
+    ok: true;
+    result: RETURN_TYPE;
+} | {
+    ok: false;
+    result: ToolCallError;
+});

package/{model-function/generate-tool-call → tool}/ToolDefinition.d.ts

@@ -1,5 +1,5 @@
-import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
-import { Schema } from "../../core/schema/Schema.js";
+import { JsonSchemaProducer } from "../core/schema/JsonSchemaProducer.js";
+import { Schema } from "../core/schema/Schema.js";
 export interface ToolDefinition<NAME extends string, PARAMETERS> {
     name: NAME;
     description?: string;

package/tool/ToolExecutionError.cjs

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ToolExecutionError = void 0;
+const getErrorMessage_js_1 = require("../util/getErrorMessage.cjs");
 class ToolExecutionError extends Error {
-    constructor({ message = "unknown error", toolName, input, cause, }) {
-        super(`Error executing tool ${toolName}: ${message}`);
+    constructor({ toolName, input, cause, message = (0, getErrorMessage_js_1.getErrorMessage)(cause), }) {
+        super(`Error executing tool '${toolName}': ${message}`);
         Object.defineProperty(this, "toolName", {
             enumerable: true,
             configurable: true,
@@ -30,11 +31,11 @@ class ToolExecutionError extends Error {
     toJSON() {
         return {
             name: this.name,
-            toolName: this.toolName,
-            input: this.input,
             cause: this.cause,
             message: this.message,
             stack: this.stack,
+            toolName: this.toolName,
+            input: this.input,
         };
     }
 }

package/tool/ToolExecutionError.d.ts

@@ -2,18 +2,18 @@ export declare class ToolExecutionError extends Error {
     readonly toolName: string;
     readonly input: unknown;
     readonly cause: unknown;
-    constructor({ message, toolName, input, cause, }: {
+    constructor({ toolName, input, cause, message, }: {
         toolName: string;
         input: unknown;
-        message: string | undefined;
         cause: unknown | undefined;
+        message?: string;
     });
     toJSON(): {
         name: string;
-        toolName: string;
-        input: unknown;
         cause: unknown;
         message: string;
         stack: string | undefined;
+        toolName: string;
+        input: unknown;
     };
 }

package/tool/ToolExecutionError.js

@@ -1,6 +1,7 @@
+import { getErrorMessage } from "../util/getErrorMessage.js";
 export class ToolExecutionError extends Error {
-    constructor({ message = "unknown error", toolName, input, cause, }) {
-        super(`Error executing tool ${toolName}: ${message}`);
+    constructor({ toolName, input, cause, message = getErrorMessage(cause), }) {
+        super(`Error executing tool '${toolName}': ${message}`);
         Object.defineProperty(this, "toolName", {
             enumerable: true,
             configurable: true,
@@ -27,11 +28,11 @@ export class ToolExecutionError extends Error {
     toJSON() {
         return {
             name: this.name,
-            toolName: this.toolName,
-            input: this.input,
             cause: this.cause,
             message: this.message,
             stack: this.stack,
+            toolName: this.toolName,
+            input: this.input,
         };
     }
 }

package/tool/WebSearchTool.cjs

@@ -4,7 +4,7 @@ exports.WebSearchTool = void 0;
 const zod_1 = require("zod");
 const ZodSchema_js_1 = require("../core/schema/ZodSchema.cjs");
 const Tool_js_1 = require("./Tool.cjs");
-const OUTPUT_SCHEMA = new ZodSchema_js_1.ZodSchema(zod_1.z.object({
+const RETURN_TYPE_SCHEMA = new ZodSchema_js_1.ZodSchema(zod_1.z.object({
     results: zod_1.z.array(zod_1.z.object({
         title: zod_1.z.string(),
         link: zod_1.z.string().url(),
@@ -12,7 +12,7 @@ const OUTPUT_SCHEMA = new ZodSchema_js_1.ZodSchema(zod_1.z.object({
     })),
 }));
 // expose the schemas to library consumers:
-const createInputSchema = (description) => 
+const createParameters = (description) => 
 // same structure, but with description:
 new ZodSchema_js_1.ZodSchema(zod_1.z.object({
     query: zod_1.z.string().describe(description),
@@ -47,8 +47,8 @@ class WebSearchTool extends Tool_js_1.Tool {
         super({
             name,
             description,
-            inputSchema: createInputSchema(queryDescription),
-            outputSchema: OUTPUT_SCHEMA,
+            parameters: createParameters(queryDescription),
+            returnType: RETURN_TYPE_SCHEMA,
             execute,
         });
     }

package/tool/WebSearchTool.d.ts

@@ -1,7 +1,7 @@
 import { FunctionOptions } from "../core/FunctionOptions.js";
 import { ZodSchema } from "../core/schema/ZodSchema.js";
 import { Tool } from "./Tool.js";
-declare const OUTPUT_SCHEMA: ZodSchema<{
+declare const RETURN_TYPE_SCHEMA: ZodSchema<{
     results: {
         link: string;
         title: string;
@@ -44,7 +44,7 @@ export type WebSearchToolOutput = {
  * ```
  */
 export declare class WebSearchTool<NAME extends string> extends Tool<NAME, WebSearchToolInput, WebSearchToolOutput> {
-    readonly outputSchema: typeof OUTPUT_SCHEMA;
+    readonly returnType: typeof RETURN_TYPE_SCHEMA;
     constructor({ name, description, queryDescription, execute, }: {
         name: NAME;
         description: string;