node-llama-cpp 2.8.4 → 3.0.0-beta.2

package/README.md

@@ -10,12 +10,12 @@
 
 [![Build](https://github.com/withcatai/node-llama-cpp/actions/workflows/build.yml/badge.svg)](https://github.com/withcatai/node-llama-cpp/actions/workflows/build.yml)
 [![License](https://badgen.net/badge/color/MIT/green?label=license)](https://www.npmjs.com/package/node-llama-cpp)
-[![License](https://badgen.net/badge/color/TypeScript/blue?label=types)](https://www.npmjs.com/package/node-llama-cpp)
+[![Types](https://badgen.net/badge/color/TypeScript/blue?label=types)](https://www.npmjs.com/package/node-llama-cpp)
 [![Version](https://badgen.net/npm/v/node-llama-cpp)](https://www.npmjs.com/package/node-llama-cpp)
 
 </div>
 
-✨ New! [Try the beta of version `3.0.0`](https://github.com/withcatai/node-llama-cpp/pull/105) ✨ (included: function calling, automatic chat wrapper detection, and more)
+✨ New! [Try the beta of version `3.0.0`](https://github.com/withcatai/node-llama-cpp/pull/105) ✨
 
 ## Features
 * Run a text generation model locally on your machine

package/dist/ChatWrapper.d.ts

@@ -0,0 +1,49 @@
+import { ChatHistoryItem, ChatModelFunctions, ChatModelResponse } from "./types.js";
+import { LlamaText } from "./utils/LlamaText.js";
+export type ChatWrapperSettings = {
+    readonly functions: {
+        readonly call: {
+            readonly optionalPrefixSpace: boolean;
+            readonly prefix: string;
+            readonly paramsPrefix: string;
+            readonly suffix: string;
+        };
+        readonly result: {
+            readonly prefix: string;
+            readonly suffix: string;
+        };
+    };
+};
+export declare abstract class ChatWrapper {
+    abstract readonly wrapperName: string;
+    readonly settings: ChatWrapperSettings;
+    generateContextText(history: readonly ChatHistoryItem[], { availableFunctions, documentFunctionParams }?: {
+        availableFunctions?: ChatModelFunctions;
+        documentFunctionParams?: boolean;
+    }): {
+        contextText: LlamaText;
+        stopGenerationTriggers: LlamaText[];
+        ignoreStartText?: LlamaText[];
+        functionCall?: {
+            initiallyEngaged: boolean;
+            disengageInitiallyEngaged: LlamaText[];
+        };
+    };
+    generateFunctionCallAndResult(name: string, params: any, result: any): string;
+    generateFunctionCall(name: string, params: any): string;
+    generateFunctionCallResult(functionName: string, functionParams: any, result: any): string;
+    generateModelResponseText(modelResponse: ChatModelResponse["response"]): string;
+    generateAvailableFunctionsSystemText(availableFunctions: ChatModelFunctions, { documentParams }: {
+        documentParams?: boolean;
+    }): string;
+    addAvailableFunctionsSystemMessageToHistory(history: readonly ChatHistoryItem[], availableFunctions?: ChatModelFunctions, { documentParams }?: {
+        documentParams?: boolean;
+    }): readonly ChatHistoryItem[];
+    /**
+     * Functions that should be made available as part of the function calling grammar and are handled by the chat wrapper
+     * for grammar purposes only
+     */
+    getInternalBuiltinFunctions({ initialFunctionCallEngaged }: {
+        initialFunctionCallEngaged: boolean;
+    }): ChatModelFunctions;
+}

package/dist/ChatWrapper.js

@@ -0,0 +1,120 @@
+import { LlamaText } from "./utils/LlamaText.js";
+import { getTypeScriptTypeStringForGbnfJsonSchema } from "./utils/getTypeScriptTypeStringForGbnfJsonSchema.js";
+export class ChatWrapper {
+    settings = {
+        functions: {
+            call: {
+                optionalPrefixSpace: true,
+                prefix: "[[call: ",
+                paramsPrefix: "(",
+                suffix: ")]]"
+            },
+            result: {
+                prefix: " [[result: ",
+                suffix: "]]"
+            }
+        }
+    };
+    generateContextText(history, { availableFunctions, documentFunctionParams } = {}) {
+        const historyWithFunctions = this.addAvailableFunctionsSystemMessageToHistory(history, availableFunctions, {
+            documentParams: documentFunctionParams
+        });
+        const texts = historyWithFunctions
+            .map((item) => {
+            if (item.type === "system")
+                return LlamaText `system: ${item.text}`;
+            else if (item.type === "user")
+                return LlamaText `user: ${item.text}`;
+            else if (item.type === "model")
+                return LlamaText `model: ${this.generateModelResponseText(item.response)}`;
+            return item;
+        });
+        return {
+            contextText: LlamaText(texts).joinValues("\n"),
+            stopGenerationTriggers: []
+        };
+    }
+    generateFunctionCallAndResult(name, params, result) {
+        return this.generateFunctionCall(name, params) + this.generateFunctionCallResult(name, params, result);
+    }
+    generateFunctionCall(name, params) {
+        return this.settings.functions.call.prefix +
+            name +
+            this.settings.functions.call.paramsPrefix +
+            (params === undefined
+                ? ""
+                : JSON.stringify(params)) +
+            this.settings.functions.call.suffix;
+    }
+    generateFunctionCallResult(functionName, functionParams, result) {
+        const resolveParameters = (text) => text.replaceAll("{{functionName}}", functionName)
+            .replaceAll("{{functionParams}}", functionParams === undefined ? "" : JSON.stringify(functionParams));
+        return resolveParameters(this.settings.functions.result.prefix) +
+            (result === undefined
+                ? "void"
+                : JSON.stringify(result)) +
+            resolveParameters(this.settings.functions.result.suffix);
+    }
+    generateModelResponseText(modelResponse) {
+        return modelResponse
+            .map((item) => {
+            if (typeof item === "string")
+                return item;
+            return item.raw ?? this.generateFunctionCallAndResult(item.name, item.params, item.result);
+        })
+            .join("\n");
+    }
+    generateAvailableFunctionsSystemText(availableFunctions, { documentParams = true }) {
+        const availableFunctionNames = Object.keys(availableFunctions ?? {});
+        if (availableFunctionNames.length === 0)
+            return "";
+        return "The assistant calls the provided functions as needed to retrieve information instead of relying on things it already knows.\n" +
+            "Provided functions:\n```\n" +
+            availableFunctionNames
+                .map((functionName) => {
+                const functionDefinition = availableFunctions[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") +
+            "\n```\n\n" +
+            "Calling any of the provided functions can be done like this:\n" +
+            this.settings.functions.call.prefix.trimStart() +
+            "functionName" +
+            this.settings.functions.call.paramsPrefix +
+            '{ someKey: "someValue" }' +
+            this.settings.functions.call.suffix + "\n\n" +
+            "After calling a function the result will appear afterwards and be visible only to the assistant, so the assistant has to tell the user about it outside of the function call context.\n" +
+            "The assistant calls the functions in advance before telling the user about the result";
+    }
+    addAvailableFunctionsSystemMessageToHistory(history, availableFunctions, { documentParams = true } = {}) {
+        const availableFunctionNames = Object.keys(availableFunctions ?? {});
+        if (availableFunctions == null || availableFunctionNames.length === 0)
+            return history;
+        const res = history.slice();
+        const firstNonSystemMessageIndex = res.findIndex((item) => item.type !== "system");
+        res.splice(Math.max(0, firstNonSystemMessageIndex), 0, {
+            type: "system",
+            text: this.generateAvailableFunctionsSystemText(availableFunctions, { documentParams })
+        });
+        return res;
+    }
+    /**
+     * Functions that should be made available as part of the function calling grammar and are handled by the chat wrapper
+     * for grammar purposes only
+     */
+    getInternalBuiltinFunctions({ initialFunctionCallEngaged }) {
+        if (initialFunctionCallEngaged)
+            return {};
+        return {};
+    }
+}
+//# sourceMappingURL=ChatWrapper.js.map

package/dist/ChatWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatWrapper.js","sourceRoot":"","sources":["../src/ChatWrapper.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,SAAS,EAAC,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAC,wCAAwC,EAAC,MAAM,qDAAqD,CAAC;AAiB7G,MAAM,OAAgB,WAAW;IAGb,QAAQ,GAAwB;QAC5C,SAAS,EAAE;YACP,IAAI,EAAE;gBACF,mBAAmB,EAAE,IAAI;gBACzB,MAAM,EAAE,UAAU;gBAClB,YAAY,EAAE,GAAG;gBACjB,MAAM,EAAE,KAAK;aAChB;YACD,MAAM,EAAE;gBACJ,MAAM,EAAE,aAAa;gBACrB,MAAM,EAAE,IAAI;aACf;SACJ;KACJ,CAAC;IAEK,mBAAmB,CAAC,OAAmC,EAAE,EAAC,kBAAkB,EAAE,sBAAsB,KAGvG,EAAE;QASF,MAAM,oBAAoB,GAAG,IAAI,CAAC,2CAA2C,CAAC,OAAO,EAAE,kBAAkB,EAAE;YACvG,cAAc,EAAE,sBAAsB;SACzC,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,oBAAoB;aAC7B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACV,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ;gBACtB,OAAO,SAAS,CAAC,WAAW,IAAI,CAAC,IAAI,EAAE,CAAC;iBACvC,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM;gBACzB,OAAO,SAAS,CAAC,SAAS,IAAI,CAAC,IAAI,EAAE,CAAC;iBACrC,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO;gBAC1B,OAAO,SAAS,CAAC,UAAU,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAE/E,OAAO,IAAoB,CAAC;QAChC,CAAC,CAAC,CAAC;QAEP,OAAO;YACH,WAAW,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;YAC9C,sBAAsB,EAAE,EAAE;SAC7B,CAAC;IACN,CAAC;IAEM,6BAA6B,CAAC,IAAY,EAAE,MAAW,EAAE,MAAW;QACvE,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,0BAA0B,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3G,CAAC;IAEM,oBAAoB,CAAC,IAAY,EAAE,MAAW;QACjD,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM;YACtC,IAAI;YACJ,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY;YACzC,CACI,MAAM,KAAK,SAAS;gBAChB,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAC/B;YACD,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;IAC5C,CAAC;IAEM,0BAA0B,CAAC,YAAoB,EAAE,cAAmB,EAAE,MAAW;QACpF,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAE,EAAE,CACvC,IAAI,CAAC,UAAU,CAAC,kBAAkB,EAAE,YAAY,CAAC;aAC5C,UAAU,CAAC,oBAAoB,EAAE,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC;QAE9G,OAAO,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC;YAC3D,CACI,MAAM,KAAK,SAAS;gBAChB,CAAC,CAAC,MAAM;gBACR,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAC/B;YACD,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC;IAEM,yBAAyB,CAAC,aAA4C;QACzE,OAAO,aAAa;aACf,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACV,IAAI,OAAO,IAAI,KAAK,QAAQ;gBACxB,OAAO,IAAI,CAAC;YAEhB,OAAO,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,6BAA6B,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/F,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IAEM,oCAAoC,CAAC,kBAAsC,EAAE,EAAC,cAAc,GAAG,IAAI,EAEzG;QACG,MAAM,sBAAsB,GAAG,MAAM,CAAC,IAAI,CAAC,kBAAkB,IAAI,EAAE,CAAC,CAAC;QAErE,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC;YACnC,OAAO,EAAE,CAAC;QAEd,OAAO,+HAA+H;YAClI,4BAA4B;YAC5B,sBAAsB;iBACjB,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE;gBAClB,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC;gBAC5D,IAAI,GAAG,GAAG,EAAE,CAAC;gBAEb,IAAI,kBAAkB,EAAE,WAAW,IAAI,IAAI,IAAI,kBAAkB,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE;oBACvF,GAAG,IAAI,KAAK,GAAG,kBAAkB,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;gBAEnF,GAAG,IAAI,WAAW,GAAG,YAAY,GAAG,GAAG,CAAC;gBAExC,IAAI,cAAc,IAAI,kBAAkB,EAAE,MAAM,IAAI,IAAI;oBACpD,GAAG,IAAI,UAAU,GAAG,wCAAwC,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;qBACvF,IAAI,CAAC,cAAc,IAAI,kBAAkB,EAAE,MAAM,IAAI,IAAI;oBAC1D,GAAG,IAAI,QAAQ,CAAC;gBAEpB,GAAG,IAAI,IAAI,CAAC;gBAEZ,OAAO,GAAG,CAAC;YACf,CAAC,CAAC;iBACD,IAAI,CAAC,MAAM,CAAC;YACjB,WAAW;YAEX,gEAAgE;YAChE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAC/C,cAAc;YACd,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY;YACzC,0BAA0B;YAC1B,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM;YAE5C,yLAAyL;YACzL,uFAAuF,CAAC;IAChG,CAAC;IAEM,2CAA2C,CAAC,OAAmC,EAAE,kBAAuC,EAAE,EAC7H,cAAc,GAAG,IAAI,KAGrB,EAAE;QACF,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,0BAA0B,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;QACnF,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,0BAA0B,CAAC,EAAE,CAAC,EAAE;YACnD,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,IAAI,CAAC,oCAAoC,CAAC,kBAAkB,EAAE,EAAC,cAAc,EAAC,CAAC;SACxF,CAAC,CAAC;QAEH,OAAO,GAAG,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,2BAA2B,CAAC,EAAC,0BAA0B,EAAwC;QAClG,IAAI,0BAA0B;YAC1B,OAAO,EAAE,CAAC;QAEd,OAAO,EAAE,CAAC;IACd,CAAC;CACJ"}

package/dist/chatWrappers/AlpacaChatWrapper.d.ts

@@ -0,0 +1,12 @@
+import { GeneralChatWrapper } from "./GeneralChatWrapper.js";
+export declare class AlpacaChatWrapper extends GeneralChatWrapper {
+    readonly wrapperName: string;
+    constructor({ userMessageTitle, modelResponseTitle, middleSystemMessageTitle }?: {
+        userMessageTitle?: string;
+        modelResponseTitle?: string;
+        middleSystemMessageTitle?: string;
+    });
+    get userMessageTitle(): string;
+    get modelResponseTitle(): string;
+    get middleSystemMessageTitle(): string;
+}

package/dist/chatWrappers/AlpacaChatWrapper.js

@@ -0,0 +1,21 @@
+import { GeneralChatWrapper } from "./GeneralChatWrapper.js";
+export class AlpacaChatWrapper extends GeneralChatWrapper {
+    wrapperName = "AlpacaChat";
+    constructor({ userMessageTitle = "Instruction", modelResponseTitle = "Response", middleSystemMessageTitle = "System" } = {}) {
+        super({
+            userMessageTitle: userMessageTitle + ":",
+            modelResponseTitle: modelResponseTitle + ":",
+            middleSystemMessageTitle: middleSystemMessageTitle + ":"
+        });
+    }
+    get userMessageTitle() {
+        return super.userMessageTitle.slice(0, -1);
+    }
+    get modelResponseTitle() {
+        return super.modelResponseTitle.slice(0, -1);
+    }
+    get middleSystemMessageTitle() {
+        return super.middleSystemMessageTitle.slice(0, -1);
+    }
+}
+//# sourceMappingURL=AlpacaChatWrapper.js.map

package/dist/chatWrappers/AlpacaChatWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AlpacaChatWrapper.js","sourceRoot":"","sources":["../../src/chatWrappers/AlpacaChatWrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AAE3D,MAAM,OAAO,iBAAkB,SAAQ,kBAAkB;IAC5B,WAAW,GAAW,YAAY,CAAC;IAE5D,YAAmB,EACf,gBAAgB,GAAG,aAAa,EAAE,kBAAkB,GAAG,UAAU,EAAE,wBAAwB,GAAG,QAAQ,KAGtG,EAAE;QACF,KAAK,CAAC;YACF,gBAAgB,EAAE,gBAAgB,GAAG,GAAG;YACxC,kBAAkB,EAAE,kBAAkB,GAAG,GAAG;YAC5C,wBAAwB,EAAE,wBAAwB,GAAG,GAAG;SAC3D,CAAC,CAAC;IACP,CAAC;IAED,IAAoB,gBAAgB;QAChC,OAAO,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED,IAAoB,kBAAkB;QAClC,OAAO,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,IAAoB,wBAAwB;QACxC,OAAO,KAAK,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC;CACJ"}

package/dist/chatWrappers/ChatMLChatWrapper.d.ts

@@ -0,0 +1,13 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { ChatHistoryItem, ChatModelFunctions } from "../types.js";
+import { LlamaText } from "../utils/LlamaText.js";
+export declare class ChatMLChatWrapper extends ChatWrapper {
+    readonly wrapperName: string;
+    generateContextText(history: readonly ChatHistoryItem[], { availableFunctions, documentFunctionParams }?: {
+        availableFunctions?: ChatModelFunctions;
+        documentFunctionParams?: boolean;
+    }): {
+        contextText: LlamaText;
+        stopGenerationTriggers: LlamaText[];
+    };
+}

package/dist/chatWrappers/ChatMLChatWrapper.js

@@ -0,0 +1,83 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { BuiltinSpecialToken, LlamaText, SpecialToken } from "../utils/LlamaText.js";
+// source: https://github.com/openai/openai-python/blob/120d225b91a8453e15240a49fb1c6794d8119326/chatml.md
+export class ChatMLChatWrapper extends ChatWrapper {
+    wrapperName = "ChatML";
+    generateContextText(history, { availableFunctions, documentFunctionParams } = {}) {
+        const historyWithFunctions = this.addAvailableFunctionsSystemMessageToHistory(history, 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.join("\n\n"),
+                    user: userTexts.join("\n\n"),
+                    model: modelTexts.join("\n\n")
+                });
+            systemTexts = [];
+            userTexts = [];
+            modelTexts = [];
+        }
+        for (const item of historyWithFunctions) {
+            if (item.type === "system") {
+                if (currentAggregateFocus !== "system")
+                    flush();
+                currentAggregateFocus = "system";
+                systemTexts.push(item.text);
+            }
+            else if (item.type === "user") {
+                flush();
+                currentAggregateFocus = null;
+                userTexts.push(item.text);
+            }
+            else if (item.type === "model") {
+                flush();
+                currentAggregateFocus = null;
+                modelTexts.push(this.generateModelResponseText(item.response));
+            }
+        }
+        flush();
+        const contextText = LlamaText(resultItems.map(({ system, user, model }, index) => {
+            const isLastItem = index === resultItems.length - 1;
+            return LlamaText([
+                (system.length === 0)
+                    ? LlamaText([])
+                    : LlamaText([
+                        new SpecialToken("<|im_start|>system\n"),
+                        system,
+                        new SpecialToken("<|im_end|>\n")
+                    ]),
+                (user.length === 0)
+                    ? LlamaText([])
+                    : LlamaText([
+                        new SpecialToken("<|im_start|>user\n"),
+                        user,
+                        new SpecialToken("<|im_end|>\n")
+                    ]),
+                (model.length === 0 && !isLastItem)
+                    ? LlamaText([])
+                    : LlamaText([
+                        new SpecialToken("<|im_start|>assistant\n"),
+                        user,
+                        isLastItem
+                            ? LlamaText([])
+                            : new SpecialToken("<|im_end|>\n")
+                    ])
+            ]);
+        }));
+        return {
+            contextText,
+            stopGenerationTriggers: [
+                LlamaText(new BuiltinSpecialToken("EOS")),
+                LlamaText(new SpecialToken("<|im_end|>")),
+                LlamaText("<|im_end|>")
+            ]
+        };
+    }
+}
+//# sourceMappingURL=ChatMLChatWrapper.js.map

package/dist/chatWrappers/ChatMLChatWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatMLChatWrapper.js","sourceRoot":"","sources":["../../src/chatWrappers/ChatMLChatWrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAC,mBAAmB,EAAE,SAAS,EAAE,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAEnF,0GAA0G;AAC1G,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAC9B,WAAW,GAAW,QAAQ,CAAC;IAE/B,mBAAmB,CAAC,OAAmC,EAAE,EAAC,kBAAkB,EAAE,sBAAsB,KAGhH,EAAE;QAIF,MAAM,oBAAoB,GAAG,IAAI,CAAC,2CAA2C,CAAC,OAAO,EAAE,kBAAkB,EAAE;YACvG,cAAc,EAAE,sBAAsB;SACzC,CAAC,CAAC;QAEH,MAAM,WAAW,GAIZ,EAAE,CAAC;QAER,IAAI,WAAW,GAAa,EAAE,CAAC;QAC/B,IAAI,SAAS,GAAa,EAAE,CAAC;QAC7B,IAAI,UAAU,GAAa,EAAE,CAAC;QAC9B,IAAI,qBAAqB,GAAoB,IAAI,CAAC;QAElD,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,IAAI,CAAC,MAAM,CAAC;oBAChC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;oBAC5B,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;iBACjC,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;YACrC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;gBACxB,IAAI,qBAAqB,KAAK,QAAQ;oBAClC,KAAK,EAAE,CAAC;gBAEZ,qBAAqB,GAAG,QAAQ,CAAC;gBACjC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC/B;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE;gBAC7B,KAAK,EAAE,CAAC;gBAER,qBAAqB,GAAG,IAAI,CAAC;gBAC7B,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC7B;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE;gBAC9B,KAAK,EAAE,CAAC;gBAER,qBAAqB,GAAG,IAAI,CAAC;gBAC7B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;aAClE;SACJ;QAED,KAAK,EAAE,CAAC;QAER,MAAM,WAAW,GAAG,SAAS,CACzB,WAAW,CAAC,GAAG,CAAC,CAAC,EAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAC,EAAE,KAAK,EAAE,EAAE;YAC7C,MAAM,UAAU,GAAG,KAAK,KAAK,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;YAEpD,OAAO,SAAS,CAAC;gBACb,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;oBACjB,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,SAAS,CAAC;wBACR,IAAI,YAAY,CAAC,sBAAsB,CAAC;wBACxC,MAAM;wBACN,IAAI,YAAY,CAAC,cAAc,CAAC;qBACnC,CAAC;gBAEN,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC;oBACf,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,SAAS,CAAC;wBACR,IAAI,YAAY,CAAC,oBAAoB,CAAC;wBACtC,IAAI;wBACJ,IAAI,YAAY,CAAC,cAAc,CAAC;qBACnC,CAAC;gBAEN,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;oBAC/B,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,SAAS,CAAC;wBACR,IAAI,YAAY,CAAC,yBAAyB,CAAC;wBAC3C,IAAI;wBAEJ,UAAU;4BACN,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;4BACf,CAAC,CAAC,IAAI,YAAY,CAAC,cAAc,CAAC;qBACzC,CAAC;aACT,CAAC,CAAC;QACP,CAAC,CAAC,CACL,CAAC;QAEF,OAAO;YACH,WAAW;YACX,sBAAsB,EAAE;gBACpB,SAAS,CAAC,IAAI,mBAAmB,CAAC,KAAK,CAAC,CAAC;gBACzC,SAAS,CAAC,IAAI,YAAY,CAAC,YAAY,CAAC,CAAC;gBACzC,SAAS,CAAC,YAAY,CAAC;aAC1B;SACJ,CAAC;IACN,CAAC;CACJ"}

package/dist/chatWrappers/EmptyChatWrapper.d.ts

@@ -0,0 +1,4 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+export declare class EmptyChatWrapper extends ChatWrapper {
+    readonly wrapperName: string;
+}

package/dist/chatWrappers/EmptyChatWrapper.js

@@ -0,0 +1,5 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+export class EmptyChatWrapper extends ChatWrapper {
+    wrapperName = "Empty";
+}
+//# sourceMappingURL=EmptyChatWrapper.js.map

package/dist/chatWrappers/EmptyChatWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EmptyChatWrapper.js","sourceRoot":"","sources":["../../src/chatWrappers/EmptyChatWrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAE9C,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC7B,WAAW,GAAW,OAAO,CAAC;CACjD"}

package/dist/chatWrappers/FalconChatWrapper.d.ts

@@ -0,0 +1,21 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { ChatHistoryItem, ChatModelFunctions } from "../types.js";
+import { LlamaText } from "../utils/LlamaText.js";
+export declare class FalconChatWrapper extends ChatWrapper {
+    readonly wrapperName: string;
+    constructor({ userMessageTitle, modelResponseTitle, middleSystemMessageTitle }?: {
+        userMessageTitle?: string;
+        modelResponseTitle?: string;
+        middleSystemMessageTitle?: string;
+    });
+    get userMessageTitle(): string;
+    get modelResponseTitle(): string;
+    get middleSystemMessageTitle(): string;
+    generateContextText(history: readonly ChatHistoryItem[], { availableFunctions, documentFunctionParams }?: {
+        availableFunctions?: ChatModelFunctions;
+        documentFunctionParams?: boolean;
+    }): {
+        contextText: LlamaText;
+        stopGenerationTriggers: LlamaText[];
+    };
+}

package/dist/chatWrappers/FalconChatWrapper.js

@@ -0,0 +1,104 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { LlamaText, BuiltinSpecialToken } from "../utils/LlamaText.js";
+export class FalconChatWrapper extends ChatWrapper {
+    wrapperName = "Falcon";
+    /** @internal */ _userMessageTitle;
+    /** @internal */ _modelResponseTitle;
+    /** @internal */ _middleSystemMessageTitle;
+    constructor({ userMessageTitle = "User", modelResponseTitle = "Assistant", middleSystemMessageTitle = "System" } = {}) {
+        super();
+        this._userMessageTitle = userMessageTitle;
+        this._modelResponseTitle = modelResponseTitle;
+        this._middleSystemMessageTitle = middleSystemMessageTitle;
+    }
+    get userMessageTitle() {
+        return this._userMessageTitle;
+    }
+    get modelResponseTitle() {
+        return this._modelResponseTitle;
+    }
+    get middleSystemMessageTitle() {
+        return this._middleSystemMessageTitle;
+    }
+    generateContextText(history, { availableFunctions, documentFunctionParams } = {}) {
+        const historyWithFunctions = this.addAvailableFunctionsSystemMessageToHistory(history, 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.join("\n\n"),
+                    user: userTexts.join("\n\n"),
+                    model: modelTexts.join("\n\n")
+                });
+            systemTexts = [];
+            userTexts = [];
+            modelTexts = [];
+        }
+        for (const item of historyWithFunctions) {
+            if (item.type === "system") {
+                if (currentAggregateFocus !== "system")
+                    flush();
+                currentAggregateFocus = "system";
+                systemTexts.push(item.text);
+            }
+            else if (item.type === "user") {
+                flush();
+                currentAggregateFocus = null;
+                userTexts.push(item.text);
+            }
+            else if (item.type === "model") {
+                flush();
+                currentAggregateFocus = null;
+                modelTexts.push(this.generateModelResponseText(item.response));
+            }
+        }
+        flush();
+        const contextText = LlamaText(new BuiltinSpecialToken("BOS"), resultItems.map(({ system, user, model }, index) => {
+            const isFirstItem = index === 0;
+            const isLastItem = index === resultItems.length - 1;
+            return LlamaText([
+                (system.length === 0)
+                    ? LlamaText([])
+                    : LlamaText([
+                        isFirstItem
+                            ? LlamaText([])
+                            : `${this._middleSystemMessageTitle}: `,
+                        system,
+                        "\n\n"
+                    ]),
+                (user.length === 0)
+                    ? LlamaText([])
+                    : LlamaText([
+                        `${this._userMessageTitle}: `,
+                        user,
+                        "\n\n"
+                    ]),
+                (model.length === 0 && !isLastItem)
+                    ? LlamaText([])
+                    : LlamaText([
+                        `${this._modelResponseTitle}: `,
+                        model,
+                        isLastItem
+                            ? LlamaText([])
+                            : "\n\n"
+                    ])
+            ]);
+        }));
+        return {
+            contextText,
+            stopGenerationTriggers: [
+                LlamaText(new BuiltinSpecialToken("EOS")),
+                LlamaText(`\n${this._userMessageTitle}:`),
+                LlamaText(`\n${this._modelResponseTitle}:`),
+                LlamaText(`\n${this._middleSystemMessageTitle}:`)
+            ]
+        };
+    }
+}
+//# sourceMappingURL=FalconChatWrapper.js.map

package/dist/chatWrappers/FalconChatWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FalconChatWrapper.js","sourceRoot":"","sources":["../../src/chatWrappers/FalconChatWrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAC,SAAS,EAAE,mBAAmB,EAAC,MAAM,uBAAuB,CAAC;AAErE,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAC9B,WAAW,GAAW,QAAQ,CAAC;IAE/C,gBAAgB,CAAkB,iBAAiB,CAAS;IAC5D,gBAAgB,CAAkB,mBAAmB,CAAS;IAC9D,gBAAgB,CAAkB,yBAAyB,CAAS;IAEpE,YAAmB,EACf,gBAAgB,GAAG,MAAM,EAAE,kBAAkB,GAAG,WAAW,EAAE,wBAAwB,GAAG,QAAQ,KAGhG,EAAE;QACF,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,CAAC,mBAAmB,GAAG,kBAAkB,CAAC;QAC9C,IAAI,CAAC,yBAAyB,GAAG,wBAAwB,CAAC;IAC9D,CAAC;IAED,IAAW,gBAAgB;QACvB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED,IAAW,kBAAkB;QACzB,OAAO,IAAI,CAAC,mBAAmB,CAAC;IACpC,CAAC;IAED,IAAW,wBAAwB;QAC/B,OAAO,IAAI,CAAC,yBAAyB,CAAC;IAC1C,CAAC;IAEe,mBAAmB,CAAC,OAAmC,EAAE,EAAC,kBAAkB,EAAE,sBAAsB,KAGhH,EAAE;QAIF,MAAM,oBAAoB,GAAG,IAAI,CAAC,2CAA2C,CAAC,OAAO,EAAE,kBAAkB,EAAE;YACvG,cAAc,EAAE,sBAAsB;SACzC,CAAC,CAAC;QAEH,MAAM,WAAW,GAIZ,EAAE,CAAC;QAER,IAAI,WAAW,GAAa,EAAE,CAAC;QAC/B,IAAI,SAAS,GAAa,EAAE,CAAC;QAC7B,IAAI,UAAU,GAAa,EAAE,CAAC;QAC9B,IAAI,qBAAqB,GAAoB,IAAI,CAAC;QAElD,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,IAAI,CAAC,MAAM,CAAC;oBAChC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;oBAC5B,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;iBACjC,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;YACrC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;gBACxB,IAAI,qBAAqB,KAAK,QAAQ;oBAClC,KAAK,EAAE,CAAC;gBAEZ,qBAAqB,GAAG,QAAQ,CAAC;gBACjC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC/B;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE;gBAC7B,KAAK,EAAE,CAAC;gBAER,qBAAqB,GAAG,IAAI,CAAC;gBAC7B,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC7B;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE;gBAC9B,KAAK,EAAE,CAAC;gBAER,qBAAqB,GAAG,IAAI,CAAC;gBAC7B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;aAClE;SACJ;QAED,KAAK,EAAE,CAAC;QAER,MAAM,WAAW,GAAG,SAAS,CACzB,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAC9B,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,OAAO,SAAS,CAAC;gBACb,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;oBACjB,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,SAAS,CAAC;wBACR,WAAW;4BACP,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;4BACf,CAAC,CAAC,GAAG,IAAI,CAAC,yBAAyB,IAAI;wBAC3C,MAAM;wBACN,MAAM;qBACT,CAAC;gBAEN,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC;oBACf,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,SAAS,CAAC;wBACR,GAAG,IAAI,CAAC,iBAAiB,IAAI;wBAC7B,IAAI;wBACJ,MAAM;qBACT,CAAC;gBAEN,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;oBAC/B,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,SAAS,CAAC;wBACR,GAAG,IAAI,CAAC,mBAAmB,IAAI;wBAC/B,KAAK;wBACL,UAAU;4BACN,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;4BACf,CAAC,CAAC,MAAM;qBACf,CAAC;aACT,CAAC,CAAC;QACP,CAAC,CAAC,CACL,CAAC;QAEF,OAAO;YACH,WAAW;YACX,sBAAsB,EAAE;gBACpB,SAAS,CAAC,IAAI,mBAAmB,CAAC,KAAK,CAAC,CAAC;gBAEzC,SAAS,CAAC,KAAK,IAAI,CAAC,iBAAiB,GAAG,CAAC;gBACzC,SAAS,CAAC,KAAK,IAAI,CAAC,mBAAmB,GAAG,CAAC;gBAC3C,SAAS,CAAC,KAAK,IAAI,CAAC,yBAAyB,GAAG,CAAC;aACpD;SACJ,CAAC;IACN,CAAC;CACJ"}

package/dist/chatWrappers/FunctionaryChatWrapper.d.ts

@@ -0,0 +1,41 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { ChatHistoryItem, ChatModelFunctions } from "../types.js";
+import { LlamaText } from "../utils/LlamaText.js";
+export declare class FunctionaryChatWrapper extends ChatWrapper {
+    readonly wrapperName: string;
+    readonly settings: {
+        functions: {
+            call: {
+                optionalPrefixSpace: boolean;
+                prefix: string;
+                paramsPrefix: string;
+                suffix: string;
+            };
+            result: {
+                prefix: string;
+                suffix: string;
+            };
+        };
+    };
+    generateContextText(history: readonly ChatHistoryItem[], { availableFunctions, documentFunctionParams }?: {
+        availableFunctions?: ChatModelFunctions;
+        documentFunctionParams?: boolean;
+    }): {
+        contextText: LlamaText;
+        stopGenerationTriggers: LlamaText[];
+        ignoreStartText?: LlamaText[];
+        functionCall?: {
+            initiallyEngaged: boolean;
+            disengageInitiallyEngaged: LlamaText[];
+        };
+    };
+    generateAvailableFunctionsSystemText(availableFunctions: ChatModelFunctions, { documentParams }: {
+        documentParams?: boolean;
+    }): string;
+    addAvailableFunctionsSystemMessageToHistory(history: readonly ChatHistoryItem[], availableFunctions?: ChatModelFunctions, { documentParams }?: {
+        documentParams?: boolean;
+    }): readonly ChatHistoryItem[];
+    getInternalBuiltinFunctions({ initialFunctionCallEngaged }: {
+        initialFunctionCallEngaged: boolean;
+    }): ChatModelFunctions;
+}