node-llama-cpp 3.0.0-beta.3 → 3.0.0-beta.30

package/dist/chatWrappers/generic/TemplateChatWrapper.js

@@ -0,0 +1,200 @@
+import { SpecialToken, LlamaText, SpecialTokensText } from "../../utils/LlamaText.js";
+import { ChatWrapper } from "../../ChatWrapper.js";
+import { parseTextTemplate } from "../../utils/parseTextTemplate.js";
+import { parseFunctionCallMessageTemplate } from "./utils/chatHistoryFunctionCallMessageTemplate.js";
+/**
+ * A chat wrapper based on a simple template.
+ * @example
+ * ```typescript
+ * const chatWrapper = new TemplateChatWrapper({
+ *     template: "{{systemPrompt}}\n{{history}}model:{{completion}}\nuser:",
+ *     historyTemplate: "{{roleName}}: {{message}}\n",
+ *     modelRoleName: "model",
+ *     userRoleName: "user",
+ *     systemRoleName: "system", // optional
+ *     // functionCallMessageTemplate: { // optional
+ *     //     call: "[[call: {{functionName}}({{functionParams}})]]",
+ *     //     result: " [[result: {{functionCallResult}}]]"
+ *     // }
+ * });
+ * ```
+ *
+ * **<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 template passed to `historyTemplate`, 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 class TemplateChatWrapper extends ChatWrapper {
+    wrapperName = "Template";
+    settings;
+    template;
+    historyTemplate;
+    modelRoleName;
+    userRoleName;
+    systemRoleName;
+    joinAdjacentMessagesOfTheSameType;
+    /** @internal */ _parsedChatTemplate;
+    /** @internal */ _parsedChatHistoryTemplate;
+    constructor({ template, historyTemplate, modelRoleName, userRoleName, systemRoleName = "System", functionCallMessageTemplate, joinAdjacentMessagesOfTheSameType = true }) {
+        super();
+        if (template == null || historyTemplate == null || modelRoleName == null || userRoleName == null)
+            throw new Error("Template chat wrapper settings must have a template, historyTemplate, modelRoleName, and userRoleName.");
+        this.template = template;
+        this.historyTemplate = historyTemplate;
+        this.modelRoleName = modelRoleName;
+        this.userRoleName = userRoleName;
+        this.systemRoleName = systemRoleName;
+        this.joinAdjacentMessagesOfTheSameType = joinAdjacentMessagesOfTheSameType;
+        this._parsedChatTemplate = parseChatTemplate(template);
+        this._parsedChatHistoryTemplate = parseChatHistoryTemplate(historyTemplate);
+        this.settings = {
+            ...ChatWrapper.defaultSettings,
+            functions: parseFunctionCallMessageTemplate(functionCallMessageTemplate) ?? ChatWrapper.defaultSettings.functions
+        };
+    }
+    generateContextState({ chatHistory, availableFunctions, documentFunctionParams }) {
+        const historyWithFunctions = this.addAvailableFunctionsSystemMessageToHistory(chatHistory, availableFunctions, {
+            documentParams: documentFunctionParams
+        });
+        const resultItems = [];
+        const systemTexts = [];
+        const userTexts = [];
+        const modelTexts = [];
+        let currentAggregateFocus = null;
+        function flush() {
+            if (systemTexts.length > 0 || userTexts.length > 0 || modelTexts.length > 0)
+                resultItems.push({
+                    system: LlamaText.joinValues("\n\n", systemTexts),
+                    user: LlamaText.joinValues("\n\n", userTexts),
+                    model: LlamaText.joinValues("\n\n", modelTexts)
+                });
+            systemTexts.length = 0;
+            userTexts.length = 0;
+            modelTexts.length = 0;
+        }
+        for (const item of historyWithFunctions) {
+            if (item.type === "system") {
+                if (!this.joinAdjacentMessagesOfTheSameType || currentAggregateFocus !== "system")
+                    flush();
+                currentAggregateFocus = "system";
+                systemTexts.push(LlamaText.fromJSON(item.text));
+            }
+            else if (item.type === "user") {
+                if (!this.joinAdjacentMessagesOfTheSameType || (currentAggregateFocus !== "system" && currentAggregateFocus !== "user"))
+                    flush();
+                currentAggregateFocus = "user";
+                userTexts.push(LlamaText(item.text));
+            }
+            else if (item.type === "model") {
+                if (!this.joinAdjacentMessagesOfTheSameType)
+                    flush();
+                currentAggregateFocus = "model";
+                modelTexts.push(this.generateModelResponseText(item.response));
+            }
+            else
+                void (item);
+        }
+        flush();
+        const getHistoryItem = (role, text, prefix) => {
+            const { roleNamePrefix, messagePrefix, messageSuffix } = this._parsedChatHistoryTemplate;
+            return LlamaText([
+                new SpecialTokensText((prefix ?? "") + roleNamePrefix + role + messagePrefix),
+                text,
+                new SpecialTokensText(messageSuffix)
+            ]);
+        };
+        const contextText = LlamaText(resultItems.map(({ system, user, model }, index) => {
+            const isFirstItem = index === 0;
+            const isLastItem = index === resultItems.length - 1;
+            const res = LlamaText([
+                isFirstItem
+                    ? system.values.length === 0
+                        ? new SpecialTokensText((this._parsedChatTemplate.systemPromptPrefix ?? "") + this._parsedChatTemplate.historyPrefix)
+                        : this._parsedChatTemplate.systemPromptPrefix != null
+                            ? LlamaText([
+                                new SpecialTokensText(this._parsedChatTemplate.systemPromptPrefix),
+                                system,
+                                new SpecialTokensText(this._parsedChatTemplate.historyPrefix)
+                            ])
+                            : getHistoryItem("system", system, this._parsedChatTemplate.historyPrefix)
+                    : system.values.length === 0
+                        ? LlamaText([])
+                        : getHistoryItem("system", system),
+                user.values.length === 0
+                    ? LlamaText([])
+                    : getHistoryItem("user", user),
+                model.values.length === 0
+                    ? LlamaText([])
+                    : !isLastItem
+                        ? getHistoryItem("model", model)
+                        : LlamaText([
+                            new SpecialTokensText(this._parsedChatTemplate.completionPrefix),
+                            model
+                        ])
+            ]);
+            return LlamaText(res.values.reduce((res, value) => {
+                if (value instanceof SpecialTokensText) {
+                    const lastItem = res[res.length - 1];
+                    if (lastItem == null || !(lastItem instanceof SpecialTokensText))
+                        return res.concat([value]);
+                    return res.slice(0, -1).concat([
+                        new SpecialTokensText(lastItem.value + value.value)
+                    ]);
+                }
+                return res.concat([value]);
+            }, []));
+        }));
+        return {
+            contextText,
+            stopGenerationTriggers: [
+                LlamaText(new SpecialToken("EOS")),
+                LlamaText(this._parsedChatTemplate.completionSuffix),
+                LlamaText(new SpecialTokensText(this._parsedChatTemplate.completionSuffix))
+            ]
+        };
+    }
+}
+function parseChatTemplate(template) {
+    const parsedTemplate = parseTextTemplate(template, [{
+            text: "{{systemPrompt}}",
+            key: "systemPrompt",
+            optional: true
+        }, {
+            text: "{{history}}",
+            key: "history"
+        }, {
+            text: "{{completion}}",
+            key: "completion"
+        }]);
+    if (parsedTemplate.completion.suffix.length == 0)
+        throw new Error('Chat template must have text after "{{completion}}"');
+    return {
+        systemPromptPrefix: parsedTemplate.systemPrompt?.prefix ?? null,
+        historyPrefix: parsedTemplate.history.prefix,
+        completionPrefix: parsedTemplate.completion.prefix,
+        completionSuffix: parsedTemplate.completion.suffix
+    };
+}
+function parseChatHistoryTemplate(template) {
+    const parsedTemplate = parseTextTemplate(template, [{
+            text: "{{roleName}}",
+            key: "roleName"
+        }, {
+            text: "{{message}}",
+            key: "message"
+        }]);
+    return {
+        roleNamePrefix: parsedTemplate.roleName.prefix,
+        messagePrefix: parsedTemplate.message.prefix,
+        messageSuffix: parsedTemplate.message.suffix
+    };
+}
+//# sourceMappingURL=TemplateChatWrapper.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TemplateChatWrapper.js","sourceRoot":"","sources":["../../../src/chatWrappers/generic/TemplateChatWrapper.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,YAAY,EAAE,SAAS,EAAkB,iBAAiB,EAAC,MAAM,0BAA0B,CAAC;AACpG,OAAO,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAC,iBAAiB,EAAC,MAAM,kCAAkC,CAAC;AACnE,OAAO,EAAyC,gCAAgC,EAAC,MAAM,mDAAmD,CAAC;AAY3I;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,OAAO,mBAAoB,SAAQ,WAAW;IAChC,WAAW,GAAG,UAAU,CAAC;IAChB,QAAQ,CAAsB;IAEvC,QAAQ,CAAyC;IACjD,eAAe,CAAgD;IAC/D,aAAa,CAAS;IACtB,YAAY,CAAS;IACrB,cAAc,CAAS;IACvB,iCAAiC,CAAU;IAE3D,gBAAgB,CAAkB,mBAAmB,CAAuC;IAC5F,gBAAgB,CAAkB,0BAA0B,CAA8C;IAE1G,YAAmB,EACf,QAAQ,EACR,eAAe,EACf,aAAa,EACb,YAAY,EACZ,cAAc,GAAG,QAAQ,EACzB,2BAA2B,EAC3B,iCAAiC,GAAG,IAAI,EACf;QACzB,KAAK,EAAE,CAAC;QAER,IAAI,QAAQ,IAAI,IAAI,IAAI,eAAe,IAAI,IAAI,IAAI,aAAa,IAAI,IAAI,IAAI,YAAY,IAAI,IAAI;YAC5F,MAAM,IAAI,KAAK,CAAC,wGAAwG,CAAC,CAAC;QAE9H,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,iCAAiC,GAAG,iCAAiC,CAAC;QAE3E,IAAI,CAAC,mBAAmB,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,CAAC,0BAA0B,GAAG,wBAAwB,CAAC,eAAe,CAAC,CAAC;QAE5E,IAAI,CAAC,QAAQ,GAAG;YACZ,GAAG,WAAW,CAAC,eAAe;YAC9B,SAAS,EAAE,gCAAgC,CAAC,2BAA2B,CAAC,IAAI,WAAW,CAAC,eAAe,CAAC,SAAS;SACpH,CAAC;IACN,CAAC;IAEe,oBAAoB,CAAC,EACjC,WAAW,EAAE,kBAAkB,EAAE,sBAAsB,EAClB;QACrC,MAAM,oBAAoB,GAAG,IAAI,CAAC,2CAA2C,CAAC,WAAW,EAAE,kBAAkB,EAAE;YAC3G,cAAc,EAAE,sBAAsB;SACzC,CAAC,CAAC;QAEH,MAAM,WAAW,GAIZ,EAAE,CAAC;QAER,MAAM,WAAW,GAAgB,EAAE,CAAC;QACpC,MAAM,SAAS,GAAgB,EAAE,CAAC;QAClC,MAAM,UAAU,GAAgB,EAAE,CAAC;QACnC,IAAI,qBAAqB,GAAuC,IAAI,CAAC;QAErE,SAAS,KAAK;YACV,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC;gBACvE,WAAW,CAAC,IAAI,CAAC;oBACb,MAAM,EAAE,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC;oBACjD,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,SAAS,CAAC;oBAC7C,KAAK,EAAE,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC;iBAClD,CAAC,CAAC;YAEP,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;YACvB,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;YACrB,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;QAC1B,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,oBAAoB,EAAE,CAAC;YACtC,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,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACpD,CAAC;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBAC9B,IAAI,CAAC,IAAI,CAAC,iCAAiC,IAAI,CAAC,qBAAqB,KAAK,QAAQ,IAAI,qBAAqB,KAAK,MAAM,CAAC;oBACnH,KAAK,EAAE,CAAC;gBAEZ,qBAAqB,GAAG,MAAM,CAAC;gBAC/B,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACzC,CAAC;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;gBAC/B,IAAI,CAAC,IAAI,CAAC,iCAAiC;oBACvC,KAAK,EAAE,CAAC;gBAEZ,qBAAqB,GAAG,OAAO,CAAC;gBAChC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;YACnE,CAAC;;gBACG,KAAK,CAAC,IAAoB,CAAC,CAAC;QACpC,CAAC;QAED,KAAK,EAAE,CAAC;QAER,MAAM,cAAc,GAAG,CAAC,IAAiC,EAAE,IAAe,EAAE,MAAsB,EAAE,EAAE;YAClG,MAAM,EAAC,cAAc,EAAE,aAAa,EAAE,aAAa,EAAC,GAAG,IAAI,CAAC,0BAA0B,CAAC;YACvF,OAAO,SAAS,CAAC;gBACb,IAAI,iBAAiB,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,cAAc,GAAG,IAAI,GAAG,aAAa,CAAC;gBAC7E,IAAI;gBACJ,IAAI,iBAAiB,CAAC,aAAa,CAAC;aACvC,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,MAAM,WAAW,GAAG,SAAS,CACzB,WAAW,CAAC,GAAG,CAAC,CAAC,EAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAC,EAAE,KAAK,EAAE,EAAE;YAC7C,MAAM,WAAW,GAAG,KAAK,KAAK,CAAC,CAAC;YAChC,MAAM,UAAU,GAAG,KAAK,KAAK,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;YAEpD,MAAM,GAAG,GAAG,SAAS,CAAC;gBAClB,WAAW;oBACP,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;wBACxB,CAAC,CAAC,IAAI,iBAAiB,CACnB,CAAC,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAC/F;wBACD,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,IAAI,IAAI;4BACjD,CAAC,CAAC,SAAS,CAAC;gCACR,IAAI,iBAAiB,CAAC,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC;gCAClE,MAAM;gCACN,IAAI,iBAAiB,CAAC,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC;6BAChE,CAAC;4BACF,CAAC,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC;oBAClF,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;wBACxB,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;wBACf,CAAC,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAG1C,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;oBACpB,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC;gBAElC,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;oBACrB,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,CAAC,UAAU;wBACT,CAAC,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC;wBAChC,CAAC,CAAC,SAAS,CAAC;4BACR,IAAI,iBAAiB,CAAC,IAAI,CAAC,mBAAmB,CAAC,gBAAgB,CAAC;4BAChE,KAAK;yBACR,CAAC;aACb,CAAC,CAAC;YAEH,OAAO,SAAS,CACZ,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;gBAC7B,IAAI,KAAK,YAAY,iBAAiB,EAAE,CAAC;oBACrC,MAAM,QAAQ,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;oBAErC,IAAI,QAAQ,IAAI,IAAI,IAAI,CAAC,CAAC,QAAQ,YAAY,iBAAiB,CAAC;wBAC5D,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;oBAE/B,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;wBAC3B,IAAI,iBAAiB,CAAC,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;qBACtD,CAAC,CAAC;gBACP,CAAC;gBAED,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YAC/B,CAAC,EAAE,EAAsB,CAAC,CAC7B,CAAC;QACN,CAAC,CAAC,CACL,CAAC;QAEF,OAAO;YACH,WAAW;YACX,sBAAsB,EAAE;gBACpB,SAAS,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;gBAClC,SAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,gBAAgB,CAAC;gBACpD,SAAS,CAAC,IAAI,iBAAiB,CAAC,IAAI,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;aAC9E;SACJ,CAAC;IACN,CAAC;CACJ;AAED,SAAS,iBAAiB,CAAC,QAAgD;IAMvE,MAAM,cAAc,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;YAChD,IAAI,EAAE,kBAAkB;YACxB,GAAG,EAAE,cAAc;YACnB,QAAQ,EAAE,IAAI;SACjB,EAAE;YACC,IAAI,EAAE,aAAa;YACnB,GAAG,EAAE,SAAS;SACjB,EAAE;YACC,IAAI,EAAE,gBAAgB;YACtB,GAAG,EAAE,YAAY;SACpB,CAAC,CAAC,CAAC;IAEJ,IAAI,cAAc,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;IAE3E,OAAO;QACH,kBAAkB,EAAE,cAAc,CAAC,YAAY,EAAE,MAAM,IAAI,IAAI;QAC/D,aAAa,EAAE,cAAc,CAAC,OAAO,CAAC,MAAM;QAC5C,gBAAgB,EAAE,cAAc,CAAC,UAAU,CAAC,MAAM;QAClD,gBAAgB,EAAE,cAAc,CAAC,UAAU,CAAC,MAAM;KACrD,CAAC;AACN,CAAC;AAED,SAAS,wBAAwB,CAAC,QAAuD;IAKrF,MAAM,cAAc,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;YAChD,IAAI,EAAE,cAAc;YACpB,GAAG,EAAE,UAAU;SAClB,EAAE;YACC,IAAI,EAAE,aAAa;YACnB,GAAG,EAAE,SAAS;SACjB,CAAC,CAAC,CAAC;IAEJ,OAAO;QACH,cAAc,EAAE,cAAc,CAAC,QAAQ,CAAC,MAAM;QAC9C,aAAa,EAAE,cAAc,CAAC,OAAO,CAAC,MAAM;QAC5C,aAAa,EAAE,cAAc,CAAC,OAAO,CAAC,MAAM;KAC/C,CAAC;AACN,CAAC"}

