modelfusion 0.130.1 → 0.131.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
   "description": "The TypeScript library for building AI applications.",
-  "version": "0.130.1",
+  "version": "0.131.1",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [
@@ -67,6 +67,7 @@
     "js-tiktoken": "1.0.7",
     "nanoid": "3.3.6",
     "secure-json-parse": "2.7.0",
+    "type-fest": "4.9.0",
     "ws": "8.14.2",
     "zod": "3.22.4",
     "zod-to-json-schema": "3.22.3"
@@ -80,7 +81,6 @@
     "@vitest/ui": "1.1.0",
     "eslint": "^8.45.0",
     "eslint-config-prettier": "9.1.0",
-    "msw": "2.1.2",
-    "type-fest": "4.9.0"
+    "msw": "2.1.2"
   }
 }

package/tool/WebSearchTool.cjs

@@ -13,7 +13,7 @@ const RETURN_TYPE_SCHEMA = (0, ZodSchema_js_1.zodSchema)(zod_1.z.object({
 }));
 // expose the schemas to library consumers:
 const createParameters = (description) => 
-// same structure, but with description:
+// same schema, but with description:
 (0, ZodSchema_js_1.zodSchema)(zod_1.z.object({
     query: zod_1.z.string().describe(description),
 }));

package/tool/WebSearchTool.js

@@ -10,7 +10,7 @@ const RETURN_TYPE_SCHEMA = zodSchema(z.object({
 }));
 // expose the schemas to library consumers:
 const createParameters = (description) => 
-// same structure, but with description:
+// same schema, but with description:
 zodSchema(z.object({
     query: z.string().describe(description),
 }));

package/tool/generate-tool-call/generateToolCall.cjs

