modelfusion 0.45.3 → 0.47.0

package/model-function/generate-image/ImageGenerationPromise.cjs

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImageGenerationPromise = void 0;
+class ImageGenerationPromise extends Promise {
+    constructor(fullPromise) {
+        super((resolve) => {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            resolve(null); // we override the resolve function
+        });
+        Object.defineProperty(this, "fullPromise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: fullPromise
+        });
+        Object.defineProperty(this, "imageBase64Promise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "imageBufferPromise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.imageBase64Promise = fullPromise.then((result) => result.value);
+        this.imageBufferPromise = this.imageBase64Promise.then((base64Text) => Buffer.from(base64Text, "base64"));
+    }
+    asFullResponse() {
+        return this.fullPromise;
+    }
+    asBase64Text() {
+        return this.imageBase64Promise;
+    }
+    asBuffer() {
+        return this.imageBufferPromise;
+    }
+    then(onfulfilled, onrejected) {
+        return this.imageBufferPromise.then(onfulfilled, onrejected);
+    }
+    catch(onrejected) {
+        return this.imageBufferPromise.catch(onrejected);
+    }
+    finally(onfinally) {
+        return this.imageBufferPromise.finally(onfinally);
+    }
+}
+exports.ImageGenerationPromise = ImageGenerationPromise;

package/model-function/generate-image/ImageGenerationPromise.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="node" />
+import { ModelCallMetadata } from "../ModelCallMetadata.js";
+export declare class ImageGenerationPromise extends Promise<Buffer> {
+    private fullPromise;
+    private imageBase64Promise;
+    private imageBufferPromise;
+    constructor(fullPromise: Promise<{
+        value: string;
+        response: unknown;
+        metadata: ModelCallMetadata;
+    }>);
+    asFullResponse(): Promise<{
+        value: string;
+        response: unknown;
+        metadata: ModelCallMetadata;
+    }>;
+    asBase64Text(): Promise<string>;
+    asBuffer(): Promise<Buffer>;
+    then<TResult1 = Buffer, TResult2 = never>(onfulfilled?: ((value: Buffer) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
+    catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | undefined | null): Promise<Buffer | TResult>;
+    finally(onfinally?: (() => void) | undefined | null): Promise<Buffer>;
+}

package/model-function/generate-image/ImageGenerationPromise.js

@@ -0,0 +1,46 @@
+export class ImageGenerationPromise extends Promise {
+    constructor(fullPromise) {
+        super((resolve) => {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            resolve(null); // we override the resolve function
+        });
+        Object.defineProperty(this, "fullPromise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: fullPromise
+        });
+        Object.defineProperty(this, "imageBase64Promise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "imageBufferPromise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.imageBase64Promise = fullPromise.then((result) => result.value);
+        this.imageBufferPromise = this.imageBase64Promise.then((base64Text) => Buffer.from(base64Text, "base64"));
+    }
+    asFullResponse() {
+        return this.fullPromise;
+    }
+    asBase64Text() {
+        return this.imageBase64Promise;
+    }
+    asBuffer() {
+        return this.imageBufferPromise;
+    }
+    then(onfulfilled, onrejected) {
+        return this.imageBufferPromise.then(onfulfilled, onrejected);
+    }
+    catch(onrejected) {
+        return this.imageBufferPromise.catch(onrejected);
+    }
+    finally(onfinally) {
+        return this.imageBufferPromise.finally(onfinally);
+    }
+}

package/model-function/generate-image/PromptFormatImageGenerationModel.cjs

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromptFormatImageGenerationModel = void 0;
+class PromptFormatImageGenerationModel {
+    constructor({ model, promptFormat, }) {
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "promptFormat", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.model = model;
+        this.promptFormat = promptFormat;
+    }
+    get modelInformation() {
+        return this.model.modelInformation;
+    }
+    get settings() {
+        return this.model.settings;
+    }
+    doGenerateImage(prompt, options) {
+        const mappedPrompt = this.promptFormat.format(prompt);
+        return this.model.doGenerateImage(mappedPrompt, options);
+    }
+    get settingsForEvent() {
+        return this.model.settingsForEvent;
+    }
+    withPromptFormat(promptFormat) {
+        return new PromptFormatImageGenerationModel({ model: this, promptFormat });
+    }
+    withSettings(additionalSettings) {
+        return new PromptFormatImageGenerationModel({
+            model: this.model.withSettings(additionalSettings),
+            promptFormat: this.promptFormat,
+        });
+    }
+}
+exports.PromptFormatImageGenerationModel = PromptFormatImageGenerationModel;

package/model-function/generate-image/PromptFormatImageGenerationModel.d.ts

@@ -0,0 +1,20 @@
+import { FunctionOptions } from "../../core/FunctionOptions.js";
+import { PromptFormat } from "../PromptFormat.js";
+import { ImageGenerationModel, ImageGenerationModelSettings } from "./ImageGenerationModel.js";
+export declare class PromptFormatImageGenerationModel<PROMPT, MODEL_PROMPT, SETTINGS extends ImageGenerationModelSettings, MODEL extends ImageGenerationModel<MODEL_PROMPT, SETTINGS>> implements ImageGenerationModel<PROMPT, SETTINGS> {
+    readonly model: MODEL;
+    readonly promptFormat: PromptFormat<PROMPT, MODEL_PROMPT>;
+    constructor({ model, promptFormat, }: {
+        model: MODEL;
+        promptFormat: PromptFormat<PROMPT, MODEL_PROMPT>;
+    });
+    get modelInformation(): import("../ModelInformation.js").ModelInformation;
+    get settings(): SETTINGS;
+    doGenerateImage(prompt: PROMPT, options?: FunctionOptions): PromiseLike<{
+        response: unknown;
+        base64Image: string;
+    }>;
+    get settingsForEvent(): Partial<SETTINGS>;
+    withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, PROMPT>): PromptFormatImageGenerationModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
+    withSettings(additionalSettings: Partial<SETTINGS>): this;
+}

