node-llama-cpp 3.0.0-beta.4 → 3.0.0-beta.41

package/dist/chatWrappers/Llama3_1ChatWrapper.d.ts

@@ -0,0 +1,31 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { ChatHistoryItem, ChatModelFunctions, ChatWrapperGenerateContextStateOptions, ChatWrapperGeneratedContextState, ChatWrapperGenerateInitialHistoryOptions, ChatWrapperSettings } from "../types.js";
+export declare class Llama3_1ChatWrapper extends ChatWrapper {
+    readonly wrapperName: string;
+    readonly cuttingKnowledgeDate?: Date | null;
+    readonly todayDate: Date | null;
+    readonly settings: ChatWrapperSettings;
+    /**
+     * @param options
+     */
+    constructor({ cuttingKnowledgeDate, todayDate }?: {
+        /**
+         * Set to `null` to disable
+         * @default December 2023
+         */
+        cuttingKnowledgeDate?: Date | number | string | null;
+        /**
+         * Set to `null` to disable
+         * @default current date
+         */
+        todayDate?: Date | number | string | null;
+    });
+    addAvailableFunctionsSystemMessageToHistory(history: readonly ChatHistoryItem[], availableFunctions?: ChatModelFunctions, { documentParams }?: {
+        documentParams?: boolean;
+    }): readonly ChatHistoryItem[];
+    generateContextState({ chatHistory, availableFunctions, documentFunctionParams }: ChatWrapperGenerateContextStateOptions): ChatWrapperGeneratedContextState;
+    generateAvailableFunctionsSystemText(availableFunctions: ChatModelFunctions, { documentParams }: {
+        documentParams?: boolean;
+    }): import("../utils/LlamaText.js")._LlamaText;
+    generateInitialChatHistory({ systemPrompt }: ChatWrapperGenerateInitialHistoryOptions): ChatHistoryItem[];
+}

package/dist/chatWrappers/Llama3_1ChatWrapper.js

