modelfusion 0.36.0 → 0.38.0

package/README.md

@@ -377,12 +377,12 @@ const image = await generateImage(
 
 Providers: [OpenAI (Dall·E)](https://modelfusion.dev/integration/model-provider/openai), [Stability AI](https://modelfusion.dev/integration/model-provider/stability), [Automatic1111](https://modelfusion.dev/integration/model-provider/automatic1111)
 
-### [Embed Text](https://modelfusion.dev/guide/function/embed-text)
+### [Embed Value](https://modelfusion.dev/guide/function/embed)
 
-Create embeddings for text. Embeddings are vectors that represent the meaning of the text.
+Create embeddings for text and other values. Embeddings are vectors that represent the essence of the values in the context of the model.
 
 ```ts
-const embeddings = await embedTexts(
+const embeddings = await embedMany(
   new OpenAITextEmbeddingModel({ model: "text-embedding-ada-002" }),
   [
     "At first, Nox didn't know what to do with the pup.",
@@ -459,7 +459,7 @@ Integrations: [Helicone](https://modelfusion.dev/integration/observability/helic
   - [Generate and stream text](https://modelfusion.dev/guide/function/generate-text)
   - [Generate structure](https://modelfusion.dev/guide/function/generate-structure)
   - [Generate structure or text](https://modelfusion.dev/guide/function/generate-structure-or-text)
-  - [Embed Text](https://modelfusion.dev/guide/function/embed-text)
+  - [Embed Value](https://modelfusion.dev/guide/function/embed)
   - [Tokenize Text](https://modelfusion.dev/guide/function/tokenize-text)
   - [Transcribe Speech](https://modelfusion.dev/guide/function/transcribe-speech)
   - [Synthesize Speech](https://modelfusion.dev/guide/function/synthesize-speech)

package/model-function/ModelCallEvent.d.ts

@@ -1,7 +1,7 @@
 import { BaseFunctionFinishedEvent, BaseFunctionStartedEvent } from "../core/FunctionEvent.js";
 import { ModelInformation } from "./ModelInformation.js";
 import { ImageDescriptionFinishedEvent, ImageDescriptionStartedEvent } from "./describe-image/ImageDescriptionEvent.js";
-import { TextEmbeddingFinishedEvent, TextEmbeddingStartedEvent } from "./embed-text/TextEmbeddingEvent.js";
+import { EmbeddingFinishedEvent, EmbeddingStartedEvent } from "./embed/EmbeddingEvent.js";
 import { ImageGenerationFinishedEvent, ImageGenerationStartedEvent } from "./generate-image/ImageGenerationEvent.js";
 import { StructureGenerationFinishedEvent, StructureGenerationStartedEvent } from "./generate-structure/StructureGenerationEvent.js";
 import { StructureStreamingFinishedEvent, StructureStreamingStartedEvent } from "./generate-structure/StructureStreamingEvent.js";
@@ -49,5 +49,5 @@ export interface BaseModelCallFinishedEvent extends BaseFunctionFinishedEvent {
      */
     result: BaseModelCallFinishedEventResult;
 }
-export type ModelCallStartedEvent = ImageDescriptionStartedEvent | ImageGenerationStartedEvent | StructureGenerationStartedEvent | StructureStreamingStartedEvent | SpeechSynthesisStartedEvent | TextEmbeddingStartedEvent | TextGenerationStartedEvent | TextStreamingStartedEvent | TranscriptionStartedEvent;
-export type ModelCallFinishedEvent = ImageDescriptionFinishedEvent | ImageGenerationFinishedEvent | StructureGenerationFinishedEvent | StructureStreamingFinishedEvent | SpeechSynthesisFinishedEvent | TextEmbeddingFinishedEvent | TextGenerationFinishedEvent | TextStreamingFinishedEvent | TranscriptionFinishedEvent;
+export type ModelCallStartedEvent = EmbeddingStartedEvent | ImageDescriptionStartedEvent | ImageGenerationStartedEvent | StructureGenerationStartedEvent | StructureStreamingStartedEvent | SpeechSynthesisStartedEvent | TextGenerationStartedEvent | TextStreamingStartedEvent | TranscriptionStartedEvent;
+export type ModelCallFinishedEvent = EmbeddingFinishedEvent | ImageDescriptionFinishedEvent | ImageGenerationFinishedEvent | StructureGenerationFinishedEvent | StructureStreamingFinishedEvent | SpeechSynthesisFinishedEvent | TextGenerationFinishedEvent | TextStreamingFinishedEvent | TranscriptionFinishedEvent;

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

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

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

@@ -0,0 +1,17 @@
+import { Vector } from "../../core/Vector.js";
+import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
+import { Model, ModelSettings } from "../Model.js";
+export interface EmbeddingModelSettings extends ModelSettings {
+}
+export interface EmbeddingModel<VALUE, RESPONSE, SETTINGS extends EmbeddingModelSettings> extends Model<SETTINGS> {
+    /**
+     * The size of the embedding vector.
+     */
+    readonly embeddingDimensions: number | undefined;
+    /**
+     * Limit of how many values can be sent in a single API call.
+     */
+    readonly maxValuesPerCall: number | undefined;
+    generateEmbeddingResponse(values: VALUE[], options?: ModelFunctionOptions<SETTINGS>): PromiseLike<RESPONSE>;
+    extractEmbeddings(response: RESPONSE): Vector[];
+}

package/model-function/{embed-text/embedText.cjs → embed/embed.cjs}

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.embedText = exports.embedTexts = void 0;
+exports.embed = exports.embedMany = void 0;
 const executeCall_js_1 = require("../executeCall.cjs");
 /**
- * Generate embeddings for multiple texts.
+ * Generate embeddings for multiple values.
  *
  * @example
- * const embeddings = await embedTexts(
+ * const embeddings = await embedMany(
  *   new OpenAITextEmbeddingModel(...),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",
@@ -14,25 +14,25 @@ const executeCall_js_1 = require("../executeCall.cjs");
  *   ]
  * );
  */
-function embedTexts(model, texts, options) {
+function embedMany(model, values, options) {
     return (0, executeCall_js_1.executeCall)({
-        functionType: "text-embedding",
-        input: texts,
+        functionType: "embedding",
+        input: values,
         model,
         options,
         generateResponse: (options) => {
-            // split the texts into groups that are small enough to be sent in one call:
-            const maxTextsPerCall = model.maxTextsPerCall;
-            const textGroups = [];
-            if (maxTextsPerCall == null) {
-                textGroups.push(texts);
+            // 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 < texts.length; i += maxTextsPerCall) {
-                    textGroups.push(texts.slice(i, i + maxTextsPerCall));
+                for (let i = 0; i < values.length; i += maxValuesPerCall) {
+                    valueGroups.push(values.slice(i, i + maxValuesPerCall));
                 }
             }
-            return Promise.all(textGroups.map((textGroup) => model.generateEmbeddingResponse(textGroup, options)));
+            return Promise.all(valueGroups.map((valueGroup) => model.generateEmbeddingResponse(valueGroup, options)));
         },
         extractOutputValue: (result) => {
             const embeddings = [];
@@ -43,26 +43,26 @@ function embedTexts(model, texts, options) {
         },
     });
 }
-exports.embedTexts = embedTexts;
+exports.embedMany = embedMany;
 /**
- * Generate an embedding for a single text.
+ * Generate an embedding for a single value.
  *
  * @example
- * const embedding = await embedText(
+ * const embedding = await embed(
  *   new OpenAITextEmbeddingModel(...),
  *   "At first, Nox didn't know what to do with the pup."
  * );
  */
-function embedText(model, text, options) {
+function embed(model, value, options) {
     return (0, executeCall_js_1.executeCall)({
-        functionType: "text-embedding",
-        input: text,
+        functionType: "embedding",
+        input: value,
         model,
         options,
         generateResponse: async (options) => [
-            await model.generateEmbeddingResponse([text], options),
+            await model.generateEmbeddingResponse([value], options),
         ],
         extractOutputValue: (result) => model.extractEmbeddings(result[0])[0],
     });
 }
-exports.embedText = embedText;
+exports.embed = embed;

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

@@ -0,0 +1,27 @@
+import { Vector } from "../../core/Vector.js";
+import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
+import { ModelFunctionPromise } from "../executeCall.js";
+import { EmbeddingModel, EmbeddingModelSettings } from "./EmbeddingModel.js";
+/**
+ * Generate embeddings for multiple values.
+ *
+ * @example
+ * const embeddings = await embedMany(
+ *   new OpenAITextEmbeddingModel(...),
+ *   [
+ *     "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.",
+ *   ]
+ * );
+ */
+export declare function embedMany<VALUE, RESPONSE, SETTINGS extends EmbeddingModelSettings>(model: EmbeddingModel<VALUE, RESPONSE, SETTINGS>, values: VALUE[], options?: ModelFunctionOptions<SETTINGS>): ModelFunctionPromise<Vector[], RESPONSE[]>;
+/**
+ * Generate an embedding for a single value.
+ *
+ * @example
+ * const embedding = await embed(
+ *   new OpenAITextEmbeddingModel(...),
+ *   "At first, Nox didn't know what to do with the pup."
+ * );
+ */
+export declare function embed<VALUE, RESPONSE, SETTINGS extends EmbeddingModelSettings>(model: EmbeddingModel<VALUE, RESPONSE, SETTINGS>, value: VALUE, options?: ModelFunctionOptions<SETTINGS>): ModelFunctionPromise<Vector, RESPONSE[]>;

package/model-function/{embed-text/embedText.js → embed/embed.js}

@@ -1,9 +1,9 @@
 import { executeCall } from "../executeCall.js";
 /**
- * Generate embeddings for multiple texts.
+ * Generate embeddings for multiple values.
  *
  * @example
- * const embeddings = await embedTexts(
+ * const embeddings = await embedMany(
  *   new OpenAITextEmbeddingModel(...),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",
@@ -11,25 +11,25 @@ import { executeCall } from "../executeCall.js";
  *   ]
  * );
  */
-export function embedTexts(model, texts, options) {
+export function embedMany(model, values, options) {
     return executeCall({
-        functionType: "text-embedding",
-        input: texts,
+        functionType: "embedding",
+        input: values,
         model,
         options,
         generateResponse: (options) => {
-            // split the texts into groups that are small enough to be sent in one call:
-            const maxTextsPerCall = model.maxTextsPerCall;
-            const textGroups = [];
-            if (maxTextsPerCall == null) {
-                textGroups.push(texts);
+            // 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 < texts.length; i += maxTextsPerCall) {
-                    textGroups.push(texts.slice(i, i + maxTextsPerCall));
+                for (let i = 0; i < values.length; i += maxValuesPerCall) {
+                    valueGroups.push(values.slice(i, i + maxValuesPerCall));
                 }
             }
-            return Promise.all(textGroups.map((textGroup) => model.generateEmbeddingResponse(textGroup, options)));
+            return Promise.all(valueGroups.map((valueGroup) => model.generateEmbeddingResponse(valueGroup, options)));
         },
         extractOutputValue: (result) => {
             const embeddings = [];
@@ -41,22 +41,22 @@ export function embedTexts(model, texts, options) {
     });
 }
 /**
- * Generate an embedding for a single text.
+ * Generate an embedding for a single value.
  *
  * @example
- * const embedding = await embedText(
+ * const embedding = await embed(
  *   new OpenAITextEmbeddingModel(...),
  *   "At first, Nox didn't know what to do with the pup."
  * );
  */
-export function embedText(model, text, options) {
+export function embed(model, value, options) {
     return executeCall({
-        functionType: "text-embedding",
-        input: text,
+        functionType: "embedding",
+        input: value,
         model,
         options,
         generateResponse: async (options) => [
-            await model.generateEmbeddingResponse([text], options),
+            await model.generateEmbeddingResponse([value], options),
         ],
         extractOutputValue: (result) => model.extractEmbeddings(result[0])[0],
     });

package/model-function/index.cjs

@@ -23,9 +23,9 @@ __exportStar(require("./SuccessfulModelCall.cjs"), exports);
 __exportStar(require("./describe-image/ImageDescriptionEvent.cjs"), exports);
 __exportStar(require("./describe-image/ImageDescriptionModel.cjs"), exports);
 __exportStar(require("./describe-image/describeImage.cjs"), exports);
-__exportStar(require("./embed-text/TextEmbeddingEvent.cjs"), exports);
-__exportStar(require("./embed-text/TextEmbeddingModel.cjs"), exports);
-__exportStar(require("./embed-text/embedText.cjs"), exports);
+__exportStar(require("./embed/EmbeddingEvent.cjs"), exports);
+__exportStar(require("./embed/EmbeddingModel.cjs"), exports);
+__exportStar(require("./embed/embed.cjs"), exports);
 __exportStar(require("./generate-image/ImageGenerationEvent.cjs"), exports);
 __exportStar(require("./generate-image/ImageGenerationModel.cjs"), exports);
 __exportStar(require("./generate-image/generateImage.cjs"), exports);

package/model-function/index.d.ts

@@ -7,9 +7,9 @@ export * from "./SuccessfulModelCall.js";
 export * from "./describe-image/ImageDescriptionEvent.js";
 export * from "./describe-image/ImageDescriptionModel.js";
 export * from "./describe-image/describeImage.js";
-export * from "./embed-text/TextEmbeddingEvent.js";
-export * from "./embed-text/TextEmbeddingModel.js";
-export * from "./embed-text/embedText.js";
+export * from "./embed/EmbeddingEvent.js";
+export * from "./embed/EmbeddingModel.js";
+export * from "./embed/embed.js";
 export * from "./generate-image/ImageGenerationEvent.js";
 export * from "./generate-image/ImageGenerationModel.js";
 export * from "./generate-image/generateImage.js";

package/model-function/index.js

@@ -7,9 +7,9 @@ export * from "./SuccessfulModelCall.js";
 export * from "./describe-image/ImageDescriptionEvent.js";
 export * from "./describe-image/ImageDescriptionModel.js";
 export * from "./describe-image/describeImage.js";
-export * from "./embed-text/TextEmbeddingEvent.js";
-export * from "./embed-text/TextEmbeddingModel.js";
-export * from "./embed-text/embedText.js";
+export * from "./embed/EmbeddingEvent.js";
+export * from "./embed/EmbeddingModel.js";
+export * from "./embed/embed.js";
 export * from "./generate-image/ImageGenerationEvent.js";
 export * from "./generate-image/ImageGenerationModel.js";
 export * from "./generate-image/generateImage.js";

package/model-provider/cohere/CohereTextEmbeddingModel.cjs

@@ -5,9 +5,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CohereTextEmbeddingModel = exports.COHERE_TEXT_EMBEDDING_MODELS = void 0;
 const zod_1 = __importDefault(require("zod"));
-const AbstractModel_js_1 = require("../../model-function/AbstractModel.cjs");
 const callWithRetryAndThrottle_js_1 = require("../../core/api/callWithRetryAndThrottle.cjs");
 const postToApi_js_1 = require("../../core/api/postToApi.cjs");
+const AbstractModel_js_1 = require("../../model-function/AbstractModel.cjs");
 const CohereApiConfiguration_js_1 = require("./CohereApiConfiguration.cjs");
 const CohereError_js_1 = require("./CohereError.cjs");
 const CohereTokenizer_js_1 = require("./CohereTokenizer.cjs");
@@ -31,7 +31,7 @@ exports.COHERE_TEXT_EMBEDDING_MODELS = {
  * @see https://docs.cohere.com/reference/embed
  *
  * @example
- * const embeddings = await embedTexts(
+ * const embeddings = await embedMany(
  *   new CohereTextEmbeddingModel({ model: "embed-english-light-v2.0" }),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",
@@ -48,7 +48,7 @@ class CohereTextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
             writable: true,
             value: "cohere"
         });
-        Object.defineProperty(this, "maxTextsPerCall", {
+        Object.defineProperty(this, "maxValuesPerCall", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -94,8 +94,8 @@ class CohereTextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
         return this.tokenizer.detokenize(tokens);
     }
     async callAPI(texts, options) {
-        if (texts.length > this.maxTextsPerCall) {
-            throw new Error(`The Cohere embedding API only supports ${this.maxTextsPerCall} texts per API call.`);
+        if (texts.length > this.maxValuesPerCall) {
+            throw new Error(`The Cohere embedding API only supports ${this.maxValuesPerCall} texts per API call.`);
         }
         const run = options?.run;
         const settings = options?.settings;

package/model-provider/cohere/CohereTextEmbeddingModel.d.ts

@@ -1,8 +1,8 @@
 import z from "zod";
-import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { ApiConfiguration } from "../../core/api/ApiConfiguration.js";
+import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { ModelFunctionOptions } from "../../model-function/ModelFunctionOptions.js";
-import { TextEmbeddingModel, TextEmbeddingModelSettings } from "../../model-function/embed-text/TextEmbeddingModel.js";
+import { EmbeddingModel, EmbeddingModelSettings } from "../../model-function/embed/EmbeddingModel.js";
 import { FullTokenizer } from "../../model-function/tokenize-text/Tokenizer.js";
 export declare const COHERE_TEXT_EMBEDDING_MODELS: {
     "embed-english-light-v2.0": {
@@ -19,7 +19,7 @@ export declare const COHERE_TEXT_EMBEDDING_MODELS: {
     };
 };
 export type CohereTextEmbeddingModelType = keyof typeof COHERE_TEXT_EMBEDDING_MODELS;
-export interface CohereTextEmbeddingModelSettings extends TextEmbeddingModelSettings {
+export interface CohereTextEmbeddingModelSettings extends EmbeddingModelSettings {
     api?: ApiConfiguration;
     model: CohereTextEmbeddingModelType;
     truncate?: "NONE" | "START" | "END";
@@ -30,7 +30,7 @@ export interface CohereTextEmbeddingModelSettings extends TextEmbeddingModelSett
  * @see https://docs.cohere.com/reference/embed
  *
  * @example
- * const embeddings = await embedTexts(
+ * const embeddings = await embedMany(
  *   new CohereTextEmbeddingModel({ model: "embed-english-light-v2.0" }),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",
@@ -38,11 +38,11 @@ export interface CohereTextEmbeddingModelSettings extends TextEmbeddingModelSett
  *   ]
  * );
  */
-export declare class CohereTextEmbeddingModel extends AbstractModel<CohereTextEmbeddingModelSettings> implements TextEmbeddingModel<CohereTextEmbeddingResponse, CohereTextEmbeddingModelSettings>, FullTokenizer {
+export declare class CohereTextEmbeddingModel extends AbstractModel<CohereTextEmbeddingModelSettings> implements EmbeddingModel<string, CohereTextEmbeddingResponse, CohereTextEmbeddingModelSettings>, FullTokenizer {
     constructor(settings: CohereTextEmbeddingModelSettings);
     readonly provider: "cohere";
     get modelName(): "embed-english-light-v2.0" | "embed-english-v2.0" | "embed-multilingual-v2.0";
-    readonly maxTextsPerCall = 96;
+    readonly maxValuesPerCall = 96;
     readonly embeddingDimensions: number;
     readonly contextWindowSize: number;
     private readonly tokenizer;

package/model-provider/cohere/CohereTextEmbeddingModel.js

@@ -1,7 +1,7 @@
 import z from "zod";
-import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { callWithRetryAndThrottle } from "../../core/api/callWithRetryAndThrottle.js";
 import { createJsonResponseHandler, postJsonToApi, } from "../../core/api/postToApi.js";
+import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { CohereApiConfiguration } from "./CohereApiConfiguration.js";
 import { failedCohereCallResponseHandler } from "./CohereError.js";
 import { CohereTokenizer } from "./CohereTokenizer.js";
@@ -25,7 +25,7 @@ export const COHERE_TEXT_EMBEDDING_MODELS = {
  * @see https://docs.cohere.com/reference/embed
  *
  * @example
- * const embeddings = await embedTexts(
+ * const embeddings = await embedMany(
  *   new CohereTextEmbeddingModel({ model: "embed-english-light-v2.0" }),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",
@@ -42,7 +42,7 @@ export class CohereTextEmbeddingModel extends AbstractModel {
             writable: true,
             value: "cohere"
         });
-        Object.defineProperty(this, "maxTextsPerCall", {
+        Object.defineProperty(this, "maxValuesPerCall", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -88,8 +88,8 @@ export class CohereTextEmbeddingModel extends AbstractModel {
         return this.tokenizer.detokenize(tokens);
     }
     async callAPI(texts, options) {
-        if (texts.length > this.maxTextsPerCall) {
-            throw new Error(`The Cohere embedding API only supports ${this.maxTextsPerCall} texts per API call.`);
+        if (texts.length > this.maxValuesPerCall) {
+            throw new Error(`The Cohere embedding API only supports ${this.maxValuesPerCall} texts per API call.`);
         }
         const run = options?.run;
         const settings = options?.settings;

package/model-provider/huggingface/HuggingFaceTextEmbeddingModel.cjs

@@ -22,7 +22,7 @@ const HuggingFaceApiConfiguration_js_1 = require("./HuggingFaceApiConfiguration.
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const embeddings = await embedTexts(
+ * const embeddings = await embedMany(
  *   model,
  *   [
  *     "At first, Nox didn't know what to do with the pup.",
@@ -39,7 +39,7 @@ class HuggingFaceTextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
             writable: true,
             value: "huggingface"
         });
-        Object.defineProperty(this, "maxTextsPerCall", {
+        Object.defineProperty(this, "maxValuesPerCall", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -70,15 +70,15 @@ class HuggingFaceTextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
             value: undefined
         });
         // There is no limit documented in the HuggingFace API. Use 1024 as a reasonable default.
-        this.maxTextsPerCall = settings.maxTextsPerCall ?? 1024;
+        this.maxValuesPerCall = settings.maxValuesPerCall ?? 1024;
         this.embeddingDimensions = settings.embeddingDimensions;
     }
     get modelName() {
         return this.settings.model;
     }
     async callAPI(texts, options) {
-        if (texts.length > this.maxTextsPerCall) {
-            throw new Error(`The HuggingFace feature extraction API is configured to only support ${this.maxTextsPerCall} texts per API call.`);
+        if (texts.length > this.maxValuesPerCall) {
+            throw new Error(`The HuggingFace feature extraction API is configured to only support ${this.maxValuesPerCall} texts per API call.`);
         }
         const run = options?.run;
         const settings = options?.settings;

package/model-provider/huggingface/HuggingFaceTextEmbeddingModel.d.ts

@@ -2,11 +2,11 @@ import z from "zod";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { ApiConfiguration } from "../../core/api/ApiConfiguration.js";
 import { ModelFunctionOptions } from "../../model-function/ModelFunctionOptions.js";
-import { TextEmbeddingModel, TextEmbeddingModelSettings } from "../../model-function/embed-text/TextEmbeddingModel.js";
-export interface HuggingFaceTextEmbeddingModelSettings extends TextEmbeddingModelSettings {
+import { EmbeddingModel, EmbeddingModelSettings } from "../../model-function/embed/EmbeddingModel.js";
+export interface HuggingFaceTextEmbeddingModelSettings extends EmbeddingModelSettings {
     api?: ApiConfiguration;
     model: string;
-    maxTextsPerCall?: number;
+    maxValuesPerCall?: number;
     embeddingDimensions?: number;
     options?: {
         useCache?: boolean;
@@ -25,7 +25,7 @@ export interface HuggingFaceTextEmbeddingModelSettings extends TextEmbeddingMode
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const embeddings = await embedTexts(
+ * const embeddings = await embedMany(
  *   model,
  *   [
  *     "At first, Nox didn't know what to do with the pup.",
@@ -33,11 +33,11 @@ export interface HuggingFaceTextEmbeddingModelSettings extends TextEmbeddingMode
  *   ]
  * );
  */
-export declare class HuggingFaceTextEmbeddingModel extends AbstractModel<HuggingFaceTextEmbeddingModelSettings> implements TextEmbeddingModel<HuggingFaceTextEmbeddingResponse, HuggingFaceTextEmbeddingModelSettings> {
+export declare class HuggingFaceTextEmbeddingModel extends AbstractModel<HuggingFaceTextEmbeddingModelSettings> implements EmbeddingModel<string, HuggingFaceTextEmbeddingResponse, HuggingFaceTextEmbeddingModelSettings> {
     constructor(settings: HuggingFaceTextEmbeddingModelSettings);
     readonly provider = "huggingface";
     get modelName(): string;
-    readonly maxTextsPerCall: number;
+    readonly maxValuesPerCall: number;
     readonly contextWindowSize: undefined;
     readonly embeddingDimensions: number | undefined;
     readonly tokenizer: undefined;

package/model-provider/huggingface/HuggingFaceTextEmbeddingModel.js

@@ -16,7 +16,7 @@ import { HuggingFaceApiConfiguration } from "./HuggingFaceApiConfiguration.js";
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const embeddings = await embedTexts(
+ * const embeddings = await embedMany(
  *   model,
  *   [
  *     "At first, Nox didn't know what to do with the pup.",
@@ -33,7 +33,7 @@ export class HuggingFaceTextEmbeddingModel extends AbstractModel {
             writable: true,
             value: "huggingface"
         });
-        Object.defineProperty(this, "maxTextsPerCall", {
+        Object.defineProperty(this, "maxValuesPerCall", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -64,15 +64,15 @@ export class HuggingFaceTextEmbeddingModel extends AbstractModel {
             value: undefined
         });
         // There is no limit documented in the HuggingFace API. Use 1024 as a reasonable default.
-        this.maxTextsPerCall = settings.maxTextsPerCall ?? 1024;
+        this.maxValuesPerCall = settings.maxValuesPerCall ?? 1024;
         this.embeddingDimensions = settings.embeddingDimensions;
     }
     get modelName() {
         return this.settings.model;
     }
     async callAPI(texts, options) {
-        if (texts.length > this.maxTextsPerCall) {
-            throw new Error(`The HuggingFace feature extraction API is configured to only support ${this.maxTextsPerCall} texts per API call.`);
+        if (texts.length > this.maxValuesPerCall) {
+            throw new Error(`The HuggingFace feature extraction API is configured to only support ${this.maxValuesPerCall} texts per API call.`);
         }
         const run = options?.run;
         const settings = options?.settings;

package/model-provider/llamacpp/LlamaCppTextEmbeddingModel.cjs

@@ -5,9 +5,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LlamaCppTextEmbeddingModel = void 0;
 const zod_1 = __importDefault(require("zod"));
-const AbstractModel_js_1 = require("../../model-function/AbstractModel.cjs");
 const callWithRetryAndThrottle_js_1 = require("../../core/api/callWithRetryAndThrottle.cjs");
 const postToApi_js_1 = require("../../core/api/postToApi.cjs");
+const AbstractModel_js_1 = require("../../model-function/AbstractModel.cjs");
 const LlamaCppApiConfiguration_js_1 = require("./LlamaCppApiConfiguration.cjs");
 const LlamaCppError_js_1 = require("./LlamaCppError.cjs");
 const LlamaCppTokenizer_js_1 = require("./LlamaCppTokenizer.cjs");
@@ -20,7 +20,7 @@ class LlamaCppTextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
             writable: true,
             value: "llamacpp"
         });
-        Object.defineProperty(this, "maxTextsPerCall", {
+        Object.defineProperty(this, "maxValuesPerCall", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -54,8 +54,8 @@ class LlamaCppTextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
         return this.tokenizer.tokenize(text);
     }
     async callAPI(texts, options) {
-        if (texts.length > this.maxTextsPerCall) {
-            throw new Error(`The Llama.cpp embedding API only supports ${this.maxTextsPerCall} texts per API call.`);
+        if (texts.length > this.maxValuesPerCall) {
+            throw new Error(`The Llama.cpp embedding API only supports ${this.maxValuesPerCall} texts per API call.`);
         }
         const run = options?.run;
         const settings = options?.settings;

package/model-provider/llamacpp/LlamaCppTextEmbeddingModel.d.ts

@@ -1,17 +1,17 @@
 import z from "zod";
-import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { ApiConfiguration } from "../../core/api/ApiConfiguration.js";
+import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { ModelFunctionOptions } from "../../model-function/ModelFunctionOptions.js";
-import { TextEmbeddingModel, TextEmbeddingModelSettings } from "../../model-function/embed-text/TextEmbeddingModel.js";
-export interface LlamaCppTextEmbeddingModelSettings extends TextEmbeddingModelSettings {
+import { EmbeddingModel, EmbeddingModelSettings } from "../../model-function/embed/EmbeddingModel.js";
+export interface LlamaCppTextEmbeddingModelSettings extends EmbeddingModelSettings {
     api?: ApiConfiguration;
     embeddingDimensions?: number;
 }
-export declare class LlamaCppTextEmbeddingModel extends AbstractModel<LlamaCppTextEmbeddingModelSettings> implements TextEmbeddingModel<LlamaCppTextEmbeddingResponse, LlamaCppTextEmbeddingModelSettings> {
+export declare class LlamaCppTextEmbeddingModel extends AbstractModel<LlamaCppTextEmbeddingModelSettings> implements EmbeddingModel<string, LlamaCppTextEmbeddingResponse, LlamaCppTextEmbeddingModelSettings> {
     constructor(settings?: LlamaCppTextEmbeddingModelSettings);
     readonly provider: "llamacpp";
     get modelName(): null;
-    readonly maxTextsPerCall = 1;
+    readonly maxValuesPerCall = 1;
     readonly contextWindowSize: undefined;
     readonly embeddingDimensions: number | undefined;
     private readonly tokenizer;

package/model-provider/llamacpp/LlamaCppTextEmbeddingModel.js

@@ -1,7 +1,7 @@
 import z from "zod";
-import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { callWithRetryAndThrottle } from "../../core/api/callWithRetryAndThrottle.js";
 import { createJsonResponseHandler, postJsonToApi, } from "../../core/api/postToApi.js";
+import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { LlamaCppApiConfiguration } from "./LlamaCppApiConfiguration.js";
 import { failedLlamaCppCallResponseHandler } from "./LlamaCppError.js";
 import { LlamaCppTokenizer } from "./LlamaCppTokenizer.js";
@@ -14,7 +14,7 @@ export class LlamaCppTextEmbeddingModel extends AbstractModel {
             writable: true,
             value: "llamacpp"
         });
-        Object.defineProperty(this, "maxTextsPerCall", {
+        Object.defineProperty(this, "maxValuesPerCall", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -48,8 +48,8 @@ export class LlamaCppTextEmbeddingModel extends AbstractModel {
         return this.tokenizer.tokenize(text);
     }
     async callAPI(texts, options) {
-        if (texts.length > this.maxTextsPerCall) {
-            throw new Error(`The Llama.cpp embedding API only supports ${this.maxTextsPerCall} texts per API call.`);
+        if (texts.length > this.maxValuesPerCall) {
+            throw new Error(`The Llama.cpp embedding API only supports ${this.maxValuesPerCall} texts per API call.`);
         }
         const run = options?.run;
         const settings = options?.settings;

package/model-provider/openai/OpenAICostCalculator.cjs

@@ -24,7 +24,7 @@ class OpenAICostCalculator {
                     settings: call.settings,
                 });
             }
-            case "text-embedding": {
+            case "embedding": {
                 if (model == null) {
                     return null;
                 }

package/model-provider/openai/OpenAICostCalculator.js

@@ -21,7 +21,7 @@ export class OpenAICostCalculator {
                     settings: call.settings,
                 });
             }
-            case "text-embedding": {
+            case "embedding": {
                 if (model == null) {
                     return null;
                 }

package/model-provider/openai/OpenAITextEmbeddingModel.cjs

@@ -37,7 +37,7 @@ exports.calculateOpenAIEmbeddingCostInMillicents = calculateOpenAIEmbeddingCostI
  * @see https://platform.openai.com/docs/api-reference/embeddings
  *
  * @example
- * const embeddings = await embedTexts(
+ * const embeddings = await embedMany(
  *   new OpenAITextEmbeddingModel({ model: "text-embedding-ada-002" }),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",
@@ -54,7 +54,7 @@ class OpenAITextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
             writable: true,
             value: "openai"
         });
-        Object.defineProperty(this, "maxTextsPerCall", {
+        Object.defineProperty(this, "maxValuesPerCall", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -115,8 +115,8 @@ class OpenAITextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
         return {};
     }
     generateEmbeddingResponse(texts, options) {
-        if (texts.length > this.maxTextsPerCall) {
-            throw new Error(`The OpenAI embedding API only supports ${this.maxTextsPerCall} texts per API call.`);
+        if (texts.length > this.maxValuesPerCall) {
+            throw new Error(`The OpenAI embedding API only supports ${this.maxValuesPerCall} texts per API call.`);
         }
         return this.callAPI(texts, options);
     }

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

@@ -2,7 +2,7 @@ import z from "zod";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { ModelFunctionOptions } from "../../model-function/ModelFunctionOptions.js";
 import { ApiConfiguration } from "../../core/api/ApiConfiguration.js";
-import { TextEmbeddingModel, TextEmbeddingModelSettings } from "../../model-function/embed-text/TextEmbeddingModel.js";
+import { EmbeddingModel, EmbeddingModelSettings } from "../../model-function/embed/EmbeddingModel.js";
 import { TikTokenTokenizer } from "./TikTokenTokenizer.js";
 export declare const OPENAI_TEXT_EMBEDDING_MODELS: {
     "text-embedding-ada-002": {
@@ -17,7 +17,7 @@ export declare const calculateOpenAIEmbeddingCostInMillicents: ({ model, respons
     model: OpenAITextEmbeddingModelType;
     responses: OpenAITextEmbeddingResponse[];
 }) => number;
-export interface OpenAITextEmbeddingModelSettings extends TextEmbeddingModelSettings {
+export interface OpenAITextEmbeddingModelSettings extends EmbeddingModelSettings {
     api?: ApiConfiguration;
     model: OpenAITextEmbeddingModelType;
     isUserIdForwardingEnabled?: boolean;
@@ -28,7 +28,7 @@ export interface OpenAITextEmbeddingModelSettings extends TextEmbeddingModelSett
  * @see https://platform.openai.com/docs/api-reference/embeddings
  *
  * @example
- * const embeddings = await embedTexts(
+ * const embeddings = await embedMany(
  *   new OpenAITextEmbeddingModel({ model: "text-embedding-ada-002" }),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",
@@ -36,11 +36,11 @@ export interface OpenAITextEmbeddingModelSettings extends TextEmbeddingModelSett
  *   ]
  * );
  */
-export declare class OpenAITextEmbeddingModel extends AbstractModel<OpenAITextEmbeddingModelSettings> implements TextEmbeddingModel<OpenAITextEmbeddingResponse, OpenAITextEmbeddingModelSettings> {
+export declare class OpenAITextEmbeddingModel extends AbstractModel<OpenAITextEmbeddingModelSettings> implements EmbeddingModel<string, OpenAITextEmbeddingResponse, OpenAITextEmbeddingModelSettings> {
     constructor(settings: OpenAITextEmbeddingModelSettings);
     readonly provider: "openai";
     get modelName(): "text-embedding-ada-002";
-    readonly maxTextsPerCall = 2048;
+    readonly maxValuesPerCall = 2048;
     readonly embeddingDimensions: number;
     readonly tokenizer: TikTokenTokenizer;
     readonly contextWindowSize: number;

package/model-provider/openai/OpenAITextEmbeddingModel.js

@@ -29,7 +29,7 @@ export const calculateOpenAIEmbeddingCostInMillicents = ({ model, responses, })
  * @see https://platform.openai.com/docs/api-reference/embeddings
  *
  * @example
- * const embeddings = await embedTexts(
+ * const embeddings = await embedMany(
  *   new OpenAITextEmbeddingModel({ model: "text-embedding-ada-002" }),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",
@@ -46,7 +46,7 @@ export class OpenAITextEmbeddingModel extends AbstractModel {
             writable: true,
             value: "openai"
         });
-        Object.defineProperty(this, "maxTextsPerCall", {
+        Object.defineProperty(this, "maxValuesPerCall", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -107,8 +107,8 @@ export class OpenAITextEmbeddingModel extends AbstractModel {
         return {};
     }
     generateEmbeddingResponse(texts, options) {
-        if (texts.length > this.maxTextsPerCall) {
-            throw new Error(`The OpenAI embedding API only supports ${this.maxTextsPerCall} texts per API call.`);
+        if (texts.length > this.maxValuesPerCall) {
+            throw new Error(`The OpenAI embedding API only supports ${this.maxValuesPerCall} texts per API call.`);
         }
         return this.callAPI(texts, options);
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
   "description": "Build multimodal applications, chatbots, and agents with JavaScript and TypeScript.",
-  "version": "0.36.0",
+  "version": "0.38.0",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [
@@ -73,7 +73,7 @@
     "husky": "^8.0.3",
     "lint-staged": "14.0.1",
     "prettier": "3.0.3",
-    "rimraf": "5.0.1",
+    "rimraf": "5.0.5",
     "typescript": "5.2.2",
     "vitest": "^0.34.5"
   },

package/vector-index/VectorIndex.d.ts

@@ -1,5 +1,5 @@
 import { Vector } from "../core/Vector.js";
-export interface VectorIndex<DATA, INDEX> {
+export interface VectorIndex<DATA, INDEX, FILTER> {
     upsertMany(data: Array<{
         id: string;
         vector: Vector;
@@ -9,6 +9,7 @@ export interface VectorIndex<DATA, INDEX> {
         queryVector: Vector;
         maxResults: number;
         similarityThreshold?: number;
+        filter?: FILTER;
     }): Promise<Array<{
         id: string;
         data: DATA;

package/vector-index/VectorIndexRetriever.cjs

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VectorIndexRetriever = void 0;
-const embedText_js_1 = require("../model-function/embed-text/embedText.cjs");
+const embed_js_1 = require("../model-function/embed/embed.cjs");
 class VectorIndexRetriever {
-    constructor({ vectorIndex, embeddingModel, maxResults, similarityThreshold, }) {
+    constructor({ vectorIndex, embeddingModel, maxResults, similarityThreshold, filter, }) {
         Object.defineProperty(this, "vectorIndex", {
             enumerable: true,
             configurable: true,
@@ -27,6 +27,7 @@ class VectorIndexRetriever {
         this.settings = {
             maxResults,
             similarityThreshold,
+            filter,
         };
     }
     async retrieve(query, options) {
@@ -37,7 +38,7 @@ class VectorIndexRetriever {
                 run: options.run,
             });
         }
-        const embedding = await (0, embedText_js_1.embedText)(this.embeddingModel, query, {
+        const embedding = await (0, embed_js_1.embed)(this.embeddingModel, query, {
             functionId: options?.functionId,
             run: options?.run,
         });
@@ -45,6 +46,7 @@ class VectorIndexRetriever {
             queryVector: embedding,
             maxResults: this.settings.maxResults ?? 1,
             similarityThreshold: this.settings.similarityThreshold,
+            filter: this.settings?.filter,
         });
         return queryResult.map((item) => item.data);
     }

package/vector-index/VectorIndexRetriever.d.ts

@@ -1,19 +1,20 @@
+import { EmbeddingModel, EmbeddingModelSettings } from "../model-function/embed/EmbeddingModel.js";
 import { ModelFunctionOptions } from "../model-function/ModelFunctionOptions.js";
-import { TextEmbeddingModel, TextEmbeddingModelSettings } from "../model-function/embed-text/TextEmbeddingModel.js";
 import { Retriever, RetrieverSettings } from "../retriever/Retriever.js";
 import { VectorIndex } from "./VectorIndex.js";
-export interface VectorIndexRetrieverSettings {
+export interface VectorIndexRetrieverSettings<FILTER> {
     maxResults?: number;
     similarityThreshold?: number;
+    filter?: FILTER;
 }
-export declare class VectorIndexRetriever<OBJECT, INDEX> implements Retriever<OBJECT, string, VectorIndexRetrieverSettings> {
+export declare class VectorIndexRetriever<OBJECT, VALUE, INDEX, FILTER> implements Retriever<OBJECT, VALUE, VectorIndexRetrieverSettings<FILTER>> {
     private readonly vectorIndex;
     private readonly embeddingModel;
     private readonly settings;
-    constructor({ vectorIndex, embeddingModel, maxResults, similarityThreshold, }: {
-        vectorIndex: VectorIndex<OBJECT, INDEX>;
-        embeddingModel: TextEmbeddingModel<unknown, TextEmbeddingModelSettings>;
-    } & VectorIndexRetrieverSettings);
-    retrieve(query: string, options?: ModelFunctionOptions<RetrieverSettings>): Promise<OBJECT[]>;
-    withSettings(additionalSettings: Partial<VectorIndexRetrieverSettings>): this;
+    constructor({ vectorIndex, embeddingModel, maxResults, similarityThreshold, filter, }: {
+        vectorIndex: VectorIndex<OBJECT, INDEX, FILTER>;
+        embeddingModel: EmbeddingModel<VALUE, unknown, EmbeddingModelSettings>;
+    } & VectorIndexRetrieverSettings<FILTER>);
+    retrieve(query: VALUE, options?: ModelFunctionOptions<RetrieverSettings>): Promise<OBJECT[]>;
+    withSettings(additionalSettings: Partial<VectorIndexRetrieverSettings<FILTER>>): this;
 }

package/vector-index/VectorIndexRetriever.js

@@ -1,6 +1,6 @@
-import { embedText } from "../model-function/embed-text/embedText.js";
+import { embed } from "../model-function/embed/embed.js";
 export class VectorIndexRetriever {
-    constructor({ vectorIndex, embeddingModel, maxResults, similarityThreshold, }) {
+    constructor({ vectorIndex, embeddingModel, maxResults, similarityThreshold, filter, }) {
         Object.defineProperty(this, "vectorIndex", {
             enumerable: true,
             configurable: true,
@@ -24,6 +24,7 @@ export class VectorIndexRetriever {
         this.settings = {
             maxResults,
             similarityThreshold,
+            filter,
         };
     }
     async retrieve(query, options) {
@@ -34,7 +35,7 @@ export class VectorIndexRetriever {
                 run: options.run,
             });
         }
-        const embedding = await embedText(this.embeddingModel, query, {
+        const embedding = await embed(this.embeddingModel, query, {
             functionId: options?.functionId,
             run: options?.run,
         });
@@ -42,6 +43,7 @@ export class VectorIndexRetriever {
             queryVector: embedding,
             maxResults: this.settings.maxResults ?? 1,
             similarityThreshold: this.settings.similarityThreshold,
+            filter: this.settings?.filter,
         });
         return queryResult.map((item) => item.data);
     }

package/vector-index/memory/MemoryVectorIndex.cjs

@@ -40,8 +40,9 @@ class MemoryVectorIndex {
             this.entries.set(entry.id, entry);
         }
     }
-    async queryByVector({ queryVector, similarityThreshold, maxResults, }) {
+    async queryByVector({ queryVector, similarityThreshold, maxResults, filter, }) {
         const results = [...this.entries.values()]
+            .filter((value) => filter?.(value.data) ?? true)
             .map((entry) => ({
             id: entry.id,
             similarity: (0, cosineSimilarity_js_1.cosineSimilarity)(entry.vector, queryVector),

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

@@ -6,7 +6,7 @@ import { VectorIndex } from "../VectorIndex.js";
  * a small number of entries and don't want to set up a real database, e.g. for conversational memory
  * that does not need to be persisted.
  */
-export declare class MemoryVectorIndex<DATA> implements VectorIndex<DATA, MemoryVectorIndex<DATA>> {
+export declare class MemoryVectorIndex<DATA> implements VectorIndex<DATA, MemoryVectorIndex<DATA>, (value: DATA) => boolean> {
     static deserialize<DATA>({ serializedData, schema, }: {
         serializedData: string;
         schema?: z.ZodSchema<DATA>;
@@ -17,10 +17,11 @@ export declare class MemoryVectorIndex<DATA> implements VectorIndex<DATA, Memory
         vector: Vector;
         data: DATA;
     }>): Promise<void>;
-    queryByVector({ queryVector, similarityThreshold, maxResults, }: {
+    queryByVector({ queryVector, similarityThreshold, maxResults, filter, }: {
         queryVector: Vector;
         maxResults: number;
         similarityThreshold?: number;
+        filter?: (value: DATA) => boolean;
     }): Promise<Array<{
         id: string;
         data: DATA;

package/vector-index/memory/MemoryVectorIndex.js

@@ -34,8 +34,9 @@ export class MemoryVectorIndex {
             this.entries.set(entry.id, entry);
         }
     }
-    async queryByVector({ queryVector, similarityThreshold, maxResults, }) {
+    async queryByVector({ queryVector, similarityThreshold, maxResults, filter, }) {
         const results = [...this.entries.values()]
+            .filter((value) => filter?.(value.data) ?? true)
             .map((entry) => ({
             id: entry.id,
             similarity: cosineSimilarity(entry.vector, queryVector),

package/vector-index/pinecone/PineconeVectorIndex.d.ts

@@ -2,7 +2,7 @@ import { VectorOperationsApi } from "@pinecone-database/pinecone/dist/pinecone-g
 import { z } from "zod";
 import { Vector } from "../../core/Vector.js";
 import { VectorIndex } from "../VectorIndex.js";
-export declare class PineconeVectorIndex<DATA extends object | undefined> implements VectorIndex<DATA, PineconeVectorIndex<DATA>> {
+export declare class PineconeVectorIndex<DATA extends object | undefined> implements VectorIndex<DATA, PineconeVectorIndex<DATA>, null> {
     readonly index: VectorOperationsApi;
     readonly namespace?: string;
     readonly schema: z.ZodSchema<DATA>;

package/vector-index/upsertIntoVectorIndex.cjs

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.upsertIntoVectorIndex = void 0;
 const nanoid_1 = require("nanoid");
-const embedText_js_1 = require("../model-function/embed-text/embedText.cjs");
+const embed_js_1 = require("../model-function/embed/embed.cjs");
 async function upsertIntoVectorIndex({ vectorIndex, embeddingModel, generateId = nanoid_1.nanoid, objects, getValueToEmbed, getId, }, options) {
     // many embedding models support bulk embedding, so we first embed all texts:
-    const embeddings = await (0, embedText_js_1.embedTexts)(embeddingModel, objects.map(getValueToEmbed), options);
+    const embeddings = await (0, embed_js_1.embedMany)(embeddingModel, objects.map(getValueToEmbed), options);
     await vectorIndex.upsertMany(objects.map((object, i) => ({
         id: getId?.(object, i) ?? generateId(),
         vector: embeddings[i],

package/vector-index/upsertIntoVectorIndex.d.ts

@@ -1,11 +1,11 @@
 import { ModelFunctionOptions } from "../model-function/ModelFunctionOptions.js";
-import { TextEmbeddingModel, TextEmbeddingModelSettings } from "../model-function/embed-text/TextEmbeddingModel.js";
+import { EmbeddingModel, EmbeddingModelSettings } from "../model-function/embed/EmbeddingModel.js";
 import { VectorIndex } from "./VectorIndex.js";
-export declare function upsertIntoVectorIndex<OBJECT, SETTINGS extends TextEmbeddingModelSettings>({ vectorIndex, embeddingModel, generateId, objects, getValueToEmbed, getId, }: {
-    vectorIndex: VectorIndex<OBJECT, unknown>;
-    embeddingModel: TextEmbeddingModel<unknown, SETTINGS>;
+export declare function upsertIntoVectorIndex<VALUE, OBJECT, SETTINGS extends EmbeddingModelSettings>({ vectorIndex, embeddingModel, generateId, objects, getValueToEmbed, getId, }: {
+    vectorIndex: VectorIndex<OBJECT, unknown, unknown>;
+    embeddingModel: EmbeddingModel<VALUE, unknown, SETTINGS>;
     generateId?: () => string;
     objects: OBJECT[];
-    getValueToEmbed: (object: OBJECT, index: number) => string;
+    getValueToEmbed: (object: OBJECT, index: number) => VALUE;
     getId?: (object: OBJECT, index: number) => string | undefined;
 }, options?: ModelFunctionOptions<SETTINGS>): Promise<void>;

package/vector-index/upsertIntoVectorIndex.js

@@ -1,8 +1,8 @@
 import { nanoid as createId } from "nanoid";
-import { embedTexts } from "../model-function/embed-text/embedText.js";
+import { embedMany } from "../model-function/embed/embed.js";
 export async function upsertIntoVectorIndex({ vectorIndex, embeddingModel, generateId = createId, objects, getValueToEmbed, getId, }, options) {
     // many embedding models support bulk embedding, so we first embed all texts:
-    const embeddings = await embedTexts(embeddingModel, objects.map(getValueToEmbed), options);
+    const embeddings = await embedMany(embeddingModel, objects.map(getValueToEmbed), options);
     await vectorIndex.upsertMany(objects.map((object, i) => ({
         id: getId?.(object, i) ?? generateId(),
         vector: embeddings[i],

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

@@ -1,21 +0,0 @@
-import { Vector } from "../../core/Vector.js";
-import { BaseModelCallFinishedEvent, BaseModelCallStartedEvent } from "../ModelCallEvent.js";
-export interface TextEmbeddingStartedEvent extends BaseModelCallStartedEvent {
-    functionType: "text-embedding";
-    input: string | Array<string>;
-}
-export type TextEmbeddingFinishedEventResult = {
-    status: "success";
-    response: unknown;
-    output: Vector | Array<Vector>;
-} | {
-    status: "error";
-    error: unknown;
-} | {
-    status: "abort";
-};
-export interface TextEmbeddingFinishedEvent extends BaseModelCallFinishedEvent {
-    functionType: "text-embedding";
-    input: string | Array<string>;
-    result: TextEmbeddingFinishedEventResult;
-}

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

@@ -1,21 +0,0 @@
-import { Vector } from "../../core/Vector.js";
-import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
-import { Model, ModelSettings } from "../Model.js";
-export interface TextEmbeddingModelSettings extends ModelSettings {
-}
-export interface TextEmbeddingModel<RESPONSE, SETTINGS extends TextEmbeddingModelSettings> extends Model<SETTINGS> {
-    /**
-     * The limit of tokens for a single text.
-     */
-    readonly contextWindowSize: number | undefined;
-    /**
-     * The size of the embedding vector.
-     */
-    readonly embeddingDimensions: number | undefined;
-    /**
-     * Limit of how many texts can be sent in a single API call.
-     */
-    readonly maxTextsPerCall: number | undefined;
-    generateEmbeddingResponse(texts: string[], options?: ModelFunctionOptions<SETTINGS>): PromiseLike<RESPONSE>;
-    extractEmbeddings(response: RESPONSE): Vector[];
-}

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

@@ -1,27 +0,0 @@
-import { Vector } from "../../core/Vector.js";
-import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
-import { ModelFunctionPromise } from "../executeCall.js";
-import { TextEmbeddingModel, TextEmbeddingModelSettings } from "./TextEmbeddingModel.js";
-/**
- * Generate embeddings for multiple texts.
- *
- * @example
- * const embeddings = await embedTexts(
- *   new OpenAITextEmbeddingModel(...),
- *   [
- *     "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.",
- *   ]
- * );
- */
-export declare function embedTexts<RESPONSE, SETTINGS extends TextEmbeddingModelSettings>(model: TextEmbeddingModel<RESPONSE, SETTINGS>, texts: string[], options?: ModelFunctionOptions<SETTINGS>): ModelFunctionPromise<Vector[], RESPONSE[]>;
-/**
- * Generate an embedding for a single text.
- *
- * @example
- * const embedding = await embedText(
- *   new OpenAITextEmbeddingModel(...),
- *   "At first, Nox didn't know what to do with the pup."
- * );
- */
-export declare function embedText<RESPONSE, SETTINGS extends TextEmbeddingModelSettings>(model: TextEmbeddingModel<RESPONSE, SETTINGS>, text: string, options?: ModelFunctionOptions<SETTINGS>): ModelFunctionPromise<Vector, RESPONSE[]>;