node-llama-cpp 3.0.0-beta.8 → 3.0.0

package/dist/chatWrappers/generic/JinjaTemplateChatWrapper.js

@@ -0,0 +1,409 @@
+import { Template } from "@huggingface/jinja";
+import { splitText } from "lifecycle-utils";
+import { SpecialToken, LlamaText, SpecialTokensText } from "../../utils/LlamaText.js";
+import { ChatWrapper } from "../../ChatWrapper.js";
+import { parseFunctionCallMessageTemplate } from "./utils/chatHistoryFunctionCallMessageTemplate.js";
+const defaultConvertUnsupportedSystemMessagesToUserMessagesFormat = {
+    format: "### System message\n\n{{message}}\n\n----"
+};
+/**
+ * A chat wrapper based on a Jinja template.
+ * Useful for using the original model's Jinja template as-is without any additional conversion work to chat with a model.
+ *
+ * If you want to create a new chat wrapper from scratch, using this chat wrapper is not recommended, and instead you better inherit
+ * from the `ChatWrapper` class and implement a custom chat wrapper of your own in TypeScript.
+ *
+ * For a simpler way to create a chat wrapper, see the `TemplateChatWrapper` class.
+ * @example
+ * <span v-pre>
+ *
+ * ```ts
+ * import {JinjaTemplateChatWrapper} from "node-llama-cpp";
+ *
+ * const chatWrapper = new JinjaTemplateChatWrapper({
+ *     template: "<Jinja template here>",
+ *     // functionCallMessageTemplate: { // optional
+ *     //     call: "[[call: {{functionName}}({{functionParams}})]]",
+ *     //     result: " [[result: {{functionCallResult}}]]"
+ *     // }
+ * });
+ * ```
+ *
+ * </span>
+ */
+export class JinjaTemplateChatWrapper extends ChatWrapper {
+    wrapperName = "JinjaTemplate";
+    settings;
+    template;
+    modelRoleName;
+    userRoleName;
+    systemRoleName;
+    convertUnsupportedSystemMessagesToUserMessages;
+    joinAdjacentMessagesOfTheSameType;
+    trimLeadingWhitespaceInResponses;
+    additionalRenderParameters;
+    /** @internal */ _jinjaTemplate;
+    /**
+     * @param options
+     */
+    constructor({ template, modelRoleName = "assistant", userRoleName = "user", systemRoleName = "system", convertUnsupportedSystemMessagesToUserMessages = defaultConvertUnsupportedSystemMessagesToUserMessagesFormat, functionCallMessageTemplate, joinAdjacentMessagesOfTheSameType = true, trimLeadingWhitespaceInResponses = true, additionalRenderParameters }) {
+        super();
+        if (template == null)
+            throw new Error("template cannot be null");
+        this.template = template;
+        this.modelRoleName = modelRoleName;
+        this.userRoleName = userRoleName;
+        this.systemRoleName = systemRoleName;
+        this.convertUnsupportedSystemMessagesToUserMessages =
+            resolveConvertUnsupportedSystemMessagesToUserMessagesOption(convertUnsupportedSystemMessagesToUserMessages);
+        this.joinAdjacentMessagesOfTheSameType = joinAdjacentMessagesOfTheSameType;
+        this.trimLeadingWhitespaceInResponses = trimLeadingWhitespaceInResponses;
+        this.additionalRenderParameters = additionalRenderParameters;
+        this.settings = {
+            ...ChatWrapper.defaultSettings,
+            functions: parseFunctionCallMessageTemplate(functionCallMessageTemplate) ?? ChatWrapper.defaultSettings.functions
+        };
+        if (this.convertUnsupportedSystemMessagesToUserMessages != null && !this.convertUnsupportedSystemMessagesToUserMessages.format.includes("{{message}}"))
+            throw new Error('convertUnsupportedSystemMessagesToUserMessages format must include "{{message}}"');
+        this._jinjaTemplate = new Template(this.template);
+        const { supportsSystemMessages } = this._runSanityTest();
+        this.settings = {
+            ...this.settings,
+            supportsSystemMessages
+        };
+    }
+    generateContextState({ chatHistory, availableFunctions, documentFunctionParams }) {
+        const historyWithFunctions = this.addAvailableFunctionsSystemMessageToHistory(chatHistory, availableFunctions, {
+            documentParams: documentFunctionParams
+        });
+        if (this.convertUnsupportedSystemMessagesToUserMessages == null) {
+            return this._generateContextText(historyWithFunctions, {
+                convertSystemMessagesToUserMessagesFormat: undefined
+            });
+        }
+        else if (this.convertUnsupportedSystemMessagesToUserMessages.use === "always") {
+            return this._generateContextText(historyWithFunctions, {
+                convertSystemMessagesToUserMessagesFormat: this.convertUnsupportedSystemMessagesToUserMessages.format
+            });
+        }
+        try {
+            return this._generateContextText(historyWithFunctions, {
+                convertSystemMessagesToUserMessagesFormat: undefined
+            });
+        }
+        catch (error) {
+            return this._generateContextText(historyWithFunctions, {
+                convertSystemMessagesToUserMessagesFormat: this.convertUnsupportedSystemMessagesToUserMessages.format
+            });
+        }
+    }
+    /** @internal */
+    _generateContextText(history, { convertSystemMessagesToUserMessagesFormat }) {
+        let transformedSystemMessagesToUserMessages = false;
+        const transformedHistory = convertSystemMessagesToUserMessagesFormat == null
+            ? history
+            : history.map((item) => {
+                if (item.type === "system") {
+                    transformedSystemMessagesToUserMessages = true;
+                    return {
+                        type: "user",
+                        text: LlamaText.joinValues(LlamaText.fromJSON(item.text), convertSystemMessagesToUserMessagesFormat.split("{{message}}")).toString()
+                    };
+                }
+                return item;
+            });
+        const resultItems = [];
+        const currentTexts = [];
+        let currentAggregateFocus = null;
+        function flush() {
+            if (currentTexts.length > 0 && currentAggregateFocus != null)
+                resultItems.push({ role: currentAggregateFocus, content: LlamaText.joinValues("\n\n", currentTexts) });
+            currentTexts.length = 0;
+        }
+        for (const item of transformedHistory) {
+            if (item.type === "system") {
+                if (!this.joinAdjacentMessagesOfTheSameType || currentAggregateFocus !== "system")
+                    flush();
+                currentAggregateFocus = "system";
+                currentTexts.push(LlamaText.fromJSON(item.text));
+            }
+            else if (item.type === "user") {
+                if (!this.joinAdjacentMessagesOfTheSameType || currentAggregateFocus !== "user")
+                    flush();
+                currentAggregateFocus = "user";
+                currentTexts.push(LlamaText(item.text));
+            }
+            else if (item.type === "model") {
+                if (!this.joinAdjacentMessagesOfTheSameType || currentAggregateFocus !== "model")
+                    flush();
+                currentAggregateFocus = "model";
+                currentTexts.push(this.generateModelResponseText(item.response));
+            }
+            else
+                void item;
+        }
+        const lastItemIsModelMessage = currentAggregateFocus === "model";
+        flush();
+        const idsGenerator = new UniqueTemplateId(this.template + this.modelRoleName + this.userRoleName + this.systemRoleName +
+            (convertSystemMessagesToUserMessagesFormat ?? "") + resultItems.map(({ content }) => content.toString()).join("\n\n"));
+        const jinjaItems = [];
+        const jinjaRoleMap = {
+            system: this.systemRoleName,
+            user: this.userRoleName,
+            model: this.modelRoleName
+        };
+        const idToContent = new Map();
+        const modelMessageIds = new Set();
+        const messageIds = new Set();
+        for (const resultItem of resultItems) {
+            const id = idsGenerator.generateId();
+            messageIds.add(id);
+            idToContent.set(id, resultItem.content);
+            jinjaItems.push({
+                role: jinjaRoleMap[resultItem.role],
+                content: id
+            });
+            if (resultItem.role === "model")
+                modelMessageIds.add(id);
+        }
+        const bosTokenId = idsGenerator.generateId();
+        const eosTokenId = idsGenerator.generateId();
+        const eotTokenId = idsGenerator.generateId();
+        idToContent.set(bosTokenId, new SpecialToken("BOS"));
+        idToContent.set(eosTokenId, new SpecialToken("EOS"));
+        idToContent.set(eotTokenId, new SpecialToken("EOT"));
+        function tryOptions(options) {
+            for (let i = 0; i < options.length; i++) {
+                if (i === options.length - 1)
+                    return options[i]();
+                try {
+                    return options[i]();
+                }
+                catch (err) {
+                    // do nothing
+                }
+            }
+            throw new Error("All options failed");
+        }
+        const renderJinjaText = () => {
+            return tryOptions([
+                () => this._jinjaTemplate.render({
+                    ...(this.additionalRenderParameters == null
+                        ? {}
+                        : structuredClone(this.additionalRenderParameters)),
+                    messages: jinjaItems,
+                    "bos_token": bosTokenId,
+                    "eos_token": eosTokenId,
+                    "eot_token": eotTokenId
+                }),
+                () => this._jinjaTemplate.render({
+                    ...(this.additionalRenderParameters == null
+                        ? {}
+                        : structuredClone(this.additionalRenderParameters)),
+                    messages: jinjaItems,
+                    "bos_token": bosTokenId,
+                    "eos_token": eosTokenId,
+                    "eot_token": eotTokenId,
+                    "add_generation_prompt": true
+                })
+            ]);
+        };
+        const validateThatAllMessageIdsAreUsed = (parts) => {
+            const messageIdsLeft = new Set(messageIds);
+            for (const part of parts) {
+                if (typeof part === "string")
+                    continue;
+                messageIdsLeft.delete(part.separator);
+            }
+            if (messageIdsLeft.size !== 0)
+                throw new Error("Some input messages are not present in the generated Jinja template output");
+        };
+        const renderJinjaAndSplitIntoParts = () => {
+            const splitJinjaParts = splitText(renderJinjaText(), [...idToContent.keys()]);
+            if (lastItemIsModelMessage) {
+                let lastModelResponseIndex = -1;
+                for (let i = splitJinjaParts.length - 1; i >= 0; i--) {
+                    const part = splitJinjaParts[i];
+                    if (part == null || typeof part === "string")
+                        continue;
+                    if (modelMessageIds.has(part.separator)) {
+                        lastModelResponseIndex = i;
+                        break;
+                    }
+                    else if (messageIds.has(part.separator)) {
+                        validateThatAllMessageIdsAreUsed(splitJinjaParts);
+                        throw new Error("Last message was expected to be a model message, but it was not");
+                    }
+                }
+                if (lastModelResponseIndex < 0) {
+                    validateThatAllMessageIdsAreUsed(splitJinjaParts);
+                    throw new Error("A model message was expected to be the last message, but it was not found");
+                }
+                return {
+                    splitJinjaParts: splitJinjaParts.slice(0, lastModelResponseIndex + 1),
+                    stopGenerationJinjaParts: splitJinjaParts.slice(lastModelResponseIndex + 1)
+                };
+            }
+            return {
+                splitJinjaParts,
+                stopGenerationJinjaParts: []
+            };
+        };
+        const { splitJinjaParts, stopGenerationJinjaParts } = renderJinjaAndSplitIntoParts();
+        const messageIdsLeftToProcess = new Set(messageIds);
+        const contextText = LlamaText(splitJinjaParts.map((part) => {
+            if (typeof part === "string")
+                return new SpecialTokensText(part); // things that are not message content can be tokenized with special tokens
+            const message = idToContent.get(part.separator);
+            if (message == null)
+                throw new Error(`Message with id "${part.separator}" not found`);
+            messageIdsLeftToProcess.delete(part.separator);
+            return message;
+        }));
+        if (messageIdsLeftToProcess.size !== 0)
+            throw new Error("Some input messages are not present in the generated Jinja template output");
+        return {
+            contextText,
+            ignoreStartText: !this.trimLeadingWhitespaceInResponses
+                ? []
+                : [
+                    // ignore up to 4 leading spaces
+                    ...Array(4).fill(0)
+                        .map((_, index) => LlamaText(" ".repeat(index + 1))),
+                    LlamaText("\t"),
+                    LlamaText("\t\t"),
+                    LlamaText("\t "),
+                    LlamaText(" \t")
+                ],
+            stopGenerationTriggers: [
+                LlamaText(new SpecialToken("EOS")),
+                ...(stopGenerationJinjaParts.length === 0
+                    ? []
+                    : [
+                        LlamaText(stopGenerationJinjaParts.map((part) => {
+                            if (typeof part === "string")
+                                return new SpecialTokensText(part);
+                            const message = idToContent.get(part.separator);
+                            if (message == null)
+                                throw new Error(`Message with id "${part.separator}" not found`);
+                            return message;
+                        }))
+                    ])
+            ],
+            transformedSystemMessagesToUserMessages
+        };
+    }
+    /**
+     * Validate that this Jinja template can be rendered
+     * @internal
+     */
+    _runSanityTest() {
+        try {
+            let supportsSystemMessages = true;
+            for (const chatHistory of chatHistoriesForSanityTest) {
+                const { transformedSystemMessagesToUserMessages } = this.generateContextState({ chatHistory });
+                if (transformedSystemMessagesToUserMessages)
+                    supportsSystemMessages = false;
+            }
+            return { supportsSystemMessages };
+        }
+        catch (err) {
+            throw new Error("The provided Jinja template failed the sanity test: " + String(err) + ". Inspect the Jinja template to find out what went wrong");
+        }
+    }
+}
+class UniqueTemplateId {
+    antiText;
+    _ids = new Set();
+    constructor(antiText) {
+        this.antiText = antiText;
+    }
+    generateId() {
+        let id;
+        do {
+            id = "W" + (Math.random()
+                .toString(36)
+                .slice(2)) + "W";
+        } while (this._ids.has(id) || this.antiText.includes(id));
+        this._ids.add(id);
+        return id;
+    }
+    removeId(id) {
+        this._ids.delete(id);
+    }
+}
+function resolveConvertUnsupportedSystemMessagesToUserMessagesOption(convertUnsupportedSystemMessagesToUserMessages) {
+    if (convertUnsupportedSystemMessagesToUserMessages === false)
+        return undefined;
+    if (convertUnsupportedSystemMessagesToUserMessages === true)
+        return {
+            ...defaultConvertUnsupportedSystemMessagesToUserMessagesFormat,
+            use: "always"
+        };
+    if (convertUnsupportedSystemMessagesToUserMessages === "auto")
+        return {
+            ...defaultConvertUnsupportedSystemMessagesToUserMessagesFormat,
+            use: "ifNeeded"
+        };
+    if (typeof convertUnsupportedSystemMessagesToUserMessages === "object")
+        return {
+            ...convertUnsupportedSystemMessagesToUserMessages,
+            use: convertUnsupportedSystemMessagesToUserMessages.use ?? "ifNeeded"
+        };
+    return { ...defaultConvertUnsupportedSystemMessagesToUserMessagesFormat, use: "ifNeeded" };
+}
+const chatHistoriesForSanityTest = [
+    [{
+            type: "system",
+            text: "System message ~!@#$%^&*()\n*"
+        }, {
+            type: "user",
+            text: "Message 1234567890!@#$%^&*()_+-=[]{}|\\:;\"',./<>?`~"
+        }, {
+            type: "model",
+            response: [""]
+        }],
+    [{
+            type: "system",
+            text: "System message ~!@#$%^&*()\n*"
+        }, {
+            type: "user",
+            text: "Message 1234567890!@#$%^&*()_+-=[]{}|\\:;\"',./<>?`~"
+        }, {
+            type: "model",
+            response: ["Result 1234567890!@#$%^&*()_+-=[]{}|\\:;\"',./<>?`~"]
+        }],
+    [{
+            type: "system",
+            text: "System message ~!@#$%^&*()\n*"
+        }, {
+            type: "user",
+            text: "Message 1234567890!@#$%^&*()_+-=[]{}|\\:;\"',./<>?`~"
+        }, {
+            type: "model",
+            response: ["Result 1234567890!@#$%^&*()_+-=[]{}|\\:;\"',./<>?`~"]
+        }, {
+            type: "user",
+            text: "Message2 1234567890!@#$%^&*()_+-=[]{}|\\:;\"',./<>?`~"
+        }, {
+            type: "model",
+            response: [""]
+        }],
+    [{
+            type: "system",
+            text: "System message ~!@#$%^&*()\n*"
+        }, {
+            type: "user",
+            text: "Message 1234567890!@#$%^&*()_+-=[]{}|\\:;\"',./<>?`~"
+        }, {
+            type: "model",
+            response: ["Result 1234567890!@#$%^&*()_+-=[]{}|\\:;\"',./<>?`~"]
+        }, {
+            type: "user",
+            text: "Message2 1234567890!@#$%^&*()_+-=[]{}|\\:;\"',./<>?`~"
+        }, {
+            type: "model",
+            response: ["Result2 1234567890!@#$%^&*()_+-=[]{}|\\:;\"',./<>?`~"]
+        }]
+];
+//# sourceMappingURL=JinjaTemplateChatWrapper.js.map

