modelfusion 0.133.0 → 0.135.0

package/model-function/classify/ClassifyEvent.d.ts

@@ -1,20 +0,0 @@
-import { BaseModelCallFinishedEvent, BaseModelCallStartedEvent } from "../ModelCallEvent.js";
-export interface ClassifyStartedEvent extends BaseModelCallStartedEvent {
-    functionType: "classify";
-    input: unknown | Array<unknown>;
-}
-export type ClassifyFinishedEventResult = {
-    status: "success";
-    rawResponse: unknown;
-    value: unknown;
-} | {
-    status: "error";
-    error: unknown;
-} | {
-    status: "abort";
-};
-export interface ClassifyFinishedEvent extends BaseModelCallFinishedEvent {
-    functionType: "classify";
-    input: unknown;
-    result: ClassifyFinishedEventResult;
-}

package/model-function/classify/ClassifyEvent.js

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

package/model-function/classify/EmbeddingSimilarityClassifier.cjs

@@ -1,97 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmbeddingSimilarityClassifier = void 0;
-const cosineSimilarity_js_1 = require("../../util/cosineSimilarity.cjs");
-const embed_js_1 = require("../embed/embed.cjs");
-/**
- * Classifies values based on their distance to the values from a set of clusters.
- * When the distance is below a certain threshold, the value is classified as belonging to the cluster,
- * and the cluster name is returned. Otherwise, the value is classified as null.
- */
-class EmbeddingSimilarityClassifier {
-    constructor(settings) {
-        Object.defineProperty(this, "settings", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "modelInformation", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: {
-                provider: "modelfusion",
-                modelName: "EmbeddingSimilarityClassifier",
-            }
-        });
-        Object.defineProperty(this, "embeddings", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.settings = settings;
-    }
-    async getEmbeddings(options) {
-        if (this.embeddings != null) {
-            return this.embeddings;
-        }
-        const embeddings = [];
-        for (const cluster of this.settings.clusters) {
-            const clusterEmbeddings = await (0, embed_js_1.embedMany)({
-                model: this.settings.embeddingModel,
-                values: cluster.values,
-                ...options,
-            });
-            for (let i = 0; i < clusterEmbeddings.length; i++) {
-                embeddings.push({
-                    embedding: clusterEmbeddings[i],
-                    clusterValue: cluster.values[i],
-                    clusterName: cluster.name,
-                });
-            }
-        }
-        this.embeddings = embeddings; // lazy caching
-        return embeddings;
-    }
-    async doClassify(value, options) {
-        const valueEmbedding = await (0, embed_js_1.embed)({
-            model: this.settings.embeddingModel,
-            value,
-            ...options,
-        });
-        const clusterEmbeddings = await this.getEmbeddings(options);
-        const allMatches = [];
-        for (const embedding of clusterEmbeddings) {
-            const similarity = (0, cosineSimilarity_js_1.cosineSimilarity)(valueEmbedding, embedding.embedding);
-            if (similarity >= this.settings.similarityThreshold) {
-                allMatches.push({
-                    similarity,
-                    clusterValue: embedding.clusterValue,
-                    clusterName: embedding.clusterName,
-                });
-            }
-        }
-        // sort (highest similarity first)
-        allMatches.sort((a, b) => b.similarity - a.similarity);
-        return {
-            class: allMatches.length > 0
-                ? allMatches[0].clusterName
-                : null,
-            rawResponse: undefined,
-        };
-    }
-    get settingsForEvent() {
-        const eventSettingProperties = [
-            "clusters",
-            "embeddingModel",
-            "similarityThreshold",
-        ];
-        return Object.fromEntries(Object.entries(this.settings).filter(([key]) => eventSettingProperties.includes(key)));
-    }
-    withSettings(additionalSettings) {
-        return new EmbeddingSimilarityClassifier(Object.assign({}, this.settings, additionalSettings));
-    }
-}
-exports.EmbeddingSimilarityClassifier = EmbeddingSimilarityClassifier;

package/model-function/classify/EmbeddingSimilarityClassifier.d.ts