package/dist/chatWrappers/generic/utils/chatHistoryFunctionCallMessageTemplate.d.ts

@@ -0,0 +1,23 @@
+import { ChatWrapperSettings } from "../../../types.js";
+export declare function parseFunctionCallMessageTemplate(template?: ChatHistoryFunctionCallMessageTemplate): ChatWrapperSettings["functions"] | null;
+/**
+ * Template format for how functions can be called by the model and how their results are fed to the model after the function call.
+ * Consists of an array with two elements:
+ * 1. The function call template.
+ * 2. The function call result template.
+ *
+ * For example:
+ * ```typescript
+ * const template: ChatHistoryFunctionCallMessageTemplate = {
+ *     call: "[[call: {{functionName}}({{functionParams}})]]",
+ *     result: " [[result: {{functionCallResult}}]]"
+ * };
+ * ```
+ *
+ * It's mandatory for the call template to have text before <span v-pre>`{{functionName}}`</span> in order for the chat wrapper know when
+ * to activate the function calling grammar.
+ */
+export type ChatHistoryFunctionCallMessageTemplate = {
+    call: `${string}{{functionName}}${string}{{functionParams}}${string}`;
+    result: `${string}{{functionCallResult}}${string}`;
+};

package/dist/chatWrappers/generic/utils/chatHistoryFunctionCallMessageTemplate.js