package/model-function/generate-image/PromptFormatImageGenerationModel.js

@@ -0,0 +1,40 @@
+export class PromptFormatImageGenerationModel {
+    constructor({ model, promptFormat, }) {
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "promptFormat", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.model = model;
+        this.promptFormat = promptFormat;
+    }
+    get modelInformation() {
+        return this.model.modelInformation;
+    }
+    get settings() {
+        return this.model.settings;
+    }
+    doGenerateImage(prompt, options) {
+        const mappedPrompt = this.promptFormat.format(prompt);
+        return this.model.doGenerateImage(mappedPrompt, options);
+    }
+    get settingsForEvent() {
+        return this.model.settingsForEvent;
+    }
+    withPromptFormat(promptFormat) {
+        return new PromptFormatImageGenerationModel({ model: this, promptFormat });
+    }
+    withSettings(additionalSettings) {
+        return new PromptFormatImageGenerationModel({
+            model: this.model.withSettings(additionalSettings),
+            promptFormat: this.promptFormat,
+        });
+    }
+}

package/model-function/generate-image/generateImage.cjs

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateImage = void 0;
 const executeCall_js_1 = require("../executeCall.cjs");
+const ImageGenerationPromise_js_1 = require("./ImageGenerationPromise.cjs");
 /**
  * Generates a base64-encoded image using a prompt.
  * The prompt format depends on the model.
@@ -18,7 +19,7 @@ const executeCall_js_1 = require("../executeCall.cjs");
  * );
  */
 function generateImage(model, prompt, options) {
-    return (0, executeCall_js_1.executeCall)({
+    return new ImageGenerationPromise_js_1.ImageGenerationPromise((0, executeCall_js_1.executeCall)({
         functionType: "image-generation",
         input: prompt,
         model,
@@ -30,6 +31,6 @@ function generateImage(model, prompt, options) {
                 extractedValue: result.base64Image,
             };
         },
-    });
+    }));
 }
 exports.generateImage = generateImage;

package/model-function/generate-image/generateImage.d.ts

@@ -1,6 +1,6 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { ModelFunctionPromise } from "../executeCall.js";
 import { ImageGenerationModel, ImageGenerationModelSettings } from "./ImageGenerationModel.js";
+import { ImageGenerationPromise } from "./ImageGenerationPromise.js";
 /**
  * Generates a base64-encoded image using a prompt.
  * The prompt format depends on the model.
@@ -16,4 +16,4 @@ import { ImageGenerationModel, ImageGenerationModelSettings } from "./ImageGener
  *   ]
  * );
  */
