modelfusion 0.38.0 → 0.39.0

package/README.md

@@ -17,10 +17,9 @@
 
 ModelFusion is a library for building AI apps, chatbots, and agents. It provides abstractions for AI models, vector indices, and tools.
 
-- **Type inference and validation**: ModelFusion uses TypeScript and [Zod](https://github.com/colinhacks/zod) to infer types wherever possible and to validate model responses.
-- **Flexibility and control**: AI application development can be complex and unique to each project. With ModelFusion, you have complete control over the prompts and model settings, and you can access the raw responses from the models quickly to build what you need.
-- **No chains and predefined prompts**: Use the concepts provided by JavaScript (variables, functions, etc.) and explicit prompts to build applications you can easily understand and control. Not hidden prompts and logic.
 - **Multimodal Support**: Beyond just LLMs, ModelFusion encompasses a diverse array of models including text generation, text-to-speech, speech-to-text, and image generation, allowing you to build multifaceted AI applications with ease.
+- **Flexibility and control**: AI application development can be complex and unique to each project. With ModelFusion, you have complete control over the prompts and model settings, and you can access the raw responses from the models quickly to build what you need.
+- **Type inference and validation**: ModelFusion uses TypeScript and [Zod](https://github.com/colinhacks/zod) to infer types wherever possible and to validate model responses.
 - **Integrated support features**: Essential features like logging, retries, throttling, tracing, and error handling are built-in, helping you focus more on building your application.
 
 ## Quick Install
@@ -358,7 +357,7 @@ const text = await describeImage(
   new HuggingFaceImageDescriptionModel({
     model: "nlpconnect/vit-gpt2-image-captioning",
   }),
-  data: buffer
+  data // buffer with image data
 );
 ```
 

package/core/structure/JsonSchemaProducer.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/core/structure/JsonSchemaProducer.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Schema defines a structure for a JSON object.
+ */
+export interface JsonSchemaProducer {
+    /**
+     * Returns the JSON schema for this schema. The schema has to be a valid JSON schema in object form.
+     */
+    getJsonSchema(): unknown;
+}

package/core/structure/JsonSchemaProducer.js

@@ -0,0 +1 @@
+export {};

package/core/structure/Schema.d.ts

@@ -1,5 +1,5 @@
 /**
- * Schema defines a structure for a JSON object.
+ * Validates that the structure of `value` matches the structure of this schema.
  */
 export interface Schema<STRUCTURE> {
     /**
@@ -13,10 +13,6 @@ export interface Schema<STRUCTURE> {
         success: false;
         error: unknown;
     };
-    /**
-     * Returns the JSON schema for this schema. The schema has to be a valid JSON schema in object form.
-     */
-    getJsonSchema(): unknown;
     /**
      * Only used for type inference.
      */

package/core/structure/StructureDefinition.d.ts

@@ -1,6 +1,7 @@
+import { JsonSchemaProducer } from "./JsonSchemaProducer.js";
 import { Schema } from "./Schema.js";
 export interface StructureDefinition<NAME extends string, STRUCTURE> {
     name: NAME;
     description?: string;
-    schema: Schema<STRUCTURE>;
+    schema: Schema<STRUCTURE> & JsonSchemaProducer;
 }

package/core/structure/{UncheckedJsonSchemaSchema.cjs → UncheckedSchema.cjs}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UncheckedJsonSchemaSchema = void 0;
-class UncheckedJsonSchemaSchema {
+exports.UncheckedSchema = void 0;
+class UncheckedSchema {
     constructor(jsonSchema) {
         Object.defineProperty(this, "jsonSchema", {
             enumerable: true,
@@ -23,4 +23,4 @@ class UncheckedJsonSchemaSchema {
         return this.jsonSchema;
     }
 }
-exports.UncheckedJsonSchemaSchema = UncheckedJsonSchemaSchema;
+exports.UncheckedSchema = UncheckedSchema;

package/core/structure/{UncheckedJsonSchemaSchema.d.ts → UncheckedSchema.d.ts}

@@ -1,7 +1,7 @@
 import { Schema } from "./Schema.js";
-export declare class UncheckedJsonSchemaSchema<STRUCTURE> implements Schema<STRUCTURE> {
-    private readonly jsonSchema;
-    constructor(jsonSchema: unknown);
+export declare class UncheckedSchema<STRUCTURE> implements Schema<STRUCTURE> {
+    private readonly jsonSchema?;
+    constructor(jsonSchema?: unknown);
     validate(value: unknown): {
         success: true;
         value: STRUCTURE;

package/core/structure/{UncheckedJsonSchemaSchema.js → UncheckedSchema.js}

@@ -1,4 +1,4 @@
-export class UncheckedJsonSchemaSchema {
+export class UncheckedSchema {
     constructor(jsonSchema) {
         Object.defineProperty(this, "jsonSchema", {
             enumerable: true,

package/core/structure/{UncheckedJsonSchemaStructureDefinition.cjs → UncheckedStructureDefinition.cjs}

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UncheckedJsonSchemaStructureDefinition = void 0;
-const UncheckedJsonSchemaSchema_js_1 = require("./UncheckedJsonSchemaSchema.cjs");
-class UncheckedJsonSchemaStructureDefinition {
+exports.UncheckedStructureDefinition = void 0;
+const UncheckedSchema_js_1 = require("./UncheckedSchema.cjs");
+class UncheckedStructureDefinition {
     constructor({ name, description, jsonSchema, }) {
         Object.defineProperty(this, "name", {
             enumerable: true,
@@ -24,7 +24,7 @@ class UncheckedJsonSchemaStructureDefinition {
         });
         this.name = name;
         this.description = description;
-        this.schema = new UncheckedJsonSchemaSchema_js_1.UncheckedJsonSchemaSchema(jsonSchema);
+        this.schema = new UncheckedSchema_js_1.UncheckedSchema(jsonSchema);
     }
 }
-exports.UncheckedJsonSchemaStructureDefinition = UncheckedJsonSchemaStructureDefinition;
+exports.UncheckedStructureDefinition = UncheckedStructureDefinition;

package/core/structure/{UncheckedJsonSchemaStructureDefinition.d.ts → UncheckedStructureDefinition.d.ts}

@@ -1,9 +1,9 @@
-import { Schema } from "./Schema.js";
 import { StructureDefinition } from "./StructureDefinition.js";
-export declare class UncheckedJsonSchemaStructureDefinition<NAME extends string, STRUCTURE> implements StructureDefinition<NAME, STRUCTURE> {
+import { UncheckedSchema } from "./UncheckedSchema.js";
+export declare class UncheckedStructureDefinition<NAME extends string, STRUCTURE> implements StructureDefinition<NAME, STRUCTURE> {
     name: NAME;
     description?: string;
-    schema: Schema<STRUCTURE>;
+    schema: UncheckedSchema<STRUCTURE>;
     constructor({ name, description, jsonSchema, }: {
         name: NAME;
         description?: string;

package/core/structure/{UncheckedJsonSchemaStructureDefinition.js → UncheckedStructureDefinition.js}

@@ -1,5 +1,5 @@
-import { UncheckedJsonSchemaSchema } from "./UncheckedJsonSchemaSchema.js";
-export class UncheckedJsonSchemaStructureDefinition {
+import { UncheckedSchema } from "./UncheckedSchema.js";
+export class UncheckedStructureDefinition {
     constructor({ name, description, jsonSchema, }) {
         Object.defineProperty(this, "name", {
             enumerable: true,
@@ -21,6 +21,6 @@ export class UncheckedJsonSchemaStructureDefinition {
         });
         this.name = name;
         this.description = description;
-        this.schema = new UncheckedJsonSchemaSchema(jsonSchema);
+        this.schema = new UncheckedSchema(jsonSchema);
     }
 }

package/core/structure/ZodStructureDefinition.d.ts

@@ -1,10 +1,10 @@
 import { z } from "zod";
-import { Schema } from "./Schema.js";
 import { StructureDefinition } from "./StructureDefinition.js";
+import { ZodSchema } from "./ZodSchema.js";
 export declare class ZodStructureDefinition<NAME extends string, STRUCTURE> implements StructureDefinition<NAME, STRUCTURE> {
     name: NAME;
     description?: string;
-    schema: Schema<STRUCTURE>;
+    schema: ZodSchema<STRUCTURE>;
     constructor({ name, description, schema, }: {
         name: NAME;
         description?: string;

package/core/structure/index.cjs

@@ -14,9 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./JsonSchemaProducer.cjs"), exports);
 __exportStar(require("./Schema.cjs"), exports);
 __exportStar(require("./StructureDefinition.cjs"), exports);
-__exportStar(require("./UncheckedJsonSchemaSchema.cjs"), exports);
-__exportStar(require("./UncheckedJsonSchemaStructureDefinition.cjs"), exports);
+__exportStar(require("./UncheckedSchema.cjs"), exports);
+__exportStar(require("./UncheckedStructureDefinition.cjs"), exports);
 __exportStar(require("./ZodSchema.cjs"), exports);
 __exportStar(require("./ZodStructureDefinition.cjs"), exports);

package/core/structure/index.d.ts

@@ -1,6 +1,7 @@
+export * from "./JsonSchemaProducer.js";
 export * from "./Schema.js";
 export * from "./StructureDefinition.js";
-export * from "./UncheckedJsonSchemaSchema.js";
-export * from "./UncheckedJsonSchemaStructureDefinition.js";
+export * from "./UncheckedSchema.js";
+export * from "./UncheckedStructureDefinition.js";
 export * from "./ZodSchema.js";
 export * from "./ZodStructureDefinition.js";

package/core/structure/index.js

@@ -1,6 +1,7 @@
+export * from "./JsonSchemaProducer.js";
 export * from "./Schema.js";
 export * from "./StructureDefinition.js";
-export * from "./UncheckedJsonSchemaSchema.js";
-export * from "./UncheckedJsonSchemaStructureDefinition.js";
+export * from "./UncheckedSchema.js";
+export * from "./UncheckedStructureDefinition.js";
 export * from "./ZodSchema.js";
 export * from "./ZodStructureDefinition.js";

package/event-source/index.cjs

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AsyncQueue.cjs"), exports);
 __exportStar(require("./createEventSourceStream.cjs"), exports);
+__exportStar(require("./readEventSource.cjs"), exports);
 __exportStar(require("./readEventSourceStream.cjs"), exports);

package/event-source/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./AsyncQueue.js";
 export * from "./createEventSourceStream.js";
+export * from "./readEventSource.js";
 export * from "./readEventSourceStream.js";

package/event-source/index.js

@@ -1,3 +1,4 @@
 export * from "./AsyncQueue.js";
 export * from "./createEventSourceStream.js";
+export * from "./readEventSource.js";
 export * from "./readEventSourceStream.js";

package/event-source/readEventSource.cjs

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readEventSource = void 0;
+const secure_json_parse_1 = __importDefault(require("secure-json-parse"));
+function readEventSource({ url, schema, onEvent, onError = console.error, }) {
+    const eventSource = new EventSource(url);
+    eventSource.onmessage = (e) => {
+        try {
+            const validationResult = schema.validate(secure_json_parse_1.default.parse(e.data));
+            if (!validationResult.success) {
+                onError(validationResult.error, eventSource);
+                return;
+            }
+            onEvent(validationResult.value, eventSource);
+        }
+        catch (error) {
+            onError(error, eventSource);
+        }
+    };
+    eventSource.onerror = (e) => {
+        onError(e, eventSource);
+    };
+}
+exports.readEventSource = readEventSource;

package/event-source/readEventSource.d.ts

@@ -0,0 +1,7 @@
+import { Schema } from "../core/structure/Schema";
+export declare function readEventSource<T>({ url, schema, onEvent, onError, }: {
+    url: string;
+    schema: Schema<T>;
+    onEvent: (event: T, eventSource: EventSource) => void;
+    onError?: (error: unknown, eventSource: EventSource) => void;
+}): void;

package/event-source/readEventSource.js

@@ -0,0 +1,20 @@
+import SecureJSON from "secure-json-parse";
+export function readEventSource({ url, schema, onEvent, onError = console.error, }) {
+    const eventSource = new EventSource(url);
+    eventSource.onmessage = (e) => {
+        try {
+            const validationResult = schema.validate(SecureJSON.parse(e.data));
+            if (!validationResult.success) {
+                onError(validationResult.error, eventSource);
+                return;
+            }
+            onEvent(validationResult.value, eventSource);
+        }
+        catch (error) {
+            onError(error, eventSource);
+        }
+    };
+    eventSource.onerror = (e) => {
+        onError(e, eventSource);
+    };
+}

package/event-source/readEventSourceStream.cjs

@@ -14,7 +14,12 @@ function readEventSourceStream({ stream, schema, errorHandler, }) {
         .then(async (events) => {
         try {
             for await (const event of events) {
-                queue.push(schema.parse(secure_json_parse_1.default.parse(event.data)));
+                const validationResult = schema.validate(secure_json_parse_1.default.parse(event.data));
+                if (!validationResult.success) {
+                    errorHandler?.(validationResult.error);
+                    continue;
+                }
+                queue.push(validationResult.value);
             }
         }
         catch (error) {

package/event-source/readEventSourceStream.d.ts

@@ -1,6 +1,7 @@
+import { Schema } from "../core/structure/Schema.js";
 import { ErrorHandler } from "../util/ErrorHandler.js";
 export declare function readEventSourceStream<T>({ stream, schema, errorHandler, }: {
     stream: ReadableStream<Uint8Array>;
-    schema: Zod.Schema<T>;
+    schema: Schema<T>;
     errorHandler?: ErrorHandler;
 }): AsyncIterable<T>;

package/event-source/readEventSourceStream.js

@@ -8,7 +8,12 @@ export function readEventSourceStream({ stream, schema, errorHandler, }) {
         .then(async (events) => {
         try {
             for await (const event of events) {
-                queue.push(schema.parse(SecureJSON.parse(event.data)));
+                const validationResult = schema.validate(SecureJSON.parse(event.data));
+                if (!validationResult.success) {
+                    errorHandler?.(validationResult.error);
+                    continue;
+                }
+                queue.push(validationResult.value);
             }
         }
         catch (error) {

package/package.json

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

package/tool/Tool.d.ts

@@ -1,4 +1,5 @@
 import { FunctionOptions } from "../core/FunctionOptions.js";
+import { JsonSchemaProducer } from "../core/structure/JsonSchemaProducer.js";
 import { Schema } from "../core/structure/Schema.js";
 import { StructureDefinition } from "../core/structure/StructureDefinition.js";
 /**
@@ -20,7 +21,7 @@ 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>;
+    readonly inputSchema: Schema<INPUT> & JsonSchemaProducer;
     /**
      * An optional schema of the output that the tool produces. This will be used to validate the output.
      */
@@ -32,7 +33,7 @@ export declare class Tool<NAME extends string, INPUT, OUTPUT> {
     constructor({ name, description, inputSchema, outputSchema, execute, }: {
         name: NAME;
         description: string;
-        inputSchema: Schema<INPUT>;
+        inputSchema: Schema<INPUT> & JsonSchemaProducer;
         outputSchema?: Schema<OUTPUT>;
         execute(input: INPUT, options?: FunctionOptions): PromiseLike<OUTPUT>;
     });

package/vector-index/memory/MemoryVectorIndex.cjs

@@ -4,8 +4,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MemoryVectorIndex = void 0;
+const secure_json_parse_1 = __importDefault(require("secure-json-parse"));
 const zod_1 = __importDefault(require("zod"));
 const cosineSimilarity_js_1 = require("../../util/cosineSimilarity.cjs");
+const jsonDataSchema = zod_1.default.array(zod_1.default.object({
+    id: zod_1.default.string(),
+    vector: zod_1.default.array(zod_1.default.number()),
+    data: zod_1.default.unknown(),
+}));
 /**
  * A very simple vector index that stores all entries in memory. Useful when you only have
  * a small number of entries and don't want to set up a real database, e.g. for conversational memory
@@ -21,15 +27,16 @@ class MemoryVectorIndex {
         });
     }
     static async deserialize({ serializedData, schema, }) {
-        let json = JSON.parse(serializedData);
+        // validate the outer structure:
+        const json = jsonDataSchema.parse(secure_json_parse_1.default.parse(serializedData));
         if (schema != null) {
-            json = zod_1.default
-                .array(zod_1.default.object({
-                id: zod_1.default.string(),
-                vector: zod_1.default.array(zod_1.default.number()),
-                data: schema,
-            }))
-                .parse(json);
+            // when a schema is provided, validate all entries:
+            for (const entry of json) {
+                const validationResult = schema.validate(entry.data);
+                if (!validationResult.success) {
+                    throw validationResult.error;
+                }
+            }
         }
         const vectorIndex = new MemoryVectorIndex();
         vectorIndex.upsertMany(json);

package/vector-index/memory/MemoryVectorIndex.d.ts

@@ -1,5 +1,5 @@
-import z from "zod";
 import { Vector } from "../../core/Vector.js";
+import { Schema } from "../../core/structure/Schema.js";
 import { VectorIndex } from "../VectorIndex.js";
 /**
  * A very simple vector index that stores all entries in memory. Useful when you only have
@@ -9,7 +9,7 @@ import { VectorIndex } from "../VectorIndex.js";
 export declare class MemoryVectorIndex<DATA> implements VectorIndex<DATA, MemoryVectorIndex<DATA>, (value: DATA) => boolean> {
     static deserialize<DATA>({ serializedData, schema, }: {
         serializedData: string;
-        schema?: z.ZodSchema<DATA>;
+        schema?: Schema<DATA>;
     }): Promise<MemoryVectorIndex<DATA>>;
     private readonly entries;
     upsertMany(data: Array<{

package/vector-index/memory/MemoryVectorIndex.js

@@ -1,5 +1,11 @@
+import SecureJSON from "secure-json-parse";
 import z from "zod";
 import { cosineSimilarity } from "../../util/cosineSimilarity.js";
+const jsonDataSchema = z.array(z.object({
+    id: z.string(),
+    vector: z.array(z.number()),
+    data: z.unknown(),
+}));
 /**
  * A very simple vector index that stores all entries in memory. Useful when you only have
  * a small number of entries and don't want to set up a real database, e.g. for conversational memory
@@ -15,15 +21,16 @@ export class MemoryVectorIndex {
         });
     }
     static async deserialize({ serializedData, schema, }) {
-        let json = JSON.parse(serializedData);
+        // validate the outer structure:
+        const json = jsonDataSchema.parse(SecureJSON.parse(serializedData));
         if (schema != null) {
-            json = z
-                .array(z.object({
-                id: z.string(),
-                vector: z.array(z.number()),
-                data: schema,
-            }))
-                .parse(json);
+            // when a schema is provided, validate all entries:
+            for (const entry of json) {
+                const validationResult = schema.validate(entry.data);
+                if (!validationResult.success) {
+                    throw validationResult.error;
+                }
+            }
         }
         const vectorIndex = new MemoryVectorIndex();
         vectorIndex.upsertMany(json);