@@ -0,0 +1,45 @@
+import { parseTextTemplate } from "../../../utils/parseTextTemplate.js";
+export function parseFunctionCallMessageTemplate(template) {
+    if (template == null)
+        return null;
+    const { call: functionCallTemplate, result: functionCallResultTemplate } = template;
+    if (functionCallTemplate == null || functionCallResultTemplate == null)
+        throw new Error("Both function call and function call result templates are required");
+    const parsedFunctionCallTemplate = parseTextTemplate(functionCallTemplate, [{
+            text: "{{functionName}}",
+            key: "functionName"
+        }, {
+            text: "{{functionParams}}",
+            key: "functionParams"
+        }]);
+    const parsedFunctionCallResultTemplate = parseTextTemplate(functionCallResultTemplate, [{
+            text: "{{functionCallResult}}",
+            key: "functionCallResult"
+        }]);
+    const callPrefix = parsedFunctionCallTemplate.functionName.prefix;
+    const callParamsPrefix = parsedFunctionCallTemplate.functionParams.prefix;
+    const callSuffix = parsedFunctionCallTemplate.functionParams.suffix;
+    const resultPrefix = parsedFunctionCallResultTemplate.functionCallResult.prefix;
+    const resultSuffix = parsedFunctionCallResultTemplate.functionCallResult.suffix;
+    if (callPrefix.length === 0)
+        throw new Error("Function call template must have text before \"{{functionName}}\"");
+    if (callSuffix.length === 0)
+        throw new Error("Function call template must have text after \"{{functionParams}}\"");
+    if (resultPrefix.length === 0)
+        throw new Error("Function call result template must have text before \"{{functionCallResult}}\"");
+    if (resultSuffix.length === 0)
+        throw new Error("Function call result template must have text after \"{{functionCallResult}}\"");
+    return {
+        call: {
+            optionalPrefixSpace: true,
+            prefix: callPrefix,
+            paramsPrefix: callParamsPrefix,
+            suffix: callSuffix
+        },
+        result: {
+            prefix: resultPrefix,
+            suffix: resultSuffix
+        }
+    };
+}
+//# sourceMappingURL=chatHistoryFunctionCallMessageTemplate.js.map

