modelfusion 0.13.0 → 0.15.0

package/prompt/{Llama2PromptMapping.cjs → Llama2PromptFormat.cjs}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatToLlama2PromptMapping = exports.InstructionToLlama2PromptMapping = void 0;
+exports.Llama2ChatPromptFormat = exports.Llama2InstructionPromptFormat = void 0;
 const validateChatPrompt_js_1 = require("./chat/validateChatPrompt.cjs");
 // see https://github.com/facebookresearch/llama/blob/6c7fe276574e78057f917549435a2554000a876d/llama/generation.py#L44
 const BEGIN_SEGMENT = "<s>";
@@ -10,19 +10,22 @@ const END_INSTRUCTION = "[/INST]\n";
 const BEGIN_SYSTEM = "<<SYS>>\n";
 const END_SYSTEM = "\n<</SYS>>\n\n";
 /**
- * Maps an instruction prompt to the Llama2 prompt format.
+ * Formats an instruction prompt as a Llama 2 prompt.
  *
  * @see https://www.philschmid.de/llama-2#how-to-prompt-llama-2-chat
  */
-const InstructionToLlama2PromptMapping = () => ({
-    stopTokens: [END_SEGMENT],
-    map: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction.system != null
+const Llama2InstructionPromptFormat = () => ({
+    stopSequences: [END_SEGMENT],
+    format: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction.system != null
         ? ` ${BEGIN_SYSTEM}${instruction.system}${END_SYSTEM}`
         : ""} ${instruction.instruction}${instruction.input != null ? `\n\n${instruction.input}` : ""} ${END_INSTRUCTION}\n`,
 });
-exports.InstructionToLlama2PromptMapping = InstructionToLlama2PromptMapping;
-const ChatToLlama2PromptMapping = () => ({
-    map: (chatPrompt) => {
+exports.Llama2InstructionPromptFormat = Llama2InstructionPromptFormat;
+/**
+ * Formats a chat prompt as a Llama 2 prompt.
+ */
+const Llama2ChatPromptFormat = () => ({
+    format: (chatPrompt) => {
         (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
         let text = "";
         for (let i = 0; i < chatPrompt.length; i++) {
@@ -51,6 +54,6 @@ const ChatToLlama2PromptMapping = () => ({
         }
         return text;
     },
-    stopTokens: [END_SEGMENT],
+    stopSequences: [END_SEGMENT],
 });
-exports.ChatToLlama2PromptMapping = ChatToLlama2PromptMapping;
+exports.Llama2ChatPromptFormat = Llama2ChatPromptFormat;

package/prompt/Llama2PromptFormat.d.ts

@@ -0,0 +1,13 @@
+import { PromptFormat } from "./PromptFormat.js";
+import { InstructionPrompt } from "./InstructionPrompt.js";
+import { ChatPrompt } from "./chat/ChatPrompt.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 const Llama2InstructionPromptFormat: () => PromptFormat<InstructionPrompt, string>;
+/**
+ * Formats a chat prompt as a Llama 2 prompt.
+ */
+export declare const Llama2ChatPromptFormat: () => PromptFormat<ChatPrompt, string>;

package/prompt/{Llama2PromptMapping.js → Llama2PromptFormat.js}

@@ -7,18 +7,21 @@ const END_INSTRUCTION = "[/INST]\n";
 const BEGIN_SYSTEM = "<<SYS>>\n";
 const END_SYSTEM = "\n<</SYS>>\n\n";
 /**
- * Maps an instruction prompt to the Llama2 prompt format.
+ * Formats an instruction prompt as a Llama 2 prompt.
  *
  * @see https://www.philschmid.de/llama-2#how-to-prompt-llama-2-chat
  */
-export const InstructionToLlama2PromptMapping = () => ({
-    stopTokens: [END_SEGMENT],
-    map: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction.system != null
+export const Llama2InstructionPromptFormat = () => ({
+    stopSequences: [END_SEGMENT],
+    format: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction.system != null
         ? ` ${BEGIN_SYSTEM}${instruction.system}${END_SYSTEM}`
         : ""} ${instruction.instruction}${instruction.input != null ? `\n\n${instruction.input}` : ""} ${END_INSTRUCTION}\n`,
 });
-export const ChatToLlama2PromptMapping = () => ({
-    map: (chatPrompt) => {
+/**
+ * Formats a chat prompt as a Llama 2 prompt.
+ */
+export const Llama2ChatPromptFormat = () => ({
+    format: (chatPrompt) => {
         validateChatPrompt(chatPrompt);
         let text = "";
         for (let i = 0; i < chatPrompt.length; i++) {
@@ -47,5 +50,5 @@ export const ChatToLlama2PromptMapping = () => ({
         }
         return text;
     },
-    stopTokens: [END_SEGMENT],
+    stopSequences: [END_SEGMENT],
 });

package/prompt/{OpenAIChatPromptMapping.cjs → OpenAIChatPromptFormat.cjs}

@@ -1,9 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatToOpenAIChatPromptMapping = exports.InstructionToOpenAIChatPromptMapping = void 0;
+exports.OpenAIChatChatPromptFormat = exports.OpenAIChatInstructionPromptFormat = void 0;
 const validateChatPrompt_js_1 = require("./chat/validateChatPrompt.cjs");
-const InstructionToOpenAIChatPromptMapping = () => ({
-    map: (instruction) => {
+/**
+ * Formats an instruction prompt as an OpenAI chat prompt.
+ */
+const OpenAIChatInstructionPromptFormat = () => ({
+    format: (instruction) => {
         const messages = [];
         if (instruction.system != null) {
             messages.push({
@@ -23,11 +26,14 @@ const InstructionToOpenAIChatPromptMapping = () => ({
         }
         return messages;
     },
-    stopTokens: [],
+    stopSequences: [],
 });
-exports.InstructionToOpenAIChatPromptMapping = InstructionToOpenAIChatPromptMapping;
-const ChatToOpenAIChatPromptMapping = () => ({
-    map: (chatPrompt) => {
+exports.OpenAIChatInstructionPromptFormat = OpenAIChatInstructionPromptFormat;
+/**
+ * Formats a chat prompt as an OpenAI chat prompt.
+ */
+const OpenAIChatChatPromptFormat = () => ({
+    format: (chatPrompt) => {
         (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
         const messages = [];
         for (let i = 0; i < chatPrompt.length; i++) {
@@ -63,6 +69,6 @@ const ChatToOpenAIChatPromptMapping = () => ({
         }
         return messages;
     },
-    stopTokens: [],
+    stopSequences: [],
 });
-exports.ChatToOpenAIChatPromptMapping = ChatToOpenAIChatPromptMapping;
+exports.OpenAIChatChatPromptFormat = OpenAIChatChatPromptFormat;

package/prompt/OpenAIChatPromptFormat.d.ts

@@ -0,0 +1,12 @@
+import { OpenAIChatMessage } from "../model-provider/openai/chat/OpenAIChatMessage.js";
+import { ChatPrompt } from "./chat/ChatPrompt.js";
+import { InstructionPrompt } from "./InstructionPrompt.js";
+import { PromptFormat } from "./PromptFormat.js";
+/**
+ * Formats an instruction prompt as an OpenAI chat prompt.
+ */
+export declare const OpenAIChatInstructionPromptFormat: () => PromptFormat<InstructionPrompt, Array<OpenAIChatMessage>>;
+/**
+ * Formats a chat prompt as an OpenAI chat prompt.
+ */
+export declare const OpenAIChatChatPromptFormat: () => PromptFormat<ChatPrompt, Array<OpenAIChatMessage>>;

package/prompt/{OpenAIChatPromptMapping.js → OpenAIChatPromptFormat.js}

@@ -1,6 +1,9 @@
 import { validateChatPrompt } from "./chat/validateChatPrompt.js";
-export const InstructionToOpenAIChatPromptMapping = () => ({
-    map: (instruction) => {
+/**
+ * Formats an instruction prompt as an OpenAI chat prompt.
+ */
+export const OpenAIChatInstructionPromptFormat = () => ({
+    format: (instruction) => {
         const messages = [];
         if (instruction.system != null) {
             messages.push({
@@ -20,10 +23,13 @@ export const InstructionToOpenAIChatPromptMapping = () => ({
         }
         return messages;
     },
-    stopTokens: [],
+    stopSequences: [],
 });
-export const ChatToOpenAIChatPromptMapping = () => ({
-    map: (chatPrompt) => {
+/**
+ * Formats a chat prompt as an OpenAI chat prompt.
+ */
+export const OpenAIChatChatPromptFormat = () => ({
+    format: (chatPrompt) => {
         validateChatPrompt(chatPrompt);
         const messages = [];
         for (let i = 0; i < chatPrompt.length; i++) {
@@ -59,5 +65,5 @@ export const ChatToOpenAIChatPromptMapping = () => ({
         }
         return messages;
     },
-    stopTokens: [],
+    stopSequences: [],
 });

package/prompt/PromptFormat.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Prompt formats format a source prompt into the structure of a target prompt.
+ */
+export interface PromptFormat<SOURCE_PROMPT, TARGET_PROMPT> {
+    /**
+     * Formats the source prompt into the structure of the target prompt.
+     */
+    format(sourcePrompt: 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/prompt/{PromptMappingTextGenerationModel.js → PromptFormatTextGenerationModel.cjs}

@@ -1,19 +1,22 @@
-export class PromptMappingTextGenerationModel {
-    constructor({ model, promptMapping, }) {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromptFormatTextGenerationModel = void 0;
+class PromptFormatTextGenerationModel {
+    constructor({ model, promptFormat, }) {
         Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "promptMapping", {
+        Object.defineProperty(this, "promptFormat", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
         this.model = model;
-        this.promptMapping = promptMapping;
+        this.promptFormat = promptFormat;
     }
     get modelInformation() {
         return this.model.modelInformation;
@@ -32,10 +35,10 @@ export class PromptMappingTextGenerationModel {
         if (originalCountPromptTokens === undefined) {
             return undefined;
         }
-        return ((prompt) => originalCountPromptTokens(this.promptMapping.map(prompt)));
+        return ((prompt) => originalCountPromptTokens(this.promptFormat.format(prompt)));
     }
     generateTextResponse(prompt, options) {
-        const mappedPrompt = this.promptMapping.map(prompt);
+        const mappedPrompt = this.promptFormat.format(prompt);
         return this.model.generateTextResponse(mappedPrompt, options);
     }
     extractText(response) {
@@ -47,38 +50,26 @@ export class PromptMappingTextGenerationModel {
             return undefined;
         }
         return ((prompt, options) => {
-            const mappedPrompt = this.promptMapping.map(prompt);
+            const mappedPrompt = this.promptFormat.format(prompt);
             return originalGenerateDeltaStreamResponse(mappedPrompt, options);
         });
     }
     get extractTextDelta() {
         return this.model.extractTextDelta;
     }
-    mapPrompt(promptMapping) {
-        return new PromptMappingTextGenerationModel({
-            model: this.withStopTokens(promptMapping.stopTokens),
-            promptMapping,
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextGenerationModel({
+            model: this.withSettings({
+                stopSequences: promptFormat.stopSequences,
+            }),
+            promptFormat,
         });
     }
     withSettings(additionalSettings) {
-        return new PromptMappingTextGenerationModel({
+        return new PromptFormatTextGenerationModel({
             model: this.model.withSettings(additionalSettings),
-            promptMapping: this.promptMapping,
-        });
-    }
-    get maxCompletionTokens() {
-        return this.model.maxCompletionTokens;
-    }
-    withMaxCompletionTokens(maxCompletionTokens) {
-        return new PromptMappingTextGenerationModel({
-            model: this.model.withMaxCompletionTokens(maxCompletionTokens),
-            promptMapping: this.promptMapping,
-        });
-    }
-    withStopTokens(stopTokens) {
-        return new PromptMappingTextGenerationModel({
-            model: this.model.withStopTokens(stopTokens),
-            promptMapping: this.promptMapping,
+            promptFormat: this.promptFormat,
         });
     }
 }
+exports.PromptFormatTextGenerationModel = PromptFormatTextGenerationModel;

package/prompt/{PromptMappingTextGenerationModel.d.ts → PromptFormatTextGenerationModel.d.ts}

@@ -1,13 +1,13 @@
 import { FunctionOptions } from "../model-function/FunctionOptions.js";
 import { DeltaEvent } from "../model-function/generate-text/DeltaEvent.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "../model-function/generate-text/TextGenerationModel.js";
-import { PromptMapping } from "./PromptMapping.js";
-export declare class PromptMappingTextGenerationModel<PROMPT, MODEL_PROMPT, RESPONSE, FULL_DELTA, SETTINGS extends TextGenerationModelSettings, MODEL extends TextGenerationModel<MODEL_PROMPT, RESPONSE, FULL_DELTA, SETTINGS>> implements TextGenerationModel<PROMPT, RESPONSE, FULL_DELTA, SETTINGS> {
+import { PromptFormat } from "./PromptFormat.js";
+export declare class PromptFormatTextGenerationModel<PROMPT, MODEL_PROMPT, RESPONSE, FULL_DELTA, SETTINGS extends TextGenerationModelSettings, MODEL extends TextGenerationModel<MODEL_PROMPT, RESPONSE, FULL_DELTA, SETTINGS>> implements TextGenerationModel<PROMPT, RESPONSE, FULL_DELTA, SETTINGS> {
     private readonly model;
-    private readonly promptMapping;
-    constructor({ model, promptMapping, }: {
+    private readonly promptFormat;
+    constructor({ model, promptFormat, }: {
         model: MODEL;
-        promptMapping: PromptMapping<PROMPT, MODEL_PROMPT>;
+        promptFormat: PromptFormat<PROMPT, MODEL_PROMPT>;
     });
     get modelInformation(): import("../index.js").ModelInformation;
     get settings(): SETTINGS;
@@ -18,9 +18,6 @@ export declare class PromptMappingTextGenerationModel<PROMPT, MODEL_PROMPT, RESP
     extractText(response: RESPONSE): string;
     get generateDeltaStreamResponse(): MODEL["generateDeltaStreamResponse"] extends undefined ? undefined : (prompt: PROMPT, options: FunctionOptions<SETTINGS>) => PromiseLike<AsyncIterable<DeltaEvent<FULL_DELTA>>>;
     get extractTextDelta(): MODEL["extractTextDelta"];
-    mapPrompt<INPUT_PROMPT>(promptMapping: PromptMapping<INPUT_PROMPT, PROMPT>): PromptMappingTextGenerationModel<INPUT_PROMPT, PROMPT, RESPONSE, FULL_DELTA, SETTINGS, this>;
+    withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, PROMPT>): PromptFormatTextGenerationModel<INPUT_PROMPT, PROMPT, RESPONSE, FULL_DELTA, SETTINGS, this>;
     withSettings(additionalSettings: Partial<SETTINGS>): this;
-    get maxCompletionTokens(): MODEL["maxCompletionTokens"];
-    withMaxCompletionTokens(maxCompletionTokens: number): this;
-    withStopTokens(stopTokens: string[]): this;
 }

package/prompt/{PromptMappingTextGenerationModel.cjs → PromptFormatTextGenerationModel.js}

@@ -1,22 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PromptMappingTextGenerationModel = void 0;
-class PromptMappingTextGenerationModel {
-    constructor({ model, promptMapping, }) {
+export class PromptFormatTextGenerationModel {
+    constructor({ model, promptFormat, }) {
         Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "promptMapping", {
+        Object.defineProperty(this, "promptFormat", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
         this.model = model;
-        this.promptMapping = promptMapping;
+        this.promptFormat = promptFormat;
     }
     get modelInformation() {
         return this.model.modelInformation;
@@ -35,10 +32,10 @@ class PromptMappingTextGenerationModel {
         if (originalCountPromptTokens === undefined) {
             return undefined;
         }
-        return ((prompt) => originalCountPromptTokens(this.promptMapping.map(prompt)));
+        return ((prompt) => originalCountPromptTokens(this.promptFormat.format(prompt)));
     }
     generateTextResponse(prompt, options) {
-        const mappedPrompt = this.promptMapping.map(prompt);
+        const mappedPrompt = this.promptFormat.format(prompt);
         return this.model.generateTextResponse(mappedPrompt, options);
     }
     extractText(response) {
@@ -50,39 +47,25 @@ class PromptMappingTextGenerationModel {
             return undefined;
         }
         return ((prompt, options) => {
-            const mappedPrompt = this.promptMapping.map(prompt);
+            const mappedPrompt = this.promptFormat.format(prompt);
             return originalGenerateDeltaStreamResponse(mappedPrompt, options);
         });
     }
     get extractTextDelta() {
         return this.model.extractTextDelta;
     }
-    mapPrompt(promptMapping) {
-        return new PromptMappingTextGenerationModel({
-            model: this.withStopTokens(promptMapping.stopTokens),
-            promptMapping,
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextGenerationModel({
+            model: this.withSettings({
+                stopSequences: promptFormat.stopSequences,
+            }),
+            promptFormat,
         });
     }
     withSettings(additionalSettings) {
-        return new PromptMappingTextGenerationModel({
+        return new PromptFormatTextGenerationModel({
             model: this.model.withSettings(additionalSettings),
-            promptMapping: this.promptMapping,
-        });
-    }
-    get maxCompletionTokens() {
-        return this.model.maxCompletionTokens;
-    }
-    withMaxCompletionTokens(maxCompletionTokens) {
-        return new PromptMappingTextGenerationModel({
-            model: this.model.withMaxCompletionTokens(maxCompletionTokens),
-            promptMapping: this.promptMapping,
-        });
-    }
-    withStopTokens(stopTokens) {
-        return new PromptMappingTextGenerationModel({
-            model: this.model.withStopTokens(stopTokens),
-            promptMapping: this.promptMapping,
+            promptFormat: this.promptFormat,
         });
     }
 }
-exports.PromptMappingTextGenerationModel = PromptMappingTextGenerationModel;

package/prompt/{TextPromptMapping.cjs → TextPromptFormat.cjs}

@@ -1,10 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatToTextPromptMapping = exports.InstructionToTextPromptMapping = void 0;
+exports.TextChatPromptFormat = exports.TextInstructionPromptFormat = void 0;
 const validateChatPrompt_js_1 = require("./chat/validateChatPrompt.cjs");
-const InstructionToTextPromptMapping = () => ({
-    stopTokens: [],
-    map: (instruction) => {
+/**
+ * Formats an instruction prompt as a basic text prompt.
+ */
+const TextInstructionPromptFormat = () => ({
+    stopSequences: [],
+    format: (instruction) => {
         let text = "";
         if (instruction.system != null) {
             text += `${instruction.system}\n\n`;
@@ -16,15 +19,15 @@ const InstructionToTextPromptMapping = () => ({
         return text;
     },
 });
-exports.InstructionToTextPromptMapping = InstructionToTextPromptMapping;
+exports.TextInstructionPromptFormat = TextInstructionPromptFormat;
 /**
- * A mapping from a chat prompt to a text prompt.
+ * 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.
  */
-const ChatToTextPromptMapping = ({ user, ai }) => ({
-    map: (chatPrompt) => {
+const TextChatPromptFormat = ({ user, ai }) => ({
+    format: (chatPrompt) => {
         (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
         let text = "";
         for (let i = 0; i < chatPrompt.length; i++) {
@@ -53,6 +56,6 @@ const ChatToTextPromptMapping = ({ user, ai }) => ({
         text += `${ai}:\n`;
         return text;
     },
-    stopTokens: [`\n${user}:`],
+    stopSequences: [`\n${user}:`],
 });
-exports.ChatToTextPromptMapping = ChatToTextPromptMapping;
+exports.TextChatPromptFormat = TextChatPromptFormat;

package/prompt/TextPromptFormat.d.ts

@@ -0,0 +1,17 @@
+import { PromptFormat } from "./PromptFormat.js";
+import { InstructionPrompt } from "./InstructionPrompt.js";
+import { ChatPrompt } from "./chat/ChatPrompt.js";
+/**
+ * Formats an instruction prompt as a basic text prompt.
+ */
+export declare const TextInstructionPromptFormat: () => PromptFormat<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 TextChatPromptFormat: ({ user, ai, }: {
+    user: string;
+    ai: string;
+}) => PromptFormat<ChatPrompt, string>;

package/prompt/{TextPromptMapping.js → TextPromptFormat.js}

@@ -1,7 +1,10 @@
 import { validateChatPrompt } from "./chat/validateChatPrompt.js";
-export const InstructionToTextPromptMapping = () => ({
-    stopTokens: [],
-    map: (instruction) => {
+/**
+ * Formats an instruction prompt as a basic text prompt.
+ */
+export const TextInstructionPromptFormat = () => ({
+    stopSequences: [],
+    format: (instruction) => {
         let text = "";
         if (instruction.system != null) {
             text += `${instruction.system}\n\n`;
@@ -14,13 +17,13 @@ export const InstructionToTextPromptMapping = () => ({
     },
 });
 /**
- * A mapping from a chat prompt to a text prompt.
+ * 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 const ChatToTextPromptMapping = ({ user, ai }) => ({
-    map: (chatPrompt) => {
+export const TextChatPromptFormat = ({ user, ai }) => ({
+    format: (chatPrompt) => {
         validateChatPrompt(chatPrompt);
         let text = "";
         for (let i = 0; i < chatPrompt.length; i++) {
@@ -49,5 +52,5 @@ export const ChatToTextPromptMapping = ({ user, ai }) => ({
         text += `${ai}:\n`;
         return text;
     },
-    stopTokens: [`\n${user}:`],
+    stopSequences: [`\n${user}:`],
 });

package/prompt/{VicunaPromptMapping.cjs → VicunaPromptFormat.cjs}

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatToVicunaPromptMapping = void 0;
+exports.VicunaChatPromptFormat = void 0;
 const validateChatPrompt_js_1 = require("./chat/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.";
 /**
- * A mapping from a chat prompt to a Vicuna prompt.
+ * Formats a chat prompt as a Vicuna prompt.
  *
  * Overridding the system message in the first chat message can affect model respones.
  *
@@ -16,8 +16,8 @@ const DEFAULT_SYSTEM_PROMPT = "A chat between a curious user and an artificial i
  * ASSISTANT:
  * ```
  */
-const ChatToVicunaPromptMapping = () => ({
-    map: (chatPrompt) => {
+const VicunaChatPromptFormat = () => ({
+    format: (chatPrompt) => {
         (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
         let text = "";
         for (let i = 0; i < chatPrompt.length; i++) {
@@ -50,6 +50,6 @@ const ChatToVicunaPromptMapping = () => ({
         text += `ASSISTANT: `;
         return text;
     },
-    stopTokens: [`\nUSER:`],
+    stopSequences: [`\nUSER:`],
 });
-exports.ChatToVicunaPromptMapping = ChatToVicunaPromptMapping;
+exports.VicunaChatPromptFormat = VicunaChatPromptFormat;

package/prompt/{VicunaPromptMapping.d.ts → VicunaPromptFormat.d.ts}

@@ -1,7 +1,7 @@
-import { PromptMapping } from "./PromptMapping.js";
+import { PromptFormat } from "./PromptFormat.js";
 import { ChatPrompt } from "./chat/ChatPrompt.js";
 /**
- * A mapping from a chat prompt to a Vicuna prompt.
+ * Formats a chat prompt as a Vicuna prompt.
  *
  * Overridding the system message in the first chat message can affect model respones.
  *
@@ -13,4 +13,4 @@ import { ChatPrompt } from "./chat/ChatPrompt.js";
  * ASSISTANT:
  * ```
  */
-export declare const ChatToVicunaPromptMapping: () => PromptMapping<ChatPrompt, string>;
+export declare const VicunaChatPromptFormat: () => PromptFormat<ChatPrompt, string>;

package/prompt/{VicunaPromptMapping.js → VicunaPromptFormat.js}

@@ -1,7 +1,7 @@
 import { validateChatPrompt } from "./chat/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.";
 /**
- * A mapping from a chat prompt to a Vicuna prompt.
+ * Formats a chat prompt as a Vicuna prompt.
  *
  * Overridding the system message in the first chat message can affect model respones.
  *
@@ -13,8 +13,8 @@ const DEFAULT_SYSTEM_PROMPT = "A chat between a curious user and an artificial i
  * ASSISTANT:
  * ```
  */
-export const ChatToVicunaPromptMapping = () => ({
-    map: (chatPrompt) => {
+export const VicunaChatPromptFormat = () => ({
+    format: (chatPrompt) => {
         validateChatPrompt(chatPrompt);
         let text = "";
         for (let i = 0; i < chatPrompt.length; i++) {
@@ -47,5 +47,5 @@ export const ChatToVicunaPromptMapping = () => ({
         text += `ASSISTANT: `;
         return text;
     },
-    stopTokens: [`\nUSER:`],
+    stopSequences: [`\nUSER:`],
 });

package/prompt/chat/trimChatPrompt.cjs

@@ -10,10 +10,10 @@ const validateChatPrompt_js_1 = require("./validateChatPrompt.cjs");
  * When the minimal chat prompt (system message + last user message) is already too long, it will only
  * return this minimal chat prompt.
  *
- * @see https://modelfusion.dev/guide/function/generate-text/prompt-mapping#limiting-the-chat-length
+ * @see https://modelfusion.dev/guide/function/generate-text/prompt-format#limiting-the-chat-length
  */
 async function trimChatPrompt({ prompt, model, tokenLimit = model.contextWindowSize -
-    (model.maxCompletionTokens ?? model.contextWindowSize / 4), }) {
+    (model.settings.maxCompletionTokens ?? model.contextWindowSize / 4), }) {
     (0, validateChatPrompt_js_1.validateChatPrompt)(prompt);
     const startsWithSystemMessage = "system" in prompt[0];
     const systemMessage = startsWithSystemMessage ? [prompt[0]] : [];

package/prompt/chat/trimChatPrompt.d.ts

@@ -8,7 +8,7 @@ import { ChatPrompt } from "./ChatPrompt.js";
  * When the minimal chat prompt (system message + last user message) is already too long, it will only
  * return this minimal chat prompt.
  *
- * @see https://modelfusion.dev/guide/function/generate-text/prompt-mapping#limiting-the-chat-length
+ * @see https://modelfusion.dev/guide/function/generate-text/prompt-format#limiting-the-chat-length
  */
 export declare function trimChatPrompt({ prompt, model, tokenLimit, }: {
     prompt: ChatPrompt;

package/prompt/chat/trimChatPrompt.js

@@ -7,10 +7,10 @@ import { validateChatPrompt } from "./validateChatPrompt.js";
  * When the minimal chat prompt (system message + last user message) is already too long, it will only
  * return this minimal chat prompt.
  *
- * @see https://modelfusion.dev/guide/function/generate-text/prompt-mapping#limiting-the-chat-length
+ * @see https://modelfusion.dev/guide/function/generate-text/prompt-format#limiting-the-chat-length
  */
 export async function trimChatPrompt({ prompt, model, tokenLimit = model.contextWindowSize -
-    (model.maxCompletionTokens ?? model.contextWindowSize / 4), }) {
+    (model.settings.maxCompletionTokens ?? model.contextWindowSize / 4), }) {
     validateChatPrompt(prompt);
     const startsWithSystemMessage = "system" in prompt[0];
     const systemMessage = startsWithSystemMessage ? [prompt[0]] : [];