package/dist/chatWrappers/generic/JinjaTemplateChatWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JinjaTemplateChatWrapper.js","sourceRoot":"","sources":["../../../src/chatWrappers/generic/JinjaTemplateChatWrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAC,SAAS,EAAC,MAAM,iBAAiB,CAAC;AAI1C,OAAO,EAAC,YAAY,EAAE,SAAS,EAAE,iBAAiB,EAAC,MAAM,0BAA0B,CAAC;AACpF,OAAO,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAyC,gCAAgC,EAAC,MAAM,mDAAmD,CAAC;AAgE3I,MAAM,2DAA2D,GAAwD;IACrH,MAAM,EAAE,2CAA2C;CACtD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,OAAO,wBAAyB,SAAQ,WAAW;IACrC,WAAW,GAAG,eAAe,CAAC;IACrB,QAAQ,CAAsB;IAEvC,QAAQ,CAAS;IACjB,aAAa,CAAS;IACtB,YAAY,CAAS;IACrB,cAAc,CAAS;IACvB,8CAA8C,CAAuD;IACrG,iCAAiC,CAAU;IAC3C,gCAAgC,CAAU;IAC1C,0BAA0B,CAAuB;IAEjE,gBAAgB,CAAkB,cAAc,CAAW;IAE3D;;OAEG;IACH,YAAmB,EACf,QAAQ,EACR,aAAa,GAAG,WAAW,EAC3B,YAAY,GAAG,MAAM,EACrB,cAAc,GAAG,QAAQ,EACzB,8CAA8C,GAAG,2DAA2D,EAC5G,2BAA2B,EAC3B,iCAAiC,GAAG,IAAI,EACxC,gCAAgC,GAAG,IAAI,EACvC,0BAA0B,EACI;QAC9B,KAAK,EAAE,CAAC;QAER,IAAI,QAAQ,IAAI,IAAI;YAChB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAE/C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,8CAA8C;YAC/C,2DAA2D,CAAC,8CAA8C,CAAC,CAAC;QAChH,IAAI,CAAC,iCAAiC,GAAG,iCAAiC,CAAC;QAC3E,IAAI,CAAC,gCAAgC,GAAG,gCAAgC,CAAC;QACzE,IAAI,CAAC,0BAA0B,GAAG,0BAA0B,CAAC;QAE7D,IAAI,CAAC,QAAQ,GAAG;YACZ,GAAG,WAAW,CAAC,eAAe;YAC9B,SAAS,EAAE,gCAAgC,CAAC,2BAA2B,CAAC,IAAI,WAAW,CAAC,eAAe,CAAC,SAAS;SACpH,CAAC;QAEF,IAAI,IAAI,CAAC,8CAA8C,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,8CAA8C,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC;YAClJ,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;QAExG,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAElD,MAAM,EAAC,sBAAsB,EAAC,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACvD,IAAI,CAAC,QAAQ,GAAG;YACZ,GAAG,IAAI,CAAC,QAAQ;YAChB,sBAAsB;SACzB,CAAC;IACN,CAAC;IAEe,oBAAoB,CAAC,EACjC,WAAW,EAAE,kBAAkB,EAAE,sBAAsB,EAClB;QAGrC,MAAM,oBAAoB,GAAG,IAAI,CAAC,2CAA2C,CAAC,WAAW,EAAE,kBAAkB,EAAE;YAC3G,cAAc,EAAE,sBAAsB;SACzC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,8CAA8C,IAAI,IAAI,EAAE,CAAC;YAC9D,OAAO,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,EAAE;gBACnD,yCAAyC,EAAE,SAAS;aACvD,CAAC,CAAC;QACP,CAAC;aAAM,IAAI,IAAI,CAAC,8CAA8C,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC9E,OAAO,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,EAAE;gBACnD,yCAAyC,EAAE,IAAI,CAAC,8CAA8C,CAAC,MAAM;aACxG,CAAC,CAAC;QACP,CAAC;QAED,IAAI,CAAC;YACD,OAAO,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,EAAE;gBACnD,yCAAyC,EAAE,SAAS;aACvD,CAAC,CAAC;QACP,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,EAAE;gBACnD,yCAAyC,EAAE,IAAI,CAAC,8CAA8C,CAAC,MAAM;aACxG,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAED,gBAAgB;IACR,oBAAoB,CAAC,OAAmC,EAAE,EAC9D,yCAAyC,EAG5C;QAMG,IAAI,uCAAuC,GAAG,KAAK,CAAC;QACpD,MAAM,kBAAkB,GAAG,yCAAyC,IAAI,IAAI;YACxE,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBACnB,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACzB,uCAAuC,GAAG,IAAI,CAAC;oBAC/C,OAAO;wBACH,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,SAAS,CAAC,UAAU,CACtB,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAC7B,yCAAyC,CAAC,KAAK,CAAC,aAAa,CAAC,CACjE,CAAC,QAAQ,EAAE;qBACW,CAAC;gBAChC,CAAC;gBAED,OAAO,IAAI,CAAC;YAChB,CAAC,CAAC,CAAC;QAEP,MAAM,WAAW,GAGZ,EAAE,CAAC;QAER,MAAM,YAAY,GAAgB,EAAE,CAAC;QACrC,IAAI,qBAAqB,GAAuC,IAAI,CAAC;QAErE,SAAS,KAAK;YACV,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,IAAI,qBAAqB,IAAI,IAAI;gBACxD,WAAW,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,EAAE,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,CAAC,EAAC,CAAC,CAAC;YAEzG,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;QAC5B,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,kBAAkB,EAAE,CAAC;YACpC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,iCAAiC,IAAI,qBAAqB,KAAK,QAAQ;oBAC7E,KAAK,EAAE,CAAC;gBAEZ,qBAAqB,GAAG,QAAQ,CAAC;gBACjC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACrD,CAAC;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBAC9B,IAAI,CAAC,IAAI,CAAC,iCAAiC,IAAI,qBAAqB,KAAK,MAAM;oBAC3E,KAAK,EAAE,CAAC;gBAEZ,qBAAqB,GAAG,MAAM,CAAC;gBAC/B,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5C,CAAC;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;gBAC/B,IAAI,CAAC,IAAI,CAAC,iCAAiC,IAAI,qBAAqB,KAAK,OAAO;oBAC5E,KAAK,EAAE,CAAC;gBAEZ,qBAAqB,GAAG,OAAO,CAAC;gBAChC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;YACrE,CAAC;;gBACG,KAAM,IAAqB,CAAC;QACpC,CAAC;QAED,MAAM,sBAAsB,GAAG,qBAAqB,KAAK,OAAO,CAAC;QACjE,KAAK,EAAE,CAAC;QAER,MAAM,YAAY,GAAG,IAAI,gBAAgB,CACrC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc;YAC5E,CAAC,yCAAyC,IAAI,EAAE,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,EAAC,OAAO,EAAC,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CACtH,CAAC;QAEF,MAAM,UAAU,GAGX,EAAE,CAAC;QACR,MAAM,YAAY,GAAG;YACjB,MAAM,EAAE,IAAI,CAAC,cAAc;YAC3B,IAAI,EAAE,IAAI,CAAC,YAAY;YACvB,KAAK,EAAE,IAAI,CAAC,aAAa;SACnB,CAAC;QACX,MAAM,WAAW,GAAG,IAAI,GAAG,EAAoC,CAAC;QAChE,MAAM,eAAe,GAAG,IAAI,GAAG,EAAU,CAAC;QAC1C,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;QAErC,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACnC,MAAM,EAAE,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;YAErC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACnB,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;YACxC,UAAU,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC;gBACnC,OAAO,EAAE,EAAE;aACd,CAAC,CAAC;YAEH,IAAI,UAAU,CAAC,IAAI,KAAK,OAAO;gBAC3B,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAChC,CAAC;QAED,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QAC7C,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QAC7C,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QAE7C,WAAW,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;QACrD,WAAW,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;QACrD,WAAW,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;QAErD,SAAS,UAAU,CAAgC,OAAU;YACzD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACtC,IAAI,CAAC,KAAK,OAAO,CAAC,MAAM,GAAG,CAAC;oBACxB,OAAO,OAAO,CAAC,CAAC,CAAE,EAAE,CAAC;gBAEzB,IAAI,CAAC;oBACD,OAAO,OAAO,CAAC,CAAC,CAAE,EAAE,CAAC;gBACzB,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACX,aAAa;gBACjB,CAAC;YACL,CAAC;YAED,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAC1C,CAAC;QAED,MAAM,eAAe,GAAG,GAAG,EAAE;YACzB,OAAO,UAAU,CAAC;gBACd,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;oBAC7B,GAAG,CACC,IAAI,CAAC,0BAA0B,IAAI,IAAI;wBACnC,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,0BAA0B,CAAC,CACzD;oBACD,QAAQ,EAAE,UAAU;oBACpB,WAAW,EAAE,UAAU;oBACvB,WAAW,EAAE,UAAU;oBACvB,WAAW,EAAE,UAAU;iBAC1B,CAAC;gBACF,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;oBAC7B,GAAG,CACC,IAAI,CAAC,0BAA0B,IAAI,IAAI;wBACnC,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,0BAA0B,CAAC,CACzD;oBACD,QAAQ,EAAE,UAAU;oBACpB,WAAW,EAAE,UAAU;oBACvB,WAAW,EAAE,UAAU;oBACvB,WAAW,EAAE,UAAU;oBACvB,uBAAuB,EAAE,IAAI;iBAChC,CAAC;aACL,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,MAAM,gCAAgC,GAAG,CAAC,KAA6C,EAAE,EAAE;YACvF,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;YAE3C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACvB,IAAI,OAAO,IAAI,KAAK,QAAQ;oBACxB,SAAS;gBAEb,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1C,CAAC;YAED,IAAI,cAAc,CAAC,IAAI,KAAK,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;QACtG,CAAC,CAAC;QAEF,MAAM,4BAA4B,GAAG,GAAG,EAAE;YACtC,MAAM,eAAe,GAAG,SAAS,CAAC,eAAe,EAAE,EAAE,CAAC,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YAE9E,IAAI,sBAAsB,EAAE,CAAC;gBACzB,IAAI,sBAAsB,GAAG,CAAC,CAAC,CAAC;gBAEhC,KAAK,IAAI,CAAC,GAAG,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;oBACnD,MAAM,IAAI,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;oBAEhC,IAAI,IAAI,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;wBACxC,SAAS;oBAEb,IAAI,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;wBACtC,sBAAsB,GAAG,CAAC,CAAC;wBAC3B,MAAM;oBACV,CAAC;yBAAM,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;wBACxC,gCAAgC,CAAC,eAAe,CAAC,CAAC;wBAClD,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;oBACvF,CAAC;gBACL,CAAC;gBAED,IAAI,sBAAsB,GAAG,CAAC,EAAE,CAAC;oBAC7B,gCAAgC,CAAC,eAAe,CAAC,CAAC;oBAClD,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;gBACjG,CAAC;gBAED,OAAO;oBACH,eAAe,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE,sBAAsB,GAAG,CAAC,CAAC;oBACrE,wBAAwB,EAAE,eAAe,CAAC,KAAK,CAAC,sBAAsB,GAAG,CAAC,CAAC;iBAC9E,CAAC;YACN,CAAC;YAED,OAAO;gBACH,eAAe;gBACf,wBAAwB,EAAE,EAAE;aAC/B,CAAC;QACN,CAAC,CAAC;QAEF,MAAM,EAAC,eAAe,EAAE,wBAAwB,EAAC,GAAG,4BAA4B,EAAE,CAAC;QAEnF,MAAM,uBAAuB,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;QACpD,MAAM,WAAW,GAAG,SAAS,CACzB,eAAe,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACzB,IAAI,OAAO,IAAI,KAAK,QAAQ;gBACxB,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,2EAA2E;YAEnH,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAEhD,IAAI,OAAO,IAAI,IAAI;gBACf,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAI,CAAC,SAAS,aAAa,CAAC,CAAC;YAErE,uBAAuB,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAE/C,OAAO,OAAO,CAAC;QACnB,CAAC,CAAC,CACL,CAAC;QAEF,IAAI,uBAAuB,CAAC,IAAI,KAAK,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;QAElG,OAAO;YACH,WAAW;YACX,eAAe,EAAE,CAAC,IAAI,CAAC,gCAAgC;gBACnD,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC;oBACE,gCAAgC;oBAChC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;yBACd,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;oBACxD,SAAS,CAAC,IAAI,CAAC;oBACf,SAAS,CAAC,MAAM,CAAC;oBACjB,SAAS,CAAC,KAAK,CAAC;oBAChB,SAAS,CAAC,KAAK,CAAC;iBACnB;YACL,sBAAsB,EAAE;gBACpB,SAAS,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;gBAClC,GAAG,CACC,wBAAwB,CAAC,MAAM,KAAK,CAAC;oBACjC,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC;wBACE,SAAS,CACL,wBAAwB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;4BAClC,IAAI,OAAO,IAAI,KAAK,QAAQ;gCACxB,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;4BAEvC,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;4BAEhD,IAAI,OAAO,IAAI,IAAI;gCACf,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAI,CAAC,SAAS,aAAa,CAAC,CAAC;4BAErE,OAAO,OAAO,CAAC;wBACnB,CAAC,CAAC,CACL;qBACJ,CACR;aACJ;YACD,uCAAuC;SAC1C,CAAC;IACN,CAAC;IAED;;;OAGG;IACK,cAAc;QAClB,IAAI,CAAC;YACD,IAAI,sBAAsB,GAAG,IAAI,CAAC;YAElC,KAAK,MAAM,WAAW,IAAI,0BAA0B,EAAE,CAAC;gBACnD,MAAM,EAAC,uCAAuC,EAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,EAAC,WAAW,EAAC,CAAC,CAAC;gBAE3F,IAAI,uCAAuC;oBACvC,sBAAsB,GAAG,KAAK,CAAC;YACvC,CAAC;YAED,OAAO,EAAC,sBAAsB,EAAC,CAAC;QACpC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,sDAAsD,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,0DAA0D,CAAC,CAAC;QACvJ,CAAC;IACL,CAAC;CACJ;AAED,MAAM,gBAAgB;IACF,QAAQ,CAAS;IAChB,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAE1C,YAAmB,QAAgB;QAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAEM,UAAU;QACb,IAAI,EAAU,CAAC;QAEf,GAAG,CAAC;YACA,EAAE,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE;iBACpB,QAAQ,CAAC,EAAE,CAAC;iBACZ,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;QACzB,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;QAE1D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAElB,OAAO,EAAE,CAAC;IACd,CAAC;IAEM,QAAQ,CAAC,EAAU;QACtB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;CACJ;AAED,SAAS,2DAA2D,CAChE,8CAAkI;IAElI,IAAI,8CAA8C,KAAK,KAAK;QACxD,OAAO,SAAS,CAAC;IAErB,IAAI,8CAA8C,KAAK,IAAI;QACvD,OAAO;YACH,GAAG,2DAA2D;YAC9D,GAAG,EAAE,QAAQ;SAChB,CAAC;IAEN,IAAI,8CAA8C,KAAK,MAAM;QACzD,OAAO;YACH,GAAG,2DAA2D;YAC9D,GAAG,EAAE,UAAU;SAClB,CAAC;IAEN,IAAI,OAAO,8CAA8C,KAAK,QAAQ;QAClE,OAAO;YACH,GAAG,8CAA8C;YACjD,GAAG,EAAE,8CAA8C,CAAC,GAAG,IAAI,UAAU;SACxE,CAAC;IAEN,OAAO,EAAC,GAAG,2DAA2D,EAAE,GAAG,EAAE,UAAU,EAAC,CAAC;AAC7F,CAAC;AAED,MAAM,0BAA0B,GAAwB;IACpD,CAAC;YACG,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,+BAA+B;SACxC,EAAE;YACC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,sDAAsD;SAC/D,EAAE;YACC,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC,EAAE,CAAC;SACjB,CAAC;IAEF,CAAC;YACG,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,+BAA+B;SACxC,EAAE;YACC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,sDAAsD;SAC/D,EAAE;YACC,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC,qDAAqD,CAAC;SACpE,CAAC;IAEF,CAAC;YACG,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,+BAA+B;SACxC,EAAE;YACC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,sDAAsD;SAC/D,EAAE;YACC,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC,qDAAqD,CAAC;SACpE,EAAE;YACC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,uDAAuD;SAChE,EAAE;YACC,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC,EAAE,CAAC;SACjB,CAAC;IAEF,CAAC;YACG,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,+BAA+B;SACxC,EAAE;YACC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,sDAAsD;SAC/D,EAAE;YACC,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC,qDAAqD,CAAC;SACpE,EAAE;YACC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,uDAAuD;SAChE,EAAE;YACC,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC,sDAAsD,CAAC;SACrE,CAAC;CACL,CAAC"}

