modelfusion 0.105.0 → 0.106.0

package/composed-function/summarize/summarizeRecursivelyWithTextGenerationAndTokenSplitting.js

@@ -1,21 +0,0 @@
-import { generateText } from "../../model-function/generate-text/generateText.js";
-import { splitAtToken } from "../../text-chunk/split/splitRecursively.js";
-import { summarizeRecursively } from "./summarizeRecursively.js";
-/**
- * Recursively summarizes a text using a text generation model, e.g. for summarization or text extraction.
- * It automatically splits the text into optimal chunks that are small enough to be processed by the model,
- * while leaving enough space for the model to generate text.
- */
-export async function summarizeRecursivelyWithTextGenerationAndTokenSplitting({ text, model, prompt, tokenLimit = model.contextWindowSize -
-    (model.settings.maxGenerationTokens ?? model.contextWindowSize / 4), join, }, options) {
-    const emptyPromptTokens = await model.countPromptTokens(await prompt({ text: "" }));
-    return summarizeRecursively({
-        split: splitAtToken({
-            tokenizer: model.tokenizer,
-            maxTokensPerChunk: tokenLimit - emptyPromptTokens,
-        }),
-        summarize: async (input) => generateText(model, await prompt(input), options),
-        join,
-        text,
-    }, options);
-}