@@ -1,40 +0,0 @@
-import { FunctionCallOptions } from "../../core/FunctionOptions.js";
-import { Vector } from "../../core/Vector.js";
-import { EmbeddingModel } from "../embed/EmbeddingModel.js";
-import { Classifier, ClassifierSettings } from "./Classifier.js";
-export interface ValueCluster<VALUE, NAME extends string> {
-    name: NAME;
-    values: VALUE[];
-}
-export interface EmbeddingSimilarityClassifierSettings<VALUE, CLUSTERS extends Array<ValueCluster<VALUE, string>>> extends ClassifierSettings {
-    clusters: CLUSTERS;
-    embeddingModel: EmbeddingModel<VALUE>;
-    similarityThreshold: number;
-}
-/**
- * Classifies values based on their distance to the values from a set of clusters.
- * When the distance is below a certain threshold, the value is classified as belonging to the cluster,
- * and the cluster name is returned. Otherwise, the value is classified as null.
- */
-export declare class EmbeddingSimilarityClassifier<VALUE, CLUSTERS extends Array<ValueCluster<VALUE, string>>> implements Classifier<VALUE, ClusterNames<CLUSTERS> | null, EmbeddingSimilarityClassifierSettings<VALUE, CLUSTERS>> {
-    readonly settings: EmbeddingSimilarityClassifierSettings<VALUE, CLUSTERS>;
-    readonly modelInformation: {
-        provider: string;
-        modelName: string;
-    };
-    private embeddings;
-    constructor(settings: EmbeddingSimilarityClassifierSettings<VALUE, CLUSTERS>);
-    getEmbeddings(options: FunctionCallOptions): Promise<{
-        embedding: Vector;
-        clusterValue: VALUE;
-        clusterName: string;
-    }[]>;
-    doClassify(value: VALUE, options: FunctionCallOptions): Promise<{
-        class: ClusterNames<CLUSTERS> | null;
-        rawResponse: undefined;
-    }>;
-    get settingsForEvent(): Partial<EmbeddingSimilarityClassifierSettings<VALUE, CLUSTERS>>;
-    withSettings(additionalSettings: Partial<EmbeddingSimilarityClassifierSettings<VALUE, CLUSTERS>>): this;
-}
-type ClusterNames<CLUSTERS> = CLUSTERS extends Array<ValueCluster<unknown, infer NAME>> ? NAME : never;
-export {};

package/model-function/classify/EmbeddingSimilarityClassifier.js

@@ -1,93 +0,0 @@
-import { cosineSimilarity } from "../../util/cosineSimilarity.js";
-import { embed, embedMany } from "../embed/embed.js";
-/**
- * Classifies values based on their distance to the values from a set of clusters.
- * When the distance is below a certain threshold, the value is classified as belonging to the cluster,
- * and the cluster name is returned. Otherwise, the value is classified as null.
- */
-export class EmbeddingSimilarityClassifier {
-    constructor(settings) {
-        Object.defineProperty(this, "settings", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "modelInformation", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: {
-                provider: "modelfusion",
-                modelName: "EmbeddingSimilarityClassifier",
-            }
-        });
-        Object.defineProperty(this, "embeddings", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.settings = settings;
-    }
-    async getEmbeddings(options) {
-        if (this.embeddings != null) {
-            return this.embeddings;
-        }
-        const embeddings = [];
-        for (const cluster of this.settings.clusters) {
-            const clusterEmbeddings = await embedMany({
-                model: this.settings.embeddingModel,
-                values: cluster.values,
-                ...options,
-            });
-            for (let i = 0; i < clusterEmbeddings.length; i++) {
-                embeddings.push({
-                    embedding: clusterEmbeddings[i],
-                    clusterValue: cluster.values[i],
-                    clusterName: cluster.name,
-                });
-            }
-        }
-        this.embeddings = embeddings; // lazy caching
-        return embeddings;
-    }
-    async doClassify(value, options) {
-        const valueEmbedding = await embed({
-            model: this.settings.embeddingModel,
-            value,
-            ...options,
-        });
-        const clusterEmbeddings = await this.getEmbeddings(options);
-        const allMatches = [];
-        for (const embedding of clusterEmbeddings) {
-            const similarity = cosineSimilarity(valueEmbedding, embedding.embedding);
-            if (similarity >= this.settings.similarityThreshold) {
-                allMatches.push({
-                    similarity,
-                    clusterValue: embedding.clusterValue,
-                    clusterName: embedding.clusterName,
-                });
-            }
-        }
-        // sort (highest similarity first)
-        allMatches.sort((a, b) => b.similarity - a.similarity);
-        return {
-            class: allMatches.length > 0
-                ? allMatches[0].clusterName
-                : null,
-            rawResponse: undefined,
-        };
-    }
-    get settingsForEvent() {
-        const eventSettingProperties = [
-            "clusters",
-            "embeddingModel",
-            "similarityThreshold",
-        ];
-        return Object.fromEntries(Object.entries(this.settings).filter(([key]) => eventSettingProperties.includes(key)));
-    }
-    withSettings(additionalSettings) {
-        return new EmbeddingSimilarityClassifier(Object.assign({}, this.settings, additionalSettings));
-    }
-}