-export declare function generateImage<PROMPT>(model: ImageGenerationModel<PROMPT, ImageGenerationModelSettings>, prompt: PROMPT, options?: FunctionOptions): ModelFunctionPromise<string>;
+export declare function generateImage<PROMPT>(model: ImageGenerationModel<PROMPT, ImageGenerationModelSettings>, prompt: PROMPT, options?: FunctionOptions): ImageGenerationPromise;

package/model-function/generate-image/generateImage.js

@@ -1,4 +1,5 @@
 import { executeCall } from "../executeCall.js";
+import { ImageGenerationPromise } from "./ImageGenerationPromise.js";
 /**
  * Generates a base64-encoded image using a prompt.
  * The prompt format depends on the model.
@@ -15,7 +16,7 @@ import { executeCall } from "../executeCall.js";
  * );
  */
 export function generateImage(model, prompt, options) {
-    return executeCall({
+    return new ImageGenerationPromise(executeCall({
         functionType: "image-generation",
         input: prompt,
         model,
@@ -27,5 +28,5 @@ export function generateImage(model, prompt, options) {
                 extractedValue: result.base64Image,
             };
         },
-    });
+    }));
 }

package/model-function/generate-structure/generateStructure.cjs

@@ -2,13 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateStructure = void 0;
 const executeCall_js_1 = require("../executeCall.cjs");
+const ModelFunctionPromise_js_1 = require("../ModelFunctionPromise.cjs");
 const StructureValidationError_js_1 = require("./StructureValidationError.cjs");
 function generateStructure(model, structureDefinition, prompt, options) {
     // Note: PROMPT must not be a function.
     const expandedPrompt = typeof prompt === "function"
         ? prompt(structureDefinition)
         : prompt;
-    return (0, executeCall_js_1.executeCall)({
+    return new ModelFunctionPromise_js_1.ModelFunctionPromise((0, executeCall_js_1.executeCall)({
         functionType: "structure-generation",
         input: expandedPrompt,
         model,
@@ -32,6 +33,6 @@ function generateStructure(model, structureDefinition, prompt, options) {
                 usage: result.usage,
             };
         },
-    });
+    }));
 }
 exports.generateStructure = generateStructure;

package/model-function/generate-structure/generateStructure.d.ts

@@ -1,5 +1,5 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
 import { StructureDefinition } from "../../core/structure/StructureDefinition.js";
-import { ModelFunctionPromise } from "../executeCall.js";
+import { ModelFunctionPromise } from "../ModelFunctionPromise.js";
 import { StructureGenerationModel, StructureGenerationModelSettings } from "./StructureGenerationModel.js";
 export declare function generateStructure<STRUCTURE, PROMPT, NAME extends string, SETTINGS extends StructureGenerationModelSettings>(model: StructureGenerationModel<PROMPT, SETTINGS>, structureDefinition: StructureDefinition<NAME, STRUCTURE>, prompt: PROMPT | ((structureDefinition: StructureDefinition<NAME, STRUCTURE>) => PROMPT), options?: FunctionOptions): ModelFunctionPromise<STRUCTURE>;

package/model-function/generate-structure/generateStructure.js

@@ -1,11 +1,12 @@
 import { executeCall } from "../executeCall.js";
+import { ModelFunctionPromise } from "../ModelFunctionPromise.js";
 import { StructureValidationError } from "./StructureValidationError.js";
 export function generateStructure(model, structureDefinition, prompt, options) {
     // Note: PROMPT must not be a function.
     const expandedPrompt = typeof prompt === "function"
         ? prompt(structureDefinition)
         : prompt;
-    return executeCall({
+    return new ModelFunctionPromise(executeCall({
         functionType: "structure-generation",
         input: expandedPrompt,
         model,
@@ -29,5 +30,5 @@ export function generateStructure(model, structureDefinition, prompt, options) {
                 usage: result.usage,
             };
         },
-    });
+    }));
 }

package/model-function/generate-structure/generateStructureOrText.cjs

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateStructureOrText = void 0;
 const executeCall_js_1 = require("../executeCall.cjs");