package/dist/chatWrappers/generic/utils/chatHistoryFunctionCallMessageTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chatHistoryFunctionCallMessageTemplate.js","sourceRoot":"","sources":["../../../../src/chatWrappers/generic/utils/chatHistoryFunctionCallMessageTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAC,MAAM,qCAAqC,CAAC;AAGtE,MAAM,UAAU,gCAAgC,CAC5C,QAAiD;IAEjD,IAAI,QAAQ,IAAI,IAAI;QAChB,OAAO,IAAI,CAAC;IAEhB,MAAM,EACF,IAAI,EAAE,oBAAoB,EAC1B,MAAM,EAAE,0BAA0B,EACrC,GAAG,QAAQ,CAAC;IAEb,IAAI,oBAAoB,IAAI,IAAI,IAAI,0BAA0B,IAAI,IAAI;QAClE,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;IAE1F,MAAM,0BAA0B,GAAG,iBAAiB,CAAC,oBAAoB,EAAE,CAAC;YACxE,IAAI,EAAE,kBAAkB;YACxB,GAAG,EAAE,cAAc;SACtB,EAAE;YACC,IAAI,EAAE,oBAAoB;YAC1B,GAAG,EAAE,gBAAgB;SACxB,CAAC,CAAC,CAAC;IACJ,MAAM,gCAAgC,GAAG,iBAAiB,CAAC,0BAA0B,EAAE,CAAC;YACpF,IAAI,EAAE,wBAAwB;YAC9B,GAAG,EAAE,oBAAoB;SAC5B,CAAC,CAAC,CAAC;IAEJ,MAAM,UAAU,GAAG,0BAA0B,CAAC,YAAY,CAAC,MAAM,CAAC;IAClE,MAAM,gBAAgB,GAAG,0BAA0B,CAAC,cAAc,CAAC,MAAM,CAAC;IAC1E,MAAM,UAAU,GAAG,0BAA0B,CAAC,cAAc,CAAC,MAAM,CAAC;IAEpE,MAAM,YAAY,GAAG,gCAAgC,CAAC,kBAAkB,CAAC,MAAM,CAAC;IAChF,MAAM,YAAY,GAAG,gCAAgC,CAAC,kBAAkB,CAAC,MAAM,CAAC;IAEhF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;IAEzF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;IAE1F,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC;IAEtG,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,+EAA+E,CAAC,CAAC;IAErG,OAAO;QACH,IAAI,EAAE;YACF,mBAAmB,EAAE,IAAI;YACzB,MAAM,EAAE,UAAU;YAClB,YAAY,EAAE,gBAAgB;YAC9B,MAAM,EAAE,UAAU;SACrB;QACD,MAAM,EAAE;YACJ,MAAM,EAAE,YAAY;YACpB,MAAM,EAAE,YAAY;SACvB;KACJ,CAAC;AACN,CAAC"}

package/dist/chatWrappers/utils/ChatModelFunctionsDocumentationGenerator.d.ts

@@ -0,0 +1,42 @@
+import { ChatModelFunctions } from "../../types.js";
+/**
+ * Generate documentation about the functions that are available for a model to call.
+ * Useful for generating a system message with information about the available functions as part of a chat wrapper.
+ */
+export declare class ChatModelFunctionsDocumentationGenerator {
+    readonly chatModelFunctions?: ChatModelFunctions;
+    readonly hasAnyFunctions: boolean;
+    constructor(chatModelFunctions: ChatModelFunctions | undefined);
+    /**
+     * Example:
+     * ```typescript
+     * // Retrieve the current date
+     * function getDate();
+     *
+     * // Retrieve the current time
+     * function getTime(params: {hours: "24" | "12", seconds: boolean});
+     * ```
+     * @param options
+     * @param [options.documentParams] - Whether to document the parameters of the functions
+     */
+    getTypeScriptFunctionSignatures({ documentParams }?: {
+        documentParams?: boolean;
+    }): string;
+    /**
+     * Example:
+     * ```typescript
+     * // Retrieve the current date
+     * type getDate = () => any;
+     *
+     * // Retrieve the current time
+     * type getTime = (_: {hours: "24" | "12", seconds: boolean}) => any;
+     * ```
+     * @param options
+     * @param [options.documentParams] - Whether to document the parameters of the functions
+     * @param [options.reservedFunctionNames] - Function names that are reserved and cannot be used
+     */
+    getTypeScriptFunctionTypes({ documentParams, reservedFunctionNames }?: {
+        documentParams?: boolean;
+        reservedFunctionNames?: string[];
+    }): string;
+}