package/model-function/classify/classify.cjs

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.classify = void 0;
-const executeStandardCall_js_1 = require("../executeStandardCall.cjs");
-async function classify({ model, value, fullResponse, ...options }) {
-    const callResponse = await (0, executeStandardCall_js_1.executeStandardCall)({
-        functionType: "classify",
-        input: value,
-        model,
-        options,
-        generateResponse: async (options) => {
-            const result = await model.doClassify(value, options);
-            return {
-                rawResponse: result.rawResponse,
-                extractedValue: result.class,
-            };
-        },
-    });
-    return fullResponse
-        ? {
-            class: callResponse.value,
-            rawResponse: callResponse.rawResponse,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}
-exports.classify = classify;

package/model-function/classify/classify.d.ts

@@ -1,17 +0,0 @@
-import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { ModelCallMetadata } from "../ModelCallMetadata.js";
-import { Classifier, ClassifierSettings } from "./Classifier.js";
-export declare function classify<VALUE, CLASS extends string | null>(args: {
-    model: Classifier<VALUE, CLASS, ClassifierSettings>;
-    value: VALUE;
-    fullResponse?: false;
-} & FunctionOptions): Promise<CLASS>;
-export declare function classify<VALUE, CLASS extends string | null>(args: {
-    model: Classifier<VALUE, CLASS, ClassifierSettings>;
-    value: VALUE;
-    fullResponse: true;
-} & FunctionOptions): Promise<{
-    class: CLASS;
-    rawResponse: unknown;
-    metadata: ModelCallMetadata;
-}>;

package/model-function/classify/classify.js

@@ -1,23 +0,0 @@
-import { executeStandardCall } from "../executeStandardCall.js";
-export async function classify({ model, value, fullResponse, ...options }) {
-    const callResponse = await executeStandardCall({
-        functionType: "classify",
-        input: value,
-        model,
-        options,
-        generateResponse: async (options) => {
-            const result = await model.doClassify(value, options);
-            return {
-                rawResponse: result.rawResponse,
-                extractedValue: result.class,
-            };
-        },
-    });
-    return fullResponse
-        ? {
-            class: callResponse.value,
-            rawResponse: callResponse.rawResponse,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}

package/model-function/classify/index.cjs

@@ -1,20 +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("./Classifier.cjs"), exports);
-__exportStar(require("./ClassifyEvent.cjs"), exports);
-__exportStar(require("./EmbeddingSimilarityClassifier.cjs"), exports);
-__exportStar(require("./classify.cjs"), exports);

package/model-function/classify/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./Classifier.js";
-export * from "./ClassifyEvent.js";
-export * from "./EmbeddingSimilarityClassifier.js";
-export * from "./classify.js";

package/model-function/classify/index.js

@@ -1,4 +0,0 @@
-export * from "./Classifier.js";
-export * from "./ClassifyEvent.js";
-export * from "./EmbeddingSimilarityClassifier.js";
-export * from "./classify.js";

package/model-function/embed/EmbeddingEvent.cjs

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

package/model-function/embed/EmbeddingEvent.d.ts

@@ -1,21 +0,0 @@
-import { Vector } from "../../core/Vector.js";
-import { BaseModelCallFinishedEvent, BaseModelCallStartedEvent } from "../ModelCallEvent.js";
-export interface EmbeddingStartedEvent extends BaseModelCallStartedEvent {
-    functionType: "embed";
-    input: unknown | Array<unknown>;
-}
-export type EmbeddingFinishedEventResult = {
-    status: "success";
-    rawResponse: unknown;
-    value: Vector | Array<Vector>;
-} | {
-    status: "error";
-    error: unknown;
-} | {
-    status: "abort";
-};
-export interface EmbeddingFinishedEvent extends BaseModelCallFinishedEvent {
-    functionType: "embed";
-    input: unknown | Array<unknown>;
-    result: EmbeddingFinishedEventResult;
-}

package/model-function/embed/EmbeddingEvent.js

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

package/model-function/embed/EmbeddingModel.cjs

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

package/model-function/embed/EmbeddingModel.d.ts

@@ -1,23 +0,0 @@
-import { FunctionCallOptions } from "../../core/FunctionOptions.js";
-import { Vector } from "../../core/Vector.js";
-import { Model, ModelSettings } from "../Model.js";
-export interface EmbeddingModelSettings extends ModelSettings {
-}
-export interface EmbeddingModel<VALUE, SETTINGS extends EmbeddingModelSettings = EmbeddingModelSettings> extends Model<SETTINGS> {
-    /**
-     * The size of the embedding vector.
-     */
-    readonly dimensions: number | undefined;
-    /**
-     * Limit of how many values can be sent in a single API call.
-     */
-    readonly maxValuesPerCall: number | undefined;
-    /**
-     * True if the model can handle multiple embedding calls in parallel.
-     */
-    readonly isParallelizable: boolean;
-    doEmbedValues(values: VALUE[], options: FunctionCallOptions): PromiseLike<{
-        rawResponse: unknown;
-        embeddings: Vector[];
-    }>;
-}

package/model-function/embed/EmbeddingModel.js

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

package/model-function/embed/embed.cjs

@@ -1,77 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.embed = exports.embedMany = void 0;
-const executeStandardCall_js_1 = require("../executeStandardCall.cjs");
-async function embedMany({ model, values, fullResponse, ...options }) {
-    const callResponse = await (0, executeStandardCall_js_1.executeStandardCall)({
-        functionType: "embed",
-        input: values,
-        model,
-        options,
-        generateResponse: async (options) => {
-            // split the values into groups that are small enough to be sent in one call:
-            const maxValuesPerCall = model.maxValuesPerCall;
-            const valueGroups = [];
-            if (maxValuesPerCall == null) {
-                valueGroups.push(values);
-            }
-            else {
-                for (let i = 0; i < values.length; i += maxValuesPerCall) {
-                    valueGroups.push(values.slice(i, i + maxValuesPerCall));
-                }
-            }
-            // call the model for each group:
-            let responses;
-            if (model.isParallelizable) {
-                responses = await Promise.all(valueGroups.map((valueGroup) => model.doEmbedValues(valueGroup, options)));
-            }
-            else {
-                responses = [];
-                for (const valueGroup of valueGroups) {
-                    const response = await model.doEmbedValues(valueGroup, options);
-                    responses.push(response);
-                }
-            }
-            const rawResponses = responses.map((response) => response.rawResponse);
-            const embeddings = [];
-            for (const response of responses) {
-                embeddings.push(...response.embeddings);
-            }
-            return {
-                rawResponse: rawResponses,
-                extractedValue: embeddings,
-            };
-        },
-    });
-    return fullResponse
-        ? {
-            embeddings: callResponse.value,
-            rawResponse: callResponse.rawResponse,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}
-exports.embedMany = embedMany;
-async function embed({ model, value, fullResponse, ...options }) {
-    const callResponse = await (0, executeStandardCall_js_1.executeStandardCall)({
-        functionType: "embed",
-        input: value,
-        model,
-        options,
-        generateResponse: async (options) => {
-            const result = await model.doEmbedValues([value], options);
-            return {
-                rawResponse: result.rawResponse,
-                extractedValue: result.embeddings[0],
-            };
-        },
-    });
-    return fullResponse
-        ? {
-            embedding: callResponse.value,
-            rawResponse: callResponse.rawResponse,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}
-exports.embed = embed;

package/model-function/embed/embed.d.ts

@@ -1,67 +0,0 @@
-import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { Vector } from "../../core/Vector.js";
-import { ModelCallMetadata } from "../ModelCallMetadata.js";
-import { EmbeddingModel, EmbeddingModelSettings } from "./EmbeddingModel.js";
-/**
- * Generate embeddings for multiple values.
- *
- * @see https://modelfusion.dev/guide/function/embed
- *
- * @example
- * const embeddings = await embedMany({
- *   embedder: openai.TextEmbedder(...),
- *   values: [
- *     "At first, Nox didn't know what to do with the pup.",
- *     "He keenly observed and absorbed everything around him, from the birds in the sky to the trees in the forest.",
- *   ]
- * });
- *
- * @param {EmbeddingModel<VALUE, EmbeddingModelSettings>} model - The model to use for generating embeddings.
- * @param {VALUE[]} values - The values to generate embeddings for.
- *
- * @returns {Promise<Vector[]>} - A promise that resolves to an array of vectors representing the embeddings.
- */
-export declare function embedMany<VALUE>(args: {
-    model: EmbeddingModel<VALUE, EmbeddingModelSettings>;
-    values: VALUE[];
-    fullResponse?: false;
-} & FunctionOptions): Promise<Vector[]>;
-export declare function embedMany<VALUE>(args: {
-    model: EmbeddingModel<VALUE, EmbeddingModelSettings>;
-    values: VALUE[];
-    fullResponse: true;
-} & FunctionOptions): Promise<{
-    embeddings: Vector[];
-    rawResponse: unknown;
-    metadata: ModelCallMetadata;
-}>;
-/**
- * Generate an embedding for a single value.
- *
- * @see https://modelfusion.dev/guide/function/embed
- *
- * @example
- * const embedding = await embed({
- *   model: openai.TextEmbedder(...),
- *   value: "At first, Nox didn't know what to do with the pup."
- * });
- *
- * @param {EmbeddingModel<VALUE, EmbeddingModelSettings>} model - The model to use for generating the embedding.
- * @param {VALUE} value - The value to generate an embedding for.
- *
- * @returns {Promise<Vector>} - A promise that resolves to a vector representing the embedding.
- */
-export declare function embed<VALUE>(args: {
-    model: EmbeddingModel<VALUE, EmbeddingModelSettings>;
-    value: VALUE;
-    fullResponse?: false;
-} & FunctionOptions): Promise<Vector>;
-export declare function embed<VALUE>(args: {
-    model: EmbeddingModel<VALUE, EmbeddingModelSettings>;
-    value: VALUE;
-    fullResponse: true;
-} & FunctionOptions): Promise<{
-    embedding: Vector;
-    rawResponse: unknown;
-    metadata: ModelCallMetadata;
-}>;

package/model-function/embed/embed.js

@@ -1,72 +0,0 @@
-import { executeStandardCall } from "../executeStandardCall.js";
-export async function embedMany({ model, values, fullResponse, ...options }) {
-    const callResponse = await executeStandardCall({
-        functionType: "embed",
-        input: values,
-        model,
-        options,
-        generateResponse: async (options) => {
-            // split the values into groups that are small enough to be sent in one call:
-            const maxValuesPerCall = model.maxValuesPerCall;
-            const valueGroups = [];
-            if (maxValuesPerCall == null) {
-                valueGroups.push(values);
-            }
-            else {
-                for (let i = 0; i < values.length; i += maxValuesPerCall) {
-                    valueGroups.push(values.slice(i, i + maxValuesPerCall));
-                }
-            }
-            // call the model for each group:
-            let responses;
-            if (model.isParallelizable) {
-                responses = await Promise.all(valueGroups.map((valueGroup) => model.doEmbedValues(valueGroup, options)));
-            }
-            else {
-                responses = [];
-                for (const valueGroup of valueGroups) {
-                    const response = await model.doEmbedValues(valueGroup, options);
-                    responses.push(response);
-                }
-            }
-            const rawResponses = responses.map((response) => response.rawResponse);
-            const embeddings = [];
-            for (const response of responses) {
-                embeddings.push(...response.embeddings);
-            }
-            return {
-                rawResponse: rawResponses,
-                extractedValue: embeddings,
-            };
-        },
-    });
-    return fullResponse
-        ? {
-            embeddings: callResponse.value,
-            rawResponse: callResponse.rawResponse,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}
-export async function embed({ model, value, fullResponse, ...options }) {
-    const callResponse = await executeStandardCall({
-        functionType: "embed",
-        input: value,
-        model,
-        options,
-        generateResponse: async (options) => {
-            const result = await model.doEmbedValues([value], options);
-            return {
-                rawResponse: result.rawResponse,
-                extractedValue: result.embeddings[0],
-            };
-        },
-    });
-    return fullResponse
-        ? {
-            embedding: callResponse.value,
-            rawResponse: callResponse.rawResponse,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}