+const ModelFunctionPromise_js_1 = require("../ModelFunctionPromise.cjs");
 const NoSuchStructureError_js_1 = require("./NoSuchStructureError.cjs");
 const StructureValidationError_js_1 = require("./StructureValidationError.cjs");
 function generateStructureOrText(model, structureDefinitions, prompt, options) {
@@ -9,7 +10,7 @@ function generateStructureOrText(model, structureDefinitions, prompt, options) {
     const expandedPrompt = typeof prompt === "function"
         ? prompt(structureDefinitions)
         : prompt;
-    return (0, executeCall_js_1.executeCall)({
+    return new ModelFunctionPromise_js_1.ModelFunctionPromise((0, executeCall_js_1.executeCall)({
         functionType: "structure-or-text-generation",
         input: expandedPrompt,
         model,
@@ -48,6 +49,6 @@ function generateStructureOrText(model, structureDefinitions, prompt, options) {
                 usage: result.usage,
             };
         },
-    });
+    }));
 }
 exports.generateStructureOrText = generateStructureOrText;

package/model-function/generate-structure/generateStructureOrText.d.ts

@@ -1,6 +1,6 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
 import { StructureDefinition } from "../../core/structure/StructureDefinition.js";
-import { ModelFunctionPromise } from "../executeCall.js";
+import { ModelFunctionPromise } from "../ModelFunctionPromise.js";
 import { StructureOrTextGenerationModel, StructureOrTextGenerationModelSettings } from "./StructureOrTextGenerationModel.js";
 type StructureDefinitionArray<T extends StructureDefinition<any, any>[]> = T;
 type ToStructureDefinitionMap<T extends StructureDefinitionArray<StructureDefinition<any, any>[]>> = {

package/model-function/generate-structure/generateStructureOrText.js

@@ -1,4 +1,5 @@
 import { executeCall } from "../executeCall.js";
+import { ModelFunctionPromise } from "../ModelFunctionPromise.js";
 import { NoSuchStructureError } from "./NoSuchStructureError.js";
 import { StructureValidationError } from "./StructureValidationError.js";
 export function generateStructureOrText(model, structureDefinitions, prompt, options) {
@@ -6,7 +7,7 @@ export function generateStructureOrText(model, structureDefinitions, prompt, opt
     const expandedPrompt = typeof prompt === "function"
         ? prompt(structureDefinitions)
         : prompt;
-    return executeCall({
+    return new ModelFunctionPromise(executeCall({
         functionType: "structure-or-text-generation",
         input: expandedPrompt,
         model,
@@ -45,5 +46,5 @@ export function generateStructureOrText(model, structureDefinitions, prompt, opt
                 usage: result.usage,
             };
         },
-    });
+    }));
 }

package/{prompt → model-function/generate-text}/AlpacaPromptFormat.d.ts

@@ -1,5 +1,5 @@
 import { InstructionPrompt } from "./InstructionPrompt.js";
-import { PromptFormat } from "./PromptFormat.js";
+import { TextGenerationPromptFormat } from "./TextGenerationPromptFormat.js";
 /**
  * Formats an instruction prompt as an Alpaca prompt.
  *
@@ -8,4 +8,4 @@ import { PromptFormat } from "./PromptFormat.js";
  *
  * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
  */
-export declare function mapInstructionPromptToAlpacaFormat(): PromptFormat<InstructionPrompt, string>;
+export declare function mapInstructionPromptToAlpacaFormat(): TextGenerationPromptFormat<InstructionPrompt, string>;

package/{prompt → model-function/generate-text}/Llama2PromptFormat.cjs

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapChatPromptToLlama2Format = exports.mapInstructionPromptToLlama2Format = void 0;
-const validateChatPrompt_js_1 = require("./chat/validateChatPrompt.cjs");
+const validateChatPrompt_js_1 = require("./validateChatPrompt.cjs");
 // see https://github.com/facebookresearch/llama/blob/6c7fe276574e78057f917549435a2554000a876d/llama/generation.py#L44
 const BEGIN_SEGMENT = "<s>";
 const END_SEGMENT = "</s>\n";

package/model-function/generate-text/Llama2PromptFormat.d.ts

@@ -0,0 +1,13 @@
+import { ChatPrompt } from "./ChatPrompt.js";
+import { InstructionPrompt } from "./InstructionPrompt.js";
+import { TextGenerationPromptFormat } from "./TextGenerationPromptFormat.js";
+/**
+ * Formats an instruction prompt as a Llama 2 prompt.
+ *
+ * @see https://www.philschmid.de/llama-2#how-to-prompt-llama-2-chat
+ */
+export declare function mapInstructionPromptToLlama2Format(): TextGenerationPromptFormat<InstructionPrompt, string>;
+/**
+ * Formats a chat prompt as a Llama 2 prompt.
+ */
+export declare function mapChatPromptToLlama2Format(): TextGenerationPromptFormat<ChatPrompt, string>;

package/{prompt → model-function/generate-text}/Llama2PromptFormat.js

@@ -1,4 +1,4 @@
-import { validateChatPrompt } from "./chat/validateChatPrompt.js";
+import { validateChatPrompt } from "./validateChatPrompt.js";
 // see https://github.com/facebookresearch/llama/blob/6c7fe276574e78057f917549435a2554000a876d/llama/generation.py#L44
 const BEGIN_SEGMENT = "<s>";
 const END_SEGMENT = "</s>\n";

package/{prompt → model-function/generate-text}/PromptFormatTextGenerationModel.d.ts

@@ -1,14 +1,14 @@
-import { FunctionOptions } from "../core/FunctionOptions.js";
-import { TextGenerationModel, TextGenerationModelSettings } from "../model-function/generate-text/TextGenerationModel.js";
-import { PromptFormat } from "./PromptFormat.js";
+import { FunctionOptions } from "../../core/FunctionOptions.js";
+import { TextGenerationModel, TextGenerationModelSettings } from "./TextGenerationModel.js";
+import { TextGenerationPromptFormat } from "./TextGenerationPromptFormat.js";
 export declare class PromptFormatTextGenerationModel<PROMPT, MODEL_PROMPT, SETTINGS extends TextGenerationModelSettings, MODEL extends TextGenerationModel<MODEL_PROMPT, SETTINGS>> implements TextGenerationModel<PROMPT, SETTINGS> {
     readonly model: MODEL;
-    readonly promptFormat: PromptFormat<PROMPT, MODEL_PROMPT>;
+    readonly promptFormat: TextGenerationPromptFormat<PROMPT, MODEL_PROMPT>;
     constructor({ model, promptFormat, }: {
         model: MODEL;
-        promptFormat: PromptFormat<PROMPT, MODEL_PROMPT>;
+        promptFormat: TextGenerationPromptFormat<PROMPT, MODEL_PROMPT>;
     });
-    get modelInformation(): import("../index.js").ModelInformation;
+    get modelInformation(): import("../ModelInformation.js").ModelInformation;
     get settings(): SETTINGS;
     get tokenizer(): MODEL["tokenizer"];
     get contextWindowSize(): MODEL["contextWindowSize"];
@@ -23,6 +23,6 @@ export declare class PromptFormatTextGenerationModel<PROMPT, MODEL_PROMPT, SETTI
         } | undefined;
     }>;
     get settingsForEvent(): Partial<SETTINGS>;
