modelfusion 0.122.0 → 0.123.0

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # Changelog
 
+## v0.123.0 - 2024-01-13
+
+### Added
+
+- `classify` model function ([docs](https://modelfusion.dev/guide/function/classify)) for classifying values. The `SemanticClassifier` has been renamed to `EmbeddingSimilarityClassifier` and can be used in conjunction with `classify`:
+
+  ```ts
+  import { classify, EmbeddingSimilarityClassifier, openai } from "modelfusion";
+
+  const classifier = new EmbeddingSimilarityClassifier({
+    embeddingModel: openai.TextEmbedder({ model: "text-embedding-ada-002" }),
+    similarityThreshold: 0.82,
+    clusters: [
+      {
+        name: "politics" as const,
+        values: [
+          "they will save the country!",
+          // ...
+        ],
+      },
+      {
+        name: "chitchat" as const,
+        values: [
+          "how's the weather today?",
+          // ...
+        ],
+      },
+    ],
+  });
+
+  // strongly typed result:
+  const result = await classify({
+    model: classifier,
+    value: "don't you love politics?",
+  });
+  ```
+
 ## v0.122.0 - 2024-01-13
 
 ### Changed

package/README.md

@@ -22,7 +22,7 @@
 - **Built for production**: ModelFusion is fully tree-shakeable, can be used in serverless environments, and only uses a minimal set of dependencies.
 
 > [!NOTE]
-> ModelFusion is getting closer to a stable v1, which is expected in Q1/2024. The main API is now mostly stable, but until version 1.0 there may be breaking changes. Feedback and suggestions are welcome.
+> ModelFusion is getting closer to a stable v1, which is expected in Q2/2024. The main API is now mostly stable, but until version 1.0 there may be breaking changes. Feedback and suggestions are welcome.
 
 ## Quick Install
 
@@ -291,6 +291,8 @@ Providers: [OpenAI (Whisper)](https://modelfusion.dev/integration/model-provider
 Create embeddings for text and other values. Embeddings are vectors that represent the essence of the values in the context of the model.
 
 ```ts
+import { embed, embedMany, openai } from "modelfusion";
+
 // embed single value:
 const embedding = await embed({
   model: openai.TextEmbedder({ model: "text-embedding-ada-002" }),
@@ -309,6 +311,43 @@ const embeddings = await embedMany({
 
 Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [Llama.cpp](https://modelfusion.dev/integration/model-provider/llamacpp), [Ollama](https://modelfusion.dev/integration/model-provider/ollama), [Mistral](https://modelfusion.dev/integration/model-provider/mistral), [Hugging Face](https://modelfusion.dev/integration/model-provider/huggingface), [Cohere](https://modelfusion.dev/integration/model-provider/cohere)
 
+### [Classify Value](https://modelfusion.dev/guide/function/classify)
+
+Classifies a value into a category.
+
+```ts
+import { classify, EmbeddingSimilarityClassifier, openai } from "modelfusion";
+
+const classifier = new EmbeddingSimilarityClassifier({
+  embeddingModel: openai.TextEmbedder({ model: "text-embedding-ada-002" }),
+  similarityThreshold: 0.82,
+  clusters: [
+    {
+      name: "politics" as const,
+      values: [
+        "they will save the country!",
+        // ...
+      ],
+    },
+    {
+      name: "chitchat" as const,
+      values: [
+        "how's the weather today?",
+        // ...
+      ],
+    },
+  ],
+});
+
+// strongly typed result:
+const result = await classify({
+  model: classifier,
+  value: "don't you love politics?",
+});
+```
+
+Classifiers: [EmbeddingSimilarityClassifier](https://modelfusion.dev/guide/function/classify#embeddingsimilarityclassifier)
+
 ### [Tokenize Text](https://modelfusion.dev/guide/function/tokenize-text)
 
 Split text into tokens and reconstruct the text from tokens.
@@ -552,6 +591,7 @@ modelfusion.setLogFormat("detailed-object"); // log full events
   - [Generate transcription](https://modelfusion.dev/guide/function/generation-transcription)
   - [Tokenize Text](https://modelfusion.dev/guide/function/tokenize-text)
   - [Embed Value](https://modelfusion.dev/guide/function/embed)
+  - [Classify Value](https://modelfusion.dev/guide/function/classify)
 - [Tools](https://modelfusion.dev/guide/tools)
   - [Use Tool](https://modelfusion.dev/guide/tools/use-tool)
   - [Use Tools](https://modelfusion.dev/guide/tools/use-tools)

package/index.cjs

@@ -14,7 +14,6 @@ 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/index.cjs"), exports);
 __exportStar(require("./core/index.cjs"), exports);
 __exportStar(require("./model-function/index.cjs"), exports);
 __exportStar(require("./model-provider/index.cjs"), exports);

package/index.d.ts

@@ -1,4 +1,3 @@
-export * from "./classifier/index.js";
 export * from "./core/index.js";
 export * from "./model-function/index.js";
 export * from "./model-provider/index.js";

package/index.js

@@ -1,4 +1,3 @@
-export * from "./classifier/index.js";
 export * from "./core/index.js";
 export * from "./model-function/index.js";
 export * from "./model-provider/index.js";

package/model-function/ModelCallEvent.d.ts

@@ -2,6 +2,7 @@ import { BaseFunctionFinishedEvent, BaseFunctionStartedEvent } from "../core/Fun
 import { ToolCallGenerationFinishedEvent, ToolCallGenerationStartedEvent } from "../tool/generate-tool-call/ToolCallGenerationEvent.js";
 import { ToolCallsGenerationFinishedEvent, ToolCallsGenerationStartedEvent } from "../tool/generate-tool-calls/ToolCallsGenerationEvent.js";
 import { ModelInformation } from "./ModelInformation.js";
+import { ClassifyFinishedEvent, ClassifyStartedEvent } from "./classify/ClassifyEvent.js";
 import { EmbeddingFinishedEvent, EmbeddingStartedEvent } from "./embed/EmbeddingEvent.js";
 import { ImageGenerationFinishedEvent, ImageGenerationStartedEvent } from "./generate-image/ImageGenerationEvent.js";
 import { SpeechGenerationFinishedEvent, SpeechGenerationStartedEvent, SpeechStreamingFinishedEvent, SpeechStreamingStartedEvent } from "./generate-speech/SpeechGenerationEvent.js";
@@ -52,5 +53,5 @@ export interface BaseModelCallFinishedEvent extends BaseFunctionFinishedEvent {
      */
     result: BaseModelCallFinishedEventResult;
 }
-export type ModelCallStartedEvent = EmbeddingStartedEvent | ImageGenerationStartedEvent | SpeechGenerationStartedEvent | SpeechStreamingStartedEvent | StructureGenerationStartedEvent | StructureStreamingStartedEvent | TextGenerationStartedEvent | TextStreamingStartedEvent | ToolCallGenerationStartedEvent | ToolCallsGenerationStartedEvent | TranscriptionStartedEvent;
-export type ModelCallFinishedEvent = EmbeddingFinishedEvent | ImageGenerationFinishedEvent | SpeechGenerationFinishedEvent | SpeechStreamingFinishedEvent | StructureGenerationFinishedEvent | StructureStreamingFinishedEvent | TextGenerationFinishedEvent | TextStreamingFinishedEvent | ToolCallGenerationFinishedEvent | ToolCallsGenerationFinishedEvent | TranscriptionFinishedEvent;
+export type ModelCallStartedEvent = ClassifyStartedEvent | EmbeddingStartedEvent | ImageGenerationStartedEvent | SpeechGenerationStartedEvent | SpeechStreamingStartedEvent | StructureGenerationStartedEvent | StructureStreamingStartedEvent | TextGenerationStartedEvent | TextStreamingStartedEvent | ToolCallGenerationStartedEvent | ToolCallsGenerationStartedEvent | TranscriptionStartedEvent;
+export type ModelCallFinishedEvent = ClassifyFinishedEvent | EmbeddingFinishedEvent | ImageGenerationFinishedEvent | SpeechGenerationFinishedEvent | SpeechStreamingFinishedEvent | StructureGenerationFinishedEvent | StructureStreamingFinishedEvent | TextGenerationFinishedEvent | TextStreamingFinishedEvent | ToolCallGenerationFinishedEvent | ToolCallsGenerationFinishedEvent | TranscriptionFinishedEvent;

package/model-function/classify/Classifier.cjs

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

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

@@ -0,0 +1,10 @@
+import { FunctionCallOptions } from "../../core/FunctionOptions.js";
+import { Model, ModelSettings } from "../Model.js";
+export interface ClassifierSettings extends ModelSettings {
+}
+export interface Classifier<VALUE, CLASS extends string | null, SETTINGS extends ClassifierSettings = ClassifierSettings> extends Model<SETTINGS> {
+    doClassify(value: VALUE, options: FunctionCallOptions): PromiseLike<{
+        rawResponse: unknown | undefined;
+        class: CLASS;
+    }>;
+}

package/model-function/classify/Classifier.js

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

package/model-function/classify/ClassifyEvent.cjs

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

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

@@ -0,0 +1,20 @@
+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

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

package/model-function/classify/EmbeddingSimilarityClassifier.cjs

@@ -0,0 +1,97 @@
+"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

@@ -0,0 +1,40 @@
+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

@@ -0,0 +1,93 @@
+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

@@ -0,0 +1,27 @@
+"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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,23 @@
+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/{classifier → model-function/classify}/index.cjs

@@ -14,4 +14,7 @@ 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("./SemanticClassifier.cjs"), exports);
+__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

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

package/model-function/classify/index.js

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

package/model-function/index.cjs

@@ -20,6 +20,7 @@ __exportStar(require("./ModelCallEvent.cjs"), exports);
 __exportStar(require("./ModelCallMetadata.cjs"), exports);
 __exportStar(require("./ModelInformation.cjs"), exports);
 __exportStar(require("./PromptTemplate.cjs"), exports);
+__exportStar(require("./classify/index.cjs"), exports);
 __exportStar(require("./embed/EmbeddingEvent.cjs"), exports);
 __exportStar(require("./embed/EmbeddingModel.cjs"), exports);
 __exportStar(require("./embed/embed.cjs"), exports);

package/model-function/index.d.ts

@@ -4,6 +4,7 @@ export * from "./ModelCallEvent.js";
 export * from "./ModelCallMetadata.js";
 export * from "./ModelInformation.js";
 export * from "./PromptTemplate.js";
+export * from "./classify/index.js";
 export * from "./embed/EmbeddingEvent.js";
 export * from "./embed/EmbeddingModel.js";
 export * from "./embed/embed.js";

package/model-function/index.js

@@ -4,6 +4,7 @@ export * from "./ModelCallEvent.js";
 export * from "./ModelCallMetadata.js";
 export * from "./ModelInformation.js";
 export * from "./PromptTemplate.js";
+export * from "./classify/index.js";
 export * from "./embed/EmbeddingEvent.js";
 export * from "./embed/EmbeddingModel.js";
 export * from "./embed/embed.js";

package/model-provider/mistral/MistralTextEmbeddingModel.d.ts

@@ -32,16 +32,16 @@ export declare class MistralTextEmbeddingModel extends AbstractModel<MistralText
     doEmbedValues(texts: string[], options: FunctionCallOptions): Promise<{
         rawResponse: {
             object: string;
-            model: string;
-            usage: {
-                prompt_tokens: number;
-                total_tokens: number;
-            };
             data: {
                 object: string;
                 embedding: number[];
                 index: number;
             }[];
+            model: string;
+            usage: {
+                prompt_tokens: number;
+                total_tokens: number;
+            };
             id: string;
         };
         embeddings: number[][];
@@ -77,29 +77,29 @@ declare const MistralTextEmbeddingResponseSchema: z.ZodObject<{
     }>;
 }, "strip", z.ZodTypeAny, {
     object: string;
-    model: string;
-    usage: {
-        prompt_tokens: number;
-        total_tokens: number;
-    };
     data: {
         object: string;
         embedding: number[];
         index: number;
     }[];
-    id: string;
-}, {
-    object: string;
     model: string;
     usage: {
         prompt_tokens: number;
         total_tokens: number;
     };
+    id: string;
+}, {
+    object: string;
     data: {
         object: string;
         embedding: number[];
         index: number;
     }[];
+    model: string;
+    usage: {
+        prompt_tokens: number;
+        total_tokens: number;
+    };
     id: string;
 }>;
 export type MistralTextEmbeddingResponse = z.infer<typeof MistralTextEmbeddingResponseSchema>;

package/model-provider/ollama/OllamaChatModel.d.ts

@@ -40,11 +40,11 @@ export declare class OllamaChatModel extends AbstractModel<OllamaChatModelSettin
     get settingsForEvent(): Partial<OllamaChatModelSettings>;
     doGenerateTexts(prompt: OllamaChatPrompt, options: FunctionCallOptions): Promise<{
         rawResponse: {
-            model: string;
             message: {
                 role: string;
                 content: string;
             };
+            model: string;
             done: true;
             created_at: string;
             total_duration: number;
@@ -61,11 +61,11 @@ export declare class OllamaChatModel extends AbstractModel<OllamaChatModelSettin
     }>;
     restoreGeneratedTexts(rawResponse: unknown): {
         rawResponse: {
-            model: string;
             message: {
                 role: string;
                 content: string;
             };
+            model: string;
             done: true;
             created_at: string;
             total_duration: number;
@@ -82,11 +82,11 @@ export declare class OllamaChatModel extends AbstractModel<OllamaChatModelSettin
     };
     private processTextGenerationResponse;
     doStreamText(prompt: OllamaChatPrompt, options: FunctionCallOptions): Promise<AsyncIterable<import("../../index.js").Delta<{
-        model: string;
         message: {
             role: string;
             content: string;
         };
+        model: string;
         done: false;
         created_at: string;
     } | {
@@ -141,11 +141,11 @@ declare const ollamaChatResponseSchema: z.ZodObject<{
     eval_count: z.ZodNumber;
     eval_duration: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    model: string;
     message: {
         role: string;
         content: string;
     };
+    model: string;
     done: true;
     created_at: string;
     total_duration: number;
@@ -155,11 +155,11 @@ declare const ollamaChatResponseSchema: z.ZodObject<{
     prompt_eval_count?: number | undefined;
     prompt_eval_duration?: number | undefined;
 }, {
-    model: string;
     message: {
         role: string;
         content: string;
     };
+    model: string;
     done: true;
     created_at: string;
     total_duration: number;
@@ -185,19 +185,19 @@ declare const ollamaChatStreamChunkSchema: z.ZodDiscriminatedUnion<"done", [z.Zo
         content: string;
     }>;
 }, "strip", z.ZodTypeAny, {
-    model: string;
     message: {
         role: string;
         content: string;
     };
+    model: string;
     done: false;
     created_at: string;
 }, {
-    model: string;
     message: {
         role: string;
         content: string;
     };
+    model: string;
     done: false;
     created_at: string;
 }>, z.ZodObject<{
@@ -247,11 +247,11 @@ export declare const OllamaChatResponseFormat: {
             requestBodyValues: unknown;
             response: Response;
         }) => Promise<{
-            model: string;
             message: {
                 role: string;
                 content: string;
             };
+            model: string;
             done: true;
             created_at: string;
             total_duration: number;
@@ -271,11 +271,11 @@ export declare const OllamaChatResponseFormat: {
         handler: ({ response }: {
             response: Response;
         }) => Promise<AsyncIterable<import("../../index.js").Delta<{
-            model: string;
             message: {
                 role: string;
                 content: string;
             };
+            model: string;
             done: false;
             created_at: string;
         } | {

package/model-provider/openai/OpenAITextEmbeddingModel.d.ts

@@ -52,16 +52,16 @@ export declare class OpenAITextEmbeddingModel extends AbstractModel<OpenAITextEm
     doEmbedValues(texts: string[], callOptions: FunctionCallOptions): Promise<{
         rawResponse: {
             object: "list";
-            model: string;
-            usage: {
-                prompt_tokens: number;
-                total_tokens: number;
-            };
             data: {
                 object: "embedding";
                 embedding: number[];
                 index: number;
             }[];
+            model: string;
+            usage: {
+                prompt_tokens: number;
+                total_tokens: number;
+            };
         };
         embeddings: number[][];
     }>;
@@ -95,28 +95,28 @@ declare const openAITextEmbeddingResponseSchema: z.ZodObject<{
     }>;
 }, "strip", z.ZodTypeAny, {
     object: "list";
-    model: string;
-    usage: {
-        prompt_tokens: number;
-        total_tokens: number;
-    };
     data: {
         object: "embedding";
         embedding: number[];
         index: number;
     }[];
-}, {
-    object: "list";
     model: string;
     usage: {
         prompt_tokens: number;
         total_tokens: number;
     };
+}, {
+    object: "list";
     data: {
         object: "embedding";
         embedding: number[];
         index: number;
     }[];
+    model: string;
+    usage: {
+        prompt_tokens: number;
+        total_tokens: number;
+    };
 }>;
 export type OpenAITextEmbeddingResponse = z.infer<typeof openAITextEmbeddingResponseSchema>;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
   "description": "The TypeScript library for building AI applications.",
-  "version": "0.122.0",
+  "version": "0.123.0",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [

package/classifier/SemanticClassifier.cjs

@@ -1,81 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SemanticClassifier = void 0;
-const embed_js_1 = require("../model-function/embed/embed.cjs");
-const cosineSimilarity_js_1 = require("../util/cosineSimilarity.cjs");
-class SemanticClassifier {
-    constructor({ clusters, embeddingModel, similarityThreshold, }) {
-        Object.defineProperty(this, "clusters", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "embeddingModel", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "similarityThreshold", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "embeddings", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.clusters = clusters;
-        this.embeddingModel = embeddingModel;
-        this.similarityThreshold = similarityThreshold;
-    }
-    async getEmbeddings() {
-        if (this.embeddings != null) {
-            return this.embeddings;
-        }
-        const embeddings = [];
-        for (const cluster of this.clusters) {
-            const clusterEmbeddings = await (0, embed_js_1.embedMany)({
-                model: this.embeddingModel,
-                values: cluster.values,
-            });
-            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 classify(value) {
-        const valueEmbedding = await (0, embed_js_1.embed)({
-            model: this.embeddingModel,
-            value,
-        });
-        const clusterEmbeddings = await this.getEmbeddings();
-        const allMatches = [];
-        for (const embedding of clusterEmbeddings) {
-            const similarity = (0, cosineSimilarity_js_1.cosineSimilarity)(valueEmbedding, embedding.embedding);
-            if (similarity >= this.similarityThreshold) {
-                allMatches.push({
-                    similarity,
-                    clusterValue: embedding.clusterValue,
-                    clusterName: embedding.clusterName,
-                });
-            }
-        }
-        // sort (highest similarity first)
-        allMatches.sort((a, b) => b.similarity - a.similarity);
-        return allMatches.length > 0
-            ? allMatches[0].clusterName
-            : null;
-    }
-}
-exports.SemanticClassifier = SemanticClassifier;

package/classifier/SemanticClassifier.d.ts

@@ -1,25 +0,0 @@
-import { Vector } from "../core/Vector.js";
-import { EmbeddingModel } from "../model-function/embed/EmbeddingModel.js";
-export interface SemanticCluster<VALUE, NAME extends string> {
-    name: NAME;
-    values: VALUE[];
-}
-export declare class SemanticClassifier<VALUE, CLUSTERS extends Array<SemanticCluster<VALUE, string>>> {
-    readonly clusters: CLUSTERS;
-    readonly embeddingModel: EmbeddingModel<VALUE>;
-    readonly similarityThreshold: number;
-    private embeddings;
-    constructor({ clusters, embeddingModel, similarityThreshold, }: {
-        clusters: CLUSTERS;
-        embeddingModel: EmbeddingModel<VALUE>;
-        similarityThreshold: number;
-    });
-    getEmbeddings(): Promise<{
-        embedding: Vector;
-        clusterValue: VALUE;
-        clusterName: string;
-    }[]>;
-    classify(value: VALUE): Promise<ClusterNames<CLUSTERS> | null>;
-}
-type ClusterNames<CLUSTERS> = CLUSTERS extends Array<SemanticCluster<unknown, infer NAME>> ? NAME : never;
-export {};

package/classifier/SemanticClassifier.js

@@ -1,77 +0,0 @@
-import { embed, embedMany } from "../model-function/embed/embed.js";
-import { cosineSimilarity } from "../util/cosineSimilarity.js";
-export class SemanticClassifier {
-    constructor({ clusters, embeddingModel, similarityThreshold, }) {
-        Object.defineProperty(this, "clusters", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "embeddingModel", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "similarityThreshold", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "embeddings", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.clusters = clusters;
-        this.embeddingModel = embeddingModel;
-        this.similarityThreshold = similarityThreshold;
-    }
-    async getEmbeddings() {
-        if (this.embeddings != null) {
-            return this.embeddings;
-        }
-        const embeddings = [];
-        for (const cluster of this.clusters) {
-            const clusterEmbeddings = await embedMany({
-                model: this.embeddingModel,
-                values: cluster.values,
-            });
-            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 classify(value) {
-        const valueEmbedding = await embed({
-            model: this.embeddingModel,
-            value,
-        });
-        const clusterEmbeddings = await this.getEmbeddings();
-        const allMatches = [];
-        for (const embedding of clusterEmbeddings) {
-            const similarity = cosineSimilarity(valueEmbedding, embedding.embedding);
-            if (similarity >= this.similarityThreshold) {
-                allMatches.push({
-                    similarity,
-                    clusterValue: embedding.clusterValue,
-                    clusterName: embedding.clusterName,
-                });
-            }
-        }
-        // sort (highest similarity first)
-        allMatches.sort((a, b) => b.similarity - a.similarity);
-        return allMatches.length > 0
-            ? allMatches[0].clusterName
-            : null;
-    }
-}

package/classifier/index.d.ts

@@ -1 +0,0 @@
-export * from "./SemanticClassifier.js";

package/classifier/index.js

@@ -1 +0,0 @@
-export * from "./SemanticClassifier.js";