@@ -0,0 +1,223 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { SpecialToken, LlamaText, SpecialTokensText } from "../utils/LlamaText.js";
+import { defaultChatSystemPrompt } from "../config.js";
+import { ChatModelFunctionsDocumentationGenerator } from "./utils/ChatModelFunctionsDocumentationGenerator.js";
+import { jsonDumps } from "./utils/jsonDumps.js";
+// source: https://llama.meta.com/docs/model-cards-and-prompt-formats/llama3_1
+export class Llama3_1ChatWrapper extends ChatWrapper {
+    wrapperName = "Llama 3.1";
+    cuttingKnowledgeDate;
+    todayDate;
+    settings = {
+        supportsSystemMessages: true,
+        functions: {
+            call: {
+                optionalPrefixSpace: true,
+                prefix: LlamaText(new SpecialTokensText("<function=")),
+                paramsPrefix: LlamaText(new SpecialTokensText(">")),
+                suffix: LlamaText(new SpecialTokensText("</function><|eom_id|>"))
+            },
+            result: {
+                prefix: LlamaText(new SpecialTokensText("\n<|start_header_id|>ipython<|end_header_id|>\n\n")),
+                suffix: LlamaText(new SpecialToken("EOT"), new SpecialTokensText("<|start_header_id|>assistant<|end_header_id|>\n\n"))
+            }
+        }
+    };
+    /**
+     * @param options
+     */
+    constructor({ cuttingKnowledgeDate = new Date("2023-12-01T00:00:00Z"), todayDate = new Date() } = {}) {
+        super();
+        this.cuttingKnowledgeDate = cuttingKnowledgeDate == null
+            ? null
+            : new Date(cuttingKnowledgeDate);
+        this.todayDate = todayDate == null
+            ? null
+            : new Date(todayDate);
+    }
+    addAvailableFunctionsSystemMessageToHistory(history, availableFunctions, { documentParams = true } = {}) {
+        const availableFunctionNames = Object.keys(availableFunctions ?? {});
+        if (availableFunctions == null || availableFunctionNames.length === 0)
+            return history;
+        const res = history.slice();
+        const functionsSystemMessage = {
+            type: "system",
+            text: this.generateAvailableFunctionsSystemText(availableFunctions, { documentParams }).toJSON()
+        };
+        if (res.length >= 2 && res[0].type === "system" && res[1].type === "system")
+            res.splice(1, 0, functionsSystemMessage);
+        else
+            res.unshift({
+                type: "system",
+                text: this.generateAvailableFunctionsSystemText(availableFunctions, { documentParams }).toJSON()
+            });
+        return res;
+    }
+    generateContextState({ chatHistory, availableFunctions, documentFunctionParams }) {
+        const historyWithFunctions = this.addAvailableFunctionsSystemMessageToHistory(chatHistory, availableFunctions, {
+            documentParams: documentFunctionParams
+        });
+        const resultItems = [];
+        let systemTexts = [];
+        let userTexts = [];
+        let modelTexts = [];
+        let currentAggregateFocus = null;
+        function flush() {
+            if (systemTexts.length > 0 || userTexts.length > 0 || modelTexts.length > 0)
+                resultItems.push({
+                    system: systemTexts.length === 0
+                        ? null
+                        : LlamaText.joinValues("\n\n", systemTexts),
+                    user: userTexts.length === 0
+                        ? null
+                        : LlamaText.joinValues("\n\n", userTexts),
+                    model: modelTexts.length === 0
+                        ? null
+                        : LlamaText.joinValues("\n\n", modelTexts)
+                });
+            systemTexts = [];
+            userTexts = [];
+            modelTexts = [];
+        }
+        for (const item of historyWithFunctions) {
+            if (item.type === "system") {
+                if (currentAggregateFocus !== "system")
+                    flush();
+                currentAggregateFocus = "system";
+                systemTexts.push(LlamaText.fromJSON(item.text));
+            }
+            else if (item.type === "user") {
+                if (currentAggregateFocus !== "user")
+                    flush();
+                currentAggregateFocus = "user";
+                userTexts.push(LlamaText(item.text));
+            }
+            else if (item.type === "model") {
+                if (currentAggregateFocus !== "model")
+                    flush();
+                currentAggregateFocus = "model";
+                modelTexts.push(this.generateModelResponseText(item.response));
+            }
+            else
+                void (item);
+        }
+        flush();
+        const contextText = LlamaText(new SpecialToken("BOS"), resultItems.map((item, index) => {
+            const isLastItem = index === resultItems.length - 1;
+            const res = [];
+            if (item.system != null) {
+                res.push(LlamaText([
+                    new SpecialTokensText("<|start_header_id|>system<|end_header_id|>\n\n"),
+                    item.system,
+                    new SpecialToken("EOT")
+                ]));
+            }
+            if (item.user != null) {
+                res.push(LlamaText([
+                    new SpecialTokensText("<|start_header_id|>user<|end_header_id|>\n\n"),
+                    item.user,
+                    new SpecialToken("EOT")
+                ]));
+            }
+            if (item.model != null) {
+                res.push(LlamaText([
+                    new SpecialTokensText("<|start_header_id|>assistant<|end_header_id|>\n\n"),
+                    item.model,
+                    isLastItem
+                        ? LlamaText([])
+                        : new SpecialToken("EOT")
+                ]));
+            }
+            return LlamaText(res);
+        }));
+        return {
+            contextText,
+            stopGenerationTriggers: [
+                LlamaText(new SpecialToken("EOS")),
+                LlamaText(new SpecialToken("EOT")),
+                LlamaText(new SpecialTokensText("<|eot_id|>")),
+                LlamaText(new SpecialTokensText("<|end_of_text|>")),
+                LlamaText("<|eot_id|>"),
+                LlamaText("<|end_of_text|>")
+            ]
+        };
+    }
+    generateAvailableFunctionsSystemText(availableFunctions, { documentParams = true }) {
+        const functionsDocumentationGenerator = new ChatModelFunctionsDocumentationGenerator(availableFunctions);
+        if (!functionsDocumentationGenerator.hasAnyFunctions)
+            return LlamaText([]);
+        return LlamaText.joinValues("\n", [
+            "You have access to the following functions:",
+            "",
+            functionsDocumentationGenerator.getLlama3_1FunctionSignatures({ documentParams }),
+            "",
+            "",
+            "If you choose to call a function ONLY reply in the following format:",
+            "<{start_tag}={function_name}>{parameters}{end_tag}",
+            "where",
+            "",
+            "start_tag => `<function`",
+            "parameters => a JSON dict with the function argument name as key and function argument value as value.",
+            "end_tag => `</function>`",
+            "",
+            "Here is an example,",
+            LlamaText([
+                new SpecialTokensText("<function="),
+                "example_function_name",
+                new SpecialTokensText(">"),
+                jsonDumps({ "example_name": "example_value" }),
+                new SpecialTokensText("</function>")
+            ]),
+            "",
+            "Reminder:",
+            "- Function calls MUST follow the specified format",
+            "- Only call one function at a time",
+            "- Put the entire function call reply on one line",
+            "- Always add your sources when using search results to answer the user query"
+        ]);
+    }
+    generateInitialChatHistory({ systemPrompt = defaultChatSystemPrompt }) {
+        const res = [];
+        function formatDate(date) {
+            const day = date.toLocaleDateString("en-US", { day: "numeric", timeZone: "UTC" });
+            const month = date.toLocaleDateString("en-US", { month: "short", timeZone: "UTC" });
+            const year = date.toLocaleDateString("en-US", { year: "numeric", timeZone: "UTC" });
+            return `${day} ${month} ${year}`;
+        }
+        const formatMonthDate = (date) => {
+            const today = this.todayDate ?? new Date();
+            if (today.getUTCMonth() === date.getUTCMonth() && today.getUTCFullYear() === date.getUTCFullYear())
+                return formatDate(date);
+            const month = date.toLocaleDateString("en-US", { month: "long", timeZone: "UTC" });
+            const year = date.toLocaleDateString("en-US", { year: "numeric", timeZone: "UTC" });
+            return `${month} ${year}`;
+        };
+        const lines = [];
+        if (this.cuttingKnowledgeDate != null)
+            lines.push(`Cutting Knowledge Date: ${formatMonthDate(this.cuttingKnowledgeDate)}`);
+        if (this.todayDate != null)
+            lines.push(`Today Date: ${formatDate(this.todayDate)}`);
+        lines.push("");
+        lines.push("# Tool Instructions");
+        lines.push("- When looking for real time information use relevant functions if available");
+        lines.push("");
+        lines.push("");
+        res.push({
+            type: "system",
+            text: LlamaText.joinValues("\n", lines).toJSON()
+        }, {
+            type: "system",
+            text: LlamaText(systemPrompt ?? defaultChatSystemPrompt).toJSON()
+        });
+        return res;
+    }
+    /** @internal */
+    static _checkModelCompatibility(options) {
+        if (options.tokenizer != null) {
+            const tokens = options.tokenizer("<|eom_id|>", true, "trimLeadingSpace");
+            return tokens.length === 1 && options.tokenizer.isSpecialToken(tokens[0]);
+        }
+        return true;
+    }
+}
+//# sourceMappingURL=Llama3_1ChatWrapper.js.map

