modelfusion 0.30.1 → 0.31.0

package/model-provider/openai/chat/OpenAIChatModel.js

@@ -1,9 +1,9 @@
 import SecureJSON from "secure-json-parse";
 import z from "zod";
-import { AbstractModel } from "../../../model-function/AbstractModel.js";
-import { PromptFormatTextGenerationModel } from "../../../prompt/PromptFormatTextGenerationModel.js";
 import { callWithRetryAndThrottle } from "../../../core/api/callWithRetryAndThrottle.js";
 import { createJsonResponseHandler, postJsonToApi, } from "../../../core/api/postToApi.js";
+import { AbstractModel } from "../../../model-function/AbstractModel.js";
+import { PromptFormatTextGenerationModel } from "../../../prompt/PromptFormatTextGenerationModel.js";
 import { OpenAIApiConfiguration } from "../OpenAIApiConfiguration.js";
 import { failedOpenAICallResponseHandler } from "../OpenAIError.js";
 import { TikTokenTokenizer } from "../TikTokenTokenizer.js";
@@ -236,15 +236,21 @@ export class OpenAIChatModel extends AbstractModel {
      *
      * @see https://platform.openai.com/docs/guides/gpt/function-calling
      */
-    generateStructureResponse(prompt, options) {
-        const settingsWithFunctionCall = Object.assign({}, options, {
-            functionCall: prompt.functionCall,
-            functions: prompt.functions,
-        });
-        return this.callAPI(prompt.messages, {
+    generateStructureResponse(structureDefinition, prompt, options) {
+        return this.callAPI(prompt, {
             responseFormat: OpenAIChatResponseFormat.json,
             functionId: options?.functionId,
-            settings: settingsWithFunctionCall,
+            settings: {
+                ...options,
+                functionCall: { name: structureDefinition.name },
+                functions: [
+                    {
+                        name: structureDefinition.name,
+                        description: structureDefinition.description,
+                        parameters: structureDefinition.schema.getJsonSchema(),
+                    },
+                ],
+            },
             run: options?.run,
         });
     }
@@ -252,6 +258,38 @@ export class OpenAIChatModel extends AbstractModel {
         const jsonText = response.choices[0].message.function_call.arguments;
         return SecureJSON.parse(jsonText);
     }
+    generateStructureOrTextResponse(structureDefinitions, prompt, options) {
+        return this.callAPI(prompt, {
+            responseFormat: OpenAIChatResponseFormat.json,
+            functionId: options?.functionId,
+            settings: {
+                ...options,
+                functionCall: "auto",
+                functions: structureDefinitions.map((structureDefinition) => ({
+                    name: structureDefinition.name,
+                    description: structureDefinition.description,
+                    parameters: structureDefinition.schema.getJsonSchema(),
+                })),
+            },
+            run: options?.run,
+        });
+    }
+    extractStructureAndText(response) {
+        const message = response.choices[0].message;
+        const content = message.content;
+        const functionCall = message.function_call;
+        return functionCall == null
+            ? {
+                structure: null,
+                value: null,
+                text: content ?? "",
+            }
+            : {
+                structure: functionCall.name,
+                value: SecureJSON.parse(functionCall.arguments),
+                text: content,
+            };
+    }
     extractUsage(response) {
         return {
             promptTokens: response.usage.prompt_tokens,

package/model-provider/openai/chat/OpenAIChatPromptFormat.cjs

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapChatPromptToOpenAIChatFormat = exports.mapInstructionPromptToOpenAIChatFormat = void 0;
+const validateChatPrompt_js_1 = require("../../../prompt/chat/validateChatPrompt.cjs");
+/**
+ * Formats an instruction prompt as an OpenAI chat prompt.
+ */
+function mapInstructionPromptToOpenAIChatFormat() {
+    return {
+        format: (instruction) => {
+            const messages = [];
+            if (instruction.system != null) {
+                messages.push({
+                    role: "system",
+                    content: instruction.system,
+                });
+            }
+            messages.push({
+                role: "user",
+                content: instruction.instruction,
+            });
+            if (instruction.input != null) {
+                messages.push({
+                    role: "user",
+                    content: instruction.input,
+                });
+            }
+            return messages;
+        },
+        stopSequences: [],
+    };
+}
+exports.mapInstructionPromptToOpenAIChatFormat = mapInstructionPromptToOpenAIChatFormat;
+/**
+ * Formats a chat prompt as an OpenAI chat prompt.
+ */
+function mapChatPromptToOpenAIChatFormat() {
+    return {
+        format: (chatPrompt) => {
+            (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
+            const messages = [];
+            for (let i = 0; i < chatPrompt.length; i++) {
+                const message = chatPrompt[i];
+                // system message:
+                if (i === 0 &&
+                    "system" in message &&
+                    typeof message.system === "string") {
+                    messages.push({
+                        role: "system",
+                        content: message.system,
+                    });
+                    continue;
+                }
+                // user message
+                if ("user" in message) {
+                    messages.push({
+                        role: "user",
+                        content: message.user,
+                    });
+                    continue;
+                }
+                // ai message:
+                if ("ai" in message) {
+                    messages.push({
+                        role: "assistant",
+                        content: message.ai,
+                    });
+                    continue;
+                }
+                // unsupported message:
+                throw new Error(`Unsupported message: ${JSON.stringify(message)}`);
+            }
+            return messages;
+        },
+        stopSequences: [],
+    };
+}
+exports.mapChatPromptToOpenAIChatFormat = mapChatPromptToOpenAIChatFormat;

package/model-provider/openai/chat/OpenAIChatPromptFormat.d.ts

@@ -0,0 +1,12 @@
+import { OpenAIChatMessage } from "./OpenAIChatMessage.js";
+import { ChatPrompt } from "../../../prompt/chat/ChatPrompt.js";
+import { InstructionPrompt } from "../../../prompt/InstructionPrompt.js";
+import { PromptFormat } from "../../../prompt/PromptFormat.js";
+/**
+ * Formats an instruction prompt as an OpenAI chat prompt.
+ */
+export declare function mapInstructionPromptToOpenAIChatFormat(): PromptFormat<InstructionPrompt, Array<OpenAIChatMessage>>;
+/**
+ * Formats a chat prompt as an OpenAI chat prompt.
+ */
+export declare function mapChatPromptToOpenAIChatFormat(): PromptFormat<ChatPrompt, Array<OpenAIChatMessage>>;

package/model-provider/openai/chat/OpenAIChatPromptFormat.js

@@ -0,0 +1,73 @@
+import { validateChatPrompt } from "../../../prompt/chat/validateChatPrompt.js";
+/**
+ * Formats an instruction prompt as an OpenAI chat prompt.
+ */
+export function mapInstructionPromptToOpenAIChatFormat() {
+    return {
+        format: (instruction) => {
+            const messages = [];
+            if (instruction.system != null) {
+                messages.push({
+                    role: "system",
+                    content: instruction.system,
+                });
+            }
+            messages.push({
+                role: "user",
+                content: instruction.instruction,
+            });
+            if (instruction.input != null) {
+                messages.push({
+                    role: "user",
+                    content: instruction.input,
+                });
+            }
+            return messages;
+        },
+        stopSequences: [],
+    };
+}
+/**
+ * Formats a chat prompt as an OpenAI chat prompt.
+ */
+export function mapChatPromptToOpenAIChatFormat() {
+    return {
+        format: (chatPrompt) => {
+            validateChatPrompt(chatPrompt);
+            const messages = [];
+            for (let i = 0; i < chatPrompt.length; i++) {
+                const message = chatPrompt[i];
+                // system message:
+                if (i === 0 &&
+                    "system" in message &&
+                    typeof message.system === "string") {
+                    messages.push({
+                        role: "system",
+                        content: message.system,
+                    });
+                    continue;
+                }
+                // user message
+                if ("user" in message) {
+                    messages.push({
+                        role: "user",
+                        content: message.user,
+                    });
+                    continue;
+                }
+                // ai message:
+                if ("ai" in message) {
+                    messages.push({
+                        role: "assistant",
+                        content: message.ai,
+                    });
+                    continue;
+                }
+                // unsupported message:
+                throw new Error(`Unsupported message: ${JSON.stringify(message)}`);
+            }
+            return messages;
+        },
+        stopSequences: [],
+    };
+}

package/model-provider/openai/index.cjs

@@ -14,7 +14,7 @@ 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 });
-exports.OpenAIChatFunctionPrompt = exports.OpenAIError = void 0;
+exports.OpenAIError = void 0;
 __exportStar(require("./AzureOpenAIApiConfiguration.cjs"), exports);
 __exportStar(require("./OpenAIApiConfiguration.cjs"), exports);
 __exportStar(require("./OpenAICostCalculator.cjs"), exports);
@@ -27,6 +27,5 @@ __exportStar(require("./OpenAITranscriptionModel.cjs"), exports);
 __exportStar(require("./TikTokenTokenizer.cjs"), exports);
 __exportStar(require("./chat/OpenAIChatMessage.cjs"), exports);
 __exportStar(require("./chat/OpenAIChatModel.cjs"), exports);
-var OpenAIChatPrompt_js_1 = require("./chat/OpenAIChatPrompt.cjs");
-Object.defineProperty(exports, "OpenAIChatFunctionPrompt", { enumerable: true, get: function () { return OpenAIChatPrompt_js_1.OpenAIChatFunctionPrompt; } });
+__exportStar(require("./chat/OpenAIChatPromptFormat.cjs"), exports);
 __exportStar(require("./chat/countOpenAIChatMessageTokens.cjs"), exports);

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

@@ -9,6 +9,6 @@ export * from "./OpenAITranscriptionModel.js";
 export * from "./TikTokenTokenizer.js";
 export * from "./chat/OpenAIChatMessage.js";
 export * from "./chat/OpenAIChatModel.js";
-export { OpenAIChatFunctionPrompt } from "./chat/OpenAIChatPrompt.js";
+export * from "./chat/OpenAIChatPromptFormat.js";
 export { OpenAIChatDelta } from "./chat/OpenAIChatStreamIterable.js";
 export * from "./chat/countOpenAIChatMessageTokens.js";

package/model-provider/openai/index.js

@@ -9,5 +9,5 @@ export * from "./OpenAITranscriptionModel.js";
 export * from "./TikTokenTokenizer.js";
 export * from "./chat/OpenAIChatMessage.js";
 export * from "./chat/OpenAIChatModel.js";
-export { OpenAIChatFunctionPrompt } from "./chat/OpenAIChatPrompt.js";
+export * from "./chat/OpenAIChatPromptFormat.js";
 export * from "./chat/countOpenAIChatMessageTokens.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
   "description": "Build multimodal applications, chatbots, and agents with JavaScript and TypeScript.",
-  "version": "0.30.1",
+  "version": "0.31.0",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [

package/prompt/AlpacaPromptFormat.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AlpacaInstructionPromptFormat = void 0;
+exports.mapInstructionPromptToAlpacaFormat = void 0;
 const DEFAULT_SYSTEM_PROMPT_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.";
 const DEFAULT_SYSTEM_PROMPT_NO_INPUT = "Below is an instruction that describes a task. Write a response that appropriately completes the request.";
 /**
@@ -11,23 +11,25 @@ const DEFAULT_SYSTEM_PROMPT_NO_INPUT = "Below is an instruction that describes a
  *
  * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
  */
-const AlpacaInstructionPromptFormat = () => ({
-    stopSequences: [],
-    format: (instruction) => {
-        let text = instruction.system ??
-            (instruction.input != null
-                ? DEFAULT_SYSTEM_PROMPT_INPUT
-                : DEFAULT_SYSTEM_PROMPT_NO_INPUT);
-        text += "\n\n### Instruction:\n";
-        if (instruction.system != null) {
-            text += `${instruction.system}\n`;
-        }
-        text += instruction.instruction;
-        if (instruction.input != null) {
-            text += `\n\n### Input:\n${instruction.input}`;
-        }
-        text += "\n\n### Response:\n";
-        return text;
-    },
-});
-exports.AlpacaInstructionPromptFormat = AlpacaInstructionPromptFormat;
+function mapInstructionPromptToAlpacaFormat() {
+    return {
+        stopSequences: [],
+        format: (instruction) => {
+            let text = instruction.system ??
+                (instruction.input != null
+                    ? DEFAULT_SYSTEM_PROMPT_INPUT
+                    : DEFAULT_SYSTEM_PROMPT_NO_INPUT);
+            text += "\n\n### Instruction:\n";
+            if (instruction.system != null) {
+                text += `${instruction.system}\n`;
+            }
+            text += instruction.instruction;
+            if (instruction.input != null) {
+                text += `\n\n### Input:\n${instruction.input}`;
+            }
+            text += "\n\n### Response:\n";
+            return text;
+        },
+    };
+}
+exports.mapInstructionPromptToAlpacaFormat = mapInstructionPromptToAlpacaFormat;

package/prompt/AlpacaPromptFormat.d.ts

@@ -8,4 +8,4 @@ import { PromptFormat } from "./PromptFormat.js";
  *
  * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
  */
-export declare const AlpacaInstructionPromptFormat: () => PromptFormat<InstructionPrompt, string>;
+export declare function mapInstructionPromptToAlpacaFormat(): PromptFormat<InstructionPrompt, string>;

package/prompt/AlpacaPromptFormat.js

@@ -8,22 +8,24 @@ const DEFAULT_SYSTEM_PROMPT_NO_INPUT = "Below is an instruction that describes a
  *
  * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
  */
-export const AlpacaInstructionPromptFormat = () => ({
-    stopSequences: [],
-    format: (instruction) => {
-        let text = instruction.system ??
-            (instruction.input != null
-                ? DEFAULT_SYSTEM_PROMPT_INPUT
-                : DEFAULT_SYSTEM_PROMPT_NO_INPUT);
-        text += "\n\n### Instruction:\n";
-        if (instruction.system != null) {
-            text += `${instruction.system}\n`;
-        }
-        text += instruction.instruction;
-        if (instruction.input != null) {
-            text += `\n\n### Input:\n${instruction.input}`;
-        }
-        text += "\n\n### Response:\n";
-        return text;
-    },
-});
+export function mapInstructionPromptToAlpacaFormat() {
+    return {
+        stopSequences: [],
+        format: (instruction) => {
+            let text = instruction.system ??
+                (instruction.input != null
+                    ? DEFAULT_SYSTEM_PROMPT_INPUT
+                    : DEFAULT_SYSTEM_PROMPT_NO_INPUT);
+            text += "\n\n### Instruction:\n";
+            if (instruction.system != null) {
+                text += `${instruction.system}\n`;
+            }
+            text += instruction.instruction;
+            if (instruction.input != null) {
+                text += `\n\n### Input:\n${instruction.input}`;
+            }
+            text += "\n\n### Response:\n";
+            return text;
+        },
+    };
+}

package/prompt/InstructionPrompt.d.ts

@@ -1,6 +1,15 @@
 /**
  * A single instruction prompt. It can contain an optional system message to define the role and behavior of the language model
  * and an optiona input to provide context for the language model.
+ *
+ * @example
+ * ```ts
+ * {
+ *   system: "You are a celebrated poet.", // optional
+ *   instruction: "Write a short story about:",
+ *   input: "a robot learning to love.", // optional
+ * }
+ * ```
  */
 export type InstructionPrompt = {
     /**

package/prompt/Llama2PromptFormat.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Llama2ChatPromptFormat = exports.Llama2InstructionPromptFormat = void 0;
+exports.mapChatPromptToLlama2Format = exports.mapInstructionPromptToLlama2Format = 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>";
@@ -14,46 +14,50 @@ const END_SYSTEM = "\n<</SYS>>\n\n";
  *
  * @see https://www.philschmid.de/llama-2#how-to-prompt-llama-2-chat
  */
-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.Llama2InstructionPromptFormat = Llama2InstructionPromptFormat;
+function mapInstructionPromptToLlama2Format() {
+    return {
+        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.mapInstructionPromptToLlama2Format = mapInstructionPromptToLlama2Format;
 /**
  * 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++) {
-            const message = chatPrompt[i];
-            // system message:
-            if (i === 0 &&
-                "system" in message &&
-                typeof message.system === "string") {
-                // Separate section for system message to simplify implementation
-                // (this is slightly different from the original instructions):
-                text += `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${BEGIN_SYSTEM}${message.system}${END_SYSTEM}${END_INSTRUCTION}${END_SEGMENT}`;
-                continue;
+function mapChatPromptToLlama2Format() {
+    return {
+        format: (chatPrompt) => {
+            (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
+            let text = "";
+            for (let i = 0; i < chatPrompt.length; i++) {
+                const message = chatPrompt[i];
+                // system message:
+                if (i === 0 &&
+                    "system" in message &&
+                    typeof message.system === "string") {
+                    // Separate section for system message to simplify implementation
+                    // (this is slightly different from the original instructions):
+                    text += `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${BEGIN_SYSTEM}${message.system}${END_SYSTEM}${END_INSTRUCTION}${END_SEGMENT}`;
+                    continue;
+                }
+                // user message
+                if ("user" in message) {
+                    text += `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${message.user}${END_INSTRUCTION}`;
+                    continue;
+                }
+                // ai message:
+                if ("ai" in message) {
+                    text += `${message.ai}${END_SEGMENT}`;
+                    continue;
+                }
+                // unsupported message:
+                throw new Error(`Unsupported message: ${JSON.stringify(message)}`);
             }
-            // user message
-            if ("user" in message) {
-                text += `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${message.user}${END_INSTRUCTION}`;
-                continue;
-            }
-            // ai message:
-            if ("ai" in message) {
-                text += `${message.ai}${END_SEGMENT}`;
-                continue;
-            }
-            // unsupported message:
-            throw new Error(`Unsupported message: ${JSON.stringify(message)}`);
-        }
-        return text;
-    },
-    stopSequences: [END_SEGMENT],
-});
-exports.Llama2ChatPromptFormat = Llama2ChatPromptFormat;
+            return text;
+        },
+        stopSequences: [END_SEGMENT],
+    };
+}
+exports.mapChatPromptToLlama2Format = mapChatPromptToLlama2Format;

package/prompt/Llama2PromptFormat.d.ts

@@ -6,8 +6,8 @@ import { ChatPrompt } from "./chat/ChatPrompt.js";
  *
  * @see https://www.philschmid.de/llama-2#how-to-prompt-llama-2-chat
  */
-export declare const Llama2InstructionPromptFormat: () => PromptFormat<InstructionPrompt, string>;
+export declare function mapInstructionPromptToLlama2Format(): PromptFormat<InstructionPrompt, string>;
 /**
  * Formats a chat prompt as a Llama 2 prompt.
  */
-export declare const Llama2ChatPromptFormat: () => PromptFormat<ChatPrompt, string>;
+export declare function mapChatPromptToLlama2Format(): PromptFormat<ChatPrompt, string>;

package/prompt/Llama2PromptFormat.js

@@ -11,44 +11,48 @@ const END_SYSTEM = "\n<</SYS>>\n\n";
  *
  * @see https://www.philschmid.de/llama-2#how-to-prompt-llama-2-chat
  */
-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 function mapInstructionPromptToLlama2Format() {
+    return {
+        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`,
+    };
+}
 /**
  * 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++) {
-            const message = chatPrompt[i];
-            // system message:
-            if (i === 0 &&
-                "system" in message &&
-                typeof message.system === "string") {
-                // Separate section for system message to simplify implementation
-                // (this is slightly different from the original instructions):
-                text += `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${BEGIN_SYSTEM}${message.system}${END_SYSTEM}${END_INSTRUCTION}${END_SEGMENT}`;
-                continue;
+export function mapChatPromptToLlama2Format() {
+    return {
+        format: (chatPrompt) => {
+            validateChatPrompt(chatPrompt);
+            let text = "";
+            for (let i = 0; i < chatPrompt.length; i++) {
+                const message = chatPrompt[i];
+                // system message:
+                if (i === 0 &&
+                    "system" in message &&
+                    typeof message.system === "string") {
+                    // Separate section for system message to simplify implementation
+                    // (this is slightly different from the original instructions):
+                    text += `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${BEGIN_SYSTEM}${message.system}${END_SYSTEM}${END_INSTRUCTION}${END_SEGMENT}`;
+                    continue;
+                }
+                // user message
+                if ("user" in message) {
+                    text += `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${message.user}${END_INSTRUCTION}`;
+                    continue;
+                }
+                // ai message:
+                if ("ai" in message) {
+                    text += `${message.ai}${END_SEGMENT}`;
+                    continue;
+                }
+                // unsupported message:
+                throw new Error(`Unsupported message: ${JSON.stringify(message)}`);
             }
-            // user message
-            if ("user" in message) {
-                text += `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${message.user}${END_INSTRUCTION}`;
-                continue;
-            }
-            // ai message:
-            if ("ai" in message) {
-                text += `${message.ai}${END_SEGMENT}`;
-                continue;
-            }
-            // unsupported message:
-            throw new Error(`Unsupported message: ${JSON.stringify(message)}`);
-        }
-        return text;
-    },
-    stopSequences: [END_SEGMENT],
-});
+            return text;
+        },
+        stopSequences: [END_SEGMENT],
+    };
+}

package/prompt/TextPromptFormat.cjs

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TextChatPromptFormat = exports.TextInstructionPromptFormat = void 0;
+exports.mapChatPromptToTextFormat = exports.mapInstructionPromptToTextFormat = void 0;
 const validateChatPrompt_js_1 = require("./chat/validateChatPrompt.cjs");
 /**
  * Formats an instruction prompt as a basic text prompt.
  */
-const TextInstructionPromptFormat = () => ({
+const mapInstructionPromptToTextFormat = () => ({
     stopSequences: [],
     format: (instruction) => {
         let text = "";
@@ -19,14 +19,14 @@ const TextInstructionPromptFormat = () => ({
         return text;
     },
 });
-exports.TextInstructionPromptFormat = TextInstructionPromptFormat;
+exports.mapInstructionPromptToTextFormat = mapInstructionPromptToTextFormat;
 /**
  * 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 TextChatPromptFormat = ({ user, ai }) => ({
+const mapChatPromptToTextFormat = ({ user, ai }) => ({
     format: (chatPrompt) => {
         (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
         let text = "";
@@ -58,4 +58,4 @@ const TextChatPromptFormat = ({ user, ai }) => ({
     },
     stopSequences: [`\n${user}:`],
 });
-exports.TextChatPromptFormat = TextChatPromptFormat;
+exports.mapChatPromptToTextFormat = mapChatPromptToTextFormat;