modelfusion 0.78.0 → 0.80.0

package/README.md

@@ -87,9 +87,10 @@ import { streamText, openai } from "modelfusion";
 const textStream = await streamText(
   openai.ChatTextGenerator({ model: "gpt-4-vision-preview" }),
   [
-    OpenAIChatMessage.user("Describe the image in detail:", {
-      image: { base64Content: image, mimeType: "image/png" },
-    }),
+    OpenAIChatMessage.user([
+      { type: "text", text: "Describe the image in detail:" },
+      { type: "image", base64Image: image, mimeType: "image/png" },
+    ]),
   ]
 );
 ```

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

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PromptFormatTextGenerationModel = void 0;
+const TextGenerationToolCallModel_js_1 = require("../../tool/generate-tool-call/TextGenerationToolCallModel.cjs");
+const TextGenerationToolCallsOrGenerateTextModel_js_1 = require("../../tool/generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.cjs");
 class PromptFormatTextGenerationModel {
     constructor({ model, promptFormat, }) {
         Object.defineProperty(this, "model", {
@@ -44,6 +46,18 @@ class PromptFormatTextGenerationModel {
     get settingsForEvent() {
         return this.model.settingsForEvent;
     }
+    asToolCallGenerationModel(promptFormat) {
+        return new TextGenerationToolCallModel_js_1.TextGenerationToolCallModel({
+            model: this,
+            format: promptFormat,
+        });
+    }
+    asToolCallsOrTextGenerationModel(promptFormat) {
+        return new TextGenerationToolCallsOrGenerateTextModel_js_1.TextGenerationToolCallsOrGenerateTextModel({
+            model: this,
+            format: promptFormat,
+        });
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextGenerationModel({
             model: this.withSettings({

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

@@ -1,4 +1,6 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
+import { TextGenerationToolCallModel, ToolCallPromptFormat } from "../../tool/generate-tool-call/TextGenerationToolCallModel.js";
+import { TextGenerationToolCallsOrGenerateTextModel, ToolCallsOrGenerateTextPromptFormat } from "../../tool/generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.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> {
@@ -23,6 +25,8 @@ export declare class PromptFormatTextGenerationModel<PROMPT, MODEL_PROMPT, SETTI
         } | undefined;
     }>;
     get settingsForEvent(): Partial<SETTINGS>;
+    asToolCallGenerationModel<INPUT_PROMPT>(promptFormat: ToolCallPromptFormat<INPUT_PROMPT, PROMPT>): TextGenerationToolCallModel<INPUT_PROMPT, PROMPT, this>;
+    asToolCallsOrTextGenerationModel<INPUT_PROMPT>(promptFormat: ToolCallsOrGenerateTextPromptFormat<INPUT_PROMPT, PROMPT>): TextGenerationToolCallsOrGenerateTextModel<INPUT_PROMPT, PROMPT, this>;
     withPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, PROMPT>): PromptFormatTextGenerationModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
     withSettings(additionalSettings: Partial<SETTINGS>): this;
 }

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

@@ -1,3 +1,5 @@
+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, }) {
         Object.defineProperty(this, "model", {
@@ -41,6 +43,18 @@ export class PromptFormatTextGenerationModel {
     get settingsForEvent() {
         return this.model.settingsForEvent;
     }
+    asToolCallGenerationModel(promptFormat) {
+        return new TextGenerationToolCallModel({
+            model: this,
+            format: promptFormat,
+        });
+    }
+    asToolCallsOrTextGenerationModel(promptFormat) {
+        return new TextGenerationToolCallsOrGenerateTextModel({
+            model: this,
+            format: promptFormat,
+        });
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextGenerationModel({
             model: this.withSettings({

package/model-function/generate-text/prompt-format/AlpacaPromptFormat.cjs

@@ -9,10 +9,10 @@ const DEFAULT_SYSTEM_PROMPT_NO_INPUT = "Below is an instruction that describes a
 function text() {
     return {
         stopSequences: [],
-        format: (instruction) => {
+        format(prompt) {
             let text = DEFAULT_SYSTEM_PROMPT_NO_INPUT;
             text += "\n\n### Instruction:\n";
-            text += instruction;
+            text += prompt;
             text += "\n\n### Response:\n";
             return text;
         },
@@ -58,18 +58,18 @@ exports.text = text;
 function instruction() {
     return {
         stopSequences: [],
-        format: (instruction) => {
-            let text = instruction.system ??
-                (instruction.input != null
+        format(prompt) {
+            let text = prompt.system ??
+                (prompt.input != null
                     ? DEFAULT_SYSTEM_PROMPT_INPUT
                     : DEFAULT_SYSTEM_PROMPT_NO_INPUT);
             text += "\n\n### Instruction:\n";
-            if (instruction.system != null) {
-                text += `${instruction.system}\n`;
+            if (prompt.system != null) {
+                text += `${prompt.system}\n`;
             }
-            text += instruction.instruction;
-            if (instruction.input != null) {
-                text += `\n\n### Input:\n${instruction.input}`;
+            text += prompt.instruction;
+            if (prompt.input != null) {
+                text += `\n\n### Input:\n${prompt.input}`;
             }
             text += "\n\n### Response:\n";
             return text;