-    withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, PROMPT>): PromptFormatTextGenerationModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
+    withPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, PROMPT>): PromptFormatTextGenerationModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
     withSettings(additionalSettings: Partial<SETTINGS>): this;
 }

package/{prompt → model-function/generate-text}/PromptFormatTextStreamingModel.d.ts

@@ -1,13 +1,13 @@
-import { FunctionOptions } from "../core/FunctionOptions.js";
-import { TextGenerationModelSettings, TextStreamingModel } from "../model-function/generate-text/TextGenerationModel.js";
-import { PromptFormat } from "./PromptFormat.js";
+import { FunctionOptions } from "../../core/FunctionOptions.js";
 import { PromptFormatTextGenerationModel } from "./PromptFormatTextGenerationModel.js";
+import { TextGenerationModelSettings, TextStreamingModel } from "./TextGenerationModel.js";
+import { TextGenerationPromptFormat } from "./TextGenerationPromptFormat.js";
 export declare class PromptFormatTextStreamingModel<PROMPT, MODEL_PROMPT, SETTINGS extends TextGenerationModelSettings, MODEL extends TextStreamingModel<MODEL_PROMPT, SETTINGS>> extends PromptFormatTextGenerationModel<PROMPT, MODEL_PROMPT, SETTINGS, MODEL> implements TextStreamingModel<PROMPT, SETTINGS> {
     constructor(options: {
         model: MODEL;
-        promptFormat: PromptFormat<PROMPT, MODEL_PROMPT>;
+        promptFormat: TextGenerationPromptFormat<PROMPT, MODEL_PROMPT>;
     });
-    doStreamText(prompt: PROMPT, options?: FunctionOptions): PromiseLike<AsyncIterable<import("../index.js").Delta<string>>>;
-    withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, PROMPT>): PromptFormatTextStreamingModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
+    doStreamText(prompt: PROMPT, options?: FunctionOptions): PromiseLike<AsyncIterable<import("../Delta.js").Delta<string>>>;
+    withPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, PROMPT>): PromptFormatTextStreamingModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
     withSettings(additionalSettings: Partial<SETTINGS>): this;
 }