package/dist/chatWrappers/Llama3_1ChatWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Llama3_1ChatWrapper.js","sourceRoot":"","sources":["../../src/chatWrappers/Llama3_1ChatWrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAK9C,OAAO,EAAC,YAAY,EAAE,SAAS,EAAE,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACjF,OAAO,EAAC,uBAAuB,EAAC,MAAM,cAAc,CAAC;AACrD,OAAO,EAAC,wCAAwC,EAAC,MAAM,qDAAqD,CAAC;AAC7G,OAAO,EAAC,SAAS,EAAC,MAAM,sBAAsB,CAAC;AAE/C,8EAA8E;AAC9E,MAAM,OAAO,mBAAoB,SAAQ,WAAW;IAChC,WAAW,GAAW,WAAW,CAAC;IAElC,oBAAoB,CAAe;IACnC,SAAS,CAAc;IAEd,QAAQ,GAAwB;QACrD,sBAAsB,EAAE,IAAI;QAC5B,SAAS,EAAE;YACP,IAAI,EAAE;gBACF,mBAAmB,EAAE,IAAI;gBACzB,MAAM,EAAE,SAAS,CAAC,IAAI,iBAAiB,CAAC,YAAY,CAAC,CAAC;gBACtD,YAAY,EAAE,SAAS,CAAC,IAAI,iBAAiB,CAAC,GAAG,CAAC,CAAC;gBACnD,MAAM,EAAE,SAAS,CAAC,IAAI,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;aACpE;YACD,MAAM,EAAE;gBACJ,MAAM,EAAE,SAAS,CAAC,IAAI,iBAAiB,CAAC,mDAAmD,CAAC,CAAC;gBAC7F,MAAM,EAAE,SAAS,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,IAAI,iBAAiB,CAAC,mDAAmD,CAAC,CAAC;aACzH;SACJ;KACJ,CAAC;IAEF;;OAEG;IACH,YAAmB,EACf,oBAAoB,GAAG,IAAI,IAAI,CAAC,sBAAsB,CAAC,EACvD,SAAS,GAAG,IAAI,IAAI,EAAE,KAatB,EAAE;QACF,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,IAAI,IAAI;YACpD,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,IAAI,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,SAAS,IAAI,IAAI;YAC9B,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9B,CAAC;IAEe,2CAA2C,CACvD,OAAmC,EACnC,kBAAuC,EAAE,EACrC,cAAc,GAAG,IAAI,KAGrB,EAAE;QAEN,MAAM,sBAAsB,GAAG,MAAM,CAAC,IAAI,CAAC,kBAAkB,IAAI,EAAE,CAAC,CAAC;QAErE,IAAI,kBAAkB,IAAI,IAAI,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC;YACjE,OAAO,OAAO,CAAC;QAEnB,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QAE5B,MAAM,sBAAsB,GAAsB;YAC9C,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,IAAI,CAAC,oCAAoC,CAAC,kBAAkB,EAAE,EAAC,cAAc,EAAC,CAAC,CAAC,MAAM,EAAE;SACjG,CAAC;QAEF,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ;YACvE,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,sBAAsB,CAAC,CAAC;;YAEzC,GAAG,CAAC,OAAO,CAAC;gBACR,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,IAAI,CAAC,oCAAoC,CAAC,kBAAkB,EAAE,EAAC,cAAc,EAAC,CAAC,CAAC,MAAM,EAAE;aACjG,CAAC,CAAC;QAEP,OAAO,GAAG,CAAC;IACf,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,IAAI,WAAW,GAAgB,EAAE,CAAC;QAClC,IAAI,SAAS,GAAgB,EAAE,CAAC;QAChC,IAAI,UAAU,GAAgB,EAAE,CAAC;QACjC,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,WAAW,CAAC,MAAM,KAAK,CAAC;wBAC5B,CAAC,CAAC,IAAI;wBACN,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC;oBAC/C,IAAI,EAAE,SAAS,CAAC,MAAM,KAAK,CAAC;wBACxB,CAAC,CAAC,IAAI;wBACN,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,SAAS,CAAC;oBAC7C,KAAK,EAAE,UAAU,CAAC,MAAM,KAAK,CAAC;wBAC1B,CAAC,CAAC,IAAI;wBACN,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC;iBACjD,CAAC,CAAC;YAEP,WAAW,GAAG,EAAE,CAAC;YACjB,SAAS,GAAG,EAAE,CAAC;YACf,UAAU,GAAG,EAAE,CAAC;QACpB,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,oBAAoB,EAAE,CAAC;YACtC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACzB,IAAI,qBAAqB,KAAK,QAAQ;oBAClC,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,qBAAqB,KAAK,MAAM;oBAChC,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,qBAAqB,KAAK,OAAO;oBACjC,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,WAAW,GAAG,SAAS,CACzB,IAAI,YAAY,CAAC,KAAK,CAAC,EACvB,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC5B,MAAM,UAAU,GAAG,KAAK,KAAK,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;YACpD,MAAM,GAAG,GAAgB,EAAE,CAAC;YAE5B,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;gBACtB,GAAG,CAAC,IAAI,CACJ,SAAS,CAAC;oBACN,IAAI,iBAAiB,CAAC,gDAAgD,CAAC;oBACvE,IAAI,CAAC,MAAM;oBACX,IAAI,YAAY,CAAC,KAAK,CAAC;iBAC1B,CAAC,CACL,CAAC;YACN,CAAC;YAED,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;gBACpB,GAAG,CAAC,IAAI,CACJ,SAAS,CAAC;oBACN,IAAI,iBAAiB,CAAC,8CAA8C,CAAC;oBACrE,IAAI,CAAC,IAAI;oBACT,IAAI,YAAY,CAAC,KAAK,CAAC;iBAC1B,CAAC,CACL,CAAC;YACN,CAAC;YAED,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;gBACrB,GAAG,CAAC,IAAI,CACJ,SAAS,CAAC;oBACN,IAAI,iBAAiB,CAAC,mDAAmD,CAAC;oBAC1E,IAAI,CAAC,KAAK;oBACV,UAAU;wBACN,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;wBACf,CAAC,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC;iBAChC,CAAC,CACL,CAAC;YACN,CAAC;YAED,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC,CAAC,CACL,CAAC;QAEF,OAAO;YACH,WAAW;YACX,sBAAsB,EAAE;gBACpB,SAAS,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;gBAClC,SAAS,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;gBAClC,SAAS,CAAC,IAAI,iBAAiB,CAAC,YAAY,CAAC,CAAC;gBAC9C,SAAS,CAAC,IAAI,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;gBACnD,SAAS,CAAC,YAAY,CAAC;gBACvB,SAAS,CAAC,iBAAiB,CAAC;aAC/B;SACJ,CAAC;IACN,CAAC;IAEe,oCAAoC,CAAC,kBAAsC,EAAE,EAAC,cAAc,GAAG,IAAI,EAElH;QACG,MAAM,+BAA+B,GAAG,IAAI,wCAAwC,CAAC,kBAAkB,CAAC,CAAC;QAEzG,IAAI,CAAC,+BAA+B,CAAC,eAAe;YAChD,OAAO,SAAS,CAAC,EAAE,CAAC,CAAC;QAEzB,OAAO,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE;YAC9B,6CAA6C;YAC7C,EAAE;YACF,+BAA+B,CAAC,6BAA6B,CAAC,EAAC,cAAc,EAAC,CAAC;YAC/E,EAAE;YACF,EAAE;YACF,sEAAsE;YACtE,oDAAoD;YACpD,OAAO;YACP,EAAE;YACF,0BAA0B;YAC1B,wGAAwG;YACxG,0BAA0B;YAC1B,EAAE;YACF,qBAAqB;YACrB,SAAS,CAAC;gBACN,IAAI,iBAAiB,CAAC,YAAY,CAAC;gBACnC,uBAAuB;gBACvB,IAAI,iBAAiB,CAAC,GAAG,CAAC;gBAC1B,SAAS,CAAC,EAAC,cAAc,EAAE,eAAe,EAAC,CAAC;gBAC5C,IAAI,iBAAiB,CAAC,aAAa,CAAC;aACvC,CAAC;YACF,EAAE;YACF,WAAW;YACX,mDAAmD;YACnD,oCAAoC;YACpC,kDAAkD;YAClD,8EAA8E;SACjF,CAAC,CAAC;IACP,CAAC;IAEe,0BAA0B,CAAC,EACvC,YAAY,GAAG,uBAAuB,EACC;QACvC,MAAM,GAAG,GAAsB,EAAE,CAAC;QAElC,SAAS,UAAU,CAAC,IAAU;YAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,EAAC,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC;YAChF,MAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,EAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC;YAClF,MAAM,IAAI,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,EAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC;YAClF,OAAO,GAAG,GAAG,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QACrC,CAAC;QAED,MAAM,eAAe,GAAG,CAAC,IAAU,EAAE,EAAE;YACnC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,IAAI,EAAE,CAAC;YAC3C,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,IAAI,KAAK,CAAC,cAAc,EAAE,KAAK,IAAI,CAAC,cAAc,EAAE;gBAC9F,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC;YAE5B,MAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,EAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC;YACjF,MAAM,IAAI,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,EAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC;YAClF,OAAO,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC;QAC9B,CAAC,CAAC;QAEF,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,IAAI,IAAI,CAAC,oBAAoB,IAAI,IAAI;YACjC,KAAK,CAAC,IAAI,CAAC,2BAA2B,eAAe,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;QAExF,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI;YACtB,KAAK,CAAC,IAAI,CAAC,eAAe,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAE5D,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,8EAA8E,CAAC,CAAC;QAC3F,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEf,GAAG,CAAC,IAAI,CAAC;YACL,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE;SACnD,EAAE;YACC,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,SAAS,CAAC,YAAY,IAAI,uBAAuB,CAAC,CAAC,MAAM,EAAE;SACpE,CAAC,CAAC;QAEH,OAAO,GAAG,CAAC;IACf,CAAC;IAED,gBAAgB;IACT,MAAM,CAAU,wBAAwB,CAAC,OAAiD;QAC7F,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;YAC5B,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,kBAAkB,CAAC,CAAC;YACzE,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9E,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}

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

