modelfusion 0.37.0 → 0.39.0

package/README.md

@@ -17,10 +17,9 @@
 
 ModelFusion is a library for building AI apps, chatbots, and agents. It provides abstractions for AI models, vector indices, and tools.
 
-- **Type inference and validation**: ModelFusion uses TypeScript and [Zod](https://github.com/colinhacks/zod) to infer types wherever possible and to validate model responses.
-- **Flexibility and control**: AI application development can be complex and unique to each project. With ModelFusion, you have complete control over the prompts and model settings, and you can access the raw responses from the models quickly to build what you need.
-- **No chains and predefined prompts**: Use the concepts provided by JavaScript (variables, functions, etc.) and explicit prompts to build applications you can easily understand and control. Not hidden prompts and logic.
 - **Multimodal Support**: Beyond just LLMs, ModelFusion encompasses a diverse array of models including text generation, text-to-speech, speech-to-text, and image generation, allowing you to build multifaceted AI applications with ease.
+- **Flexibility and control**: AI application development can be complex and unique to each project. With ModelFusion, you have complete control over the prompts and model settings, and you can access the raw responses from the models quickly to build what you need.
+- **Type inference and validation**: ModelFusion uses TypeScript and [Zod](https://github.com/colinhacks/zod) to infer types wherever possible and to validate model responses.
 - **Integrated support features**: Essential features like logging, retries, throttling, tracing, and error handling are built-in, helping you focus more on building your application.
 
 ## Quick Install
@@ -358,7 +357,7 @@ const text = await describeImage(
   new HuggingFaceImageDescriptionModel({
     model: "nlpconnect/vit-gpt2-image-captioning",
   }),
-  data: buffer
+  data // buffer with image data
 );
 ```
 
@@ -377,12 +376,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 +458,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/core/structure/JsonSchemaProducer.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Schema defines a structure for a JSON object.
+ */
+export interface JsonSchemaProducer {
+    /**
+     * Returns the JSON schema for this schema. The schema has to be a valid JSON schema in object form.
+     */
+    getJsonSchema(): unknown;
+}

package/core/structure/Schema.d.ts

@@ -1,5 +1,5 @@
 /**
- * Schema defines a structure for a JSON object.
+ * Validates that the structure of `value` matches the structure of this schema.
  */
 export interface Schema<STRUCTURE> {
     /**
@@ -13,10 +13,6 @@ export interface Schema<STRUCTURE> {
         success: false;
         error: unknown;
     };
-    /**
-     * Returns the JSON schema for this schema. The schema has to be a valid JSON schema in object form.
-     */
-    getJsonSchema(): unknown;
     /**
      * Only used for type inference.
      */

package/core/structure/StructureDefinition.d.ts

@@ -1,6 +1,7 @@
+import { JsonSchemaProducer } from "./JsonSchemaProducer.js";
 import { Schema } from "./Schema.js";
 export interface StructureDefinition<NAME extends string, STRUCTURE> {
     name: NAME;
     description?: string;
-    schema: Schema<STRUCTURE>;
+    schema: Schema<STRUCTURE> & JsonSchemaProducer;
 }

package/core/structure/{UncheckedJsonSchemaSchema.cjs → UncheckedSchema.cjs}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UncheckedJsonSchemaSchema = void 0;
-class UncheckedJsonSchemaSchema {
+exports.UncheckedSchema = void 0;
+class UncheckedSchema {
     constructor(jsonSchema) {
         Object.defineProperty(this, "jsonSchema", {
             enumerable: true,
@@ -23,4 +23,4 @@ class UncheckedJsonSchemaSchema {
         return this.jsonSchema;
     }
 }
-exports.UncheckedJsonSchemaSchema = UncheckedJsonSchemaSchema;
+exports.UncheckedSchema = UncheckedSchema;

package/core/structure/{UncheckedJsonSchemaSchema.d.ts → UncheckedSchema.d.ts}

@@ -1,7 +1,7 @@
 import { Schema } from "./Schema.js";
-export declare class UncheckedJsonSchemaSchema<STRUCTURE> implements Schema<STRUCTURE> {
-    private readonly jsonSchema;
-    constructor(jsonSchema: unknown);
+export declare class UncheckedSchema<STRUCTURE> implements Schema<STRUCTURE> {
+    private readonly jsonSchema?;
+    constructor(jsonSchema?: unknown);
     validate(value: unknown): {
         success: true;
         value: STRUCTURE;

package/core/structure/{UncheckedJsonSchemaSchema.js → UncheckedSchema.js}

@@ -1,4 +1,4 @@
-export class UncheckedJsonSchemaSchema {
+export class UncheckedSchema {
     constructor(jsonSchema) {
         Object.defineProperty(this, "jsonSchema", {
             enumerable: true,

package/core/structure/{UncheckedJsonSchemaStructureDefinition.cjs → UncheckedStructureDefinition.cjs}

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UncheckedJsonSchemaStructureDefinition = void 0;
-const UncheckedJsonSchemaSchema_js_1 = require("./UncheckedJsonSchemaSchema.cjs");
-class UncheckedJsonSchemaStructureDefinition {
+exports.UncheckedStructureDefinition = void 0;
+const UncheckedSchema_js_1 = require("./UncheckedSchema.cjs");
+class UncheckedStructureDefinition {
     constructor({ name, description, jsonSchema, }) {
         Object.defineProperty(this, "name", {
             enumerable: true,
@@ -24,7 +24,7 @@ class UncheckedJsonSchemaStructureDefinition {
         });
         this.name = name;
         this.description = description;
-        this.schema = new UncheckedJsonSchemaSchema_js_1.UncheckedJsonSchemaSchema(jsonSchema);
+        this.schema = new UncheckedSchema_js_1.UncheckedSchema(jsonSchema);
     }
 }
-exports.UncheckedJsonSchemaStructureDefinition = UncheckedJsonSchemaStructureDefinition;
+exports.UncheckedStructureDefinition = UncheckedStructureDefinition;

package/core/structure/{UncheckedJsonSchemaStructureDefinition.d.ts → UncheckedStructureDefinition.d.ts}

@@ -1,9 +1,9 @@
-import { Schema } from "./Schema.js";
 import { StructureDefinition } from "./StructureDefinition.js";
-export declare class UncheckedJsonSchemaStructureDefinition<NAME extends string, STRUCTURE> implements StructureDefinition<NAME, STRUCTURE> {
+import { UncheckedSchema } from "./UncheckedSchema.js";
+export declare class UncheckedStructureDefinition<NAME extends string, STRUCTURE> implements StructureDefinition<NAME, STRUCTURE> {
     name: NAME;
     description?: string;
-    schema: Schema<STRUCTURE>;
+    schema: UncheckedSchema<STRUCTURE>;
     constructor({ name, description, jsonSchema, }: {
         name: NAME;
         description?: string;

package/core/structure/{UncheckedJsonSchemaStructureDefinition.js → UncheckedStructureDefinition.js}

@@ -1,5 +1,5 @@
-import { UncheckedJsonSchemaSchema } from "./UncheckedJsonSchemaSchema.js";
-export class UncheckedJsonSchemaStructureDefinition {
+import { UncheckedSchema } from "./UncheckedSchema.js";
+export class UncheckedStructureDefinition {
     constructor({ name, description, jsonSchema, }) {
         Object.defineProperty(this, "name", {
             enumerable: true,
@@ -21,6 +21,6 @@ export class UncheckedJsonSchemaStructureDefinition {
         });
         this.name = name;
         this.description = description;
-        this.schema = new UncheckedJsonSchemaSchema(jsonSchema);
+        this.schema = new UncheckedSchema(jsonSchema);
     }
 }

package/core/structure/ZodStructureDefinition.d.ts

@@ -1,10 +1,10 @@
 import { z } from "zod";
-import { Schema } from "./Schema.js";
 import { StructureDefinition } from "./StructureDefinition.js";
+import { ZodSchema } from "./ZodSchema.js";
 export declare class ZodStructureDefinition<NAME extends string, STRUCTURE> implements StructureDefinition<NAME, STRUCTURE> {
     name: NAME;
     description?: string;
-    schema: Schema<STRUCTURE>;
+    schema: ZodSchema<STRUCTURE>;
     constructor({ name, description, schema, }: {
         name: NAME;
         description?: string;

package/core/structure/index.cjs

@@ -14,9 +14,10 @@ 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("./JsonSchemaProducer.cjs"), exports);
 __exportStar(require("./Schema.cjs"), exports);
 __exportStar(require("./StructureDefinition.cjs"), exports);
-__exportStar(require("./UncheckedJsonSchemaSchema.cjs"), exports);
-__exportStar(require("./UncheckedJsonSchemaStructureDefinition.cjs"), exports);
+__exportStar(require("./UncheckedSchema.cjs"), exports);
+__exportStar(require("./UncheckedStructureDefinition.cjs"), exports);
 __exportStar(require("./ZodSchema.cjs"), exports);
 __exportStar(require("./ZodStructureDefinition.cjs"), exports);

package/core/structure/index.d.ts

@@ -1,6 +1,7 @@
+export * from "./JsonSchemaProducer.js";
 export * from "./Schema.js";
 export * from "./StructureDefinition.js";
-export * from "./UncheckedJsonSchemaSchema.js";
-export * from "./UncheckedJsonSchemaStructureDefinition.js";
+export * from "./UncheckedSchema.js";
+export * from "./UncheckedStructureDefinition.js";
 export * from "./ZodSchema.js";
 export * from "./ZodStructureDefinition.js";

package/core/structure/index.js

@@ -1,6 +1,7 @@
+export * from "./JsonSchemaProducer.js";
 export * from "./Schema.js";
 export * from "./StructureDefinition.js";
-export * from "./UncheckedJsonSchemaSchema.js";
-export * from "./UncheckedJsonSchemaStructureDefinition.js";
+export * from "./UncheckedSchema.js";
+export * from "./UncheckedStructureDefinition.js";
 export * from "./ZodSchema.js";
 export * from "./ZodStructureDefinition.js";

package/event-source/index.cjs

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AsyncQueue.cjs"), exports);
 __exportStar(require("./createEventSourceStream.cjs"), exports);
+__exportStar(require("./readEventSource.cjs"), exports);
 __exportStar(require("./readEventSourceStream.cjs"), exports);

package/event-source/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./AsyncQueue.js";
 export * from "./createEventSourceStream.js";
+export * from "./readEventSource.js";
 export * from "./readEventSourceStream.js";

package/event-source/index.js

@@ -1,3 +1,4 @@
 export * from "./AsyncQueue.js";
 export * from "./createEventSourceStream.js";
+export * from "./readEventSource.js";
 export * from "./readEventSourceStream.js";

package/event-source/readEventSource.cjs

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readEventSource = void 0;
+const secure_json_parse_1 = __importDefault(require("secure-json-parse"));
+function readEventSource({ url, schema, onEvent, onError = console.error, }) {
+    const eventSource = new EventSource(url);
+    eventSource.onmessage = (e) => {
+        try {
+            const validationResult = schema.validate(secure_json_parse_1.default.parse(e.data));
+            if (!validationResult.success) {
+                onError(validationResult.error, eventSource);
+                return;
+            }
+            onEvent(validationResult.value, eventSource);
+        }
+        catch (error) {
+            onError(error, eventSource);
+        }
+    };
+    eventSource.onerror = (e) => {
+        onError(e, eventSource);
+    };
+}
+exports.readEventSource = readEventSource;

package/event-source/readEventSource.d.ts

@@ -0,0 +1,7 @@
+import { Schema } from "../core/structure/Schema";
+export declare function readEventSource<T>({ url, schema, onEvent, onError, }: {
+    url: string;
+    schema: Schema<T>;
+    onEvent: (event: T, eventSource: EventSource) => void;
+    onError?: (error: unknown, eventSource: EventSource) => void;
+}): void;

package/event-source/readEventSource.js

@@ -0,0 +1,20 @@
+import SecureJSON from "secure-json-parse";
+export function readEventSource({ url, schema, onEvent, onError = console.error, }) {
+    const eventSource = new EventSource(url);
+    eventSource.onmessage = (e) => {
+        try {
+            const validationResult = schema.validate(SecureJSON.parse(e.data));
+            if (!validationResult.success) {
+                onError(validationResult.error, eventSource);
+                return;
+            }
+            onEvent(validationResult.value, eventSource);
+        }
+        catch (error) {
+            onError(error, eventSource);
+        }
+    };
+    eventSource.onerror = (e) => {
+        onError(e, eventSource);
+    };
+}

package/event-source/readEventSourceStream.cjs

@@ -14,7 +14,12 @@ function readEventSourceStream({ stream, schema, errorHandler, }) {
         .then(async (events) => {
         try {
             for await (const event of events) {
-                queue.push(schema.parse(secure_json_parse_1.default.parse(event.data)));
+                const validationResult = schema.validate(secure_json_parse_1.default.parse(event.data));
+                if (!validationResult.success) {
+                    errorHandler?.(validationResult.error);
+                    continue;
+                }
+                queue.push(validationResult.value);
             }
         }
         catch (error) {

package/event-source/readEventSourceStream.d.ts

@@ -1,6 +1,7 @@
+import { Schema } from "../core/structure/Schema.js";
 import { ErrorHandler } from "../util/ErrorHandler.js";
 export declare function readEventSourceStream<T>({ stream, schema, errorHandler, }: {
     stream: ReadableStream<Uint8Array>;
-    schema: Zod.Schema<T>;
+    schema: Schema<T>;
     errorHandler?: ErrorHandler;
 }): AsyncIterable<T>;

package/event-source/readEventSourceStream.js

@@ -8,7 +8,12 @@ export function readEventSourceStream({ stream, schema, errorHandler, }) {
         .then(async (events) => {
         try {
             for await (const event of events) {
-                queue.push(schema.parse(SecureJSON.parse(event.data)));
+                const validationResult = schema.validate(SecureJSON.parse(event.data));
+                if (!validationResult.success) {
+                    errorHandler?.(validationResult.error);
+                    continue;
+                }
+                queue.push(validationResult.value);
             }
         }
         catch (error) {

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.cjs

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

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/EmbeddingModel.js

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

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";