package/model-function/generate-text/TextGenerationModel.d.ts

@@ -1,8 +1,8 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { PromptFormat } from "../../prompt/PromptFormat.js";
 import { Delta } from "../Delta.js";
 import { Model, ModelSettings } from "../Model.js";
 import { BasicTokenizer, FullTokenizer } from "../tokenize-text/Tokenizer.js";
+import { TextGenerationPromptFormat } from "./TextGenerationPromptFormat.js";
 export interface TextGenerationModelSettings extends ModelSettings {
     /**
      * Maximum number of tokens to generate.
@@ -20,6 +20,13 @@ export interface TextGenerationModelSettings extends ModelSettings {
      */
     trimWhitespace?: boolean;
 }
+export interface HasContextWindowSize {
+    contextWindowSize: number;
+}
+export interface HasTokenizer<PROMPT> {
+    tokenizer: BasicTokenizer | FullTokenizer;
+    countPromptTokens(prompt: PROMPT): PromiseLike<number>;
+}
 export interface TextGenerationModel<PROMPT, SETTINGS extends TextGenerationModelSettings = TextGenerationModelSettings> extends Model<SETTINGS> {
     readonly contextWindowSize: number | undefined;
     readonly tokenizer: BasicTokenizer | FullTokenizer | undefined;
@@ -36,9 +43,9 @@ export interface TextGenerationModel<PROMPT, SETTINGS extends TextGenerationMode
             totalTokens: number;
         };
     }>;
-    withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, PROMPT>): TextGenerationModel<INPUT_PROMPT, SETTINGS>;
+    withPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, PROMPT>): TextGenerationModel<INPUT_PROMPT, SETTINGS>;
 }
 export interface TextStreamingModel<PROMPT, SETTINGS extends TextGenerationModelSettings = TextGenerationModelSettings> extends TextGenerationModel<PROMPT, SETTINGS> {
     doStreamText(prompt: PROMPT, options?: FunctionOptions): PromiseLike<AsyncIterable<Delta<string>>>;
-    withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, PROMPT>): TextStreamingModel<INPUT_PROMPT, SETTINGS>;
+    withPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, PROMPT>): TextStreamingModel<INPUT_PROMPT, SETTINGS>;
 }

package/model-function/generate-text/TextGenerationPromptFormat.cjs

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

package/model-function/generate-text/TextGenerationPromptFormat.d.ts

@@ -0,0 +1,11 @@
+import { PromptFormat } from "../PromptFormat.js";
+/**
+ * Prompt formats format a source prompt into the structure of a target prompt.
+ */
+export interface TextGenerationPromptFormat<SOURCE_PROMPT, TARGET_PROMPT> extends PromptFormat<SOURCE_PROMPT, TARGET_PROMPT> {
+    /**
+     * The texts that should be used as default stop sequences.
+     * This is e.g. important for chat formats.
+     */
+    stopSequences: string[];
+}

package/model-function/generate-text/TextGenerationPromptFormat.js

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