package/dist/chatWrappers/utils/ChatModelFunctionsDocumentationGenerator.js

@@ -0,0 +1,82 @@
+import { getTypeScriptTypeStringForGbnfJsonSchema } from "../../utils/getTypeScriptTypeStringForGbnfJsonSchema.js";
+/**
+ * Generate documentation about the functions that are available for a model to call.
+ * Useful for generating a system message with information about the available functions as part of a chat wrapper.
+ */
+export class ChatModelFunctionsDocumentationGenerator {
+    chatModelFunctions;
+    hasAnyFunctions;
+    constructor(chatModelFunctions) {
+        this.chatModelFunctions = chatModelFunctions;
+        this.hasAnyFunctions = Object.keys(this.chatModelFunctions ?? {}).length > 0;
+    }
+    /**
+     * Example:
+     * ```typescript
+     * // Retrieve the current date
+     * function getDate();
+     *
+     * // Retrieve the current time
+     * function getTime(params: {hours: "24" | "12", seconds: boolean});
+     * ```
+     * @param options
+     * @param [options.documentParams] - Whether to document the parameters of the functions
+     */
+    getTypeScriptFunctionSignatures({ documentParams = true } = {}) {
+        const chatModelFunctions = this.chatModelFunctions;
+        if (!this.hasAnyFunctions || chatModelFunctions == null)
+            return "";
+        const functionNames = Object.keys(chatModelFunctions);
+        return functionNames
+            .map((functionName) => {
+            const functionDefinition = chatModelFunctions[functionName];
+            let res = "";
+            if (functionDefinition?.description != null && functionDefinition.description.trim() !== "")
+                res += "// " + functionDefinition.description.split("\n").join("\n// ") + "\n";
+            res += "function " + functionName + "(";
+            if (documentParams && functionDefinition?.params != null)
+                res += "params: " + getTypeScriptTypeStringForGbnfJsonSchema(functionDefinition.params);
+            else if (!documentParams && functionDefinition?.params != null)
+                res += "params";
+            res += ");";
+            return res;
+        })
+            .join("\n\n");
+    }
+    /**
+     * Example:
+     * ```typescript
+     * // Retrieve the current date
+     * type getDate = () => any;
+     *
+     * // Retrieve the current time
+     * type getTime = (_: {hours: "24" | "12", seconds: boolean}) => any;
+     * ```
+     * @param options
+     * @param [options.documentParams] - Whether to document the parameters of the functions
+     * @param [options.reservedFunctionNames] - Function names that are reserved and cannot be used
+     */
+    getTypeScriptFunctionTypes({ documentParams = true, reservedFunctionNames = [] } = {}) {
+        const chatModelFunctions = this.chatModelFunctions;
+        if (!this.hasAnyFunctions || chatModelFunctions == null)
+            return "";
+        const functionNames = Object.keys(chatModelFunctions);
+        const reservedFunctionNamesSet = new Set(reservedFunctionNames);
+        return functionNames
+            .map((functionName) => {
+            if (reservedFunctionNamesSet.has(functionName))
+                throw new Error(`Function name "${functionName}" is reserved and cannot be used`);
+            const functionDefinition = chatModelFunctions[functionName];
+            let res = "";
+            if (functionDefinition?.description != null && functionDefinition.description.trim() !== "")
+                res += "// " + functionDefinition.description.split("\n").join("\n// ") + "\n";
+            res += "type " + functionName + " = (";
+            if (documentParams && functionDefinition?.params != null)
+                res += "_: " + getTypeScriptTypeStringForGbnfJsonSchema(functionDefinition.params);
+            res += ") => any;";
+            return res;
+        })
+            .join("\n\n");
+    }
+}
+//# sourceMappingURL=ChatModelFunctionsDocumentationGenerator.js.map

package/dist/chatWrappers/utils/ChatModelFunctionsDocumentationGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatModelFunctionsDocumentationGenerator.js","sourceRoot":"","sources":["../../../src/chatWrappers/utils/ChatModelFunctionsDocumentationGenerator.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,wCAAwC,EAAC,MAAM,yDAAyD,CAAC;AAEjH;;;GAGG;AACH,MAAM,OAAO,wCAAwC;IACjC,kBAAkB,CAAsB;IACxC,eAAe,CAAU;IAEzC,YAAmB,kBAAkD;QACjE,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;OAWG;IACI,+BAA+B,CAAC,EAAC,cAAc,GAAG,IAAI,KAAgC,EAAE;QAC3F,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAEnD,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,kBAAkB,IAAI,IAAI;YACnD,OAAO,EAAE,CAAC;QAEd,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAEtD,OAAO,aAAa;aACf,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE;YAClB,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC;YAC5D,IAAI,GAAG,GAAG,EAAE,CAAC;YAEb,IAAI,kBAAkB,EAAE,WAAW,IAAI,IAAI,IAAI,kBAAkB,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE;gBACvF,GAAG,IAAI,KAAK,GAAG,kBAAkB,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;YAEnF,GAAG,IAAI,WAAW,GAAG,YAAY,GAAG,GAAG,CAAC;YAExC,IAAI,cAAc,IAAI,kBAAkB,EAAE,MAAM,IAAI,IAAI;gBACpD,GAAG,IAAI,UAAU,GAAG,wCAAwC,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;iBACvF,IAAI,CAAC,cAAc,IAAI,kBAAkB,EAAE,MAAM,IAAI,IAAI;gBAC1D,GAAG,IAAI,QAAQ,CAAC;YAEpB,GAAG,IAAI,IAAI,CAAC;YAEZ,OAAO,GAAG,CAAC;QACf,CAAC,CAAC;aACD,IAAI,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,0BAA0B,CAAC,EAAC,cAAc,GAAG,IAAI,EAAE,qBAAqB,GAAG,EAAE,KAEhF,EAAE;QACF,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAEnD,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,kBAAkB,IAAI,IAAI;YACnD,OAAO,EAAE,CAAC;QAEd,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACtD,MAAM,wBAAwB,GAAG,IAAI,GAAG,CAAC,qBAAqB,CAAC,CAAC;QAEhE,OAAO,aAAa;aACf,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE;YAClB,IAAI,wBAAwB,CAAC,GAAG,CAAC,YAAY,CAAC;gBAC1C,MAAM,IAAI,KAAK,CAAC,kBAAkB,YAAY,kCAAkC,CAAC,CAAC;YAEtF,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC;YAC5D,IAAI,GAAG,GAAG,EAAE,CAAC;YAEb,IAAI,kBAAkB,EAAE,WAAW,IAAI,IAAI,IAAI,kBAAkB,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE;gBACvF,GAAG,IAAI,KAAK,GAAG,kBAAkB,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;YAEnF,GAAG,IAAI,OAAO,GAAG,YAAY,GAAG,MAAM,CAAC;YAEvC,IAAI,cAAc,IAAI,kBAAkB,EAAE,MAAM,IAAI,IAAI;gBACpD,GAAG,IAAI,KAAK,GAAG,wCAAwC,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAEvF,GAAG,IAAI,WAAW,CAAC;YAEnB,OAAO,GAAG,CAAC;QACf,CAAC,CAAC;aACD,IAAI,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;CACJ"}