package/cost/Cost.cjs

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cost = void 0;
-class Cost {
-    constructor({ costInMillicents, hasUnknownCost, callsWithUnknownCost, }) {
-        Object.defineProperty(this, "costInMillicents", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "hasUnknownCost", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "callsWithUnknownCost", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.costInMillicents = costInMillicents;
-        this.hasUnknownCost = hasUnknownCost;
-        this.callsWithUnknownCost = callsWithUnknownCost;
-    }
-    get costInCent() {
-        return this.costInMillicents / 1000;
-    }
-    get costInDollar() {
-        return this.costInCent / 100;
-    }
-    formatAsDollarAmount({ decimals = 2 } = {}) {
-        return `$${this.costInDollar.toFixed(decimals)}`;
-    }
-}
-exports.Cost = Cost;

package/cost/Cost.d.ts

@@ -1,16 +0,0 @@
-import { SuccessfulModelCall } from "../model-function/SuccessfulModelCall.js";
-export declare class Cost {
-    readonly costInMillicents: number;
-    readonly hasUnknownCost: boolean;
-    readonly callsWithUnknownCost: SuccessfulModelCall[];
-    constructor({ costInMillicents, hasUnknownCost, callsWithUnknownCost, }: {
-        costInMillicents: number;
-        hasUnknownCost: boolean;
-        callsWithUnknownCost: SuccessfulModelCall[];
-    });
-    get costInCent(): number;
-    get costInDollar(): number;
-    formatAsDollarAmount({ decimals }?: {
-        decimals?: number;
-    }): string;
-}

package/cost/Cost.js

@@ -1,34 +0,0 @@
-export class Cost {
-    constructor({ costInMillicents, hasUnknownCost, callsWithUnknownCost, }) {
-        Object.defineProperty(this, "costInMillicents", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "hasUnknownCost", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "callsWithUnknownCost", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.costInMillicents = costInMillicents;
-        this.hasUnknownCost = hasUnknownCost;
-        this.callsWithUnknownCost = callsWithUnknownCost;
-    }
-    get costInCent() {
-        return this.costInMillicents / 1000;
-    }
-    get costInDollar() {
-        return this.costInCent / 100;
-    }
-    formatAsDollarAmount({ decimals = 2 } = {}) {
-        return `$${this.costInDollar.toFixed(decimals)}`;
-    }
-}

package/cost/CostCalculator.d.ts

@@ -1,8 +0,0 @@
-import { SuccessfulModelCall } from "../model-function/SuccessfulModelCall.js";
-export interface CostCalculator {
-    readonly provider: string;
-    /**
-     * @return null if the cost is unknown, otherwise the cost in Millicents (0 if free)
-     */
-    calculateCostInMillicents(call: SuccessfulModelCall): PromiseLike<number | null>;
-}

package/cost/calculateCost.cjs

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateCost = void 0;
-const Cost_js_1 = require("./Cost.cjs");
-async function calculateCost({ calls, costCalculators, }) {
-    let costInMillicents = 0;
-    const callsWithUnknownCost = [];
-    for (const call of calls) {
-        const model = call.model;
-        const providerCostCalculator = costCalculators.find((providerCostCalculator) => providerCostCalculator.provider === model.provider);
-        if (!providerCostCalculator) {
-            callsWithUnknownCost.push(call);
-            continue;
-        }
-        const cost = await providerCostCalculator.calculateCostInMillicents(call);
-        if (cost === null) {
-            callsWithUnknownCost.push(call);
-            continue;
-        }
-        costInMillicents += cost;
-    }
-    return new Cost_js_1.Cost({
-        costInMillicents,
-        hasUnknownCost: callsWithUnknownCost.length > 0,
-        callsWithUnknownCost,
-    });
-}
-exports.calculateCost = calculateCost;

package/cost/calculateCost.d.ts

@@ -1,7 +0,0 @@
-import { Cost } from "./Cost.js";
-import { CostCalculator } from "./CostCalculator.js";
-import { SuccessfulModelCall } from "../model-function/SuccessfulModelCall.js";
-export declare function calculateCost({ calls, costCalculators, }: {
-    calls: SuccessfulModelCall[];
-    costCalculators: CostCalculator[];
-}): Promise<Cost>;

package/cost/calculateCost.js

@@ -1,24 +0,0 @@
-import { Cost } from "./Cost.js";
-export async function calculateCost({ calls, costCalculators, }) {
-    let costInMillicents = 0;
-    const callsWithUnknownCost = [];
-    for (const call of calls) {
-        const model = call.model;
-        const providerCostCalculator = costCalculators.find((providerCostCalculator) => providerCostCalculator.provider === model.provider);
-        if (!providerCostCalculator) {
-            callsWithUnknownCost.push(call);
-            continue;
-        }
-        const cost = await providerCostCalculator.calculateCostInMillicents(call);
-        if (cost === null) {
-            callsWithUnknownCost.push(call);
-            continue;
-        }
-        costInMillicents += cost;
-    }
-    return new Cost({
-        costInMillicents,
-        hasUnknownCost: callsWithUnknownCost.length > 0,
-        callsWithUnknownCost,
-    });
-}

package/cost/index.cjs

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-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("./Cost.cjs"), exports);
-__exportStar(require("./calculateCost.cjs"), exports);
-__exportStar(require("./CostCalculator.cjs"), exports);

package/cost/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./Cost.js";
-export * from "./calculateCost.js";
-export * from "./CostCalculator.js";

package/cost/index.js

@@ -1,3 +0,0 @@
-export * from "./Cost.js";
-export * from "./calculateCost.js";
-export * from "./CostCalculator.js";

package/guard/GuardEvent.cjs

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

package/guard/GuardEvent.d.ts

@@ -1,7 +0,0 @@
-import { BaseFunctionFinishedEvent, BaseFunctionStartedEvent } from "../core/FunctionEvent.js";
-export interface GuardStartedEvent extends BaseFunctionStartedEvent {
-    functionType: "guard";
-}
-export interface GuardFinishedEvent extends BaseFunctionFinishedEvent {
-    functionType: "guard";
-}

package/guard/GuardEvent.js

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

package/guard/fixStructure.cjs

@@ -1,75 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fixStructure = void 0;
-const StructureParseError_js_1 = require("../model-function/generate-structure/StructureParseError.cjs");
-const StructureValidationError_js_1 = require("../model-function/generate-structure/StructureValidationError.cjs");
-/**
- * Attempts to correct and retry structure generation when encountering parsing or validation errors.
- *
- * This function acts as a guard within the structure generation process. If the generation results in
- * an error, identified as either a `StructureParseError` or `StructureValidationError`, the function
- * triggers a retry mechanism. It uses the `modifyInputForRetry` method, provided via options, to adjust
- * the input parameters, aiming to resolve the issue that caused the initial error. The process continues
- * until a valid structure is generated, or it exhausts the predefined retry limits.
- *
- * @template INPUT - The expected format/type of the input data used for structure generation.
- * @template OUTPUT - The expected format/type of the output data, i.e., the successfully generated structure.
- *
- * @param {Object} options - Configuration options for modifying the input before retrying structure generation.
- * @param {function} options.modifyInputForRetry - A function that takes the error type, original input, and error object.
- *        It modifies the input data based on the error information, aiming to correct the issue for the retry attempt.
- *        This function must return a promise that resolves with the modified input.
- *
- * @returns {Guard<INPUT, OUTPUT>} A guard function that intercepts the structure generation process, checking for
- *          errors, and initiating retries by modifying the input parameters. The guard can trigger multiple retries
- *          if the issues persist. If the process succeeds, it returns the valid structure; otherwise, it returns
- *          undefined, indicating the exhaustion of retry attempts or a non-recoverable error.
- *
- * @example
- * const result = await guard(
- *  (input) =>
- *    generateStructure(
- *      openai
- *        .ChatTextGenerator(/* ... * /)
- *        .asFunctionCallStructureGenerationModel(/* ... * /),
- *
- *      new ZodSchema({
- *        // ...
- *      }),
- *
- *      input
- *    ),
- *  [
- *    // ...
- *  ],
- *  fixStructure({
- *    modifyInputForRetry: async ({ input, error }) => [
- *      ...input,
- *      openai.ChatMessage.assistant(null, {
- *        functionCall: {
- *          name: "sentiment",
- *          arguments: JSON.stringify(error.valueText),
- *        },
- *      }),
- *      openai.ChatMessage.user(error.message),
- *      openai.ChatMessage.user("Please fix the error and try again."),
- *    ],
- *  })
- * );
- */
-const fixStructure = ({ modifyInputForRetry }) => async (result) => {
-    if (result.type === "error" &&
-        (result.error instanceof StructureValidationError_js_1.StructureValidationError ||
-            result.error instanceof StructureParseError_js_1.StructureParseError)) {
-        return {
-            action: "retry",
-            input: await modifyInputForRetry({
-                type: "error",
-                input: result.input,
-                error: result.error,
-            }),
-        };
-    }
-    return undefined;
-};
-exports.fixStructure = fixStructure;

package/guard/fixStructure.d.ts

@@ -1,64 +0,0 @@
-import { StructureParseError } from "../model-function/generate-structure/StructureParseError.js";
-import { StructureValidationError } from "../model-function/generate-structure/StructureValidationError.js";
-import { Guard } from "./guard.js";
-/**
- * Attempts to correct and retry structure generation when encountering parsing or validation errors.
- *
- * This function acts as a guard within the structure generation process. If the generation results in
- * an error, identified as either a `StructureParseError` or `StructureValidationError`, the function
- * triggers a retry mechanism. It uses the `modifyInputForRetry` method, provided via options, to adjust
- * the input parameters, aiming to resolve the issue that caused the initial error. The process continues
- * until a valid structure is generated, or it exhausts the predefined retry limits.
- *
- * @template INPUT - The expected format/type of the input data used for structure generation.
- * @template OUTPUT - The expected format/type of the output data, i.e., the successfully generated structure.
- *
- * @param {Object} options - Configuration options for modifying the input before retrying structure generation.
- * @param {function} options.modifyInputForRetry - A function that takes the error type, original input, and error object.
- *        It modifies the input data based on the error information, aiming to correct the issue for the retry attempt.
- *        This function must return a promise that resolves with the modified input.
- *
- * @returns {Guard<INPUT, OUTPUT>} A guard function that intercepts the structure generation process, checking for
- *          errors, and initiating retries by modifying the input parameters. The guard can trigger multiple retries
- *          if the issues persist. If the process succeeds, it returns the valid structure; otherwise, it returns
- *          undefined, indicating the exhaustion of retry attempts or a non-recoverable error.
- *
- * @example
- * const result = await guard(
- *  (input) =>
- *    generateStructure(
- *      openai
- *        .ChatTextGenerator(/* ... * /)
- *        .asFunctionCallStructureGenerationModel(/* ... * /),
- *
- *      new ZodSchema({
- *        // ...
- *      }),
- *
- *      input
- *    ),
- *  [
- *    // ...
- *  ],
- *  fixStructure({
- *    modifyInputForRetry: async ({ input, error }) => [
- *      ...input,
- *      openai.ChatMessage.assistant(null, {
- *        functionCall: {
- *          name: "sentiment",
- *          arguments: JSON.stringify(error.valueText),
- *        },
- *      }),
- *      openai.ChatMessage.user(error.message),
- *      openai.ChatMessage.user("Please fix the error and try again."),
- *    ],
- *  })
- * );
- */
-export declare const fixStructure: <INPUT, OUTPUT>(options: {
-    modifyInputForRetry: (options: {
-        type: "error";
-        input: INPUT;
-        error: StructureValidationError | StructureParseError;
-    }) => PromiseLike<INPUT>;
-}) => Guard<INPUT, OUTPUT>;

package/guard/fixStructure.js

@@ -1,71 +0,0 @@
-import { StructureParseError } from "../model-function/generate-structure/StructureParseError.js";
-import { StructureValidationError } from "../model-function/generate-structure/StructureValidationError.js";
-/**
- * Attempts to correct and retry structure generation when encountering parsing or validation errors.
- *
- * This function acts as a guard within the structure generation process. If the generation results in
- * an error, identified as either a `StructureParseError` or `StructureValidationError`, the function
- * triggers a retry mechanism. It uses the `modifyInputForRetry` method, provided via options, to adjust
- * the input parameters, aiming to resolve the issue that caused the initial error. The process continues
- * until a valid structure is generated, or it exhausts the predefined retry limits.
- *
- * @template INPUT - The expected format/type of the input data used for structure generation.
- * @template OUTPUT - The expected format/type of the output data, i.e., the successfully generated structure.
- *
- * @param {Object} options - Configuration options for modifying the input before retrying structure generation.
- * @param {function} options.modifyInputForRetry - A function that takes the error type, original input, and error object.
- *        It modifies the input data based on the error information, aiming to correct the issue for the retry attempt.
- *        This function must return a promise that resolves with the modified input.
- *
- * @returns {Guard<INPUT, OUTPUT>} A guard function that intercepts the structure generation process, checking for
- *          errors, and initiating retries by modifying the input parameters. The guard can trigger multiple retries
- *          if the issues persist. If the process succeeds, it returns the valid structure; otherwise, it returns
- *          undefined, indicating the exhaustion of retry attempts or a non-recoverable error.
- *
- * @example
- * const result = await guard(
- *  (input) =>
- *    generateStructure(
- *      openai
- *        .ChatTextGenerator(/* ... * /)
- *        .asFunctionCallStructureGenerationModel(/* ... * /),
- *
- *      new ZodSchema({
- *        // ...
- *      }),
- *
- *      input
- *    ),
- *  [
- *    // ...
- *  ],
- *  fixStructure({
- *    modifyInputForRetry: async ({ input, error }) => [
- *      ...input,
- *      openai.ChatMessage.assistant(null, {
- *        functionCall: {
- *          name: "sentiment",
- *          arguments: JSON.stringify(error.valueText),
- *        },
- *      }),
- *      openai.ChatMessage.user(error.message),
- *      openai.ChatMessage.user("Please fix the error and try again."),
- *    ],
- *  })
- * );
- */
-export const fixStructure = ({ modifyInputForRetry }) => async (result) => {
-    if (result.type === "error" &&
-        (result.error instanceof StructureValidationError ||
-            result.error instanceof StructureParseError)) {
-        return {
-            action: "retry",
-            input: await modifyInputForRetry({
-                type: "error",
-                input: result.input,
-                error: result.error,
-            }),
-        };
-    }
-    return undefined;
-};

package/guard/guard.cjs

@@ -1,79 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.guard = void 0;
-const executeFunctionCall_js_1 = require("../core/executeFunctionCall.cjs");
-async function guard(execute, input, guards, options) {
-    const guardList = Array.isArray(guards) ? guards : [guards];
-    const maxAttempts = options?.maxAttempts ?? 2;
-    return (0, executeFunctionCall_js_1.executeFunctionCall)({
-        options,
-        input,
-        functionType: "guard",
-        execute: async (options) => {
-            let attempts = 0;
-            while (attempts < maxAttempts) {
-                let result;
-                try {
-                    result = {
-                        type: "value",
-                        input,
-                        output: await execute(input, options),
-                    };
-                }
-                catch (error) {
-                    result = {
-                        type: "error",
-                        input,
-                        error,
-                    };
-                }
-                let isValid = true;
-                for (const guard of guardList) {
-                    const guardResult = await guard(result);
-                    if (guardResult === undefined) {
-                        continue;
-                    }
-                    switch (guardResult.action) {
-                        case "passThrough": {
-                            break;
-                        }
-                        case "retry": {
-                            input = guardResult.input;
-                            isValid = false;
-                            break;
-                        }
-                        case "return": {
-                            result = {
-                                type: "value",
-                                input,
-                                output: guardResult.output,
-                            };
-                            break;
-                        }
-                        case "throwError": {
-                            result = {
-                                type: "error",
-                                input,
-                                error: guardResult.error,
-                            };
-                            break;
-                        }
-                    }
-                }
-                if (isValid) {
-                    if (result.type === "value") {
-                        return result.output;
-                    }
-                    else {
-                        throw result.error;
-                    }
-                }
-                attempts++;
-            }
-            // TODO dedicated error type
-            throw new Error(`Maximum attempts of ${maxAttempts} reached ` +
-                `without producing a valid output or handling an error.`);
-        },
-    });
-}
-exports.guard = guard;

package/guard/guard.d.ts

@@ -1,29 +0,0 @@
-import { FunctionOptions } from "../core/FunctionOptions.js";
-type OutputResult<INPUT, OUTPUT> = {
-    type: "value";
-    input: INPUT;
-    output: OUTPUT;
-    error?: undefined;
-} | {
-    type: "error";
-    input: INPUT;
-    output?: undefined;
-    error: unknown;
-};
-export type OutputValidator<INPUT, OUTPUT> = ({ type, input, output, error, }: OutputResult<INPUT, OUTPUT>) => PromiseLike<boolean>;
-export type Guard<INPUT, OUTPUT> = ({ type, input, output, error, }: OutputResult<INPUT, OUTPUT>) => PromiseLike<{
-    action: "retry";
-    input: INPUT;
-} | {
-    action: "return";
-    output: OUTPUT;
-} | {
-    action: "throwError";
-    error: unknown;
-} | {
-    action: "passThrough";
-} | undefined>;
-export declare function guard<INPUT, OUTPUT>(execute: (input: INPUT, options?: FunctionOptions) => PromiseLike<OUTPUT>, input: INPUT, guards: Guard<INPUT, OUTPUT> | Array<Guard<INPUT, OUTPUT>>, options?: FunctionOptions & {
-    maxAttempts: number;
-}): Promise<OUTPUT | undefined>;
-export {};

package/guard/guard.js

@@ -1,75 +0,0 @@
-import { executeFunctionCall } from "../core/executeFunctionCall.js";
-export async function guard(execute, input, guards, options) {
-    const guardList = Array.isArray(guards) ? guards : [guards];
-    const maxAttempts = options?.maxAttempts ?? 2;
-    return executeFunctionCall({
-        options,
-        input,
-        functionType: "guard",
-        execute: async (options) => {
-            let attempts = 0;
-            while (attempts < maxAttempts) {
-                let result;
-                try {
-                    result = {
-                        type: "value",
-                        input,
-                        output: await execute(input, options),
-                    };
-                }
-                catch (error) {
-                    result = {
-                        type: "error",
-                        input,
-                        error,
-                    };
-                }
-                let isValid = true;
-                for (const guard of guardList) {
-                    const guardResult = await guard(result);
-                    if (guardResult === undefined) {
-                        continue;
-                    }
-                    switch (guardResult.action) {
-                        case "passThrough": {
-                            break;
-                        }
-                        case "retry": {
-                            input = guardResult.input;
-                            isValid = false;
-                            break;
-                        }
-                        case "return": {
-                            result = {
-                                type: "value",
-                                input,
-                                output: guardResult.output,
-                            };
-                            break;
-                        }
-                        case "throwError": {
-                            result = {
-                                type: "error",
-                                input,
-                                error: guardResult.error,
-                            };
-                            break;
-                        }
-                    }
-                }
-                if (isValid) {
-                    if (result.type === "value") {
-                        return result.output;
-                    }
-                    else {
-                        throw result.error;
-                    }
-                }
-                attempts++;
-            }
-            // TODO dedicated error type
-            throw new Error(`Maximum attempts of ${maxAttempts} reached ` +
-                `without producing a valid output or handling an error.`);
-        },
-    });
-}

package/guard/index.cjs

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-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("./GuardEvent.cjs"), exports);
-__exportStar(require("./fixStructure.cjs"), exports);
-__exportStar(require("./guard.cjs"), exports);

package/guard/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./GuardEvent.js";
-export * from "./fixStructure.js";
-export * from "./guard.js";

package/guard/index.js

@@ -1,3 +0,0 @@
-export * from "./GuardEvent.js";
-export * from "./fixStructure.js";
-export * from "./guard.js";