@@ -37,7 +37,7 @@ async function generateToolCall({ model, tool, prompt, fullResponse, ...options
                     extractedValue: {
                         id: toolCall.id,
                         name: tool.name,
-                        args: parseResult.data,
+                        args: parseResult.value,
                     },
                     usage: result.usage,
                 };

package/tool/generate-tool-call/generateToolCall.js

@@ -34,7 +34,7 @@ export async function generateToolCall({ model, tool, prompt, fullResponse, ...o
                     extractedValue: {
                         id: toolCall.id,
                         name: tool.name,
-                        args: parseResult.data,
+                        args: parseResult.value,
                     },
                     usage: result.usage,
                 };

package/tool/generate-tool-calls/generateToolCalls.cjs

@@ -45,7 +45,7 @@ async function generateToolCalls({ model, tools, prompt, fullResponse, ...option
                 return {
                     id: rawToolCall.id,
                     name: tool.name,
-                    args: parseResult.data,
+                    args: parseResult.value,
                 };
             });
             return {

package/tool/generate-tool-calls/generateToolCalls.js

@@ -42,7 +42,7 @@ export async function generateToolCalls({ model, tools, prompt, fullResponse, ..
                 return {
                     id: rawToolCall.id,
                     name: tool.name,
-                    args: parseResult.data,
+                    args: parseResult.value,
                 };
             });
             return {

package/{model-function/generate-structure → util}/fixJson.test.cjs

@@ -148,7 +148,7 @@ const fixJson_js_1 = require("./fixJson.cjs");
     (0, vitest_1.test)("should handle nested arrays and objects", () => {
         node_assert_1.default.strictEqual((0, fixJson_js_1.fixJson)('{"a": {"b": ["c", {"d": "e",'), '{"a": {"b": ["c", {"d": "e"}]}}');
     });
-    (0, vitest_1.test)("should handle deeply nested structures", () => {
+    (0, vitest_1.test)("should handle deeply nested objects", () => {
         node_assert_1.default.strictEqual((0, fixJson_js_1.fixJson)('{"a": {"b": {"c": {"d":'), '{"a": {"b": {"c": {}}}}');
     });
     (0, vitest_1.test)("should handle potential nested arrays or objects", () => {

package/{model-function/generate-structure → util}/fixJson.test.js

@@ -143,7 +143,7 @@ describe("nesting", () => {
     test("should handle nested arrays and objects", () => {
         assert.strictEqual(fixJson('{"a": {"b": ["c", {"d": "e",'), '{"a": {"b": ["c", {"d": "e"}]}}');
     });
-    test("should handle deeply nested structures", () => {
+    test("should handle deeply nested objects", () => {
         assert.strictEqual(fixJson('{"a": {"b": {"c": {"d":'), '{"a": {"b": {"c": {}}}}');
     });
     test("should handle potential nested arrays or objects", () => {

package/util/isDeepEqualData.cjs

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isDeepEqualData = void 0;
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /**
- * Performs a deep-equal comparison of two parsed JSON structures.
+ * Performs a deep-equal comparison of two parsed JSON objects.
  *
  * @param {any} obj1 - The first object to compare.
  * @param {any} obj2 - The second object to compare.

package/util/isDeepEqualData.d.ts

@@ -1,5 +1,5 @@
 /**
- * Performs a deep-equal comparison of two parsed JSON structures.
+ * Performs a deep-equal comparison of two parsed JSON objects.
  *
  * @param {any} obj1 - The first object to compare.
  * @param {any} obj2 - The second object to compare.

package/util/isDeepEqualData.js

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /**
- * Performs a deep-equal comparison of two parsed JSON structures.
+ * Performs a deep-equal comparison of two parsed JSON objects.
  *
  * @param {any} obj1 - The first object to compare.
  * @param {any} obj2 - The second object to compare.

package/util/streaming/parseEventSourceStreamAsAsyncIterable.cjs

@@ -29,7 +29,7 @@ async function parseEventSourceStreamAsAsyncIterable({ stream, schema, }) {
                     // chunks that are not parsable, and ModelFusion should be resilient to that.
                     continue;
                 }
-                const completionChunk = parseResult.data;
+                const completionChunk = parseResult.value;
                 queue.push({
                     type: "delta",
                     deltaValue: completionChunk,

package/util/streaming/parseEventSourceStreamAsAsyncIterable.js

@@ -26,7 +26,7 @@ export async function parseEventSourceStreamAsAsyncIterable({ stream, schema, })
                     // chunks that are not parsable, and ModelFusion should be resilient to that.
                     continue;
                 }
-                const completionChunk = parseResult.data;
+                const completionChunk = parseResult.value;
                 queue.push({
                     type: "delta",
                     deltaValue: completionChunk,

package/vector-index/memory/MemoryVectorIndex.cjs

@@ -25,7 +25,7 @@ class MemoryVectorIndex {
         });
     }
     static async deserialize({ serializedData, schema, }) {
-        // validate the outer structure:
+        // validate the outer value:
         const json = (0, parseJSON_js_1.parseJSON)({ text: serializedData, schema: jsonDataSchema });
         if (schema != null) {
             // when a schema is provided, validate all entries:

package/vector-index/memory/MemoryVectorIndex.js

@@ -22,7 +22,7 @@ export class MemoryVectorIndex {
         });
     }
     static async deserialize({ serializedData, schema, }) {
-        // validate the outer structure:
+        // validate the outer value:
         const json = parseJSON({ text: serializedData, schema: jsonDataSchema });
         if (schema != null) {
             // when a schema is provided, validate all entries:

package/model-function/generate-structure/StructureFromTextStreamingModel.d.ts

@@ -1,19 +0,0 @@
-import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
-import { Schema } from "../../core/schema/Schema.js";
-import { Delta } from "../../model-function/Delta.js";
-import { AsyncQueue } from "../../util/AsyncQueue.js";
-import { TextGenerationModelSettings, TextStreamingModel } from "../generate-text/TextGenerationModel.js";
-import { StructureFromTextGenerationModel } from "./StructureFromTextGenerationModel.js";
-import { StructureFromTextPromptTemplate } from "./StructureFromTextPromptTemplate.js";
-import { StructureStreamingModel } from "./StructureGenerationModel.js";
-export declare class StructureFromTextStreamingModel<SOURCE_PROMPT, TARGET_PROMPT, MODEL extends TextStreamingModel<TARGET_PROMPT, TextGenerationModelSettings>> extends StructureFromTextGenerationModel<SOURCE_PROMPT, TARGET_PROMPT, MODEL> implements StructureStreamingModel<SOURCE_PROMPT, MODEL["settings"]> {
-    constructor(options: {
-        model: MODEL;
-        template: StructureFromTextPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT>;
-    });
-    doStreamStructure(schema: Schema<unknown> & JsonSchemaProducer, prompt: SOURCE_PROMPT, options?: FunctionOptions): Promise<AsyncQueue<Delta<string>>>;
-    extractStructureTextDelta(delta: unknown): string;
-    parseAccumulatedStructureText(accumulatedText: string): unknown;
-    withSettings(additionalSettings: Partial<MODEL["settings"]>): this;
-}

package/model-function/generate-structure/StructureGenerationModel.d.ts

@@ -1,24 +0,0 @@
-import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
-import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { Schema } from "../../core/schema/Schema.js";
-import { Delta } from "../../model-function/Delta.js";
-import { Model, ModelSettings } from "../Model.js";
-export interface StructureGenerationModelSettings extends ModelSettings {
-}
-export interface StructureGenerationModel<PROMPT, SETTINGS extends StructureGenerationModelSettings = StructureGenerationModelSettings> extends Model<SETTINGS> {
-    doGenerateStructure(schema: Schema<unknown> & JsonSchemaProducer, prompt: PROMPT, options?: FunctionOptions): PromiseLike<{
-        rawResponse: unknown;
-        valueText: string;
-        value: unknown;
-        usage?: {
-            promptTokens: number;
-            completionTokens: number;
-            totalTokens: number;
-        };
-    }>;
-}
-export interface StructureStreamingModel<PROMPT, SETTINGS extends StructureGenerationModelSettings = StructureGenerationModelSettings> extends StructureGenerationModel<PROMPT, SETTINGS> {
-    doStreamStructure(schema: Schema<unknown> & JsonSchemaProducer, prompt: PROMPT, options?: FunctionOptions): PromiseLike<AsyncIterable<Delta<unknown>>>;
-    extractStructureTextDelta(delta: unknown): string | undefined;
-    parseAccumulatedStructureText(accumulatedText: string): unknown;
-}

package/model-function/generate-structure/StructureStreamingEvent.d.ts

@@ -1,7 +0,0 @@
-import { BaseModelCallFinishedEvent, BaseModelCallStartedEvent } from "../ModelCallEvent.js";
-export interface StructureStreamingStartedEvent extends BaseModelCallStartedEvent {
-    functionType: "stream-structure";
-}
-export interface StructureStreamingFinishedEvent extends BaseModelCallFinishedEvent {
-    functionType: "stream-structure";
-}

package/model-function/generate-structure/generateStructure.d.ts

@@ -1,56 +0,0 @@
-import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
-import { Schema } from "../../core/schema/Schema.js";
-import { ModelCallMetadata } from "../ModelCallMetadata.js";
-import { StructureGenerationModel, StructureGenerationModelSettings } from "./StructureGenerationModel.js";
-/**
- * Generate a typed object for a prompt and a schema.
- *
- * @see https://modelfusion.dev/guide/function/generate-structure
- *
- * @example
- * const sentiment = await generateStructure({
- *   model: openai.ChatTextGenerator(...).asFunctionCallStructureGenerationModel(...),
- *
- *   schema: zodSchema(z.object({
- *     sentiment: z
- *       .enum(["positive", "neutral", "negative"])
- *       .describe("Sentiment."),
- *   })),
- *
- *   prompt: [
- *     openai.ChatMessage.system(
- *       "You are a sentiment evaluator. " +
- *         "Analyze the sentiment of the following product review:"
- *     ),
- *     openai.ChatMessage.user(
- *       "After I opened the package, I was met by a very unpleasant smell " +
- *         "that did not disappear even after washing. Never again!"
- *     ),
- *   ]
- * });
- *
- * @param {StructureGenerationModel<PROMPT, SETTINGS>} model - The model to generate the structure.
- * @param {Schema<STRUCTURE>} schema - The schema to be used.
- * @param {PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT)} prompt
- * The prompt to be used.
- * You can also pass a function that takes the schema as an argument and returns the prompt.
- *
- * @returns {Promise<STRUCTURE>} - Returns a promise that resolves to the generated structure.
- */
-export declare function generateStructure<STRUCTURE, PROMPT, SETTINGS extends StructureGenerationModelSettings>(args: {
-    model: StructureGenerationModel<PROMPT, SETTINGS>;
-    schema: Schema<STRUCTURE> & JsonSchemaProducer;
-    prompt: PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT);
-    fullResponse?: false;
-} & FunctionOptions): Promise<STRUCTURE>;
-export declare function generateStructure<STRUCTURE, PROMPT, SETTINGS extends StructureGenerationModelSettings>(args: {
-    model: StructureGenerationModel<PROMPT, SETTINGS>;
-    schema: Schema<STRUCTURE> & JsonSchemaProducer;
-    prompt: PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT);
-    fullResponse: true;
-} & FunctionOptions): Promise<{
-    structure: STRUCTURE;
-    rawResponse: unknown;
-    metadata: ModelCallMetadata;
-}>;

package/model-function/generate-structure/index.d.ts

@@ -1,11 +0,0 @@
-export * from "./StructureFromTextGenerationModel.js";
-export * from "./StructureFromTextPromptTemplate.js";
-export * from "./StructureFromTextStreamingModel.js";
-export * from "./StructureGenerationEvent.js";
-export * from "./StructureGenerationModel.js";
-export * from "./StructureParseError.js";
-export * from "./StructureStreamingEvent.js";
-export * from "./StructureValidationError.js";
-export * from "./generateStructure.js";
-export * from "./jsonStructurePrompt.js";
-export * from "./streamStructure.js";

package/model-function/generate-structure/index.js

@@ -1,11 +0,0 @@
-export * from "./StructureFromTextGenerationModel.js";
-export * from "./StructureFromTextPromptTemplate.js";
-export * from "./StructureFromTextStreamingModel.js";
-export * from "./StructureGenerationEvent.js";
-export * from "./StructureGenerationModel.js";
-export * from "./StructureParseError.js";
-export * from "./StructureStreamingEvent.js";
-export * from "./StructureValidationError.js";
-export * from "./generateStructure.js";
-export * from "./jsonStructurePrompt.js";
-export * from "./streamStructure.js";

package/model-function/generate-structure/streamStructure.cjs

@@ -1,61 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.streamStructure = void 0;
-const isDeepEqualData_js_1 = require("../../util/isDeepEqualData.cjs");
-const executeStreamCall_js_1 = require("../executeStreamCall.cjs");
-async function streamStructure({ model, schema, prompt, fullResponse, ...options }) {
-    // Note: PROMPT must not be a function.
-    const expandedPrompt = typeof prompt === "function"
-        ? prompt(schema)
-        : prompt;
-    let accumulatedText = "";
-    let lastStructure;
-    let resolveStructure;
-    let rejectStructure;
-    const structurePromise = new Promise((resolve, reject) => {
-        resolveStructure = resolve;
-        rejectStructure = reject;
-    });
-    const callResponse = await (0, executeStreamCall_js_1.executeStreamCall)({
-        functionType: "stream-structure",
-        input: {
-            schema,
-            prompt: expandedPrompt,
-        },
-        model,
-        options,
-        startStream: async (options) => model.doStreamStructure(schema, expandedPrompt, options),
-        processDelta: (delta) => {
-            const textDelta = model.extractStructureTextDelta(delta.deltaValue);
-            if (textDelta == null) {
-                return undefined;
-            }
-            accumulatedText += textDelta;
-            const latestStructure = model.parseAccumulatedStructureText(accumulatedText);
-            // only send a new part into the stream when the partial structure has changed:
-            if (!(0, isDeepEqualData_js_1.isDeepEqualData)(lastStructure, latestStructure)) {
-                lastStructure = latestStructure;
-                return lastStructure;
-            }
-            return undefined;
-        },
-        onDone: () => {
-            // process the final result (full type validation):
-            const parseResult = schema.validate(lastStructure);
-            if (parseResult.success) {
-                resolveStructure(parseResult.data);
-            }
-            else {
-                rejectStructure(parseResult.error);
-            }
-        },
-    });
-    return fullResponse
-        ? {
-            structureStream: callResponse.value,
-            structurePromise,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}
-exports.streamStructure = streamStructure;

package/model-function/generate-structure/streamStructure.d.ts

@@ -1,67 +0,0 @@
-import type { PartialDeep } from "type-fest";
-import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
-import { Schema } from "../../core/schema/Schema.js";
-import { ModelCallMetadata } from "../ModelCallMetadata.js";
-import { StructureStreamingModel } from "./StructureGenerationModel.js";
-/**
- * Generate and stream an object for a prompt and a structure definition.
- *
- * For the OpenAI chat model, this generates and parses a function call with a single function.
- *
- * @see https://modelfusion.dev/guide/function/generate-structure
- *
- * @example
- * const structureStream = await streamStructure({
- *   structureGenerator: openai.ChatTextGenerator(...).asFunctionCallStructureGenerationModel(...),
- *   schema: zodSchema(
- *     z.array(
- *       z.object({
- *         name: z.string(),
- *         class: z
- *           .string()
- *           .describe("Character class, e.g. warrior, mage, or thief."),
- *         description: z.string(),
- *       })
- *     ),
- *   prompt: [
- *     openai.ChatMessage.user(
- *       "Generate 3 character descriptions for a fantasy role playing game."
- *     ),
- *   ]
- * });
- *
- * for await (const partialStructure of structureStream) {
- *   // ...
- * }
- *
- * @param {StructureStreamingModel<PROMPT>} structureGenerator - The model to use for streaming
- * @param {Schema<STRUCTURE>} schema - The schema to be used.
- * @param {PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT)} prompt
- * The prompt to be used.
- * You can also pass a function that takes the schema as an argument and returns the prompt.
- *
- * @returns {AsyncIterableResultPromise<StructureStreamPart<STRUCTURE>>}
- * The async iterable result promise.
- * Each part of the stream is a partial structure.
- */
-export declare function streamStructure<STRUCTURE, PROMPT>(args: {
-    model: StructureStreamingModel<PROMPT>;
-    schema: Schema<STRUCTURE> & JsonSchemaProducer;
-    prompt: PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT);
-    fullResponse?: false;
-} & FunctionOptions): Promise<AsyncIterable<PartialDeep<STRUCTURE, {
-    recurseIntoArrays: true;
-}>>>;
-export declare function streamStructure<STRUCTURE, PROMPT>(args: {
-    model: StructureStreamingModel<PROMPT>;
-    schema: Schema<STRUCTURE> & JsonSchemaProducer;
-    prompt: PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT);
-    fullResponse: true;
-} & FunctionOptions): Promise<{
-    structureStream: AsyncIterable<PartialDeep<STRUCTURE, {
-        recurseIntoArrays: true;
-    }>>;
-    structurePromise: PromiseLike<STRUCTURE>;
-    metadata: Omit<ModelCallMetadata, "durationInMs" | "finishTimestamp">;
-}>;

package/model-function/generate-structure/streamStructure.js

@@ -1,57 +0,0 @@
-import { isDeepEqualData } from "../../util/isDeepEqualData.js";
-import { executeStreamCall } from "../executeStreamCall.js";
-export async function streamStructure({ model, schema, prompt, fullResponse, ...options }) {
-    // Note: PROMPT must not be a function.
-    const expandedPrompt = typeof prompt === "function"
-        ? prompt(schema)
-        : prompt;
-    let accumulatedText = "";
-    let lastStructure;
-    let resolveStructure;
-    let rejectStructure;
-    const structurePromise = new Promise((resolve, reject) => {
-        resolveStructure = resolve;
-        rejectStructure = reject;
-    });
-    const callResponse = await executeStreamCall({
-        functionType: "stream-structure",
-        input: {
-            schema,
-            prompt: expandedPrompt,
-        },
-        model,
-        options,
-        startStream: async (options) => model.doStreamStructure(schema, expandedPrompt, options),
-        processDelta: (delta) => {
-            const textDelta = model.extractStructureTextDelta(delta.deltaValue);
-            if (textDelta == null) {
-                return undefined;
-            }
-            accumulatedText += textDelta;
-            const latestStructure = model.parseAccumulatedStructureText(accumulatedText);
-            // only send a new part into the stream when the partial structure has changed:
-            if (!isDeepEqualData(lastStructure, latestStructure)) {
-                lastStructure = latestStructure;
-                return lastStructure;
-            }
-            return undefined;
-        },
-        onDone: () => {
-            // process the final result (full type validation):
-            const parseResult = schema.validate(lastStructure);
-            if (parseResult.success) {
-                resolveStructure(parseResult.data);
-            }
-            else {
-                rejectStructure(parseResult.error);
-            }
-        },
-    });
-    return fullResponse
-        ? {
-            structureStream: callResponse.value,
-            structurePromise,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}