package/dist/chatWrappers/utils/isJinjaTemplateEquivalentToSpecializedChatWrapper.d.ts

@@ -0,0 +1,4 @@
+import { ChatWrapper } from "../../ChatWrapper.js";
+import { Tokenizer } from "../../types.js";
+import { JinjaTemplateChatWrapperOptions } from "../generic/JinjaTemplateChatWrapper.js";
+export declare function isJinjaTemplateEquivalentToSpecializedChatWrapper(jinjaTemplateWrapperOptions: JinjaTemplateChatWrapperOptions, specializedChatWrapper: ChatWrapper, tokenizer?: Tokenizer): boolean;

package/dist/chatWrappers/utils/isJinjaTemplateEquivalentToSpecializedChatWrapper.js

@@ -0,0 +1,210 @@
+import { JinjaTemplateChatWrapper } from "../generic/JinjaTemplateChatWrapper.js";
+import { SpecialToken, LlamaText } from "../../utils/LlamaText.js";
+import { compareTokens } from "../../utils/compareTokens.js";
+import { StopGenerationDetector } from "../../utils/StopGenerationDetector.js";
+export function isJinjaTemplateEquivalentToSpecializedChatWrapper(jinjaTemplateWrapperOptions, specializedChatWrapper, tokenizer) {
+    const canTestMultipleConvertSystemMessagesToUserMessages = jinjaTemplateWrapperOptions.convertUnsupportedSystemMessagesToUserMessages == null ||
+        jinjaTemplateWrapperOptions.convertUnsupportedSystemMessagesToUserMessages === "auto";
+    try {
+        const jinjaChatWrapper = new JinjaTemplateChatWrapper({
+            ...jinjaTemplateWrapperOptions,
+            convertUnsupportedSystemMessagesToUserMessages: canTestMultipleConvertSystemMessagesToUserMessages
+                ? false
+                : jinjaTemplateWrapperOptions.convertUnsupportedSystemMessagesToUserMessages,
+            trimLeadingWhitespaceInResponses: false
+        });
+        if (checkEquivalence(jinjaChatWrapper, specializedChatWrapper, testChatHistories, tokenizer))
+            return true;
+        const jinjaChatWrapperWithLeadingWhitespaceTrimming = new JinjaTemplateChatWrapper({
+            ...jinjaTemplateWrapperOptions,
+            convertUnsupportedSystemMessagesToUserMessages: canTestMultipleConvertSystemMessagesToUserMessages
+                ? false
+                : jinjaTemplateWrapperOptions.convertUnsupportedSystemMessagesToUserMessages,
+            trimLeadingWhitespaceInResponses: true
+        });
+        if (checkEquivalence(jinjaChatWrapperWithLeadingWhitespaceTrimming, specializedChatWrapper, testChatHistories, tokenizer))
+            return true;
+    }
+    catch (err) {
+        // Do nothing
+    }
+    if (!canTestMultipleConvertSystemMessagesToUserMessages)
+        return false;
+    try {
+        const convertSystemMessagesToUserMessagesTemplate = "### System message\n\n{{message}}\n\n----";
+        const jinjaChatWrapper = new JinjaTemplateChatWrapper({
+            ...jinjaTemplateWrapperOptions,
+            convertUnsupportedSystemMessagesToUserMessages: {
+                use: "always",
+                format: convertSystemMessagesToUserMessagesTemplate
+            },
+            trimLeadingWhitespaceInResponses: false
+        });
+        const transformedTestChatHistories = testChatHistories
+            .map((history) => (history
+            .slice()
+            .map((item, index, array) => {
+            if (item.type === "system") {
+                if (index === 0 && array.length > 1 && array[1].type === "user") {
+                    array[1] = {
+                        type: "user",
+                        text: LlamaText([
+                            LlamaText.joinValues(LlamaText.fromJSON(item.text), convertSystemMessagesToUserMessagesTemplate.split("{{message}}")),
+                            "\n\n",
+                            array[1].text
+                        ]).toString()
+                    };
+                    return null;
+                }
+                return {
+                    type: "user",
+                    text: LlamaText.joinValues(LlamaText.fromJSON(item.text), convertSystemMessagesToUserMessagesTemplate.split("{{message}}")).toString()
+                };
+            }
+            return item;
+        })
+            .filter((item) => item != null)));
+        if (checkEquivalence(jinjaChatWrapper, specializedChatWrapper, transformedTestChatHistories, tokenizer))
+            return true;
+        const jinjaChatWrapperWithLeadingWhitespaceTrimming = new JinjaTemplateChatWrapper({
+            ...jinjaTemplateWrapperOptions,
+            convertUnsupportedSystemMessagesToUserMessages: {
+                use: "always",
+                format: convertSystemMessagesToUserMessagesTemplate
+            },
+            trimLeadingWhitespaceInResponses: true
+        });
+        if (checkEquivalence(jinjaChatWrapperWithLeadingWhitespaceTrimming, specializedChatWrapper, transformedTestChatHistories, tokenizer))
+            return true;
+    }
+    catch (err) {
+        // Do nothing
+    }
+    return false;
+}
+function checkEquivalence(jinjaChatWrapper, specializedChatWrapper, testChatHistories, tokenizer) {
+    for (const testChatHistory of testChatHistories) {
+        const jinjaRes = jinjaChatWrapper.generateContextState({ chatHistory: testChatHistory });
+        const specializedWrapperRes = specializedChatWrapper.generateContextState({ chatHistory: testChatHistory });
+        if (!compareContextTexts(jinjaRes.contextText, specializedWrapperRes.contextText, tokenizer))
+            return false;
+        const jinjaHasAllSpecializedStopGenerationTriggers = jinjaRes.stopGenerationTriggers
+            .every((trigger) => {
+            return [trigger, trigger.trimEnd(), trigger.trimStart(), trigger.trimStart().trimEnd()].some((normalizedJinjaTrigger) => {
+                if (normalizedJinjaTrigger.values.length === 0)
+                    return true;
+                const foundSimilarTriggers = specializedWrapperRes.stopGenerationTriggers.some((specializedTrigger) => (normalizedJinjaTrigger.includes(specializedTrigger)));
+                if (foundSimilarTriggers)
+                    return true;
+                if (tokenizer != null) {
+                    const resolvedStopGenerationTrigger = StopGenerationDetector.resolveLlamaTextTrigger(normalizedJinjaTrigger, tokenizer);
+                    const foundSimilarOrShorterTokenizedTriggers = specializedWrapperRes.stopGenerationTriggers
+                        .some((specializedTrigger) => {
+                        const resolvedSpecializedTrigger = StopGenerationDetector.resolveLlamaTextTrigger(specializedTrigger, tokenizer);
+                        return resolvedSpecializedTrigger.every((item, index) => {
+                            const resolveTriggerItem = resolvedStopGenerationTrigger[index];
+                            if (typeof item === "string" && typeof resolveTriggerItem === "string")
+                                return item === resolveTriggerItem;
+                            else if (typeof item === "string" || typeof resolveTriggerItem === "string")
+                                return false;
+                            return compareTokens(item, resolveTriggerItem);
+                        });
+                    });
+                    if (foundSimilarOrShorterTokenizedTriggers)
+                        return true;
+                }
+                return false;
+            });
+        });
+        if (!jinjaHasAllSpecializedStopGenerationTriggers)
+            return false;
+    }
+    return true;
+}
+function compareContextTexts(text1, text2, tokenizer) {
+    function compare(text1, text2) {
+        if (LlamaText.compare(text1, text2))
+            return true;
+        if (tokenizer != null) {
+            const tokenizedText1 = text1.tokenize(tokenizer);
+            const tokenizedText2 = text2.tokenize(tokenizer);
+            if (tokenizedText1.length === tokenizedText2.length)
+                return tokenizedText1.every((token, index) => compareTokens(token, tokenizedText2[index]));
+        }
+        return false;
+    }
+    const trimmedText1 = text1.trimEnd();
+    const trimmedText2 = text2.trimEnd();
+    const normalizedText1 = removeLeadingBos(trimmedText1);
+    const normalizedText2 = removeLeadingBos(trimmedText2);
+    const texts1 = (normalizedText1.values.length !== trimmedText1.values.length && tokenizer != null)
+        ? [trimmedText1, normalizedText1]
+        : [normalizedText1];
+    const texts2 = (normalizedText2.values.length !== trimmedText2.values.length && tokenizer != null)
+        ? [trimmedText2, normalizedText2]
+        : [normalizedText2];
+    return texts1.some((text1) => (texts2.some((text2) => (compare(text1, text2)))));
+}
+const testChatHistories = [
+    [{
+            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!@#$%^&*()_+-=[]{}|\\:;\"',./<>?`~"]
+        }]
+];
+function removeLeadingBos(llamaText) {
+    if (llamaText.values.length === 0)
+        return llamaText;
+    const firstValue = llamaText.values[0];
+    if (firstValue instanceof SpecialToken && firstValue.value === "BOS")
+        return LlamaText(llamaText.values.slice(1));
+    return llamaText;
+}
+//# sourceMappingURL=isJinjaTemplateEquivalentToSpecializedChatWrapper.js.map