package/model-function/generate-text/prompt-format/AlpacaPromptFormat.d.ts

@@ -1,5 +1,5 @@
-import { InstructionPrompt } from "./InstructionPrompt.js";
 import { TextGenerationPromptFormat } from "../TextGenerationPromptFormat.js";
+import { TextInstructionPrompt } from "./InstructionPrompt.js";
 /**
  * Formats a text prompt as an Alpaca prompt.
  */
@@ -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<InstructionPrompt & {
+export declare function instruction(): TextGenerationPromptFormat<TextInstructionPrompt & {
     input?: string;
 }, // optional input supported by Alpaca
 string>;

package/model-function/generate-text/prompt-format/AlpacaPromptFormat.js

@@ -6,10 +6,10 @@ const DEFAULT_SYSTEM_PROMPT_NO_INPUT = "Below is an instruction that describes a
 export function text() {
     return {
         stopSequences: [],
-        format: (instruction) => {
+        format(prompt) {
             let text = DEFAULT_SYSTEM_PROMPT_NO_INPUT;
             text += "\n\n### Instruction:\n";
-            text += instruction;
+            text += prompt;
             text += "\n\n### Response:\n";
             return text;
         },
@@ -54,18 +54,18 @@ export function text() {
 export function instruction() {
     return {
         stopSequences: [],
-        format: (instruction) => {
-            let text = instruction.system ??
-                (instruction.input != null
+        format(prompt) {
+            let text = prompt.system ??
+                (prompt.input != null
                     ? DEFAULT_SYSTEM_PROMPT_INPUT
                     : DEFAULT_SYSTEM_PROMPT_NO_INPUT);
             text += "\n\n### Instruction:\n";
-            if (instruction.system != null) {
-                text += `${instruction.system}\n`;
+            if (prompt.system != null) {
+                text += `${prompt.system}\n`;
             }
-            text += instruction.instruction;
-            if (instruction.input != null) {
-                text += `\n\n### Input:\n${instruction.input}`;
+            text += prompt.instruction;
+            if (prompt.input != null) {
+                text += `\n\n### Input:\n${prompt.input}`;
             }
             text += "\n\n### Response:\n";
             return text;

package/model-function/generate-text/prompt-format/ChatMLPromptFormat.cjs

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.chat = exports.instruction = exports.text = void 0;
-const validateChatPrompt_js_1 = require("./validateChatPrompt.cjs");
+const ChatPrompt_js_1 = require("./ChatPrompt.cjs");
 const START_SEGMENT = "<|im_start|>";
 const END_SEGMENT = "<|im_end|>";
 function chatMLStart(role) {
@@ -16,7 +16,10 @@ function chatMLSegment(role, text) {
 function text() {
     return {
         stopSequences: [END_SEGMENT],
-        format: (instruction) => chatMLSegment("user", instruction),
+        format(prompt) {
+            // prompt and then prefix start of assistant response:
+            return chatMLSegment("user", prompt) + chatMLStart("assistant");
+        },
     };
 }
 exports.text = text;
@@ -36,8 +39,12 @@ exports.text = text;
 function instruction() {
     return {
         stopSequences: [END_SEGMENT],
-        format: (instruction) => chatMLSegment("system", instruction.system) +
-            chatMLSegment("user", instruction.instruction),
+        format(prompt) {
+            return (chatMLSegment("system", prompt.system) +
+                chatMLSegment("user", prompt.instruction) +
+                chatMLStart("assistant") // prefix start of assistant response
+            );
+        },
     };
 }
 exports.instruction = instruction;
@@ -56,12 +63,10 @@ exports.instruction = instruction;
  */
 function chat() {
     return {
-        format: (chatPrompt) => {
-            (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
-            let text = chatPrompt.system != null
-                ? chatMLSegment("system", chatPrompt.system)
-                : "";
-            for (const { role, content } of chatPrompt.messages) {
+        format(prompt) {
+            (0, ChatPrompt_js_1.validateChatPrompt)(prompt);
+            let text = prompt.system != null ? chatMLSegment("system", prompt.system) : "";
+            for (const { role, content } of prompt.messages) {
                 switch (role) {
                     case "user": {
                         text += chatMLSegment("user", content);

package/model-function/generate-text/prompt-format/ChatMLPromptFormat.d.ts

@@ -1,6 +1,6 @@
-import { ChatPrompt } from "./ChatPrompt.js";
-import { InstructionPrompt } from "./InstructionPrompt.js";
 import { TextGenerationPromptFormat } from "../TextGenerationPromptFormat.js";
+import { ChatPrompt } from "./ChatPrompt.js";
+import { TextInstructionPrompt } from "./InstructionPrompt.js";
 /**
  * Formats a text prompt using the ChatML format.
  */
@@ -18,7 +18,7 @@ export declare function text(): TextGenerationPromptFormat<string, string>;
  * Paris<|im_end|>
  * ```
  */
-export declare function instruction(): TextGenerationPromptFormat<InstructionPrompt, string>;
+export declare function instruction(): TextGenerationPromptFormat<TextInstructionPrompt, string>;
 /**
  * Formats a chat prompt using the ChatML format.
  *

package/model-function/generate-text/prompt-format/ChatMLPromptFormat.js

@@ -1,4 +1,4 @@
-import { validateChatPrompt } from "./validateChatPrompt.js";
+import { validateChatPrompt } from "./ChatPrompt.js";
 const START_SEGMENT = "<|im_start|>";
 const END_SEGMENT = "<|im_end|>";
 function chatMLStart(role) {
@@ -13,7 +13,10 @@ function chatMLSegment(role, text) {
 export function text() {
     return {
         stopSequences: [END_SEGMENT],
-        format: (instruction) => chatMLSegment("user", instruction),
+        format(prompt) {
+            // prompt and then prefix start of assistant response:
+            return chatMLSegment("user", prompt) + chatMLStart("assistant");
+        },
     };
 }
 /**
@@ -32,8 +35,12 @@ export function text() {
 export function instruction() {
     return {
         stopSequences: [END_SEGMENT],
-        format: (instruction) => chatMLSegment("system", instruction.system) +
-            chatMLSegment("user", instruction.instruction),
+        format(prompt) {
+            return (chatMLSegment("system", prompt.system) +
+                chatMLSegment("user", prompt.instruction) +
+                chatMLStart("assistant") // prefix start of assistant response
+            );
+        },
     };
 }
 /**
@@ -51,12 +58,10 @@ export function instruction() {
  */
 export function chat() {
     return {
-        format: (chatPrompt) => {
-            validateChatPrompt(chatPrompt);
-            let text = chatPrompt.system != null
-                ? chatMLSegment("system", chatPrompt.system)
-                : "";
-            for (const { role, content } of chatPrompt.messages) {
+        format(prompt) {
+            validateChatPrompt(prompt);
+            let text = prompt.system != null ? chatMLSegment("system", prompt.system) : "";
+            for (const { role, content } of prompt.messages) {
                 switch (role) {
                     case "user": {
                         text += chatMLSegment("user", content);

package/model-function/generate-text/prompt-format/ChatPrompt.cjs

@@ -1,2 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateChatPrompt = void 0;
+const InvalidPromptError_js_1 = require("./InvalidPromptError.cjs");
+/**
+ * Checks if a chat prompt is valid. Throws a {@link ChatPromptValidationError} if it's not.
+ *
+ * @throws {@link ChatPromptValidationError}
+ */
+function validateChatPrompt(chatPrompt) {
+    const messages = chatPrompt.messages;
+    if (messages.length < 1) {
+        throw new InvalidPromptError_js_1.InvalidPromptError("ChatPrompt should have at least one message.", chatPrompt);
+    }
+    for (let i = 0; i < messages.length; i++) {
+        const expectedRole = i % 2 === 0 ? "user" : "assistant";
+        const role = messages[i].role;
+        if (role !== expectedRole) {
+            throw new InvalidPromptError_js_1.InvalidPromptError(`Message at index ${i} should have role '${expectedRole}', but has role '${role}'.`, chatPrompt);
+        }
+    }
+    if (messages.length % 2 === 0) {
+        throw new InvalidPromptError_js_1.InvalidPromptError("The last message must be a user message.", chatPrompt);
+    }
+}
+exports.validateChatPrompt = validateChatPrompt;

package/model-function/generate-text/prompt-format/ChatPrompt.d.ts

@@ -36,3 +36,9 @@ export type ChatMessage = {
     role: "user" | "assistant";
     content: string;
 };
+/**
+ * Checks if a chat prompt is valid. Throws a {@link ChatPromptValidationError} if it's not.
+ *
+ * @throws {@link ChatPromptValidationError}
+ */
+export declare function validateChatPrompt(chatPrompt: ChatPrompt): void;

package/model-function/generate-text/prompt-format/ChatPrompt.js

@@ -1 +1,22 @@
-export {};
+import { InvalidPromptError } from "./InvalidPromptError.js";
+/**
+ * Checks if a chat prompt is valid. Throws a {@link ChatPromptValidationError} if it's not.
+ *
+ * @throws {@link ChatPromptValidationError}
+ */
+export function validateChatPrompt(chatPrompt) {
+    const messages = chatPrompt.messages;
+    if (messages.length < 1) {
+        throw new InvalidPromptError("ChatPrompt should have at least one message.", chatPrompt);
+    }
+    for (let i = 0; i < messages.length; i++) {
+        const expectedRole = i % 2 === 0 ? "user" : "assistant";
+        const role = messages[i].role;
+        if (role !== expectedRole) {
+            throw new InvalidPromptError(`Message at index ${i} should have role '${expectedRole}', but has role '${role}'.`, chatPrompt);
+        }
+    }
+    if (messages.length % 2 === 0) {
+        throw new InvalidPromptError("The last message must be a user message.", chatPrompt);
+    }
+}

package/model-function/generate-text/prompt-format/Content.cjs

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

package/model-function/generate-text/prompt-format/Content.d.ts

@@ -0,0 +1,20 @@
+export type MultiModalInput = Array<Content>;
+export type Content = TextContent | ImageContent;
+export type TextContent = {
+    type: "text";
+    /**
+     * The text content.
+     */
+    text: string;
+};
+export type ImageContent = {
+    type: "image";
+    /**
+     * Base-64 encoded image.
+     */
+    base64Image: string;
+    /**
+     * Optional mime type of the image.
+     */
+    mimeType?: string;
+};

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

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

package/model-function/generate-text/prompt-format/InstructionPrompt.d.ts

@@ -1,5 +1,23 @@
+import { MultiModalInput } from "./Content.js";
 /**
- * A single instruction prompt. It can contain an optional system message to define the role and behavior of the language model.
+ * A single multi-modal instruction prompt. It can contain an optional system message to define
+ * the role and behavior of the language model.
+ * The instruction is a multi-model input (`array` of content).
+ */
+export type InstructionPrompt = {
+    /**
+     * Optional system message to provide context for the language model. Note that for some models,
+     * changing the system message can impact the results, because the model may be trained on the default system message.
+     */
+    system?: string;
+    /**
+     * The multi-modal instruction for the model.
+     */
+    instruction: MultiModalInput;
+};
+/**
+ * A single text instruction prompt. It can contain an optional system message to define
+ * the role and behavior of the language model.
  *
  * @example
  * ```ts
@@ -9,27 +27,14 @@
  * }
  * ```
  */
-export type InstructionPrompt = {
+export type TextInstructionPrompt = {
     /**
      * Optional system message to provide context for the language model. Note that for some models,
      * changing the system message can impact the results, because the model may be trained on the default system message.
      */
     system?: string;
     /**
-     * The instruction for the model.
+     * The text instruction for the model.
      */
     instruction: string;
-    /**
-     * Optional image to provide context for the language model. Only supported by some models.
-     */
-    image?: {
-        /**
-         * Base-64 encoded image.
-         */
-        base64Content: string;
-        /**
-         * Optional mime type of the image.
-         */
-        mimeType?: string;
-    };
 };

package/model-function/generate-text/prompt-format/InvalidPromptError.cjs

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvalidPromptError = void 0;
+/**
+ * Error thrown when a prompt validation fails.
+ */
+class InvalidPromptError extends Error {
+    constructor(message, prompt) {
+        super(message);
+        Object.defineProperty(this, "prompt", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.name = "InvalidPromptError";
+        this.prompt = prompt;
+    }
+    toJSON() {
+        return {
+            name: this.name,
+            message: this.message,
+            stack: this.stack,
+            prompt: this.prompt,
+        };
+    }
+}
+exports.InvalidPromptError = InvalidPromptError;

package/model-function/generate-text/prompt-format/InvalidPromptError.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Error thrown when a prompt validation fails.
+ */
+export declare class InvalidPromptError extends Error {
+    readonly prompt: unknown;
+    constructor(message: string, prompt: unknown);
+    toJSON(): {
+        name: string;
+        message: string;
+        stack: string | undefined;
+        prompt: unknown;
+    };
+}

package/model-function/generate-text/prompt-format/InvalidPromptError.js

@@ -0,0 +1,24 @@
+/**
+ * Error thrown when a prompt validation fails.
+ */
+export class InvalidPromptError extends Error {
+    constructor(message, prompt) {
+        super(message);
+        Object.defineProperty(this, "prompt", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.name = "InvalidPromptError";
+        this.prompt = prompt;
+    }
+    toJSON() {
+        return {
+            name: this.name,
+            message: this.message,
+            stack: this.stack,
+            prompt: this.prompt,
+        };
+    }
+}

package/model-function/generate-text/prompt-format/Llama2PromptFormat.cjs

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.chat = exports.instruction = exports.text = void 0;
-const validateChatPrompt_js_1 = require("./validateChatPrompt.cjs");
+const ChatPrompt_js_1 = require("./ChatPrompt.cjs");
 // see https://github.com/facebookresearch/llama/blob/6c7fe276574e78057f917549435a2554000a876d/llama/generation.py#L44
 const BEGIN_SEGMENT = "<s>";
 const END_SEGMENT = "</s>";
@@ -22,7 +22,9 @@ const END_SYSTEM = "\n<</SYS>>\n\n";
 function text() {
     return {
         stopSequences: [END_SEGMENT],
-        format: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction}${END_INSTRUCTION}\n`,
+        format(prompt) {
+            return `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${prompt}${END_INSTRUCTION}\n`;
+        },
     };
 }
 exports.text = text;
@@ -43,9 +45,11 @@ exports.text = text;
 function instruction() {
     return {
         stopSequences: [END_SEGMENT],
-        format: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction.system != null
-            ? ` ${BEGIN_SYSTEM}${instruction.system}${END_SYSTEM}`
-            : ""}${instruction.instruction}${END_INSTRUCTION}\n`,
+        format(prompt) {
+            return `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${prompt.system != null
+                ? ` ${BEGIN_SYSTEM}${prompt.system}${END_SYSTEM}`
+                : ""}${prompt.instruction}${END_INSTRUCTION}\n`;
+        },
     };
 }
 exports.instruction = instruction;
@@ -63,14 +67,14 @@ exports.instruction = instruction;
  */
 function chat() {
     return {
-        format: (chatPrompt) => {
-            (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
-            let text = chatPrompt.system != null
+        format(prompt) {
+            (0, ChatPrompt_js_1.validateChatPrompt)(prompt);
+            let text = prompt.system != null
                 ? // Separate section for system message to simplify implementation
                     // (this is slightly different from the original instructions):
-                    `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${BEGIN_SYSTEM}${chatPrompt.system}${END_SYSTEM}${END_INSTRUCTION}${END_SEGMENT}`
+                    `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${BEGIN_SYSTEM}${prompt.system}${END_SYSTEM}${END_INSTRUCTION}${END_SEGMENT}`
                 : "";
-            for (const { role, content } of chatPrompt.messages) {
+            for (const { role, content } of prompt.messages) {
                 switch (role) {
                     case "user": {
                         text += `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${content}${END_INSTRUCTION}`;

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

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

package/model-function/generate-text/prompt-format/Llama2PromptFormat.js

@@ -1,4 +1,4 @@
-import { validateChatPrompt } from "./validateChatPrompt.js";
+import { validateChatPrompt } from "./ChatPrompt.js";
 // see https://github.com/facebookresearch/llama/blob/6c7fe276574e78057f917549435a2554000a876d/llama/generation.py#L44
 const BEGIN_SEGMENT = "<s>";
 const END_SEGMENT = "</s>";
@@ -19,7 +19,9 @@ const END_SYSTEM = "\n<</SYS>>\n\n";
 export function text() {
     return {
         stopSequences: [END_SEGMENT],
-        format: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction}${END_INSTRUCTION}\n`,
+        format(prompt) {
+            return `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${prompt}${END_INSTRUCTION}\n`;
+        },
     };
 }
 /**
@@ -39,9 +41,11 @@ export function text() {
 export function instruction() {
     return {
         stopSequences: [END_SEGMENT],
-        format: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction.system != null
-            ? ` ${BEGIN_SYSTEM}${instruction.system}${END_SYSTEM}`
-            : ""}${instruction.instruction}${END_INSTRUCTION}\n`,
+        format(prompt) {
+            return `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${prompt.system != null
+                ? ` ${BEGIN_SYSTEM}${prompt.system}${END_SYSTEM}`
+                : ""}${prompt.instruction}${END_INSTRUCTION}\n`;
+        },
     };
 }
 /**
@@ -58,14 +62,14 @@ export function instruction() {
  */
 export function chat() {
     return {
-        format: (chatPrompt) => {
-            validateChatPrompt(chatPrompt);
-            let text = chatPrompt.system != null
+        format(prompt) {
+            validateChatPrompt(prompt);
+            let text = prompt.system != null
                 ? // Separate section for system message to simplify implementation
                     // (this is slightly different from the original instructions):
-                    `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${BEGIN_SYSTEM}${chatPrompt.system}${END_SYSTEM}${END_INSTRUCTION}${END_SEGMENT}`
+                    `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${BEGIN_SYSTEM}${prompt.system}${END_SYSTEM}${END_INSTRUCTION}${END_SEGMENT}`
                 : "";
-            for (const { role, content } of chatPrompt.messages) {
+            for (const { role, content } of prompt.messages) {
                 switch (role) {
                     case "user": {
                         text += `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${content}${END_INSTRUCTION}`;