package/dist/chatWrappers/generic/TemplateChatWrapper.d.ts

@@ -0,0 +1,60 @@
+import { ChatWrapperGenerateContextStateOptions, ChatWrapperGeneratedContextState, ChatWrapperSettings } from "../../types.js";
+import { ChatWrapper } from "../../ChatWrapper.js";
+import { ChatHistoryFunctionCallMessageTemplate } from "./utils/chatHistoryFunctionCallMessageTemplate.js";
+export type TemplateChatWrapperOptions = {
+    template: `${"" | `${string}{{systemPrompt}}`}${string}{{history}}${string}{{completion}}${string}`;
+    historyTemplate: {
+        system: `${string}{{message}}${string}`;
+        user: `${string}{{message}}${string}`;
+        model: `${string}{{message}}${string}`;
+    };
+    functionCallMessageTemplate?: ChatHistoryFunctionCallMessageTemplate;
+    joinAdjacentMessagesOfTheSameType?: boolean;
+};
+/**
+ * A chat wrapper based on a simple template.
+ * @example
+ * <span v-pre>
+ *
+ * ```ts
+ * import {TemplateChatWrapper} from "node-llama-cpp";
+ *
+ * const chatWrapper = new TemplateChatWrapper({
+ *     template: "{{systemPrompt}}\n{{history}}model: {{completion}}\nuser: ",
+ *     historyTemplate: {
+ *         system: "system: {{message}}\n",
+ *         user: "user: {{message}}\n",
+ *         model: "model: {{message}}\n"
+ *     },
+ *     // functionCallMessageTemplate: { // optional
+ *     //     call: "[[call: {{functionName}}({{functionParams}})]]",
+ *     //     result: " [[result: {{functionCallResult}}]]"
+ *     // }
+ * });
+ * ```
+ *
+ * </span>
+ *
+ * **<span v-pre>`{{systemPrompt}}`</span>** is optional and is replaced with the first system message
+ * (when is does, that system message is not included in the history).
+ *
+ * **<span v-pre>`{{history}}`</span>** is replaced with the chat history.
+ * Each message in the chat history is converted using the template passed to `historyTemplate` for the message role,
+ * and all messages are joined together.
+ *
+ * **<span v-pre>`{{completion}}`</span>** is where the model's response is generated.
+ * The text that comes after <span v-pre>`{{completion}}`</span> is used to determine when the model has finished generating the response,
+ * and thus is mandatory.
+ *
+ * **`functionCallMessageTemplate`** is used to specify the format in which functions can be called by the model and
+ * how their results are fed to the model after the function call.
+ */
+export declare class TemplateChatWrapper extends ChatWrapper {
+    readonly wrapperName = "Template";
+    readonly settings: ChatWrapperSettings;
+    readonly template: TemplateChatWrapperOptions["template"];
+    readonly historyTemplate: Readonly<TemplateChatWrapperOptions["historyTemplate"]>;
+    readonly joinAdjacentMessagesOfTheSameType: boolean;
+    constructor({ template, historyTemplate, functionCallMessageTemplate, joinAdjacentMessagesOfTheSameType }: TemplateChatWrapperOptions);
+    generateContextState({ chatHistory, availableFunctions, documentFunctionParams }: ChatWrapperGenerateContextStateOptions): ChatWrapperGeneratedContextState;
+}