modelfusion 0.10.0 → 0.12.0

package/README.md

@@ -8,7 +8,7 @@
 [![Discord](https://discordapp.com/api/guilds/1136309340740006029/widget.png?style=shield)](https://discord.gg/GqCwYZATem)
 [![Created by Lars Grammel](https://img.shields.io/badge/created%20by-@lgrammel-4BBAAB.svg)](https://twitter.com/lgrammel)
 
-[Introduction](#introduction) | [Quick Install](#quick-install) | [Usage](#usage-examples) | [Features](#features) | [Integrations](#integrations) | [Documentation](#documentation) | [Examples](#more-examples) | [modelfusion.dev](https://modelfusion.dev)
+[Introduction](#introduction) | [Quick Install](#quick-install) | [Usage](#usage-examples) | [Features](#features) | [Integrations](#integrations) | [Documentation](#documentation) | [Examples](#more-examples) | [Contributing](#contributing) | [modelfusion.dev](https://modelfusion.dev)
 
 > [!NOTE]
 > ModelFusion is in its initial development phase. Until version 1.0 there may be breaking changes, because I am still exploring the API design. Feedback and suggestions are welcome.
@@ -451,6 +451,12 @@ Record audio with push-to-talk and transcribe it using Whisper, implemented as a
 
 TypeScript implementation of the BabyAGI classic and BabyBeeAGI.
 
+### [Wikipedia Agent](https://github.com/lgrammel/modelfusion/tree/main/examples/wikipedia-agent)
+
+> _terminal app_, _ReAct agent_, _GPT-4_, _OpenAI functions_, _tools_
+
+Get answers to questions from Wikipedia, e.g. "Who was born first, Einstein or Picasso?"
+
 ### [Middle school math agent](https://github.com/lgrammel/modelfusion/tree/main/examples/middle-school-math-agent)
 
 > _terminal app_, _agent_, _tools_, _GPT-4_
@@ -462,3 +468,9 @@ Small agent that solves middle school math problems. It uses a calculator tool t
 > _terminal app_, _PDF parsing_, _recursive information extraction_, _in memory vector index, \_style example retrieval_, _OpenAI GPT-4_, _cost calculation_
 
 Extracts information about a topic from a PDF and writes a tweet in your own style about it.
+
+## Contributing
+
+### [Contributing Guide](https://github.com/lgrammel/modelfusion/blob/main/CONTRIBUTING.md)
+
+Read the [ModelFusion contributing guide](https://github.com/lgrammel/modelfusion/blob/main/CONTRIBUTING.md) to learn about the development process, how to propose bugfixes and improvements, and how to build and test your changes.

package/model-function/generate-json/GenerateJsonModel.d.ts

@@ -2,9 +2,7 @@ import { FunctionOptions } from "../FunctionOptions.js";
 import { Model, ModelSettings } from "../Model.js";
 export interface GenerateJsonModelSettings extends ModelSettings {
 }
-export interface GenerateJsonPrompt<RESPONSE> {
-    extractJson(response: RESPONSE): unknown;
-}
 export interface GenerateJsonModel<PROMPT, RESPONSE, SETTINGS extends GenerateJsonModelSettings> extends Model<SETTINGS> {
-    generateJsonResponse(prompt: PROMPT & GenerateJsonPrompt<RESPONSE>, options?: FunctionOptions<SETTINGS>): PromiseLike<RESPONSE>;
+    generateJsonResponse(prompt: PROMPT, options?: FunctionOptions<SETTINGS>): PromiseLike<RESPONSE>;
+    extractJson(response: RESPONSE): unknown;
 }

package/model-function/generate-json/InstructionWithSchemaPrompt.cjs

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstructionWithSchemaPrompt = void 0;
+exports.InstructionWithSchemaPrompt = {
+    forSchema({ instruction, schemaDefinition, }) {
+        return { schemaDefinition, instruction };
+    },
+    forTool({ instruction, tool, }) {
+        return exports.InstructionWithSchemaPrompt.forSchema({
+            instruction,
+            schemaDefinition: tool.inputSchemaDefinition,
+        });
+    },
+    forToolCurried(instruction) {
+        return (tool) => this.forTool({ instruction, tool });
+    },
+};

package/model-function/generate-json/InstructionWithSchemaPrompt.d.ts

@@ -0,0 +1,26 @@
+import { Tool } from "../../tool/Tool.js";
+import { SchemaDefinition } from "./SchemaDefinition.js";
+export type InstructionWithSchema<NAME extends string, STRUCTURE> = {
+    instruction: string;
+    schemaDefinition: SchemaDefinition<NAME, STRUCTURE>;
+};
+export declare const InstructionWithSchemaPrompt: {
+    forSchema<STRUCTURE>({ instruction, schemaDefinition, }: {
+        instruction: string;
+        schemaDefinition: SchemaDefinition<string, STRUCTURE>;
+    }): {
+        schemaDefinition: SchemaDefinition<string, STRUCTURE>;
+        instruction: string;
+    };
+    forTool<INPUT, OUTPUT>({ instruction, tool, }: {
+        instruction: string;
+        tool: Tool<string, INPUT, OUTPUT>;
+    }): {
+        schemaDefinition: SchemaDefinition<string, INPUT>;
+        instruction: string;
+    };
+    forToolCurried<INPUT_1, OUTPUT_1>(instruction: string): (tool: Tool<string, INPUT_1, OUTPUT_1>) => {
+        schemaDefinition: SchemaDefinition<string, INPUT_1>;
+        instruction: string;
+    };
+};

package/model-function/generate-json/InstructionWithSchemaPrompt.js

@@ -0,0 +1,14 @@
+export const InstructionWithSchemaPrompt = {
+    forSchema({ instruction, schemaDefinition, }) {
+        return { schemaDefinition, instruction };
+    },
+    forTool({ instruction, tool, }) {
+        return InstructionWithSchemaPrompt.forSchema({
+            instruction,
+            schemaDefinition: tool.inputSchemaDefinition,
+        });
+    },
+    forToolCurried(instruction) {
+        return (tool) => this.forTool({ instruction, tool });
+    },
+};

package/model-function/generate-json/JsonTextGenerationModel.cjs

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonTextGenerationModel = void 0;
+const generateText_js_1 = require("../generate-text/generateText.cjs");
+class JsonTextGenerationModel {
+    constructor({ model, format, }) {
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "format", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.model = model;
+        this.format = format;
+    }
+    get modelInformation() {
+        return this.model.modelInformation;
+    }
+    get settings() {
+        return this.model.settings;
+    }
+    async generateJsonResponse(prompt, options) {
+        return await (0, generateText_js_1.generateText)(this.model, this.format.createPrompt(prompt), options);
+    }
+    extractJson(response) {
+        return this.format.extractJson(response);
+    }
+    withSettings(additionalSettings) {
+        return new JsonTextGenerationModel({
+            model: this.model.withSettings(additionalSettings),
+            format: this.format,
+        });
+    }
+}
+exports.JsonTextGenerationModel = JsonTextGenerationModel;

package/model-function/generate-json/JsonTextGenerationModel.d.ts

@@ -0,0 +1,25 @@
+import { TextGenerationModel, TextGenerationModelSettings } from "../generate-text/TextGenerationModel.js";
+import { SchemaDefinition } from "./SchemaDefinition.js";
+import { InstructionWithSchema } from "./InstructionWithSchemaPrompt.js";
+import { GenerateJsonModel } from "./GenerateJsonModel.js";
+import { FunctionOptions } from "../FunctionOptions.js";
+export type JsonTextPromptFormat = {
+    createPrompt: (prompt: {
+        instruction: string;
+        schemaDefinition: SchemaDefinition<string, unknown>;
+    }) => string;
+    extractJson: (response: string) => unknown;
+};
+export declare class JsonTextGenerationModel<SETTINGS extends TextGenerationModelSettings, MODEL extends TextGenerationModel<string, any, any, SETTINGS>> implements GenerateJsonModel<InstructionWithSchema<string, unknown>, string, SETTINGS> {
+    private readonly model;
+    private readonly format;
+    constructor({ model, format, }: {
+        model: MODEL;
+        format: JsonTextPromptFormat;
+    });
+    get modelInformation(): import("../ModelInformation.js").ModelInformation;
+    get settings(): SETTINGS;
+    generateJsonResponse(prompt: InstructionWithSchema<string, unknown>, options?: FunctionOptions<SETTINGS> | undefined): Promise<string>;
+    extractJson(response: string): unknown;
+    withSettings(additionalSettings: Partial<SETTINGS>): this;
+}

package/model-function/generate-json/JsonTextGenerationModel.js

@@ -0,0 +1,37 @@
+import { generateText } from "../generate-text/generateText.js";
+export class JsonTextGenerationModel {
+    constructor({ model, format, }) {
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "format", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.model = model;
+        this.format = format;
+    }
+    get modelInformation() {
+        return this.model.modelInformation;
+    }
+    get settings() {
+        return this.model.settings;
+    }
+    async generateJsonResponse(prompt, options) {
+        return await generateText(this.model, this.format.createPrompt(prompt), options);
+    }
+    extractJson(response) {
+        return this.format.extractJson(response);
+    }
+    withSettings(additionalSettings) {
+        return new JsonTextGenerationModel({
+            model: this.model.withSettings(additionalSettings),
+            format: this.format,
+        });
+    }
+}

package/model-function/generate-json/generateJson.cjs

@@ -10,7 +10,7 @@ async function generateJson(model, schemaDefinition, prompt, options) {
         options,
         generateResponse: (options) => model.generateJsonResponse(expandedPrompt, options),
         extractOutputValue: (response) => {
-            const json = expandedPrompt.extractJson(response);
+            const json = model.extractJson(response);
             const parseResult = schemaDefinition.schema.safeParse(json);
             if (!parseResult.success) {
                 throw new SchemaValidationError_js_1.SchemaValidationError({

package/model-function/generate-json/generateJson.d.ts

@@ -1,14 +1,14 @@
 import { FunctionOptions } from "../FunctionOptions.js";
 import { CallMetadata } from "../executeCall.js";
-import { GenerateJsonModel, GenerateJsonModelSettings, GenerateJsonPrompt } from "./GenerateJsonModel.js";
+import { GenerateJsonModel, GenerateJsonModelSettings } from "./GenerateJsonModel.js";
 import { SchemaDefinition } from "./SchemaDefinition.js";
-export declare function generateJson<STRUCTURE, PROMPT, RESPONSE, NAME extends string, SETTINGS extends GenerateJsonModelSettings>(model: GenerateJsonModel<PROMPT, RESPONSE, SETTINGS>, schemaDefinition: SchemaDefinition<NAME, STRUCTURE>, prompt: (schemaDefinition: SchemaDefinition<NAME, STRUCTURE>) => PROMPT & GenerateJsonPrompt<RESPONSE>, options: FunctionOptions<SETTINGS> & {
+export declare function generateJson<STRUCTURE, PROMPT, RESPONSE, NAME extends string, SETTINGS extends GenerateJsonModelSettings>(model: GenerateJsonModel<PROMPT, RESPONSE, SETTINGS>, schemaDefinition: SchemaDefinition<NAME, STRUCTURE>, prompt: (schemaDefinition: SchemaDefinition<NAME, STRUCTURE>) => PROMPT, options: FunctionOptions<SETTINGS> & {
     fullResponse: true;
 }): Promise<{
     value: STRUCTURE;
     response: RESPONSE;
     metadata: CallMetadata<GenerateJsonModel<PROMPT, RESPONSE, SETTINGS>>;
 }>;
-export declare function generateJson<STRUCTURE, PROMPT, RESPONSE, NAME extends string, SETTINGS extends GenerateJsonModelSettings>(model: GenerateJsonModel<PROMPT, RESPONSE, SETTINGS>, schemaDefinition: SchemaDefinition<NAME, STRUCTURE>, prompt: (schemaDefinition: SchemaDefinition<NAME, STRUCTURE>) => PROMPT & GenerateJsonPrompt<RESPONSE>, options?: FunctionOptions<SETTINGS> & {
+export declare function generateJson<STRUCTURE, PROMPT, RESPONSE, NAME extends string, SETTINGS extends GenerateJsonModelSettings>(model: GenerateJsonModel<PROMPT, RESPONSE, SETTINGS>, schemaDefinition: SchemaDefinition<NAME, STRUCTURE>, prompt: (schemaDefinition: SchemaDefinition<NAME, STRUCTURE>) => PROMPT, options?: FunctionOptions<SETTINGS> & {
     fullResponse?: false;
 }): Promise<STRUCTURE>;

package/model-function/generate-json/generateJson.js

@@ -7,7 +7,7 @@ export async function generateJson(model, schemaDefinition, prompt, options) {
         options,
         generateResponse: (options) => model.generateJsonResponse(expandedPrompt, options),
         extractOutputValue: (response) => {
-            const json = expandedPrompt.extractJson(response);
+            const json = model.extractJson(response);
             const parseResult = schemaDefinition.schema.safeParse(json);
             if (!parseResult.success) {
                 throw new SchemaValidationError({

package/model-function/index.cjs

@@ -17,7 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./FunctionOptions.cjs"), exports);
 __exportStar(require("./Model.cjs"), exports);
 __exportStar(require("./ModelCallEvent.cjs"), exports);
-__exportStar(require("../run/RunFunctionObserver.cjs"), exports);
 __exportStar(require("./ModelInformation.cjs"), exports);
 __exportStar(require("./SuccessfulModelCall.cjs"), exports);
 __exportStar(require("./embed-text/TextEmbeddingEvent.cjs"), exports);
@@ -28,17 +27,19 @@ __exportStar(require("./generate-image/ImageGenerationModel.cjs"), exports);
 __exportStar(require("./generate-image/generateImage.cjs"), exports);
 __exportStar(require("./generate-json/GenerateJsonModel.cjs"), exports);
 __exportStar(require("./generate-json/GenerateJsonOrTextModel.cjs"), exports);
+__exportStar(require("./generate-json/InstructionWithSchemaPrompt.cjs"), exports);
 __exportStar(require("./generate-json/JsonGenerationEvent.cjs"), exports);
+__exportStar(require("./generate-json/JsonTextGenerationModel.cjs"), exports);
 __exportStar(require("./generate-json/NoSuchSchemaError.cjs"), exports);
 __exportStar(require("./generate-json/SchemaDefinition.cjs"), exports);
 __exportStar(require("./generate-json/SchemaValidationError.cjs"), exports);
 __exportStar(require("./generate-json/generateJson.cjs"), exports);
 __exportStar(require("./generate-json/generateJsonOrText.cjs"), exports);
+__exportStar(require("./generate-text/DeltaEvent.cjs"), exports);
+__exportStar(require("./generate-text/TextDeltaEventSource.cjs"), exports);
 __exportStar(require("./generate-text/TextGenerationEvent.cjs"), exports);
 __exportStar(require("./generate-text/TextGenerationModel.cjs"), exports);
 __exportStar(require("./generate-text/generateText.cjs"), exports);
-__exportStar(require("./generate-text/DeltaEvent.cjs"), exports);
-__exportStar(require("./generate-text/TextDeltaEventSource.cjs"), exports);
 __exportStar(require("./generate-text/streamText.cjs"), exports);
 __exportStar(require("./tokenize-text/Tokenizer.cjs"), exports);
 __exportStar(require("./tokenize-text/countTokens.cjs"), exports);

package/model-function/index.d.ts

@@ -1,7 +1,6 @@
 export * from "./FunctionOptions.js";
 export * from "./Model.js";
 export * from "./ModelCallEvent.js";
-export * from "../run/RunFunctionObserver.js";
 export * from "./ModelInformation.js";
 export * from "./SuccessfulModelCall.js";
 export * from "./embed-text/TextEmbeddingEvent.js";
@@ -12,17 +11,19 @@ export * from "./generate-image/ImageGenerationModel.js";
 export * from "./generate-image/generateImage.js";
 export * from "./generate-json/GenerateJsonModel.js";
 export * from "./generate-json/GenerateJsonOrTextModel.js";
+export * from "./generate-json/InstructionWithSchemaPrompt.js";
 export * from "./generate-json/JsonGenerationEvent.js";
+export * from "./generate-json/JsonTextGenerationModel.js";
 export * from "./generate-json/NoSuchSchemaError.js";
 export * from "./generate-json/SchemaDefinition.js";
 export * from "./generate-json/SchemaValidationError.js";
 export * from "./generate-json/generateJson.js";
 export * from "./generate-json/generateJsonOrText.js";
+export * from "./generate-text/DeltaEvent.js";
+export * from "./generate-text/TextDeltaEventSource.js";
 export * from "./generate-text/TextGenerationEvent.js";
 export * from "./generate-text/TextGenerationModel.js";
 export * from "./generate-text/generateText.js";
-export * from "./generate-text/DeltaEvent.js";
-export * from "./generate-text/TextDeltaEventSource.js";
 export * from "./generate-text/streamText.js";
 export * from "./tokenize-text/Tokenizer.js";
 export * from "./tokenize-text/countTokens.js";

package/model-function/index.js

@@ -1,7 +1,6 @@
 export * from "./FunctionOptions.js";
 export * from "./Model.js";
 export * from "./ModelCallEvent.js";
-export * from "../run/RunFunctionObserver.js";
 export * from "./ModelInformation.js";
 export * from "./SuccessfulModelCall.js";
 export * from "./embed-text/TextEmbeddingEvent.js";
@@ -12,17 +11,19 @@ export * from "./generate-image/ImageGenerationModel.js";
 export * from "./generate-image/generateImage.js";
 export * from "./generate-json/GenerateJsonModel.js";
 export * from "./generate-json/GenerateJsonOrTextModel.js";
+export * from "./generate-json/InstructionWithSchemaPrompt.js";
 export * from "./generate-json/JsonGenerationEvent.js";
+export * from "./generate-json/JsonTextGenerationModel.js";
 export * from "./generate-json/NoSuchSchemaError.js";
 export * from "./generate-json/SchemaDefinition.js";
 export * from "./generate-json/SchemaValidationError.js";
 export * from "./generate-json/generateJson.js";
 export * from "./generate-json/generateJsonOrText.js";
+export * from "./generate-text/DeltaEvent.js";
+export * from "./generate-text/TextDeltaEventSource.js";
 export * from "./generate-text/TextGenerationEvent.js";
 export * from "./generate-text/TextGenerationModel.js";
 export * from "./generate-text/generateText.js";
-export * from "./generate-text/DeltaEvent.js";
-export * from "./generate-text/TextDeltaEventSource.js";
 export * from "./generate-text/streamText.js";
 export * from "./tokenize-text/Tokenizer.js";
 export * from "./tokenize-text/countTokens.js";

package/model-provider/openai/chat/OpenAIChatModel.cjs

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAIChatResponseFormat = exports.OpenAIChatModel = exports.calculateOpenAIChatCostInMillicents = exports.isOpenAIChatModel = exports.OPENAI_CHAT_MODELS = void 0;
+const secure_json_parse_1 = __importDefault(require("secure-json-parse"));
 const zod_1 = __importDefault(require("zod"));
 const AbstractModel_js_1 = require("../../../model-function/AbstractModel.cjs");
 const PromptMappingTextGenerationModel_js_1 = require("../../../prompt/PromptMappingTextGenerationModel.cjs");
@@ -200,6 +201,10 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
             run: options?.run,
         });
     }
+    extractJson(response) {
+        const jsonText = response.choices[0].message.function_call.arguments;
+        return secure_json_parse_1.default.parse(jsonText);
+    }
     mapPrompt(promptMapping) {
         return new PromptMappingTextGenerationModel_js_1.PromptMappingTextGenerationModel({
             model: this.withStopTokens(promptMapping.stopTokens),

package/model-provider/openai/chat/OpenAIChatModel.d.ts

@@ -1,6 +1,7 @@
 import z from "zod";
 import { AbstractModel } from "../../../model-function/AbstractModel.js";
 import { FunctionOptions } from "../../../model-function/FunctionOptions.js";
+import { GenerateJsonModel } from "../../../model-function/generate-json/GenerateJsonModel.js";
 import { GenerateJsonOrTextModel } from "../../../model-function/generate-json/GenerateJsonOrTextModel.js";
 import { DeltaEvent } from "../../../model-function/generate-text/DeltaEvent.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "../../../model-function/generate-text/TextGenerationModel.js";
@@ -116,7 +117,7 @@ export interface OpenAIChatSettings extends TextGenerationModelSettings, OpenAIM
  *   ),
  * ]);
  */
-export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> implements TextGenerationModel<OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatDelta, OpenAIChatSettings>, GenerateJsonOrTextModel<OpenAIChatSingleFunctionPrompt<unknown> | OpenAIChatAutoFunctionPrompt<Array<OpenAIFunctionDescription<unknown>>>, OpenAIChatResponse, OpenAIChatSettings> {
+export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> implements TextGenerationModel<OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatDelta, OpenAIChatSettings>, GenerateJsonModel<OpenAIChatSingleFunctionPrompt<unknown>, OpenAIChatResponse, OpenAIChatSettings>, GenerateJsonOrTextModel<OpenAIChatAutoFunctionPrompt<Array<OpenAIFunctionDescription<unknown>>>, OpenAIChatResponse, OpenAIChatSettings> {
     constructor(settings: OpenAIChatSettings);
     readonly provider: "openai";
     get modelName(): "gpt-4" | "gpt-4-0314" | "gpt-4-0613" | "gpt-4-32k" | "gpt-4-32k-0314" | "gpt-4-32k-0613" | "gpt-3.5-turbo" | "gpt-3.5-turbo-0301" | "gpt-3.5-turbo-0613" | "gpt-3.5-turbo-16k" | "gpt-3.5-turbo-16k-0613";
@@ -168,6 +169,7 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
      * @see https://platform.openai.com/docs/guides/gpt/function-calling
      */
     generateJsonResponse(prompt: OpenAIChatSingleFunctionPrompt<unknown> | OpenAIChatAutoFunctionPrompt<Array<OpenAIFunctionDescription<unknown>>>, options?: FunctionOptions<OpenAIChatSettings> | undefined): PromiseLike<OpenAIChatResponse>;
+    extractJson(response: OpenAIChatResponse): unknown;
     mapPrompt<INPUT_PROMPT>(promptMapping: PromptMapping<INPUT_PROMPT, OpenAIChatMessage[]>): PromptMappingTextGenerationModel<INPUT_PROMPT, OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatDelta, OpenAIChatSettings, this>;
     withSettings(additionalSettings: Partial<OpenAIChatSettings>): this;
     get maxCompletionTokens(): number | undefined;

package/model-provider/openai/chat/OpenAIChatModel.js

@@ -1,3 +1,4 @@
+import SecureJSON from "secure-json-parse";
 import z from "zod";
 import { AbstractModel } from "../../../model-function/AbstractModel.js";
 import { PromptMappingTextGenerationModel } from "../../../prompt/PromptMappingTextGenerationModel.js";
@@ -192,6 +193,10 @@ export class OpenAIChatModel extends AbstractModel {
             run: options?.run,
         });
     }
+    extractJson(response) {
+        const jsonText = response.choices[0].message.function_call.arguments;
+        return SecureJSON.parse(jsonText);
+    }
     mapPrompt(promptMapping) {
         return new PromptMappingTextGenerationModel({
             model: this.withStopTokens(promptMapping.stopTokens),

package/model-provider/openai/chat/OpenAIChatPrompt.cjs

@@ -78,10 +78,6 @@ class OpenAIChatSingleFunctionPrompt {
         this.messages = messages;
         this.fn = fn;
     }
-    extractJson(response) {
-        const jsonText = response.choices[0].message.function_call.arguments;
-        return secure_json_parse_1.default.parse(jsonText);
-    }
     get functionCall() {
         return { name: this.fn.name };
     }

package/model-provider/openai/chat/OpenAIChatPrompt.d.ts

@@ -1,5 +1,4 @@
 import z from "zod";
-import { GenerateJsonPrompt } from "../../../model-function/generate-json/GenerateJsonModel.js";
 import { GenerateJsonOrTextPrompt } from "../../../model-function/generate-json/GenerateJsonOrTextModel.js";
 import { SchemaDefinition } from "../../../model-function/generate-json/SchemaDefinition.js";
 import { Tool } from "../../../tool/Tool.js";
@@ -56,14 +55,13 @@ export declare const OpenAIChatFunctionPrompt: {
         parameters: z.ZodType<any, z.ZodTypeDef, any>;
     }[]>;
 };
-export declare class OpenAIChatSingleFunctionPrompt<T> implements GenerateJsonPrompt<OpenAIChatResponse> {
+export declare class OpenAIChatSingleFunctionPrompt<FUNCTION> {
     readonly messages: OpenAIChatMessage[];
-    readonly fn: OpenAIFunctionDescription<T>;
+    readonly fn: OpenAIFunctionDescription<FUNCTION>;
     constructor({ messages, fn, }: {
         messages: OpenAIChatMessage[];
-        fn: OpenAIFunctionDescription<T>;
+        fn: OpenAIFunctionDescription<FUNCTION>;
     });
-    extractJson(response: OpenAIChatResponse): any;
     get functionCall(): {
         name: string;
     };

package/model-provider/openai/chat/OpenAIChatPrompt.js

@@ -72,10 +72,6 @@ export class OpenAIChatSingleFunctionPrompt {
         this.messages = messages;
         this.fn = fn;
     }
-    extractJson(response) {
-        const jsonText = response.choices[0].message.function_call.arguments;
-        return SecureJSON.parse(jsonText);
-    }
     get functionCall() {
         return { name: this.fn.name };
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
   "description": "Build AI applications, chatbots, and agents with JavaScript and TypeScript.",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [
@@ -67,11 +67,11 @@
     "eslint": "^8.45.0",
     "eslint-config-prettier": "9.0.0",
     "husky": "^8.0.3",
-    "lint-staged": "13.2.3",
+    "lint-staged": "14.0.0",
     "prettier": "3.0.1",
     "rimraf": "5.0.1",
     "typescript": "5.1.6",
-    "zod": "3.21.4",
+    "zod": "3.22.0",
     "zod-to-json-schema": "3.21.4"
   },
   "peerDependencies": {

package/tool/WebSearchTool.cjs

@@ -13,31 +13,39 @@ const OUTPUT_SCHEMA = zod_1.z.object({
         snippet: zod_1.z.string(),
     })),
 });
-/**
- * @see https://serpapi.com/search-api
- */
 class WebSearchTool extends Tool_js_1.Tool {
-    constructor(options) {
+    constructor({ name, description, queryDescription = "Search query", execute, }) {
         super({
-            name: options.name,
-            description: options.description,
-            inputSchema: INPUT_SCHEMA,
+            name,
+            description,
+            inputSchema: WebSearchTool.createInputSchema(queryDescription),
             outputSchema: OUTPUT_SCHEMA,
-            execute: options.execute,
+            execute,
         });
+        Object.defineProperty(this, "outputSchema", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.outputSchema = OUTPUT_SCHEMA;
     }
 }
 exports.WebSearchTool = WebSearchTool;
 // expose the schemas to library consumers:
-Object.defineProperty(WebSearchTool, "INPUT_SCHEMA", {
+Object.defineProperty(WebSearchTool, "createInputSchema", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: INPUT_SCHEMA
+    value: (description) => 
+    // same structure, but with description:
+    zod_1.z.object({
+        query: zod_1.z.string().describe(description),
+    })
 });
-Object.defineProperty(WebSearchTool, "OUTPUT_SCHEMA", {
+Object.defineProperty(WebSearchTool, "createOutputSchema", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: OUTPUT_SCHEMA
+    value: () => OUTPUT_SCHEMA
 });

package/tool/WebSearchTool.d.ts

@@ -34,18 +34,15 @@ declare const OUTPUT_SCHEMA: z.ZodObject<{
         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<{
+    static readonly createInputSchema: (description: string) => z.ZodObject<{
         query: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         query: string;
     }, {
         query: string;
     }>;
-    static readonly OUTPUT_SCHEMA: z.ZodObject<{
+    static readonly createOutputSchema: () => z.ZodObject<{
         results: z.ZodArray<z.ZodObject<{
             title: z.ZodString;
             link: z.ZodString;
@@ -72,9 +69,11 @@ export declare class WebSearchTool<NAME extends string> extends Tool<NAME, z.inf
             snippet: string;
         }[];
     }>;
-    constructor(options: {
+    readonly outputSchema: typeof OUTPUT_SCHEMA;
+    constructor({ name, description, queryDescription, execute, }: {
         name: NAME;
         description: string;
+        queryDescription?: string;
         execute(input: z.infer<typeof INPUT_SCHEMA>): Promise<z.infer<typeof OUTPUT_SCHEMA>>;
     });
 }

package/tool/WebSearchTool.js

@@ -10,30 +10,38 @@ const OUTPUT_SCHEMA = z.object({
         snippet: z.string(),
     })),
 });
-/**
- * @see https://serpapi.com/search-api
- */
 export class WebSearchTool extends Tool {
-    constructor(options) {
+    constructor({ name, description, queryDescription = "Search query", execute, }) {
         super({
-            name: options.name,
-            description: options.description,
-            inputSchema: INPUT_SCHEMA,
+            name,
+            description,
+            inputSchema: WebSearchTool.createInputSchema(queryDescription),
             outputSchema: OUTPUT_SCHEMA,
-            execute: options.execute,
+            execute,
         });
+        Object.defineProperty(this, "outputSchema", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.outputSchema = OUTPUT_SCHEMA;
     }
 }
 // expose the schemas to library consumers:
-Object.defineProperty(WebSearchTool, "INPUT_SCHEMA", {
+Object.defineProperty(WebSearchTool, "createInputSchema", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: INPUT_SCHEMA
+    value: (description) => 
+    // same structure, but with description:
+    z.object({
+        query: z.string().describe(description),
+    })
 });
-Object.defineProperty(WebSearchTool, "OUTPUT_SCHEMA", {
+Object.defineProperty(WebSearchTool, "createOutputSchema", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: OUTPUT_SCHEMA
+    value: () => OUTPUT_SCHEMA
 });

package/tool/useTool.d.ts

@@ -1,5 +1,5 @@
 import { FunctionOptions } from "../model-function/FunctionOptions.js";
-import { GenerateJsonModel, GenerateJsonModelSettings, GenerateJsonPrompt } from "../model-function/generate-json/GenerateJsonModel.js";
+import { GenerateJsonModel, GenerateJsonModelSettings } from "../model-function/generate-json/GenerateJsonModel.js";
 import { Tool } from "./Tool.js";
 /**
  * `useTool` uses `generateJson` to generate parameters for a tool and then executes the tool with the parameters.
@@ -8,7 +8,7 @@ import { Tool } from "./Tool.js";
  * the parameters (`parameters` property, typed),
  * and the result of the tool execution (`result` property, typed).
  */
-export declare function useTool<PROMPT, RESPONSE, SETTINGS extends GenerateJsonModelSettings, TOOL extends Tool<any, any, any>>(model: GenerateJsonModel<PROMPT, RESPONSE, SETTINGS>, tool: TOOL, prompt: (tool: TOOL) => PROMPT & GenerateJsonPrompt<RESPONSE>, options?: FunctionOptions<SETTINGS>): Promise<{
+export declare function useTool<PROMPT, RESPONSE, SETTINGS extends GenerateJsonModelSettings, TOOL extends Tool<any, any, any>>(model: GenerateJsonModel<PROMPT, RESPONSE, SETTINGS>, tool: TOOL, prompt: (tool: TOOL) => PROMPT, options?: FunctionOptions<SETTINGS>): Promise<{
     tool: TOOL["name"];
     parameters: TOOL["inputSchema"];
     result: Awaited<ReturnType<TOOL["execute"]>>;