@@ -0,0 +1,76 @@
+import { ChatWrapperGenerateContextStateOptions, ChatWrapperGeneratedContextState, ChatWrapperSettings } from "../../types.js";
+import { ChatWrapper } from "../../ChatWrapper.js";
+import { ChatHistoryFunctionCallMessageTemplate } from "./utils/chatHistoryFunctionCallMessageTemplate.js";
+export type JinjaTemplateChatWrapperOptions = {
+    template: string;
+    /**
+     * Defaults to `"assistant"`.
+     */
+    modelRoleName?: string;
+    /**
+     * Defaults to `"user"`.
+     */
+    userRoleName?: string;
+    /**
+     * Defaults to `"system"`.
+     */
+    systemRoleName?: string;
+    /**
+     * Some Jinja templates may not support system messages, and in such cases,
+     * it'll be detected and system messages can be converted to user messages.
+     *
+     * You can specify the format of the converted user message.
+     * - **"auto"**: Convert system messages to user messages only if the template does not support system messages.
+     * - **`true`**: Always convert system messages to user messages.
+     * - **`false`**: Never convert system messages to user messages.
+     * May throw an error if some system messages don't appear in the template.
+     * - **`{use: "ifNeeded", format: "..."}`**: Convert system messages to user messages only if the template does not support system
+     * messages with the specified format.
+     * - **`{use: "always", format: "..."}`**: Always convert system messages to user messages with the specified format.
+     *
+     * Defaults to `"auto"`.
+     */
+    convertUnsupportedSystemMessagesToUserMessages?: "auto" | boolean | JinjaTemplateChatWrapperOptionsConvertMessageFormat;
+    functionCallMessageTemplate?: ChatHistoryFunctionCallMessageTemplate;
+    /**
+     * Whether to join adjacent messages of the same type.
+     * Some Jinja templates may throw an error if this is not set to `true`.
+     *
+     * Defaults to `true`.
+     */
+    joinAdjacentMessagesOfTheSameType?: boolean;
+    /**
+     * Whether to trim leading whitespace in responses.
+     *
+     * Defaults to `true`.
+     */
+    trimLeadingWhitespaceInResponses?: boolean;
+};
+export type JinjaTemplateChatWrapperOptionsConvertMessageFormat = {
+    use?: "always" | "ifNeeded";
+    format: `${string}{{message}}${string}`;
+};
+/**
+ * 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.
+ */
+export declare class JinjaTemplateChatWrapper extends ChatWrapper {
+    readonly wrapperName = "JinjaTemplate";
+    readonly settings: ChatWrapperSettings;
+    readonly template: string;
+    readonly modelRoleName: string;
+    readonly userRoleName: string;
+    readonly systemRoleName: string;
+    readonly convertUnsupportedSystemMessagesToUserMessages?: JinjaTemplateChatWrapperOptionsConvertMessageFormat;
+    readonly joinAdjacentMessagesOfTheSameType: boolean;
+    readonly trimLeadingWhitespaceInResponses: boolean;
+    constructor({ template, modelRoleName, userRoleName, systemRoleName, convertUnsupportedSystemMessagesToUserMessages, functionCallMessageTemplate, joinAdjacentMessagesOfTheSameType, trimLeadingWhitespaceInResponses }: JinjaTemplateChatWrapperOptions);
+    generateContextState({ chatHistory, availableFunctions, documentFunctionParams }: ChatWrapperGenerateContextStateOptions): ChatWrapperGeneratedContextState & {
+        transformedSystemMessagesToUserMessages: boolean;
+    };
+}