modelfusion 0.92.1 → 0.93.1

package/model-function/generate-text/{PromptFormatTextGenerationModel.js → PromptTemplateTextGenerationModel.js}

@@ -1,22 +1,22 @@
-import { StructureFromTextGenerationModel } from "../../model-function/generate-structure/StructureFromTextGenerationModel.js";
 import { TextGenerationToolCallModel, } from "../../tool/generate-tool-call/TextGenerationToolCallModel.js";
 import { TextGenerationToolCallsOrGenerateTextModel, } from "../../tool/generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.js";
-export class PromptFormatTextGenerationModel {
-    constructor({ model, promptFormat, }) {
+import { StructureFromTextGenerationModel } from "../generate-structure/StructureFromTextGenerationModel.js";
+export class PromptTemplateTextGenerationModel {
+    constructor({ model, promptTemplate, }) {
         Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "promptFormat", {
+        Object.defineProperty(this, "promptTemplate", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
         this.model = model;
-        this.promptFormat = promptFormat;
+        this.promptTemplate = promptTemplate;
     }
     get modelInformation() {
         return this.model.modelInformation;
@@ -35,48 +35,48 @@ export class PromptFormatTextGenerationModel {
         if (originalCountPromptTokens === undefined) {
             return undefined;
         }
-        return ((prompt) => originalCountPromptTokens(this.promptFormat.format(prompt)));
+        return ((prompt) => originalCountPromptTokens(this.promptTemplate.format(prompt)));
     }
     doGenerateText(prompt, options) {
-        const mappedPrompt = this.promptFormat.format(prompt);
+        const mappedPrompt = this.promptTemplate.format(prompt);
         return this.model.doGenerateText(mappedPrompt, options);
     }
     get settingsForEvent() {
         return this.model.settingsForEvent;
     }
-    asToolCallGenerationModel(promptFormat) {
+    asToolCallGenerationModel(promptTemplate) {
         return new TextGenerationToolCallModel({
             model: this,
-            format: promptFormat,
+            format: promptTemplate,
         });
     }
-    asToolCallsOrTextGenerationModel(promptFormat) {
+    asToolCallsOrTextGenerationModel(promptTemplate) {
         return new TextGenerationToolCallsOrGenerateTextModel({
             model: this,
-            format: promptFormat,
+            template: promptTemplate,
         });
     }
-    asStructureGenerationModel(promptFormat) {
+    asStructureGenerationModel(promptTemplate) {
         return new StructureFromTextGenerationModel({
             model: this,
-            format: promptFormat,
+            template: promptTemplate,
         });
     }
-    withPromptFormat(promptFormat) {
-        return new PromptFormatTextGenerationModel({
+    withPromptTemplate(promptTemplate) {
+        return new PromptTemplateTextGenerationModel({
             model: this.withSettings({
                 stopSequences: [
                     ...(this.settings.stopSequences ?? []),
-                    ...promptFormat.stopSequences,
+                    ...promptTemplate.stopSequences,
                 ],
             }),
-            promptFormat,
+            promptTemplate,
         });
     }
     withSettings(additionalSettings) {
-        return new PromptFormatTextGenerationModel({
+        return new PromptTemplateTextGenerationModel({
             model: this.model.withSettings(additionalSettings),
-            promptFormat: this.promptFormat,
+            promptTemplate: this.promptTemplate,
         });
     }
 }

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

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromptTemplateTextStreamingModel = void 0;
+const StructureFromTextStreamingModel_js_1 = require("../generate-structure/StructureFromTextStreamingModel.cjs");
+const PromptTemplateTextGenerationModel_js_1 = require("./PromptTemplateTextGenerationModel.cjs");
+class PromptTemplateTextStreamingModel extends PromptTemplateTextGenerationModel_js_1.PromptTemplateTextGenerationModel {
+    constructor(options) {
+        super(options);
+    }
+    doStreamText(prompt, options) {
+        const mappedPrompt = this.promptTemplate.format(prompt);
+        return this.model.doStreamText(mappedPrompt, options);
+    }
+    asStructureGenerationModel(promptTemplate) {
+        return new StructureFromTextStreamingModel_js_1.StructureFromTextStreamingModel({
+            model: this,
+            template: promptTemplate,
+        });
+    }
+    withPromptTemplate(promptTemplate) {
+        return new PromptTemplateTextStreamingModel({
+            model: this.withSettings({
+                stopSequences: [
+                    ...(this.settings.stopSequences ?? []),
+                    ...promptTemplate.stopSequences,
+                ],
+            }),
+            promptTemplate,
+        });
+    }
+    withSettings(additionalSettings) {
+        return new PromptTemplateTextStreamingModel({
+            model: this.model.withSettings(additionalSettings),
+            promptTemplate: this.promptTemplate,
+        });
+    }
+}
+exports.PromptTemplateTextStreamingModel = PromptTemplateTextStreamingModel;

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

@@ -0,0 +1,16 @@
+import { FunctionOptions } from "../../core/FunctionOptions.js";
+import { StructureFromTextPromptTemplate } from "../generate-structure/StructureFromTextPromptTemplate.js";
+import { StructureFromTextStreamingModel } from "../generate-structure/StructureFromTextStreamingModel.js";
+import { PromptTemplateTextGenerationModel } from "./PromptTemplateTextGenerationModel.js";
+import { TextGenerationModelSettings, TextStreamingModel } from "./TextGenerationModel.js";
+import { TextGenerationPromptTemplate } from "./TextGenerationPromptTemplate.js";
+export declare class PromptTemplateTextStreamingModel<PROMPT, MODEL_PROMPT, SETTINGS extends TextGenerationModelSettings, MODEL extends TextStreamingModel<MODEL_PROMPT, SETTINGS>> extends PromptTemplateTextGenerationModel<PROMPT, MODEL_PROMPT, SETTINGS, MODEL> implements TextStreamingModel<PROMPT, SETTINGS> {
+    constructor(options: {
+        model: MODEL;
+        promptTemplate: TextGenerationPromptTemplate<PROMPT, MODEL_PROMPT>;
+    });
+    doStreamText(prompt: PROMPT, options?: FunctionOptions): PromiseLike<AsyncIterable<import("../Delta.js").Delta<string>>>;
+    asStructureGenerationModel<INPUT_PROMPT>(promptTemplate: StructureFromTextPromptTemplate<INPUT_PROMPT, PROMPT>): StructureFromTextStreamingModel<INPUT_PROMPT, PROMPT, this>;
+    withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, PROMPT>): PromptTemplateTextStreamingModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
+    withSettings(additionalSettings: Partial<SETTINGS>): this;
+}

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

@@ -0,0 +1,34 @@
+import { StructureFromTextStreamingModel } from "../generate-structure/StructureFromTextStreamingModel.js";
+import { PromptTemplateTextGenerationModel } from "./PromptTemplateTextGenerationModel.js";
+export class PromptTemplateTextStreamingModel extends PromptTemplateTextGenerationModel {
+    constructor(options) {
+        super(options);
+    }
+    doStreamText(prompt, options) {
+        const mappedPrompt = this.promptTemplate.format(prompt);
+        return this.model.doStreamText(mappedPrompt, options);
+    }
+    asStructureGenerationModel(promptTemplate) {
+        return new StructureFromTextStreamingModel({
+            model: this,
+            template: promptTemplate,
+        });
+    }
+    withPromptTemplate(promptTemplate) {
+        return new PromptTemplateTextStreamingModel({
+            model: this.withSettings({
+                stopSequences: [
+                    ...(this.settings.stopSequences ?? []),
+                    ...promptTemplate.stopSequences,
+                ],
+            }),
+            promptTemplate,
+        });
+    }
+    withSettings(additionalSettings) {
+        return new PromptTemplateTextStreamingModel({
+            model: this.model.withSettings(additionalSettings),
+            promptTemplate: this.promptTemplate,
+        });
+    }
+}

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

@@ -2,7 +2,7 @@ import { FunctionOptions } from "../../core/FunctionOptions.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";
+import { TextGenerationPromptTemplate } from "./TextGenerationPromptTemplate.js";
 export interface TextGenerationModelSettings extends ModelSettings {
     /**
      * Maximum number of tokens to generate.
@@ -43,9 +43,9 @@ export interface TextGenerationModel<PROMPT, SETTINGS extends TextGenerationMode
             totalTokens: number;
         };
     }>;
-    withPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, PROMPT>): TextGenerationModel<INPUT_PROMPT, SETTINGS>;
+    withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<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: TextGenerationPromptFormat<INPUT_PROMPT, PROMPT>): TextStreamingModel<INPUT_PROMPT, SETTINGS>;
+    withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, PROMPT>): TextStreamingModel<INPUT_PROMPT, SETTINGS>;
 }

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

@@ -0,0 +1,11 @@
+import { PromptTemplate } from "../PromptTemplate.js";
+/**
+ * Prompt templates format a source prompt into the structure of a target prompt.
+ */
+export interface TextGenerationPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT> extends PromptTemplate<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/index.cjs

@@ -14,11 +14,11 @@ 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("./PromptFormatTextGenerationModel.cjs"), exports);
-__exportStar(require("./PromptFormatTextStreamingModel.cjs"), exports);
+__exportStar(require("./PromptTemplateTextGenerationModel.cjs"), exports);
+__exportStar(require("./PromptTemplateTextStreamingModel.cjs"), exports);
 __exportStar(require("./TextGenerationEvent.cjs"), exports);
 __exportStar(require("./TextGenerationModel.cjs"), exports);
-__exportStar(require("./TextGenerationPromptFormat.cjs"), exports);
+__exportStar(require("./TextGenerationPromptTemplate.cjs"), exports);
 __exportStar(require("./generateText.cjs"), exports);
-__exportStar(require("./prompt-format/index.cjs"), exports);
+__exportStar(require("./prompt-template/index.cjs"), exports);
 __exportStar(require("./streamText.cjs"), exports);

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

@@ -1,8 +1,8 @@
-export * from "./PromptFormatTextGenerationModel.js";
-export * from "./PromptFormatTextStreamingModel.js";
+export * from "./PromptTemplateTextGenerationModel.js";
+export * from "./PromptTemplateTextStreamingModel.js";
 export * from "./TextGenerationEvent.js";
 export * from "./TextGenerationModel.js";
-export * from "./TextGenerationPromptFormat.js";
+export * from "./TextGenerationPromptTemplate.js";
 export * from "./generateText.js";
-export * from "./prompt-format/index.js";
+export * from "./prompt-template/index.js";
 export * from "./streamText.js";

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

@@ -1,8 +1,8 @@
-export * from "./PromptFormatTextGenerationModel.js";
-export * from "./PromptFormatTextStreamingModel.js";
+export * from "./PromptTemplateTextGenerationModel.js";
+export * from "./PromptTemplateTextStreamingModel.js";
 export * from "./TextGenerationEvent.js";
 export * from "./TextGenerationModel.js";
-export * from "./TextGenerationPromptFormat.js";
+export * from "./TextGenerationPromptTemplate.js";
 export * from "./generateText.js";
-export * from "./prompt-format/index.js";
+export * from "./prompt-template/index.js";
 export * from "./streamText.js";

package/model-function/generate-text/{prompt-format/AlpacaPromptFormat.cjs → prompt-template/AlpacaPromptTemplate.cjs}

@@ -25,7 +25,7 @@ exports.text = text;
  * If the instruction has a system prompt, it overrides the default system prompt
  * (which can impact the results, because the model may be trained on the default system prompt).
  *
- * Prompt format with input:
+ * Prompt template with input:
  * ```
  * Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
  *
@@ -41,7 +41,7 @@ exports.text = text;
  *
  * ```
  *
- * Prompt format without input:
+ * Prompt template without input:
  * ```
  * Below is an instruction that describes a task. Write a response that appropriately completes the request.
  *
@@ -72,6 +72,9 @@ function instruction() {
                 text += `\n\n### Input:\n${prompt.input}`;
             }
             text += "\n\n### Response:\n";
+            if (prompt.responsePrefix != null) {
+                text += `${prompt.responsePrefix}\n`;
+            }
             return text;
         },
     };

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

@@ -1,16 +1,16 @@
-import { TextGenerationPromptFormat } from "../TextGenerationPromptFormat.js";
+import { TextGenerationPromptTemplate } from "../TextGenerationPromptTemplate.js";
 import { TextInstructionPrompt } from "./InstructionPrompt.js";
 /**
  * Formats a text prompt as an Alpaca prompt.
  */
-export declare function text(): TextGenerationPromptFormat<string, string>;
+export declare function text(): TextGenerationPromptTemplate<string, string>;
 /**
  * Formats an instruction prompt as an Alpaca prompt.
  *
  * If the instruction has a system prompt, it overrides the default system prompt
  * (which can impact the results, because the model may be trained on the default system prompt).
  *
- * Prompt format with input:
+ * Prompt template with input:
  * ```
  * Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
  *
@@ -26,7 +26,7 @@ export declare function text(): TextGenerationPromptFormat<string, string>;
  *
  * ```
  *
- * Prompt format without input:
+ * Prompt template without input:
  * ```
  * Below is an instruction that describes a task. Write a response that appropriately completes the request.
  *
@@ -40,7 +40,7 @@ export declare function text(): TextGenerationPromptFormat<string, string>;
  *
  * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
  */
-export declare function instruction(): TextGenerationPromptFormat<TextInstructionPrompt & {
+export declare function instruction(): TextGenerationPromptTemplate<TextInstructionPrompt & {
     input?: string;
 }, // optional input supported by Alpaca
 string>;

package/model-function/generate-text/{prompt-format/AlpacaPromptFormat.js → prompt-template/AlpacaPromptTemplate.js}

@@ -21,7 +21,7 @@ export function text() {
  * If the instruction has a system prompt, it overrides the default system prompt
  * (which can impact the results, because the model may be trained on the default system prompt).
  *
- * Prompt format with input:
+ * Prompt template with input:
  * ```
  * Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
  *
@@ -37,7 +37,7 @@ export function text() {
  *
  * ```
  *
- * Prompt format without input:
+ * Prompt template without input:
  * ```
  * Below is an instruction that describes a task. Write a response that appropriately completes the request.
  *
@@ -68,6 +68,9 @@ export function instruction() {
                 text += `\n\n### Input:\n${prompt.input}`;
             }
             text += "\n\n### Response:\n";
+            if (prompt.responsePrefix != null) {
+                text += `${prompt.responsePrefix}\n`;
+            }
             return text;
         },
     };

package/model-function/generate-text/prompt-template/AlpacaPromptTemplate.test.cjs

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const AlpacaPromptTemplate_js_1 = require("./AlpacaPromptTemplate.cjs");
+describe("text prompt", () => {
+    it("should format prompt", () => {
+        const prompt = (0, AlpacaPromptTemplate_js_1.text)().format("prompt");
+        expect(prompt).toMatchSnapshot();
+    });
+});
+describe("instruction prompt", () => {
+    it("should format prompt with instruction", () => {
+        const prompt = (0, AlpacaPromptTemplate_js_1.instruction)().format({
+            instruction: "instruction",
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+    it("should format prompt with system and instruction", () => {
+        const prompt = (0, AlpacaPromptTemplate_js_1.instruction)().format({
+            system: "system",
+            instruction: "instruction",
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+    it("should format prompt with instruction and response prefix", () => {
+        const prompt = (0, AlpacaPromptTemplate_js_1.instruction)().format({
+            instruction: "instruction",
+            responsePrefix: "response prefix",
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+});

package/model-function/generate-text/prompt-template/AlpacaPromptTemplate.test.js

@@ -0,0 +1,29 @@
+import { instruction, text } from "./AlpacaPromptTemplate.js";
+describe("text prompt", () => {
+    it("should format prompt", () => {
+        const prompt = text().format("prompt");
+        expect(prompt).toMatchSnapshot();
+    });
+});
+describe("instruction prompt", () => {
+    it("should format prompt with instruction", () => {
+        const prompt = instruction().format({
+            instruction: "instruction",
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+    it("should format prompt with system and instruction", () => {
+        const prompt = instruction().format({
+            system: "system",
+            instruction: "instruction",
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+    it("should format prompt with instruction and response prefix", () => {
+        const prompt = instruction().format({
+            instruction: "instruction",
+            responsePrefix: "response prefix",
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+});

package/model-function/generate-text/{prompt-format/ChatMLPromptFormat.cjs → prompt-template/ChatMLPromptTemplate.cjs}

@@ -29,11 +29,11 @@ exports.text = text;
  * ChatML prompt template:
  * ```
  * <|im_start|>system
- * You are a helpful assistant that answers questions about the world.<|im_end|>
+ * ${ system prompt }<|im_end|>
  * <|im_start|>user
- * What is the capital of France?<|im_end|>
+ * ${ instruction }<|im_end|>
  * <|im_start|>assistant
- * Paris<|im_end|>
+ * ${response prefix}
  * ```
  */
 function instruction() {
@@ -42,8 +42,8 @@ function instruction() {
         format(prompt) {
             return (chatMLSegment("system", prompt.system) +
                 chatMLSegment("user", prompt.instruction) +
-                chatMLStart("assistant") // prefix start of assistant response
-            );
+                chatMLStart("assistant") +
+                (prompt.responsePrefix ?? ""));
         },
     };
 }

package/model-function/generate-text/{prompt-format/ChatMLPromptFormat.d.ts → prompt-template/ChatMLPromptTemplate.d.ts}

@@ -1,24 +1,24 @@
-import { TextGenerationPromptFormat } from "../TextGenerationPromptFormat.js";
+import { TextGenerationPromptTemplate } from "../TextGenerationPromptTemplate.js";
 import { TextChatPrompt } from "./ChatPrompt.js";
 import { TextInstructionPrompt } from "./InstructionPrompt.js";
 /**
  * Formats a text prompt using the ChatML format.
  */
-export declare function text(): TextGenerationPromptFormat<string, string>;
+export declare function text(): TextGenerationPromptTemplate<string, string>;
 /**
  * Formats an instruction prompt using the ChatML format.
  *
  * ChatML prompt template:
  * ```
  * <|im_start|>system
- * You are a helpful assistant that answers questions about the world.<|im_end|>
+ * ${ system prompt }<|im_end|>
  * <|im_start|>user
- * What is the capital of France?<|im_end|>
+ * ${ instruction }<|im_end|>
  * <|im_start|>assistant
- * Paris<|im_end|>
+ * ${response prefix}
  * ```
  */
-export declare function instruction(): TextGenerationPromptFormat<TextInstructionPrompt, string>;
+export declare function instruction(): TextGenerationPromptTemplate<TextInstructionPrompt, string>;
 /**
  * Formats a chat prompt using the ChatML format.
  *
@@ -32,4 +32,4 @@ export declare function instruction(): TextGenerationPromptFormat<TextInstructio
  * Paris<|im_end|>
  * ```
  */
-export declare function chat(): TextGenerationPromptFormat<TextChatPrompt, string>;
+export declare function chat(): TextGenerationPromptTemplate<TextChatPrompt, string>;

package/model-function/generate-text/{prompt-format/ChatMLPromptFormat.js → prompt-template/ChatMLPromptTemplate.js}

@@ -25,11 +25,11 @@ export function text() {
  * ChatML prompt template:
  * ```
  * <|im_start|>system
- * You are a helpful assistant that answers questions about the world.<|im_end|>
+ * ${ system prompt }<|im_end|>
  * <|im_start|>user
- * What is the capital of France?<|im_end|>
+ * ${ instruction }<|im_end|>
  * <|im_start|>assistant
- * Paris<|im_end|>
+ * ${response prefix}
  * ```
  */
 export function instruction() {
@@ -38,8 +38,8 @@ export function instruction() {
         format(prompt) {
             return (chatMLSegment("system", prompt.system) +
                 chatMLSegment("user", prompt.instruction) +
-                chatMLStart("assistant") // prefix start of assistant response
-            );
+                chatMLStart("assistant") +
+                (prompt.responsePrefix ?? ""));
         },
     };
 }

package/model-function/generate-text/prompt-template/ChatMLPromptTemplate.test.cjs

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ChatMLPromptTemplate_js_1 = require("./ChatMLPromptTemplate.cjs");
+describe("text prompt", () => {
+    it("should format prompt", () => {
+        const prompt = (0, ChatMLPromptTemplate_js_1.text)().format("prompt");
+        expect(prompt).toMatchSnapshot();
+    });
+});
+describe("instruction prompt", () => {
+    it("should format prompt with instruction", () => {
+        const prompt = (0, ChatMLPromptTemplate_js_1.instruction)().format({
+            instruction: "instruction",
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+    it("should format prompt with system and instruction", () => {
+        const prompt = (0, ChatMLPromptTemplate_js_1.instruction)().format({
+            system: "system",
+            instruction: "instruction",
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+    it("should format prompt with instruction and response prefix", () => {
+        const prompt = (0, ChatMLPromptTemplate_js_1.instruction)().format({
+            instruction: "instruction",
+            responsePrefix: "response prefix",
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+});
+describe("chat prompt", () => {
+    it("should format prompt with user message", () => {
+        const prompt = (0, ChatMLPromptTemplate_js_1.chat)().format({
+            messages: [{ role: "user", content: "user message" }],
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+    it("should format prompt with user-assistant-user messages", () => {
+        const prompt = (0, ChatMLPromptTemplate_js_1.chat)().format({
+            messages: [
+                { role: "user", content: "1st user message" },
+                { role: "assistant", content: "assistant message" },
+                { role: "user", content: "2nd user message" },
+            ],
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+});

package/model-function/generate-text/prompt-template/ChatMLPromptTemplate.test.js

@@ -0,0 +1,47 @@
+import { chat, instruction, text } from "./ChatMLPromptTemplate.js";
+describe("text prompt", () => {
+    it("should format prompt", () => {
+        const prompt = text().format("prompt");
+        expect(prompt).toMatchSnapshot();
+    });
+});
+describe("instruction prompt", () => {
+    it("should format prompt with instruction", () => {
+        const prompt = instruction().format({
+            instruction: "instruction",
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+    it("should format prompt with system and instruction", () => {
+        const prompt = instruction().format({
+            system: "system",
+            instruction: "instruction",
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+    it("should format prompt with instruction and response prefix", () => {
+        const prompt = instruction().format({
+            instruction: "instruction",
+            responsePrefix: "response prefix",
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+});
+describe("chat prompt", () => {
+    it("should format prompt with user message", () => {
+        const prompt = chat().format({
+            messages: [{ role: "user", content: "user message" }],
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+    it("should format prompt with user-assistant-user messages", () => {
+        const prompt = chat().format({
+            messages: [
+                { role: "user", content: "1st user message" },
+                { role: "assistant", content: "assistant message" },
+                { role: "user", content: "2nd user message" },
+            ],
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+});

package/model-function/generate-text/{prompt-format → prompt-template}/ChatPrompt.d.ts

@@ -9,7 +9,7 @@ import { MultiModalInput } from "./Content.js";
  *
  * You can use a ChatPrompt without an final user message when you e.g. want to display the current state of a conversation.
  *
- * The type checking is done at runtime when you submit a chat prompt to a model with a prompt format.
+ * The type checking is done at runtime when you submit a chat prompt to a model with a prompt template.
  *
  * @example
  * ```ts

package/model-function/generate-text/prompt-template/Content.js

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

package/model-function/generate-text/{prompt-format → prompt-template}/InstructionPrompt.d.ts

@@ -37,4 +37,11 @@ export interface TextInstructionPrompt {
      * The text instruction for the model.
      */
     instruction: string;
+    /**
+     * Response prefix that will be injected in the prompt at the beginning of the response.
+     * This is useful for guiding the model by starting its response with a specific text.
+     *
+     * Note: Not all models support this feature. E.g. it is not supported by OpenAI chat models.
+     */
+    responsePrefix?: string;
 }

package/model-function/generate-text/prompt-template/InstructionPrompt.js

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