package/{prompt → model-function/generate-text}/TextPromptFormat.cjs

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapChatPromptToTextFormat = exports.mapInstructionPromptToTextFormat = void 0;
-const validateChatPrompt_js_1 = require("./chat/validateChatPrompt.cjs");
+const validateChatPrompt_js_1 = require("./validateChatPrompt.cjs");
 /**
  * Formats an instruction prompt as a basic text prompt.
  */
@@ -26,7 +26,7 @@ exports.mapInstructionPromptToTextFormat = mapInstructionPromptToTextFormat;
  * @param user The label of the user in the chat.
  * @param ai The name of the AI in the chat.
  */
-const mapChatPromptToTextFormat = ({ user, ai }) => ({
+const mapChatPromptToTextFormat = ({ user = "user", ai = "ai", } = {}) => ({
     format: (chatPrompt) => {
         (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
         let text = "";

package/model-function/generate-text/TextPromptFormat.d.ts

@@ -0,0 +1,17 @@
+import { ChatPrompt } from "./ChatPrompt.js";
+import { InstructionPrompt } from "./InstructionPrompt.js";
+import { TextGenerationPromptFormat } from "./TextGenerationPromptFormat.js";
+/**
+ * Formats an instruction prompt as a basic text prompt.
+ */
+export declare const mapInstructionPromptToTextFormat: () => TextGenerationPromptFormat<InstructionPrompt, string>;
+/**
+ * Formats a chat prompt as a basic text prompt.
+ *
+ * @param user The label of the user in the chat.
+ * @param ai The name of the AI in the chat.
+ */
+export declare const mapChatPromptToTextFormat: (options?: {
+    user?: string;
+    ai?: string;
+}) => TextGenerationPromptFormat<ChatPrompt, string>;

package/{prompt → model-function/generate-text}/TextPromptFormat.js

@@ -1,4 +1,4 @@
-import { validateChatPrompt } from "./chat/validateChatPrompt.js";
+import { validateChatPrompt } from "./validateChatPrompt.js";
 /**
  * Formats an instruction prompt as a basic text prompt.
  */
@@ -22,7 +22,7 @@ export const mapInstructionPromptToTextFormat = () => ({
  * @param user The label of the user in the chat.
  * @param ai The name of the AI in the chat.
  */
-export const mapChatPromptToTextFormat = ({ user, ai }) => ({
+export const mapChatPromptToTextFormat = ({ user = "user", ai = "ai", } = {}) => ({
     format: (chatPrompt) => {
         validateChatPrompt(chatPrompt);
         let text = "";

package/{prompt → model-function/generate-text}/VicunaPromptFormat.cjs

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapChatPromptToVicunaFormat = void 0;
-const validateChatPrompt_js_1 = require("./chat/validateChatPrompt.cjs");
+const validateChatPrompt_js_1 = require("./validateChatPrompt.cjs");
 const DEFAULT_SYSTEM_PROMPT = "A chat between a curious user and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the user's questions.";
 /**
  * Formats a chat prompt as a Vicuna prompt.

package/{prompt → model-function/generate-text}/VicunaPromptFormat.d.ts

@@ -1,5 +1,5 @@
-import { PromptFormat } from "./PromptFormat.js";
-import { ChatPrompt } from "./chat/ChatPrompt.js";
+import { ChatPrompt } from "./ChatPrompt.js";
+import { TextGenerationPromptFormat } from "./TextGenerationPromptFormat.js";
 /**
  * Formats a chat prompt as a Vicuna prompt.
  *
@@ -13,4 +13,4 @@ import { ChatPrompt } from "./chat/ChatPrompt.js";
  * ASSISTANT:
  * ```
  */
-export declare function mapChatPromptToVicunaFormat(): PromptFormat<ChatPrompt, string>;
+export declare function mapChatPromptToVicunaFormat(): TextGenerationPromptFormat<ChatPrompt, string>;

package/{prompt → model-function/generate-text}/VicunaPromptFormat.js

@@ -1,4 +1,4 @@
-import { validateChatPrompt } from "./chat/validateChatPrompt.js";
+import { validateChatPrompt } from "./validateChatPrompt.js";
 const DEFAULT_SYSTEM_PROMPT = "A chat between a curious user and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the user's questions.";
 /**
  * Formats a chat prompt as a Vicuna prompt.