modprompt 0.4.0 → 0.6.0

package/README.md

@@ -6,7 +6,7 @@ A collection of prompt templates for language models
 
 - Classic templates formats for different models
 - Easily modify and adapt templates on-the-fly
-- Few shots support
+- Few shots and conversation history support
 
 :books: [Api doc](https://synw.github.io/modprompt/)
 
@@ -77,7 +77,7 @@ The template have system messages support if the original template supports it.
 To replace a system message:
 
 ```js
-tpl.system("You are a javascript specialist");
+tpl.replaceSystem("You are a javascript specialist");
 ```
 
 Rendering for an Alpaca template:

package/dist/cls.d.ts

@@ -1,4 +1,10 @@
 import { LmTemplate, PromptBlock, TurnBlock, SpacingSlots, HistoryTurn } from "./interfaces";
+/**
+ * Represents a modified language model template.
+ *
+ * @example
+ * const tpl = new PromptTemplate('alpaca');
+ */
 declare class PromptTemplate {
     id: string;
     name: string;
@@ -15,17 +21,147 @@ declare class PromptTemplate {
     _extraAssistant: string;
     _replacePrompt: string;
     _replaceSystem: string;
+    /**
+     * Constructs a new `PromptTemplate` instance.
+     *
+     * @param template - Either the name of the template to load or an instance of `LmTemplate`.
+     *
+     * @example
+     * const tpl = new PromptTemplate('alpaca');
+     */
     constructor(template: string | LmTemplate);
+    /**
+     * Clones the current `PromptTemplate` instance to a new instance of `PromptTemplate`.
+     *
+     * This function creates a new `PromptTemplate` instance with the same state as the current instance.
+     * It is useful when you want to work with a copy of the current template without modifying the original one.
+     *
+     * @param {string | LmTemplate} template - The id or template instance of the new `PromptTemplate` to make
+     * @param {boolean} keepShots - Keep the shots for the template instance: this will also clone the shots
+     * @returns {PromptTemplate} - A new `PromptTemplate` instance with the same state as the current one.
+     *
+     * @example
+     * const tpl = new PromptTemplate('alpaca');
+     * const clonedTpl = tpl.cloneTo('chatml');
+     * console.log(clonedTpl);
+     */
     cloneTo(template: string | LmTemplate, keepShots?: boolean): PromptTemplate;
+    /**
+  * Converts the current `PromptTemplate` instance to a JSON object.
+  *
+  * This function serializes the current state of the `PromptTemplate` instance into a JSON object,
+  * which can be used for storing the template or transmitting it over a network.
+  *
+  * @returns {LmTemplate} - A JSON object representing the current state of the `PromptTemplate`.
+  *
+  * @example
+  * const tpl = new PromptTemplate('alpaca');
+  * const json = tpl.toJson();
+  * console.log(json);
+  */
     toJson(): LmTemplate;
+    /**
+     * Replaces the system block with a given message.
+     *
+     * @param msg - The message to replace the system block with.
+     * @returns A reference to the current `PromptTemplate` instance for chaining.
+     *
+     * @example
+     * tpl.replaceSystem('You are a javascript expert');
+     */
     replaceSystem(msg: string): PromptTemplate;
+    /**
+     * Appends a given message after the system message.
+     *
+     * @param msg - The message to append.
+     * @returns A reference to the current `PromptTemplate` instance for chaining.
+     *
+     * @example
+     * tpl.afterSystem('You are a javascript expert');
+     */
     afterSystem(msg: string): PromptTemplate;
+    /**
+     * Appends a given message after the assistant prompt token.
+     *
+     * @param msg - The message to append.
+     * @returns A reference to the current `PromptTemplate` instance for chaining.
+     *
+     * @example
+     * tpl.afterAssistant('( answer in json )');
+     */
     afterAssistant(msg: string): PromptTemplate;
+    /**
+     * Replaces the `{prompt}` placeholder in the user message with a given message.
+     *
+     * @param msg - The message to replace the placeholder with.
+     * @returns A reference to the current `PromptTemplate` instance for chaining.
+     *
+     * @example
+     * tpl.replacePrompt(fix this invalid json:\n\n```json\n{prompt}\n```);
+     */
     replacePrompt(msg: string): PromptTemplate;
+    /**
+     * Adds a new shot (a user-assistant interaction) to the template.
+     *
+     * @param user - The user's message.
+     * @param assistant - The assistant's response.
+     * @returns A reference to the current `PromptTemplate` instance for chaining.
+     *
+     * @example
+     * tpl.addShot('Is it raining?', 'No, it is sunny.');
+     */
     addShot(user: string, assistant: string): PromptTemplate;
+    /**
+     * Adds multiple shots (user-assistant interactions) to the template.
+     *
+     * This function allows you to add multiple turns to the conversation. Each turn is represented by an object
+     * with a 'user' property (the user's message) and an 'assistant' property (the assistant's response).
+     *
+     * @param {Array<TurnBlock>} shots - An array of objects, where each object represents a user-assistant interaction.
+     * @returns {PromptTemplate} - A reference to the current `PromptTemplate` instance for chaining.
+     *
+     * @example
+     * const tpl = new PromptTemplate('alpaca');
+     * tpl.addShots([
+     *   { user: 'What is the weather like?', assistant: 'It is sunny today!' },
+     *   { user: 'What is the weather like tomorrow?', assistant: 'I am sorry, but I can\'t predict the future.' }
+     * ]);
+     */
+    addShots(shots: Array<TurnBlock>): PromptTemplate;
+    /**
+     * Render a turn block
+     *
+     * @param {TurnBlock | HistoryTurn} shot the shot to render
+     * @returns {string} ther rendered text
+     */
     renderShot(shot: TurnBlock | HistoryTurn): string;
+    /**
+     * Renders the template into a string representation.
+     *
+     * @returns The rendered template as a string.
+     *
+     * @example
+     * const rendered = tpl.render();
+     * console.log(rendered);
+     */
     render(skip_empty_system?: boolean): string;
+    /**
+    * Renders the template with the provided message replacing the `{prompt}` placeholder.
+    *
+    * @param msg - The message to use for replacing the `{prompt}` placeholder.
+    * @returns The rendered template with the provided message.
+    *
+    * @example
+    * const prompted = tpl.prompt("list the planets in the solar system");
+    * console.log(prompted);
+    */
     prompt(msg: string): string;
+    /**
+     * Push a turn into history
+     *
+     * @param {HistoryTurn} turn the history turn
+     * @returns {PromptTemplate}
+     */
     pushToHistory(turn: HistoryTurn): PromptTemplate;
     private _buildSystemBlock;
     private _buildUserBlock;

package/dist/interfaces.d.ts

@@ -1,32 +1,157 @@
+/**
+ * Defines the spacing (in terms of line breaks) to be applied between different parts of the conversation.
+ *
+ * @interface SpacingSlots
+ * @typedef {SpacingSlots}
+ *
+ * @example
+ * const spacingExample: SpacingSlots = {
+ *   system: 2,
+ *   user: 1,
+ *   assistant: 1
+ * };
+ */
 interface SpacingSlots {
+    /**
+     * Number of line breaks to be applied after the system message.
+     */
     system?: number;
+    /**
+     * Number of line breaks to be applied after the user message.
+     */
     user?: number;
+    /**
+     * Number of line breaks to be applied after the assistant message.
+     */
     assistant?: number;
 }
+/**
+ * Represents a block of system-level prompts or instructions in the conversation.
+ *
+ * @example
+ * const promptExample: PromptBlock = {
+ *   schema: '### System: {system}',
+ *   message: 'Some system message'
+ * };
+ */
 interface PromptBlock {
+    /**
+     * The schema or format for the system message.
+     *
+     * Can include placeholders like `{system}` which can be programmatically replaced with actual messages later.
+     */
     schema: string;
+    /**
+     * Optional default message content for the system.
+     *
+     * Used if a dynamic value isn't provided for `{system}` placeholder.
+     */
     message?: string;
 }
+/**
+ * Represents a single turn in a conversation, consisting of a user message followed by an assistant response.
+ *
+ * @example
+ * const turnExample: TurnBlock = {
+ *   user: 'What's the weather like?',
+ *   assistant: 'It's sunny today!'
+ * };
+ */
 interface TurnBlock {
+    /**
+     * The message content from the user.
+     */
     user: string;
+    /**
+     * The corresponding response from the assistant.
+     */
     assistant: string;
 }
+/**
+ * Represents a template for language modeling, detailing the structure and interaction elements of a conversation.
+ *
+ * @example
+ * const sampleTemplate: LmTemplate = {
+ *  id: "alapaca",
+ *  name: "Alpaca",
+ *  system: {
+ *    schema: "{system}",
+ *    message: "Below is an instruction that describes a task. Write a response that appropriately completes the request.",
+ *  },
+ *  user: "### Instruction:\n{prompt}",
+ *  assistant: "### Response:",
+ *   linebreaks: {
+ *     system: 2,
+ *     user: 2,
+ *   }
+ * };
+ */
 interface LmTemplate {
+    /**
+     * The id slug of the template.
+     */
     id: string;
+    /**
+     * The name of the template.
+     */
     name: string;
+    /**
+     * The default message template for the user.
+     *
+     * Includes a `{prompt}` placeholder which can be programmatically replaced later.
+     */
     user: string;
+    /**
+     * The default message template for the assistant.
+     */
     assistant: string;
+    /**
+     * Optional prompt block that represents system-level messages or instructions.
+     */
     system?: PromptBlock;
+    /**
+     * Optional array of turn blocks representing back-and-forths between the user and the assistant.
+     *
+     * Useful for simulating multi-turn interactions.
+     */
     shots?: Array<TurnBlock>;
+    /**
+     * Optional array of strings that signal the end of a conversation.
+     *
+     * These strings can be used to detect when a conversation should be terminated.
+     */
     stop?: Array<string>;
+    /**
+     * Optional specifications for line breaks between different message types.
+     *
+     * This can be used to format the rendered conversation.
+     */
     linebreaks?: SpacingSlots;
+    /**
+     * String to display after a shot
+     */
     afterShot?: string;
+    /**
+     * A prefix like a bos token to insert before content
+     */
     prefix?: string;
 }
+/**
+ * Image data
+ *
+ * @interface ImgData
+ * @typedef {ImgData}
+ */
 interface ImgData {
     id: number;
     data: string;
 }
+/**
+ * A history turn
+ *
+ * @interface HistoryTurn
+ * @typedef {HistoryTurn}
+ */
 interface HistoryTurn {
     user: string;
     assistant: string;

package/dist/mod.es.mjs

@@ -184,10 +184,11 @@ const templates = {
     "minichat": {
         "id": "minichat",
         "name": "Minichat",
-        "user": "<s> [|User|] {prompt} </s>",
+        "user": "[|User|] {prompt} </s>",
         "assistant": "[|Assistant|]",
         "stop": ["</s>", "[|User|]"],
         "afterShot": "\n",
+        "prefix": "<s> "
     },
     "phi": {
         "id": "phi",
@@ -206,6 +207,7 @@ const templates = {
             "schema": "{system}",
             "message": "You are an AI programming assistant, utilizing the DeepSeek Coder model, developed by DeepSeek Company, and you only answer questions related to computer science. For politically sensitive questions, security and privacy issues, and other non-computer science questions, you will refuse to answer."
         },
+        "afterShot": "\n",
         "user": "### Instruction:\n{prompt}",
         "assistant": "### Response:",
         "linebreaks": {
@@ -213,9 +215,40 @@ const templates = {
             "system": 1,
         },
         "stop": ["<|EOT|>", "### Instruction:"]
-    }
+    },
+    "opencodeinterpreter": {
+        "id": "opencodeinterpreter",
+        "name": "Open code interpreter",
+        "user": "<|User|>\n{prompt}",
+        "assistant": "<|Assistant|>",
+        "linebreaks": {
+            "user": 2
+        },
+        "stop": ["<|EOT|>", "<|User|>"]
+    },
+    "cerebrum": {
+        "id": "cerebrum",
+        "name": "Cerebrum",
+        "system": {
+            "schema": "{system}",
+            "message": "A chat between a user and a thinking artificial intelligence assistant. The assistant describes its thought process and gives helpful and detailed answers to the user's questions."
+        },
+        "user": "User: {prompt}",
+        "assistant": "Ai:",
+        "linebreaks": {
+            "user": 1
+        },
+        "prefix": "<s>",
+        "stop": ["</s>"]
+    },
 };
 
+/**
+ * Represents a modified language model template.
+ *
+ * @example
+ * const tpl = new PromptTemplate('alpaca');
+ */
 class PromptTemplate {
     id;
     name;
@@ -228,10 +261,19 @@ class PromptTemplate {
     linebreaks;
     afterShot;
     prefix;
+    // internal state
     _extraSystem = "";
     _extraAssistant = "";
     _replacePrompt = "";
     _replaceSystem = "";
+    /**
+     * Constructs a new `PromptTemplate` instance.
+     *
+     * @param template - Either the name of the template to load or an instance of `LmTemplate`.
+     *
+     * @example
+     * const tpl = new PromptTemplate('alpaca');
+     */
     constructor(template) {
         let tpl;
         if (typeof template == "string") {
@@ -251,6 +293,21 @@ class PromptTemplate {
         this.afterShot = tpl.afterShot;
         this.prefix = tpl.prefix;
     }
+    /**
+     * Clones the current `PromptTemplate` instance to a new instance of `PromptTemplate`.
+     *
+     * This function creates a new `PromptTemplate` instance with the same state as the current instance.
+     * It is useful when you want to work with a copy of the current template without modifying the original one.
+     *
+     * @param {string | LmTemplate} template - The id or template instance of the new `PromptTemplate` to make
+     * @param {boolean} keepShots - Keep the shots for the template instance: this will also clone the shots
+     * @returns {PromptTemplate} - A new `PromptTemplate` instance with the same state as the current one.
+     *
+     * @example
+     * const tpl = new PromptTemplate('alpaca');
+     * const clonedTpl = tpl.cloneTo('chatml');
+     * console.log(clonedTpl);
+     */
     cloneTo(template, keepShots = true) {
         const tpl = new PromptTemplate(template);
         if (keepShots) {
@@ -274,6 +331,19 @@ class PromptTemplate {
         }
         return tpl;
     }
+    /**
+  * Converts the current `PromptTemplate` instance to a JSON object.
+  *
+  * This function serializes the current state of the `PromptTemplate` instance into a JSON object,
+  * which can be used for storing the template or transmitting it over a network.
+  *
+  * @returns {LmTemplate} - A JSON object representing the current state of the `PromptTemplate`.
+  *
+  * @example
+  * const tpl = new PromptTemplate('alpaca');
+  * const json = tpl.toJson();
+  * console.log(json);
+  */
     toJson() {
         const res = {
             id: this.id,
@@ -301,6 +371,15 @@ class PromptTemplate {
         }
         return res;
     }
+    /**
+     * Replaces the system block with a given message.
+     *
+     * @param msg - The message to replace the system block with.
+     * @returns A reference to the current `PromptTemplate` instance for chaining.
+     *
+     * @example
+     * tpl.replaceSystem('You are a javascript expert');
+     */
     replaceSystem(msg) {
         if (!this.system) {
             return this;
@@ -308,6 +387,15 @@ class PromptTemplate {
         this._replaceSystem = msg;
         return this;
     }
+    /**
+     * Appends a given message after the system message.
+     *
+     * @param msg - The message to append.
+     * @returns A reference to the current `PromptTemplate` instance for chaining.
+     *
+     * @example
+     * tpl.afterSystem('You are a javascript expert');
+     */
     afterSystem(msg) {
         if (!this.system) {
             return this;
@@ -315,14 +403,42 @@ class PromptTemplate {
         this._extraSystem = msg;
         return this;
     }
+    /**
+     * Appends a given message after the assistant prompt token.
+     *
+     * @param msg - The message to append.
+     * @returns A reference to the current `PromptTemplate` instance for chaining.
+     *
+     * @example
+     * tpl.afterAssistant('( answer in json )');
+     */
     afterAssistant(msg) {
         this._extraAssistant = msg;
         return this;
     }
+    /**
+     * Replaces the `{prompt}` placeholder in the user message with a given message.
+     *
+     * @param msg - The message to replace the placeholder with.
+     * @returns A reference to the current `PromptTemplate` instance for chaining.
+     *
+     * @example
+     * tpl.replacePrompt(fix this invalid json:\n\n```json\n{prompt}\n```);
+     */
     replacePrompt(msg) {
         this._replacePrompt = msg;
         return this;
     }
+    /**
+     * Adds a new shot (a user-assistant interaction) to the template.
+     *
+     * @param user - The user's message.
+     * @param assistant - The assistant's response.
+     * @returns A reference to the current `PromptTemplate` instance for chaining.
+     *
+     * @example
+     * tpl.addShot('Is it raining?', 'No, it is sunny.');
+     */
     addShot(user, assistant) {
         if (!this?.shots) {
             this.shots = [];
@@ -334,6 +450,32 @@ class PromptTemplate {
         });
         return this;
     }
+    /**
+     * Adds multiple shots (user-assistant interactions) to the template.
+     *
+     * This function allows you to add multiple turns to the conversation. Each turn is represented by an object
+     * with a 'user' property (the user's message) and an 'assistant' property (the assistant's response).
+     *
+     * @param {Array<TurnBlock>} shots - An array of objects, where each object represents a user-assistant interaction.
+     * @returns {PromptTemplate} - A reference to the current `PromptTemplate` instance for chaining.
+     *
+     * @example
+     * const tpl = new PromptTemplate('alpaca');
+     * tpl.addShots([
+     *   { user: 'What is the weather like?', assistant: 'It is sunny today!' },
+     *   { user: 'What is the weather like tomorrow?', assistant: 'I am sorry, but I can\'t predict the future.' }
+     * ]);
+     */
+    addShots(shots) {
+        shots.forEach((s) => this.addShot(s.user, s.assistant));
+        return this;
+    }
+    /**
+     * Render a turn block
+     *
+     * @param {TurnBlock | HistoryTurn} shot the shot to render
+     * @returns {string} ther rendered text
+     */
     renderShot(shot) {
         const buf = [];
         buf.push(this._buildUserBlock(shot.user));
@@ -347,11 +489,22 @@ class PromptTemplate {
         buf.push(this._buildAssistantBlock(_assistantMsg));
         return buf.join("");
     }
+    /**
+     * Renders the template into a string representation.
+     *
+     * @returns The rendered template as a string.
+     *
+     * @example
+     * const rendered = tpl.render();
+     * console.log(rendered);
+     */
     render(skip_empty_system = false) {
         const buf = new Array();
+        // prefix
         if (this.prefix) {
             buf.push(this.prefix);
         }
+        // system prompt if any
         const _systemBlock = this._buildSystemBlock(skip_empty_system);
         if (_systemBlock.length > 0) {
             buf.push(_systemBlock);
@@ -359,21 +512,42 @@ class PromptTemplate {
                 buf.push("\n".repeat(this.linebreaks.system));
             }
         }
+        // shots
         if (this?.shots) {
             for (const shot of this.shots) {
                 buf.push(this.renderShot(shot));
             }
         }
+        // history
         for (const turn of this.history) {
             buf.push(this.renderShot(turn));
         }
+        // user block
         buf.push(this._buildUserBlock());
+        // assistant block
         buf.push(this._buildAssistantBlock());
+        //console.log(buf)
         return buf.join("");
     }
+    /**
+    * Renders the template with the provided message replacing the `{prompt}` placeholder.
+    *
+    * @param msg - The message to use for replacing the `{prompt}` placeholder.
+    * @returns The rendered template with the provided message.
+    *
+    * @example
+    * const prompted = tpl.prompt("list the planets in the solar system");
+    * console.log(prompted);
+    */
     prompt(msg) {
         return this.render().replace("{prompt}", msg);
     }
+    /**
+     * Push a turn into history
+     *
+     * @param {HistoryTurn} turn the history turn
+     * @returns {PromptTemplate}
+     */
     pushToHistory(turn) {
         this.history.push(turn);
         return this;
@@ -399,6 +573,7 @@ class PromptTemplate {
     }
     _buildUserBlock(msg) {
         let buf = [];
+        // prompt replacement
         let _userBlock = this.user;
         if (this._replacePrompt.length > 0) {
             _userBlock = _userBlock.replace("{prompt}", this._replacePrompt);
@@ -408,6 +583,7 @@ class PromptTemplate {
             buf.push("\n".repeat(this.linebreaks.user));
         }
         if (msg) {
+            // this is a shot
             buf[0] = _userBlock.replace("{prompt}", msg);
         }
         return buf.join("");
@@ -423,6 +599,7 @@ class PromptTemplate {
             buf.push("\n".repeat(this.linebreaks.assistant));
         }
         if (msg) {
+            // this is a shot
             buf.push(msg);
         }
         return buf.join("");
@@ -430,6 +607,7 @@ class PromptTemplate {
     _load(name) {
         try {
             if (name in templates) {
+                //console.log("Loading", name)
                 return templates[name];
             }
             else {

package/dist/mod.min.js

@@ -1 +1 @@
-var $tpl=function(s){"use strict";const t={none:{id:"none",name:"No template",user:"{prompt}",assistant:""},alpaca:{id:"alpaca",name:"Alpaca",system:{schema:"{system}",message:"Below is an instruction that describes a task. Write a response that appropriately completes the request."},user:"### Instruction:\n{prompt}",assistant:"### Response:",linebreaks:{system:2,user:2}},llama:{id:"llama",name:"Llama",system:{schema:"[INST] <<SYS>>\n{system}\n<</SYS>>",message:"You are a helpful, respectful and honest assistant. Always answer as helpfully as possible\n\nIf a question does not make any sense, or is not factually coherent, explain why instead of answering something not correct. If you don't know the answer to a question, please don't share false information."},user:"{prompt}",assistant:" [/INST] ",linebreaks:{system:2,user:0},prefix:"<s>",stop:["</s>"]},mistral:{id:"mistral",name:"Mistral",user:"[INST] {prompt}",assistant:" [/INST]",stop:["</s>"],afterShot:"\n",prefix:"<s>"},orca:{id:"orca",name:"Orca",system:{schema:"### System:\n{system}",message:"You are an AI assistant that follows instruction extremely well. Help as much as you can."},user:"### User:\n{prompt}",assistant:"### Response:",linebreaks:{system:2,user:2}},vicuna:{id:"vicuna",name:"Vicuna",user:"USER: {prompt}",assistant:"### ASSISTANT:",linebreaks:{user:2}},vicuna_system:{id:"vicuna_system",name:"Vicuna system",system:{schema:"SYSTEM: {system}"},user:"USER: {prompt}",assistant:"### ASSISTANT:",linebreaks:{system:2,user:2}},wizard_vicuna:{id:"wizard_vicuna",name:"Wizard Vicuna",user:"### Human:\n{prompt}",assistant:"### ASSISTANT:",linebreaks:{user:2},stop:["<|endoftext|>"]},guanaco:{id:"guanaco",name:"Guanaco",user:"### Human: {prompt}",assistant:"### Assistant:",linebreaks:{user:1}},chatml:{id:"chatml",name:"ChatMl",system:{schema:"<|im_start|>system\n{system}\n<|im_end|>"},user:"<|im_start|>user\n{prompt}<|im_end|>",assistant:"<|im_start|>assistant",linebreaks:{system:1,user:1,assistant:1},stop:["<|im_end|>"],afterShot:" <|im_end|>"},zephyr:{id:"zephyr",name:"Zephyr",system:{schema:"<|system|>\n{system}</s>"},user:"<|user|>\n{prompt}</s>",assistant:"<|assistant|>",linebreaks:{system:1,user:1,assistant:1},afterShot:"\n"},"synthia-cot":{id:"synthia-cot",name:"Synthia CoT",system:{schema:"SYSTEM: {system}",message:"Elaborate on the topic using a Tree of Thoughts and backtrack when necessary to construct a clear, cohesive Chain of Thought reasoning. Always answer without hesitation."},user:"USER: {prompt}",assistant:"ASSISTANT:",linebreaks:{system:1,user:1}},wizardlm:{id:"wizardlm",name:"WizardLM",system:{schema:"{system}",message:"You are a helpful AI assistant."},user:"USER: {prompt}",assistant:"ASSISTANT:",linebreaks:{user:1}},openchat:{id:"openchat",name:"OpenChat",user:"GPT4 User: {prompt}<|end_of_turn|>",assistant:"GPT4 Assistant:",stop:["<|end_of_turn|>"]},"openchat-correct":{id:"openchat",name:"OpenChat",user:"GPT4 Correct User: {prompt}<|end_of_turn|>",assistant:"GPT4 Correct Assistant:",stop:["<|end_of_turn|>"]},human_response:{id:"human_response",name:"Human response",user:"### HUMAN:\n{prompt}",assistant:"### RESPONSE:",linebreaks:{user:2,assistant:1}},minichat:{id:"minichat",name:"Minichat",user:"<s> [|User|] {prompt} </s>",assistant:"[|Assistant|]",stop:["</s>","[|User|]"],afterShot:"\n"},phi:{id:"phi",name:"Phi",user:"Instruct: {prompt}",assistant:"Output:",linebreaks:{user:1},stop:["</s>","Instruct:"]},deepseek:{id:"deepseek",name:"Deepseek",system:{schema:"{system}",message:"You are an AI programming assistant, utilizing the DeepSeek Coder model, developed by DeepSeek Company, and you only answer questions related to computer science. For politically sensitive questions, security and privacy issues, and other non-computer science questions, you will refuse to answer."},user:"### Instruction:\n{prompt}",assistant:"### Response:",linebreaks:{user:1,system:1},stop:["<|EOT|>","### Instruction:"]}};class e{id;name;user;assistant;history=[];system;shots;stop;linebreaks;afterShot;prefix;_extraSystem="";_extraAssistant="";_replacePrompt="";_replaceSystem="";constructor(s){let t;t="string"==typeof s?this._load(s):s,this.id=t.id,this.name=t.name,this.user=t.user,this.assistant=t.assistant,this.system=t.system,this.shots=t.shots,this.stop=t.stop,this.linebreaks=t.linebreaks,this.afterShot=t.afterShot,this.prefix=t.prefix}cloneTo(s,t=!0){const a=new e(s);return t&&this?.shots&&this.shots.forEach((s=>{a.addShot(s.user,s.assistant)})),this._extraSystem.length>0&&a.afterSystem(this._extraSystem),this._replaceSystem.length>0&&a.replaceSystem(this._replaceSystem),this._extraAssistant.length>0&&a.afterAssistant(this._extraAssistant),this._replacePrompt.length>0&&a.replacePrompt(this._replacePrompt),a}toJson(){const s={id:this.id,name:this.name,user:this.user,assistant:this.assistant};return this?.prefix&&(s.prefix=this.prefix),this?.system&&(s.system=this.system),this?.shots&&(s.shots=this.shots),this?.afterShot&&(s.afterShot=this.afterShot),this?.stop&&(s.stop=this.stop),this?.linebreaks&&(s.linebreaks=this.linebreaks),s}replaceSystem(s){return this.system?(this._replaceSystem=s,this):this}afterSystem(s){return this.system?(this._extraSystem=s,this):this}afterAssistant(s){return this._extraAssistant=s,this}replacePrompt(s){return this._replacePrompt=s,this}addShot(s,t){this?.shots||(this.shots=[]);let e=t;return this.shots.push({user:s,assistant:e}),this}renderShot(s){const t=[];t.push(this._buildUserBlock(s.user));let e=s.assistant;return this.afterShot?e+=this.afterShot:e+="\n\n",t.push(this._buildAssistantBlock(e)),t.join("")}render(s=!1){const t=new Array;this.prefix&&t.push(this.prefix);const e=this._buildSystemBlock(s);if(e.length>0&&(t.push(e),this?.linebreaks?.system&&t.push("\n".repeat(this.linebreaks.system))),this?.shots)for(const s of this.shots)t.push(this.renderShot(s));for(const s of this.history)t.push(this.renderShot(s));return t.push(this._buildUserBlock()),t.push(this._buildAssistantBlock()),t.join("")}prompt(s){return this.render().replace("{prompt}",s)}pushToHistory(s){return this.history.push(s),this}_buildSystemBlock(s){let t="";return this?.system?(this._replaceSystem&&(this.system.message=this._replaceSystem),this.system?.message?(t=this.system.schema.replace("{system}",this.system.message),this._extraSystem&&(t+=this._extraSystem)):s||(t=this.system.schema),t):""}_buildUserBlock(s){let t=[],e=this.user;return this._replacePrompt.length>0&&(e=e.replace("{prompt}",this._replacePrompt)),t.push(e),this?.linebreaks?.user&&t.push("\n".repeat(this.linebreaks.user)),s&&(t[0]=e.replace("{prompt}",s)),t.join("")}_buildAssistantBlock(s){let t=[],e=this.assistant;return this._extraAssistant.length>0&&(e+=this._extraAssistant),t.push(e),this?.linebreaks?.assistant&&t.push("\n".repeat(this.linebreaks.assistant)),s&&t.push(s),t.join("")}_load(s){try{if(s in t)return t[s];throw new Error(`Template ${s} not found`)}catch(t){throw new Error(`Error loading template ${s}: ${t}`)}}}return s.PromptTemplate=e,s.templates=t,s}({});
+var $tpl=function(s){"use strict";const t={none:{id:"none",name:"No template",user:"{prompt}",assistant:""},alpaca:{id:"alpaca",name:"Alpaca",system:{schema:"{system}",message:"Below is an instruction that describes a task. Write a response that appropriately completes the request."},user:"### Instruction:\n{prompt}",assistant:"### Response:",linebreaks:{system:2,user:2}},llama:{id:"llama",name:"Llama",system:{schema:"[INST] <<SYS>>\n{system}\n<</SYS>>",message:"You are a helpful, respectful and honest assistant. Always answer as helpfully as possible\n\nIf a question does not make any sense, or is not factually coherent, explain why instead of answering something not correct. If you don't know the answer to a question, please don't share false information."},user:"{prompt}",assistant:" [/INST] ",linebreaks:{system:2,user:0},prefix:"<s>",stop:["</s>"]},mistral:{id:"mistral",name:"Mistral",user:"[INST] {prompt}",assistant:" [/INST]",stop:["</s>"],afterShot:"\n",prefix:"<s>"},orca:{id:"orca",name:"Orca",system:{schema:"### System:\n{system}",message:"You are an AI assistant that follows instruction extremely well. Help as much as you can."},user:"### User:\n{prompt}",assistant:"### Response:",linebreaks:{system:2,user:2}},vicuna:{id:"vicuna",name:"Vicuna",user:"USER: {prompt}",assistant:"### ASSISTANT:",linebreaks:{user:2}},vicuna_system:{id:"vicuna_system",name:"Vicuna system",system:{schema:"SYSTEM: {system}"},user:"USER: {prompt}",assistant:"### ASSISTANT:",linebreaks:{system:2,user:2}},wizard_vicuna:{id:"wizard_vicuna",name:"Wizard Vicuna",user:"### Human:\n{prompt}",assistant:"### ASSISTANT:",linebreaks:{user:2},stop:["<|endoftext|>"]},guanaco:{id:"guanaco",name:"Guanaco",user:"### Human: {prompt}",assistant:"### Assistant:",linebreaks:{user:1}},chatml:{id:"chatml",name:"ChatMl",system:{schema:"<|im_start|>system\n{system}\n<|im_end|>"},user:"<|im_start|>user\n{prompt}<|im_end|>",assistant:"<|im_start|>assistant",linebreaks:{system:1,user:1,assistant:1},stop:["<|im_end|>"],afterShot:" <|im_end|>"},zephyr:{id:"zephyr",name:"Zephyr",system:{schema:"<|system|>\n{system}</s>"},user:"<|user|>\n{prompt}</s>",assistant:"<|assistant|>",linebreaks:{system:1,user:1,assistant:1},afterShot:"\n"},"synthia-cot":{id:"synthia-cot",name:"Synthia CoT",system:{schema:"SYSTEM: {system}",message:"Elaborate on the topic using a Tree of Thoughts and backtrack when necessary to construct a clear, cohesive Chain of Thought reasoning. Always answer without hesitation."},user:"USER: {prompt}",assistant:"ASSISTANT:",linebreaks:{system:1,user:1}},wizardlm:{id:"wizardlm",name:"WizardLM",system:{schema:"{system}",message:"You are a helpful AI assistant."},user:"USER: {prompt}",assistant:"ASSISTANT:",linebreaks:{user:1}},openchat:{id:"openchat",name:"OpenChat",user:"GPT4 User: {prompt}<|end_of_turn|>",assistant:"GPT4 Assistant:",stop:["<|end_of_turn|>"]},"openchat-correct":{id:"openchat",name:"OpenChat",user:"GPT4 Correct User: {prompt}<|end_of_turn|>",assistant:"GPT4 Correct Assistant:",stop:["<|end_of_turn|>"]},human_response:{id:"human_response",name:"Human response",user:"### HUMAN:\n{prompt}",assistant:"### RESPONSE:",linebreaks:{user:2,assistant:1}},minichat:{id:"minichat",name:"Minichat",user:"[|User|] {prompt} </s>",assistant:"[|Assistant|]",stop:["</s>","[|User|]"],afterShot:"\n",prefix:"<s> "},phi:{id:"phi",name:"Phi",user:"Instruct: {prompt}",assistant:"Output:",linebreaks:{user:1},stop:["</s>","Instruct:"]},deepseek:{id:"deepseek",name:"Deepseek",system:{schema:"{system}",message:"You are an AI programming assistant, utilizing the DeepSeek Coder model, developed by DeepSeek Company, and you only answer questions related to computer science. For politically sensitive questions, security and privacy issues, and other non-computer science questions, you will refuse to answer."},afterShot:"\n",user:"### Instruction:\n{prompt}",assistant:"### Response:",linebreaks:{user:1,system:1},stop:["<|EOT|>","### Instruction:"]},opencodeinterpreter:{id:"opencodeinterpreter",name:"Open code interpreter",user:"<|User|>\n{prompt}",assistant:"<|Assistant|>",linebreaks:{user:2},stop:["<|EOT|>","<|User|>"]},cerebrum:{id:"cerebrum",name:"Cerebrum",system:{schema:"{system}",message:"A chat between a user and a thinking artificial intelligence assistant. The assistant describes its thought process and gives helpful and detailed answers to the user's questions."},user:"User: {prompt}",assistant:"Ai:",linebreaks:{user:1},prefix:"<s>",stop:["</s>"]}};class e{id;name;user;assistant;history=[];system;shots;stop;linebreaks;afterShot;prefix;_extraSystem="";_extraAssistant="";_replacePrompt="";_replaceSystem="";constructor(s){let t;t="string"==typeof s?this._load(s):s,this.id=t.id,this.name=t.name,this.user=t.user,this.assistant=t.assistant,this.system=t.system,this.shots=t.shots,this.stop=t.stop,this.linebreaks=t.linebreaks,this.afterShot=t.afterShot,this.prefix=t.prefix}cloneTo(s,t=!0){const a=new e(s);return t&&this?.shots&&this.shots.forEach((s=>{a.addShot(s.user,s.assistant)})),this._extraSystem.length>0&&a.afterSystem(this._extraSystem),this._replaceSystem.length>0&&a.replaceSystem(this._replaceSystem),this._extraAssistant.length>0&&a.afterAssistant(this._extraAssistant),this._replacePrompt.length>0&&a.replacePrompt(this._replacePrompt),a}toJson(){const s={id:this.id,name:this.name,user:this.user,assistant:this.assistant};return this?.prefix&&(s.prefix=this.prefix),this?.system&&(s.system=this.system),this?.shots&&(s.shots=this.shots),this?.afterShot&&(s.afterShot=this.afterShot),this?.stop&&(s.stop=this.stop),this?.linebreaks&&(s.linebreaks=this.linebreaks),s}replaceSystem(s){return this.system?(this._replaceSystem=s,this):this}afterSystem(s){return this.system?(this._extraSystem=s,this):this}afterAssistant(s){return this._extraAssistant=s,this}replacePrompt(s){return this._replacePrompt=s,this}addShot(s,t){this?.shots||(this.shots=[]);let e=t;return this.shots.push({user:s,assistant:e}),this}addShots(s){return s.forEach((s=>this.addShot(s.user,s.assistant))),this}renderShot(s){const t=[];t.push(this._buildUserBlock(s.user));let e=s.assistant;return this.afterShot?e+=this.afterShot:e+="\n\n",t.push(this._buildAssistantBlock(e)),t.join("")}render(s=!1){const t=new Array;this.prefix&&t.push(this.prefix);const e=this._buildSystemBlock(s);if(e.length>0&&(t.push(e),this?.linebreaks?.system&&t.push("\n".repeat(this.linebreaks.system))),this?.shots)for(const s of this.shots)t.push(this.renderShot(s));for(const s of this.history)t.push(this.renderShot(s));return t.push(this._buildUserBlock()),t.push(this._buildAssistantBlock()),t.join("")}prompt(s){return this.render().replace("{prompt}",s)}pushToHistory(s){return this.history.push(s),this}_buildSystemBlock(s){let t="";return this?.system?(this._replaceSystem&&(this.system.message=this._replaceSystem),this.system?.message?(t=this.system.schema.replace("{system}",this.system.message),this._extraSystem&&(t+=this._extraSystem)):s||(t=this.system.schema),t):""}_buildUserBlock(s){let t=[],e=this.user;return this._replacePrompt.length>0&&(e=e.replace("{prompt}",this._replacePrompt)),t.push(e),this?.linebreaks?.user&&t.push("\n".repeat(this.linebreaks.user)),s&&(t[0]=e.replace("{prompt}",s)),t.join("")}_buildAssistantBlock(s){let t=[],e=this.assistant;return this._extraAssistant.length>0&&(e+=this._extraAssistant),t.push(e),this?.linebreaks?.assistant&&t.push("\n".repeat(this.linebreaks.assistant)),s&&t.push(s),t.join("")}_load(s){try{if(s in t)return t[s];throw new Error(`Template ${s} not found`)}catch(t){throw new Error(`Error loading template ${s}: ${t}`)}}}return s.PromptTemplate=e,s.templates=t,s}({});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modprompt",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Prompt templates for language models",
   "license": "MIT",
   "scripts": {