modelfusion 0.1.1 → 0.2.0

package/README.md

@@ -377,6 +377,18 @@ const { chunks } = await retrieveTextChunks(
 - [Memory](https://modelfusion.dev/integration/vector-index/memory)
 - [Pinecone](https://modelfusion.dev/integration/vector-index/pinecone)
 
+### Prompt Mappings
+
+Use higher level prompts that are mapped into model specific prompts.
+
+| Model        | Instruction Prompt | Chat Prompt |
+| ------------ | ------------------ | ----------- |
+| OpenAI       | ✅                 | ✅          |
+| Llama 2      | ✅                 | ✅          |
+| Alpaca       | ✅                 | ❌          |
+| Vicuna       | ❌                 | ✅          |
+| Generic Text | ✅                 | ✅          |
+
 ## Documentation
 
 - [Guide](https://modelfusion.dev/guide)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
   "description": "Build AI applications, chatbots, and agents with JavaScript and TypeScript.",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [
@@ -65,10 +65,10 @@
     "@typescript-eslint/parser": "^6.1.0",
     "copyfiles": "2.4.1",
     "eslint": "^8.45.0",
-    "eslint-config-prettier": "8.9.0",
+    "eslint-config-prettier": "8.10.0",
     "husky": "^8.0.3",
     "lint-staged": "13.2.3",
-    "prettier": "3.0.0",
+    "prettier": "3.0.1",
     "rimraf": "5.0.1",
     "typescript": "5.1.6",
     "zod": "3.21.4",

package/prompt/AlpacaPromptMapping.cjs

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstructionToAlpacaPromptMapping = 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.";
+/**
+ * Maps an instruction prompt to the Alpaca prompt format.
+ *
+ * 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).
+ *
+ * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
+ */
+const InstructionToAlpacaPromptMapping = () => ({
+    stopTokens: [],
+    map: (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.InstructionToAlpacaPromptMapping = InstructionToAlpacaPromptMapping;

package/prompt/AlpacaPromptMapping.d.ts

@@ -0,0 +1,11 @@
+import { InstructionPrompt } from "./InstructionPrompt.js";
+import { PromptMapping } from "./PromptMapping.js";
+/**
+ * Maps an instruction prompt to the Alpaca prompt format.
+ *
+ * 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).
+ *
+ * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
+ */
+export declare const InstructionToAlpacaPromptMapping: () => PromptMapping<InstructionPrompt, string>;

package/prompt/AlpacaPromptMapping.js

@@ -0,0 +1,29 @@
+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.";
+/**
+ * Maps an instruction prompt to the Alpaca prompt format.
+ *
+ * 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).
+ *
+ * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
+ */
+export const InstructionToAlpacaPromptMapping = () => ({
+    stopTokens: [],
+    map: (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,7 +1,19 @@
 /**
- * A single instruction prompt. It can contain an optional system message to provide context for the language model.
+ * 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.
  */
 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 instruction for the model.
+     */
     instruction: string;
+    /**
+     * Optional additional input or context, e.g. a the content from which information should be extracted.
+     */
+    input?: string;
 };

package/prompt/Llama2PromptMapping.cjs

@@ -18,7 +18,7 @@ const InstructionToLlama2PromptMapping = () => ({
     stopTokens: [END_SEGMENT],
     map: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction.system != null
         ? ` ${BEGIN_SYSTEM}${instruction.system}${END_SYSTEM}`
-        : ""} ${instruction.instruction} ${END_INSTRUCTION}\n`,
+        : ""} ${instruction.instruction}${instruction.input != null ? `\n\n${instruction.input}` : ""} ${END_INSTRUCTION}\n`,
 });
 exports.InstructionToLlama2PromptMapping = InstructionToLlama2PromptMapping;
 const ChatToLlama2PromptMapping = () => ({

package/prompt/Llama2PromptMapping.js

@@ -15,7 +15,7 @@ export const InstructionToLlama2PromptMapping = () => ({
     stopTokens: [END_SEGMENT],
     map: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction.system != null
         ? ` ${BEGIN_SYSTEM}${instruction.system}${END_SYSTEM}`
-        : ""} ${instruction.instruction} ${END_INSTRUCTION}\n`,
+        : ""} ${instruction.instruction}${instruction.input != null ? `\n\n${instruction.input}` : ""} ${END_INSTRUCTION}\n`,
 });
 export const ChatToLlama2PromptMapping = () => ({
     map: (chatPrompt) => {

package/prompt/OpenAIChatPromptMapping.cjs

@@ -15,6 +15,12 @@ const InstructionToOpenAIChatPromptMapping = () => ({
             role: "user",
             content: instruction.instruction,
         });
+        if (instruction.input != null) {
+            messages.push({
+                role: "user",
+                content: instruction.input,
+            });
+        }
         return messages;
     },
     stopTokens: [],

package/prompt/OpenAIChatPromptMapping.js

@@ -12,6 +12,12 @@ export const InstructionToOpenAIChatPromptMapping = () => ({
             role: "user",
             content: instruction.instruction,
         });
+        if (instruction.input != null) {
+            messages.push({
+                role: "user",
+                content: instruction.input,
+            });
+        }
         return messages;
     },
     stopTokens: [],

package/prompt/TextPromptMapping.cjs

@@ -4,9 +4,17 @@ exports.ChatToTextPromptMapping = exports.InstructionToTextPromptMapping = void
 const validateChatPrompt_js_1 = require("./chat/validateChatPrompt.cjs");
 const InstructionToTextPromptMapping = () => ({
     stopTokens: [],
-    map: (instruction) => instruction.system != null
-        ? `${instruction.system}\n\n${instruction.instruction}`
-        : instruction.instruction,
+    map: (instruction) => {
+        let text = "";
+        if (instruction.system != null) {
+            text += `${instruction.system}\n\n`;
+        }
+        text += instruction.instruction;
+        if (instruction.input != null) {
+            text += `\n\n${instruction.input}`;
+        }
+        return text;
+    },
 });
 exports.InstructionToTextPromptMapping = InstructionToTextPromptMapping;
 /**

package/prompt/TextPromptMapping.js

@@ -1,9 +1,17 @@
 import { validateChatPrompt } from "./chat/validateChatPrompt.js";
 export const InstructionToTextPromptMapping = () => ({
     stopTokens: [],
-    map: (instruction) => instruction.system != null
-        ? `${instruction.system}\n\n${instruction.instruction}`
-        : instruction.instruction,
+    map: (instruction) => {
+        let text = "";
+        if (instruction.system != null) {
+            text += `${instruction.system}\n\n`;
+        }
+        text += instruction.instruction;
+        if (instruction.input != null) {
+            text += `\n\n${instruction.input}`;
+        }
+        return text;
+    },
 });
 /**
  * A mapping from a chat prompt to a text prompt.

package/prompt/VicunaPromptMapping.cjs

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatToVicunaPromptMapping = 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.
+ *
+ * Overridding the system message in the first chat message can affect model respones.
+ *
+ * Vicuna prompt template:
+ * ```
+ * A chat between a curious user and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the user's questions.
+ *
+ * USER: {prompt}
+ * ASSISTANT:
+ * ```
+ */
+const ChatToVicunaPromptMapping = () => ({
+    map: (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") {
+                text += `${message.system}\n\n`;
+                continue;
+            }
+            // first message was not a system message:
+            if (i === 0) {
+                text += `${DEFAULT_SYSTEM_PROMPT}\n\n`;
+            }
+            // user message
+            if ("user" in message) {
+                text += `USER: ${message.user}\n`;
+                continue;
+            }
+            // ai message:
+            if ("ai" in message) {
+                text += `ASSISTANT:\n${message.ai}\n`;
+                continue;
+            }
+            // unsupported message:
+            throw new Error(`Unsupported message: ${JSON.stringify(message)}`);
+        }
+        // AI message prefix:
+        text += `ASSISTANT: `;
+        return text;
+    },
+    stopTokens: [`\nUSER:`],
+});
+exports.ChatToVicunaPromptMapping = ChatToVicunaPromptMapping;

package/prompt/VicunaPromptMapping.d.ts

@@ -0,0 +1,16 @@
+import { PromptMapping } from "./PromptMapping.js";
+import { ChatPrompt } from "./chat/ChatPrompt.js";
+/**
+ * A mapping from a chat prompt to a Vicuna prompt.
+ *
+ * Overridding the system message in the first chat message can affect model respones.
+ *
+ * Vicuna prompt template:
+ * ```
+ * A chat between a curious user and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the user's questions.
+ *
+ * USER: {prompt}
+ * ASSISTANT:
+ * ```
+ */
+export declare const ChatToVicunaPromptMapping: () => PromptMapping<ChatPrompt, string>;

package/prompt/VicunaPromptMapping.js

@@ -0,0 +1,51 @@
+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.
+ *
+ * Overridding the system message in the first chat message can affect model respones.
+ *
+ * Vicuna prompt template:
+ * ```
+ * A chat between a curious user and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the user's questions.
+ *
+ * USER: {prompt}
+ * ASSISTANT:
+ * ```
+ */
+export const ChatToVicunaPromptMapping = () => ({
+    map: (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") {
+                text += `${message.system}\n\n`;
+                continue;
+            }
+            // first message was not a system message:
+            if (i === 0) {
+                text += `${DEFAULT_SYSTEM_PROMPT}\n\n`;
+            }
+            // user message
+            if ("user" in message) {
+                text += `USER: ${message.user}\n`;
+                continue;
+            }
+            // ai message:
+            if ("ai" in message) {
+                text += `ASSISTANT:\n${message.ai}\n`;
+                continue;
+            }
+            // unsupported message:
+            throw new Error(`Unsupported message: ${JSON.stringify(message)}`);
+        }
+        // AI message prefix:
+        text += `ASSISTANT: `;
+        return text;
+    },
+    stopTokens: [`\nUSER:`],
+});

package/prompt/index.cjs

@@ -14,12 +14,14 @@ 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("./AlpacaPromptMapping.cjs"), exports);
 __exportStar(require("./InstructionPrompt.cjs"), exports);
 __exportStar(require("./Llama2PromptMapping.cjs"), exports);
 __exportStar(require("./OpenAIChatPromptMapping.cjs"), exports);
 __exportStar(require("./PromptMapping.cjs"), exports);
 __exportStar(require("./PromptMappingTextGenerationModel.cjs"), exports);
 __exportStar(require("./TextPromptMapping.cjs"), exports);
+__exportStar(require("./VicunaPromptMapping.cjs"), exports);
 __exportStar(require("./chat/ChatPrompt.cjs"), exports);
 __exportStar(require("./chat/trimChatPrompt.cjs"), exports);
 __exportStar(require("./chat/validateChatPrompt.cjs"), exports);

package/prompt/index.d.ts

@@ -1,9 +1,11 @@
+export * from "./AlpacaPromptMapping.js";
 export * from "./InstructionPrompt.js";
 export * from "./Llama2PromptMapping.js";
 export * from "./OpenAIChatPromptMapping.js";
 export * from "./PromptMapping.js";
 export * from "./PromptMappingTextGenerationModel.js";
 export * from "./TextPromptMapping.js";
+export * from "./VicunaPromptMapping.js";
 export * from "./chat/ChatPrompt.js";
 export * from "./chat/trimChatPrompt.js";
 export * from "./chat/validateChatPrompt.js";

package/prompt/index.js

@@ -1,9 +1,11 @@
+export * from "./AlpacaPromptMapping.js";
 export * from "./InstructionPrompt.js";
 export * from "./Llama2PromptMapping.js";
 export * from "./OpenAIChatPromptMapping.js";
 export * from "./PromptMapping.js";
 export * from "./PromptMappingTextGenerationModel.js";
 export * from "./TextPromptMapping.js";
+export * from "./VicunaPromptMapping.js";
 export * from "./chat/ChatPrompt.js";
 export * from "./chat/trimChatPrompt.js";
 export * from "./chat/validateChatPrompt.js";