package/dist/chatWrappers/utils/isJinjaTemplateEquivalentToSpecializedChatWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isJinjaTemplateEquivalentToSpecializedChatWrapper.js","sourceRoot":"","sources":["../../../src/chatWrappers/utils/isJinjaTemplateEquivalentToSpecializedChatWrapper.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,wBAAwB,EAAkC,MAAM,wCAAwC,CAAC;AACjH,OAAO,EAAC,YAAY,EAAE,SAAS,EAAC,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAC,aAAa,EAAC,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAC,sBAAsB,EAAC,MAAM,uCAAuC,CAAC;AAE7E,MAAM,UAAU,iDAAiD,CAC7D,2BAA4D,EAC5D,sBAAmC,EACnC,SAAqB;IAErB,MAAM,kDAAkD,GACpD,2BAA2B,CAAC,8CAA8C,IAAI,IAAI;QAClF,2BAA2B,CAAC,8CAA8C,KAAK,MAAM,CAAC;IAE1F,IAAI,CAAC;QACD,MAAM,gBAAgB,GAAG,IAAI,wBAAwB,CAAC;YAClD,GAAG,2BAA2B;YAC9B,8CAA8C,EAAE,kDAAkD;gBAC9F,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,2BAA2B,CAAC,8CAA8C;YAChF,gCAAgC,EAAE,KAAK;SAC1C,CAAC,CAAC;QAEH,IAAI,gBAAgB,CAAC,gBAAgB,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,SAAS,CAAC;YACxF,OAAO,IAAI,CAAC;QAGhB,MAAM,6CAA6C,GAAG,IAAI,wBAAwB,CAAC;YAC/E,GAAG,2BAA2B;YAC9B,8CAA8C,EAAE,kDAAkD;gBAC9F,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,2BAA2B,CAAC,8CAA8C;YAChF,gCAAgC,EAAE,IAAI;SACzC,CAAC,CAAC;QAEH,IAAI,gBAAgB,CAAC,6CAA6C,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,SAAS,CAAC;YACrH,OAAO,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,aAAa;IACjB,CAAC;IAED,IAAI,CAAC,kDAAkD;QACnD,OAAO,KAAK,CAAC;IAEjB,IAAI,CAAC;QACD,MAAM,2CAA2C,GAAG,2CAA2C,CAAC;QAChG,MAAM,gBAAgB,GAAG,IAAI,wBAAwB,CAAC;YAClD,GAAG,2BAA2B;YAC9B,8CAA8C,EAAE;gBAC5C,GAAG,EAAE,QAAQ;gBACb,MAAM,EAAE,2CAA2C;aACtD;YACD,gCAAgC,EAAE,KAAK;SAC1C,CAAC,CAAC;QAEH,MAAM,4BAA4B,GAAG,iBAAiB;aACjD,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CACd,OAAO;aACF,KAAK,EAAE;aACP,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YACxB,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACzB,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;oBAC9D,KAAK,CAAC,CAAC,CAAC,GAAG;wBACP,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,SAAS,CAAC;4BACZ,SAAS,CAAC,UAAU,CAChB,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAC7B,2CAA2C,CAAC,KAAK,CAAC,aAAa,CAAC,CACnE;4BACD,MAAM;4BACN,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI;yBAChB,CAAC,CAAC,QAAQ,EAAE;qBACU,CAAC;oBAC5B,OAAO,IAAI,CAAC;gBAChB,CAAC;gBAED,OAAO;oBACH,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,SAAS,CAAC,UAAU,CACtB,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAC7B,2CAA2C,CAAC,KAAK,CAAC,aAAa,CAAC,CACnE,CAAC,QAAQ,EAAE;iBACW,CAAC;YAChC,CAAC;YAED,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,IAAI,EAA+C,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC,CACnF,CAAC,CAAC;QAEP,IAAI,gBAAgB,CAAC,gBAAgB,EAAE,sBAAsB,EAAE,4BAA4B,EAAE,SAAS,CAAC;YACnG,OAAO,IAAI,CAAC;QAGhB,MAAM,6CAA6C,GAAG,IAAI,wBAAwB,CAAC;YAC/E,GAAG,2BAA2B;YAC9B,8CAA8C,EAAE;gBAC5C,GAAG,EAAE,QAAQ;gBACb,MAAM,EAAE,2CAA2C;aACtD;YACD,gCAAgC,EAAE,IAAI;SACzC,CAAC,CAAC;QAEH,IAAI,gBAAgB,CAChB,6CAA6C,EAAE,sBAAsB,EAAE,4BAA4B,EAAE,SAAS,CACjH;YACG,OAAO,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,aAAa;IACjB,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,SAAS,gBAAgB,CACrB,gBAA0C,EAC1C,sBAAmC,EACnC,iBAAsC,EACtC,SAAqB;IAErB,KAAK,MAAM,eAAe,IAAI,iBAAiB,EAAE,CAAC;QAC9C,MAAM,QAAQ,GAAG,gBAAgB,CAAC,oBAAoB,CAAC,EAAC,WAAW,EAAE,eAAe,EAAC,CAAC,CAAC;QACvF,MAAM,qBAAqB,GAAG,sBAAsB,CAAC,oBAAoB,CAAC,EAAC,WAAW,EAAE,eAAe,EAAC,CAAC,CAAC;QAE1G,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,WAAW,EAAE,qBAAqB,CAAC,WAAW,EAAE,SAAS,CAAC;YACxF,OAAO,KAAK,CAAC;QAEjB,MAAM,4CAA4C,GAAG,QAAQ,CAAC,sBAAsB;aAC/E,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE;YACf,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,SAAS,EAAE,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,sBAAsB,EAAE,EAAE;gBACpH,IAAI,sBAAsB,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;oBAC1C,OAAO,IAAI,CAAC;gBAEhB,MAAM,oBAAoB,GAAI,qBAAqB,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,kBAAkB,EAAE,EAAE,CAAC,CACpG,sBAAsB,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CACtD,CAAC,CAAC;gBAEH,IAAI,oBAAoB;oBACpB,OAAO,IAAI,CAAC;gBAEhB,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;oBACpB,MAAM,6BAA6B,GAAG,sBAAsB,CAAC,uBAAuB,CAChF,sBAAsB,EACtB,SAAS,CACZ,CAAC;oBAEF,MAAM,sCAAsC,GAAG,qBAAqB,CAAC,sBAAsB;yBACtF,IAAI,CAAC,CAAC,kBAAkB,EAAE,EAAE;wBACzB,MAAM,0BAA0B,GAAG,sBAAsB,CAAC,uBAAuB,CAC7E,kBAAkB,EAClB,SAAS,CACZ,CAAC;wBAEF,OAAO,0BAA0B,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;4BACpD,MAAM,kBAAkB,GAAG,6BAA6B,CAAC,KAAK,CAAC,CAAC;4BAEhE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,kBAAkB,KAAK,QAAQ;gCAClE,OAAO,IAAI,KAAK,kBAAkB,CAAC;iCAClC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,kBAAkB,KAAK,QAAQ;gCACvE,OAAO,KAAK,CAAC;4BAEjB,OAAO,aAAa,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;wBACnD,CAAC,CAAC,CAAC;oBACP,CAAC,CAAC,CAAC;oBAEP,IAAI,sCAAsC;wBACtC,OAAO,IAAI,CAAC;gBACpB,CAAC;gBAED,OAAO,KAAK,CAAC;YACjB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEP,IAAI,CAAC,4CAA4C;YAC7C,OAAO,KAAK,CAAC;IACrB,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAgB,EAAE,KAAgB,EAAE,SAAqB;IAClF,SAAS,OAAO,CAAC,KAAgB,EAAE,KAAgB;QAC/C,IAAI,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;YAC/B,OAAO,IAAI,CAAC;QAEhB,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACpB,MAAM,cAAc,GAAG,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YACjD,MAAM,cAAc,GAAG,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YAEjD,IAAI,cAAc,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM;gBAC/C,OAAO,cAAc,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACnG,CAAC;QAED,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;IACrC,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;IAErC,MAAM,eAAe,GAAG,gBAAgB,CAAC,YAAY,CAAC,CAAC;IACvD,MAAM,eAAe,GAAG,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAEvD,MAAM,MAAM,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM,CAAC,MAAM,IAAI,SAAS,IAAI,IAAI,CAAC;QAC9F,CAAC,CAAC,CAAC,YAAY,EAAE,eAAe,CAAC;QACjC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;IAExB,MAAM,MAAM,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM,CAAC,MAAM,IAAI,SAAS,IAAI,IAAI,CAAC;QAC9F,CAAC,CAAC,CAAC,YAAY,EAAE,eAAe,CAAC;QACjC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;IAExB,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAC1B,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CACnB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CACxB,CAAC,CACL,CAAC,CAAC;AACP,CAAC;AAED,MAAM,iBAAiB,GAAwB;IAC3C,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;AAEF,SAAS,gBAAgB,CAAC,SAAoB;IAC1C,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;QAC7B,OAAO,SAAS,CAAC;IAErB,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAEvC,IAAI,UAAU,YAAY,YAAY,IAAI,UAAU,CAAC,KAAK,KAAK,KAAK;QAChE,OAAO,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhD,OAAO,SAAS,CAAC;AACrB,CAAC"}