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

package/dist/chatWrappers/GemmaChatWrapper.js

@@ -0,0 +1,96 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { SpecialToken, LlamaText, SpecialTokensText } from "../utils/LlamaText.js";
+// source: https://ai.google.dev/gemma/docs/formatting
+// source: https://www.promptingguide.ai/models/gemma
+export class GemmaChatWrapper extends ChatWrapper {
+    wrapperName = "Gemma";
+    settings = {
+        ...ChatWrapper.defaultSettings,
+        supportsSystemMessages: false
+    };
+    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) {
+                const systemText = LlamaText.joinValues("\n\n", systemTexts);
+                let userText = LlamaText.joinValues("\n\n", userTexts);
+                // there's no system prompt support in Gemma, so we'll prepend the system text to the user message
+                if (systemText.values.length > 0) {
+                    if (userText.values.length === 0)
+                        userText = systemText;
+                    else
+                        userText = LlamaText([
+                            systemText,
+                            "\n\n---\n\n",
+                            userText
+                        ]);
+                }
+                resultItems.push({
+                    user: userText,
+                    model: 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 !== "system" && currentAggregateFocus !== "user")
+                    flush();
+                currentAggregateFocus = "user";
+                userTexts.push(LlamaText(item.text));
+            }
+            else if (item.type === "model") {
+                currentAggregateFocus = "model";
+                modelTexts.push(this.generateModelResponseText(item.response));
+            }
+            else
+                void (item);
+        }
+        flush();
+        const contextText = LlamaText(new SpecialToken("BOS"), resultItems.map(({ user, model }, index) => {
+            const isLastItem = index === resultItems.length - 1;
+            return LlamaText([
+                (user.values.length === 0)
+                    ? LlamaText([])
+                    : LlamaText([
+                        new SpecialTokensText("<start_of_turn>user\n"),
+                        user,
+                        new SpecialTokensText("<end_of_turn>\n")
+                    ]),
+                (model.values.length === 0 && !isLastItem)
+                    ? LlamaText([])
+                    : LlamaText([
+                        new SpecialTokensText("<start_of_turn>model\n"),
+                        model,
+                        isLastItem
+                            ? LlamaText([])
+                            : new SpecialTokensText("<end_of_turn>\n")
+                    ])
+            ]);
+        }));
+        return {
+            contextText,
+            stopGenerationTriggers: [
+                LlamaText(new SpecialToken("EOS")),
+                LlamaText(new SpecialTokensText("<end_of_turn>\n")),
+                LlamaText("<end_of_turn>")
+            ]
+        };
+    }
+}
+//# sourceMappingURL=GemmaChatWrapper.js.map

package/dist/chatWrappers/GemmaChatWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GemmaChatWrapper.js","sourceRoot":"","sources":["../../src/chatWrappers/GemmaChatWrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAC,YAAY,EAAE,SAAS,EAAE,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAEjF,sDAAsD;AACtD,qDAAqD;AACrD,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC7B,WAAW,GAAW,OAAO,CAAC;IAErB,QAAQ,GAAwB;QACrD,GAAG,WAAW,CAAC,eAAe;QAC9B,sBAAsB,EAAE,KAAK;KAChC,CAAC;IAEc,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,GAGZ,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,EAAE,CAAC;gBAC1E,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;gBAC7D,IAAI,QAAQ,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;gBAEvD,kGAAkG;gBAClG,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC/B,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;wBAC5B,QAAQ,GAAG,UAAU,CAAC;;wBAEtB,QAAQ,GAAG,SAAS,CAAC;4BACjB,UAAU;4BACV,aAAa;4BACb,QAAQ;yBACX,CAAC,CAAC;gBAEX,CAAC;gBACD,WAAW,CAAC,IAAI,CAAC;oBACb,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC;iBAClD,CAAC,CAAC;YACP,CAAC;YAED,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,QAAQ,IAAI,qBAAqB,KAAK,MAAM;oBACtE,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,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,EAAC,IAAI,EAAE,KAAK,EAAC,EAAE,KAAK,EAAE,EAAE;YACrC,MAAM,UAAU,GAAG,KAAK,KAAK,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;YAEpD,OAAO,SAAS,CAAC;gBACb,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;oBACtB,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,SAAS,CAAC;wBACR,IAAI,iBAAiB,CAAC,uBAAuB,CAAC;wBAC9C,IAAI;wBACJ,IAAI,iBAAiB,CAAC,iBAAiB,CAAC;qBAC3C,CAAC;gBAEN,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;oBACtC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,SAAS,CAAC;wBACR,IAAI,iBAAiB,CAAC,wBAAwB,CAAC;wBAC/C,KAAK;wBAEL,UAAU;4BACN,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;4BACf,CAAC,CAAC,IAAI,iBAAiB,CAAC,iBAAiB,CAAC;qBACjD,CAAC;aACT,CAAC,CAAC;QACP,CAAC,CAAC,CACL,CAAC;QAEF,OAAO;YACH,WAAW;YACX,sBAAsB,EAAE;gBACpB,SAAS,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;gBAClC,SAAS,CAAC,IAAI,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;gBACnD,SAAS,CAAC,eAAe,CAAC;aAC7B;SACJ,CAAC;IACN,CAAC;CACJ"}

package/dist/chatWrappers/GeneralChatWrapper.d.ts

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

package/dist/chatWrappers/GeneralChatWrapper.js

@@ -1,15 +1,17 @@
 import { ChatWrapper } from "../ChatWrapper.js";
-import { BuiltinSpecialToken, LlamaText, SpecialToken } from "../utils/LlamaText.js";
+import { SpecialToken, LlamaText, SpecialTokensText } from "../utils/LlamaText.js";
 export class GeneralChatWrapper extends ChatWrapper {
     wrapperName = "General";
     /** @internal */ _userMessageTitle;
     /** @internal */ _modelResponseTitle;
     /** @internal */ _middleSystemMessageTitle;
-    constructor({ userMessageTitle = "Human", modelResponseTitle = "Assistant", middleSystemMessageTitle = "System" } = {}) {
+    /** @internal */ _allowSpecialTokensInTitles;
+    constructor({ userMessageTitle = "Human", modelResponseTitle = "Assistant", middleSystemMessageTitle = "System", allowSpecialTokensInTitles = false } = {}) {
         super();
         this._userMessageTitle = userMessageTitle;
         this._modelResponseTitle = modelResponseTitle;
         this._middleSystemMessageTitle = middleSystemMessageTitle;
+        this._allowSpecialTokensInTitles = allowSpecialTokensInTitles;
     }
     get userMessageTitle() {
         return this._userMessageTitle;
@@ -20,8 +22,8 @@ export class GeneralChatWrapper extends ChatWrapper {
     get middleSystemMessageTitle() {
         return this._middleSystemMessageTitle;
     }
-    generateContextText(history, { availableFunctions, documentFunctionParams } = {}) {
-        const historyWithFunctions = this.addAvailableFunctionsSystemMessageToHistory(history, availableFunctions, {
+    generateContextState({ chatHistory, availableFunctions, documentFunctionParams }) {
+        const historyWithFunctions = this.addAvailableFunctionsSystemMessageToHistory(chatHistory, availableFunctions, {
             documentParams: documentFunctionParams
         });
         const resultItems = [];
@@ -32,9 +34,9 @@ export class GeneralChatWrapper extends ChatWrapper {
         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")
+                    system: LlamaText.joinValues("\n\n", systemTexts),
+                    user: LlamaText.joinValues("\n\n", userTexts),
+                    model: LlamaText.joinValues("\n\n", modelTexts)
                 });
             systemTexts = [];
             userTexts = [];
@@ -45,56 +47,58 @@ export class GeneralChatWrapper extends ChatWrapper {
                 if (currentAggregateFocus !== "system")
                     flush();
                 currentAggregateFocus = "system";
-                systemTexts.push(item.text);
+                systemTexts.push(LlamaText.fromJSON(item.text));
             }
             else if (item.type === "user") {
                 flush();
                 currentAggregateFocus = null;
-                userTexts.push(item.text);
+                userTexts.push(LlamaText(item.text));
             }
             else if (item.type === "model") {
                 flush();
                 currentAggregateFocus = null;
                 modelTexts.push(this.generateModelResponseText(item.response));
             }
+            else
+                void (item);
         }
         flush();
-        const contextText = LlamaText(new BuiltinSpecialToken("BOS"), resultItems.map(({ system, user, model }, index) => {
+        const contextText = LlamaText(new SpecialToken("BOS"), resultItems.map(({ system, user, model }, index) => {
             const isFirstItem = index === 0;
             const isLastItem = index === resultItems.length - 1;
             return LlamaText([
-                (system.length === 0)
+                (system.values.length === 0)
                     ? LlamaText([])
                     : LlamaText([
                         isFirstItem
                             ? LlamaText([])
-                            : `### ${this._middleSystemMessageTitle}\n`,
+                            : SpecialTokensText.wrapIf(this._allowSpecialTokensInTitles, `### ${this._middleSystemMessageTitle}\n`),
                         system,
-                        "\n\n"
+                        SpecialTokensText.wrapIf(this._allowSpecialTokensInTitles, "\n\n")
                     ]),
-                (user.length === 0)
+                (user.values.length === 0)
                     ? LlamaText([])
                     : LlamaText([
-                        `### ${this._userMessageTitle}\n`,
+                        SpecialTokensText.wrapIf(this._allowSpecialTokensInTitles, `### ${this._userMessageTitle}\n`),
                         user,
-                        "\n\n"
+                        SpecialTokensText.wrapIf(this._allowSpecialTokensInTitles, "\n\n")
                     ]),
-                (model.length === 0 && !isLastItem)
+                (model.values.length === 0 && !isLastItem)
                     ? LlamaText([])
                     : LlamaText([
-                        `### ${this._modelResponseTitle}\n`,
+                        SpecialTokensText.wrapIf(this._allowSpecialTokensInTitles, `### ${this._modelResponseTitle}\n`),
                         model,
                         isLastItem
                             ? LlamaText([])
-                            : "\n\n"
+                            : SpecialTokensText.wrapIf(this._allowSpecialTokensInTitles, "\n\n")
                     ])
             ]);
         }));
         return {
             contextText,
             stopGenerationTriggers: [
-                LlamaText(new BuiltinSpecialToken("EOS")),
-                LlamaText(new SpecialToken("<end>")),
+                LlamaText(new SpecialToken("EOS")),
+                LlamaText(new SpecialTokensText("<end>")),
                 LlamaText("<end>"),
                 LlamaText(`### ${this._userMessageTitle}`),
                 LlamaText(`\n### ${this._userMessageTitle}`),
@@ -104,9 +108,28 @@ export class GeneralChatWrapper extends ChatWrapper {
                 LlamaText(`\n\n### ${this._modelResponseTitle}`),
                 LlamaText(`### ${this._middleSystemMessageTitle}`),
                 LlamaText(`\n### ${this._middleSystemMessageTitle}`),
-                LlamaText(`\n\n### ${this._middleSystemMessageTitle}`)
+                LlamaText(`\n\n### ${this._middleSystemMessageTitle}`),
+                ...(!this._allowSpecialTokensInTitles
+                    ? []
+                    : [
+                        LlamaText(new SpecialTokensText(`### ${this._userMessageTitle}`)),
+                        LlamaText(new SpecialTokensText(`\n### ${this._userMessageTitle}`)),
+                        LlamaText(new SpecialTokensText(`\n\n### ${this._userMessageTitle}`)),
+                        LlamaText(new SpecialTokensText(`### ${this._modelResponseTitle}`)),
+                        LlamaText(new SpecialTokensText(`\n### ${this._modelResponseTitle}`)),
+                        LlamaText(new SpecialTokensText(`\n\n### ${this._modelResponseTitle}`)),
+                        LlamaText(new SpecialTokensText(`### ${this._middleSystemMessageTitle}`)),
+                        LlamaText(new SpecialTokensText(`\n### ${this._middleSystemMessageTitle}`)),
+                        LlamaText(new SpecialTokensText(`\n\n### ${this._middleSystemMessageTitle}`))
+                    ])
             ]
         };
     }
+    /** @internal */
+    static _getOptionConfigurationsToTestIfCanSupersedeJinjaTemplate() {
+        return [{}, {
+                allowSpecialTokensInTitles: true
+            }];
+    }
 }
 //# sourceMappingURL=GeneralChatWrapper.js.map

package/dist/chatWrappers/GeneralChatWrapper.js.map

@@ -1 +1 @@
-{"version":3,"file":"GeneralChatWrapper.js","sourceRoot":"","sources":["../../src/chatWrappers/GeneralChatWrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAC,mBAAmB,EAAE,SAAS,EAAE,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAEnF,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IAC/B,WAAW,GAAW,SAAS,CAAC;IAEhD,gBAAgB,CAAkB,iBAAiB,CAAS;IAC5D,gBAAgB,CAAkB,mBAAmB,CAAS;IAC9D,gBAAgB,CAAkB,yBAAyB,CAAS;IAEpE,YAAmB,EACf,gBAAgB,GAAG,OAAO,EAAE,kBAAkB,GAAG,WAAW,EAAE,wBAAwB,GAAG,QAAQ,KAGjG,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,OAAO,IAAI,CAAC,yBAAyB,IAAI;wBAC/C,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,OAAO,IAAI,CAAC,iBAAiB,IAAI;wBACjC,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,OAAO,IAAI,CAAC,mBAAmB,IAAI;wBACnC,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;gBACzC,SAAS,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;gBACpC,SAAS,CAAC,OAAO,CAAC;gBAElB,SAAS,CAAC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAC1C,SAAS,CAAC,SAAS,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAC5C,SAAS,CAAC,WAAW,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAE9C,SAAS,CAAC,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBAC5C,SAAS,CAAC,SAAS,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBAC9C,SAAS,CAAC,WAAW,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBAEhD,SAAS,CAAC,OAAO,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBAClD,SAAS,CAAC,SAAS,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBACpD,SAAS,CAAC,WAAW,IAAI,CAAC,yBAAyB,EAAE,CAAC;aACzD;SACJ,CAAC;IACN,CAAC;CACJ"}
+{"version":3,"file":"GeneralChatWrapper.js","sourceRoot":"","sources":["../../src/chatWrappers/GeneralChatWrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAC,YAAY,EAAE,SAAS,EAAE,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAEjF,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IAC/B,WAAW,GAAW,SAAS,CAAC;IAEhD,gBAAgB,CAAkB,iBAAiB,CAAS;IAC5D,gBAAgB,CAAkB,mBAAmB,CAAS;IAC9D,gBAAgB,CAAkB,yBAAyB,CAAS;IACpE,gBAAgB,CAAkB,2BAA2B,CAAU;IAEvE,YAAmB,EACf,gBAAgB,GAAG,OAAO,EAAE,kBAAkB,GAAG,WAAW,EAAE,wBAAwB,GAAG,QAAQ,EACjG,0BAA0B,GAAG,KAAK,KAGlC,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;QAC1D,IAAI,CAAC,2BAA2B,GAAG,0BAA0B,CAAC;IAClE,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,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,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,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,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,KAAK,EAAE,CAAC;gBAER,qBAAqB,GAAG,IAAI,CAAC;gBAC7B,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,KAAK,EAAE,CAAC;gBAER,qBAAqB,GAAG,IAAI,CAAC;gBAC7B,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,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,CAAC,MAAM,KAAK,CAAC,CAAC;oBACxB,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,SAAS,CAAC;wBACR,WAAW;4BACP,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;4BACf,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE,OAAO,IAAI,CAAC,yBAAyB,IAAI,CAAC;wBAC3G,MAAM;wBACN,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE,MAAM,CAAC;qBACrE,CAAC;gBAEN,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;oBACtB,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,SAAS,CAAC;wBACR,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE,OAAO,IAAI,CAAC,iBAAiB,IAAI,CAAC;wBAC7F,IAAI;wBACJ,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE,MAAM,CAAC;qBACrE,CAAC;gBAEN,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;oBACtC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,SAAS,CAAC;wBACR,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE,OAAO,IAAI,CAAC,mBAAmB,IAAI,CAAC;wBAC/F,KAAK;wBACL,UAAU;4BACN,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;4BACf,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE,MAAM,CAAC;qBAC3E,CAAC;aACT,CAAC,CAAC;QACP,CAAC,CAAC,CACL,CAAC;QAEF,OAAO;YACH,WAAW;YACX,sBAAsB,EAAE;gBACpB,SAAS,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;gBAClC,SAAS,CAAC,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC;gBACzC,SAAS,CAAC,OAAO,CAAC;gBAElB,SAAS,CAAC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAC1C,SAAS,CAAC,SAAS,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAC5C,SAAS,CAAC,WAAW,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAE9C,SAAS,CAAC,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBAC5C,SAAS,CAAC,SAAS,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBAC9C,SAAS,CAAC,WAAW,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBAEhD,SAAS,CAAC,OAAO,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBAClD,SAAS,CAAC,SAAS,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBACpD,SAAS,CAAC,WAAW,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBAEtD,GAAG,CACC,CAAC,IAAI,CAAC,2BAA2B;oBAC7B,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC;wBACE,SAAS,CAAC,IAAI,iBAAiB,CAAC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;wBACjE,SAAS,CAAC,IAAI,iBAAiB,CAAC,SAAS,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;wBACnE,SAAS,CAAC,IAAI,iBAAiB,CAAC,WAAW,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;wBAErE,SAAS,CAAC,IAAI,iBAAiB,CAAC,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;wBACnE,SAAS,CAAC,IAAI,iBAAiB,CAAC,SAAS,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;wBACrE,SAAS,CAAC,IAAI,iBAAiB,CAAC,WAAW,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;wBAEvE,SAAS,CAAC,IAAI,iBAAiB,CAAC,OAAO,IAAI,CAAC,yBAAyB,EAAE,CAAC,CAAC;wBACzE,SAAS,CAAC,IAAI,iBAAiB,CAAC,SAAS,IAAI,CAAC,yBAAyB,EAAE,CAAC,CAAC;wBAC3E,SAAS,CAAC,IAAI,iBAAiB,CAAC,WAAW,IAAI,CAAC,yBAAyB,EAAE,CAAC,CAAC;qBAChF,CACR;aACJ;SACJ,CAAC;IACN,CAAC;IAED,gBAAgB;IACT,MAAM,CAAU,yDAAyD;QAC5E,OAAO,CAAC,EAAE,EAAE;gBACR,0BAA0B,EAAE,IAAI;aACnC,CAA4D,CAAC;IAClE,CAAC;CACJ"}

package/dist/chatWrappers/Llama2ChatWrapper.d.ts

@@ -0,0 +1,12 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { ChatWrapperGenerateContextStateOptions, ChatWrapperGeneratedContextState } from "../types.js";
+export declare class Llama2ChatWrapper extends ChatWrapper {
+    readonly wrapperName: string;
+    constructor({ addSpaceBeforeEos }?: {
+        /**
+         * Default to `true`
+         */
+        addSpaceBeforeEos?: boolean;
+    });
+    generateContextState({ chatHistory, availableFunctions, documentFunctionParams }: ChatWrapperGenerateContextStateOptions): ChatWrapperGeneratedContextState;
+}

package/dist/chatWrappers/{LlamaChatWrapper.js → Llama2ChatWrapper.js}

@@ -1,10 +1,15 @@
 import { ChatWrapper } from "../ChatWrapper.js";
-import { BuiltinSpecialToken, LlamaText, SpecialToken } from "../utils/LlamaText.js";
+import { SpecialToken, LlamaText, SpecialTokensText } from "../utils/LlamaText.js";
 // source: https://huggingface.co/blog/llama2#how-to-prompt-llama-2
-export class LlamaChatWrapper extends ChatWrapper {
-    wrapperName = "LlamaChat";
-    generateContextText(history, { availableFunctions, documentFunctionParams } = {}) {
-        const historyWithFunctions = this.addAvailableFunctionsSystemMessageToHistory(history, availableFunctions, {
+export class Llama2ChatWrapper extends ChatWrapper {
+    wrapperName = "Llama2Chat";
+    /** @internal */ _addSpaceBeforeEos;
+    constructor({ addSpaceBeforeEos = false } = {}) {
+        super();
+        this._addSpaceBeforeEos = addSpaceBeforeEos;
+    }
+    generateContextState({ chatHistory, availableFunctions, documentFunctionParams }) {
+        const historyWithFunctions = this.addAvailableFunctionsSystemMessageToHistory(chatHistory, availableFunctions, {
             documentParams: documentFunctionParams
         });
         const resultItems = [];
@@ -15,9 +20,9 @@ export class LlamaChatWrapper extends ChatWrapper {
         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")
+                    system: LlamaText.joinValues("\n\n", systemTexts),
+                    user: LlamaText.joinValues("\n\n", userTexts),
+                    model: LlamaText.joinValues("\n\n", modelTexts)
                 });
             systemTexts = [];
             userTexts = [];
@@ -28,51 +33,64 @@ export class LlamaChatWrapper extends ChatWrapper {
                 if (currentAggregateFocus !== "system")
                     flush();
                 currentAggregateFocus = "system";
-                systemTexts.push(item.text);
+                systemTexts.push(LlamaText.fromJSON(item.text));
             }
             else if (item.type === "user") {
                 if (currentAggregateFocus !== "system" && currentAggregateFocus !== "user")
                     flush();
                 currentAggregateFocus = "user";
-                userTexts.push(item.text);
+                userTexts.push(LlamaText(item.text));
             }
             else if (item.type === "model") {
                 currentAggregateFocus = "model";
                 modelTexts.push(this.generateModelResponseText(item.response));
             }
+            else
+                void (item);
         }
         flush();
         const contextText = LlamaText(resultItems.map(({ system, user, model }, index) => {
             const isLastItem = index === resultItems.length - 1;
             return LlamaText([
-                new BuiltinSpecialToken("BOS"),
-                (system.length === 0 && user.length === 0)
+                new SpecialToken("BOS"),
+                (system.values.length === 0 && user.values.length === 0)
                     ? LlamaText([])
                     : LlamaText([
-                        new SpecialToken("[INST] "),
-                        system.length === 0
+                        new SpecialTokensText("[INST] "),
+                        system.values.length === 0
                             ? LlamaText([])
                             : LlamaText([
-                                new SpecialToken("<<SYS>>\n"),
+                                new SpecialTokensText("<<SYS>>\n"),
                                 system,
-                                new SpecialToken("\n<</SYS>>\n\n")
+                                new SpecialTokensText("\n<</SYS>>\n\n")
                             ]),
                         user,
-                        new SpecialToken(" [/INST]\n\n")
+                        new SpecialTokensText(" [/INST] ")
                     ]),
                 model,
+                this._addSpaceBeforeEos
+                    ? " "
+                    : "",
                 isLastItem
                     ? LlamaText([])
-                    : new BuiltinSpecialToken("EOS")
+                    : new SpecialToken("EOS")
             ]);
         }));
         return {
             contextText,
             stopGenerationTriggers: [
-                LlamaText(new BuiltinSpecialToken("EOS")),
+                LlamaText(new SpecialToken("EOS")),
                 LlamaText("</s>")
             ]
         };
     }
+    /** @internal */
+    static _getOptionConfigurationsToTestIfCanSupersedeJinjaTemplate() {
+        return [{
+                addSpaceBeforeEos: false
+            }, {
+                addSpaceBeforeEos: true
+            }];
+    }
 }
-//# sourceMappingURL=LlamaChatWrapper.js.map
+//# sourceMappingURL=Llama2ChatWrapper.js.map

package/dist/chatWrappers/Llama2ChatWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Llama2ChatWrapper.js","sourceRoot":"","sources":["../../src/chatWrappers/Llama2ChatWrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAC,YAAY,EAAE,SAAS,EAAE,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAEjF,mEAAmE;AACnE,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAC9B,WAAW,GAAW,YAAY,CAAC;IAEnD,gBAAgB,CAAkB,kBAAkB,CAAU;IAE9D,YAAmB,EACf,iBAAiB,GAAG,KAAK,KAMzB,EAAE;QACF,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;IAChD,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,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,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,QAAQ,IAAI,qBAAqB,KAAK,MAAM;oBACtE,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,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,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,IAAI,YAAY,CAAC,KAAK,CAAC;gBACvB,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;oBACpD,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,SAAS,CAAC;wBACR,IAAI,iBAAiB,CAAC,SAAS,CAAC;wBAChC,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;4BACtB,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;4BACf,CAAC,CAAC,SAAS,CAAC;gCACR,IAAI,iBAAiB,CAAC,WAAW,CAAC;gCAClC,MAAM;gCACN,IAAI,iBAAiB,CAAC,gBAAgB,CAAC;6BAC1C,CAAC;wBACN,IAAI;wBACJ,IAAI,iBAAiB,CAAC,WAAW,CAAC;qBACrC,CAAC;gBACN,KAAK;gBACL,IAAI,CAAC,kBAAkB;oBACnB,CAAC,CAAC,GAAG;oBACL,CAAC,CAAC,EAAE;gBACR,UAAU;oBACN,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACf,CAAC,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC;aAChC,CAAC,CAAC;QACP,CAAC,CAAC,CACL,CAAC;QAEF,OAAO;YACH,WAAW;YACX,sBAAsB,EAAE;gBACpB,SAAS,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;gBAClC,SAAS,CAAC,MAAM,CAAC;aACpB;SACJ,CAAC;IACN,CAAC;IAED,gBAAgB;IACT,MAAM,CAAU,yDAAyD;QAC5E,OAAO,CAAC;gBACJ,iBAAiB,EAAE,KAAK;aAC3B,EAAE;gBACC,iBAAiB,EAAE,IAAI;aAC1B,CAA4D,CAAC;IAClE,CAAC;CACJ"}

package/dist/chatWrappers/Llama3ChatWrapper.d.ts

@@ -0,0 +1,16 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { ChatModelFunctions, ChatWrapperGenerateContextStateOptions, ChatWrapperGeneratedContextState, ChatWrapperSettings } from "../types.js";
+export declare class Llama3ChatWrapper extends ChatWrapper {
+    readonly wrapperName: string;
+    readonly settings: ChatWrapperSettings;
+    constructor({ parallelFunctionCalling }?: {
+        /**
+         * Defaults to `true`
+         */
+        parallelFunctionCalling?: boolean;
+    });
+    generateContextState({ chatHistory, availableFunctions, documentFunctionParams }: ChatWrapperGenerateContextStateOptions): ChatWrapperGeneratedContextState;
+    generateAvailableFunctionsSystemText(availableFunctions: ChatModelFunctions, { documentParams }: {
+        documentParams?: boolean;
+    }): import("../utils/LlamaText.js")._LlamaText;
+}

package/dist/chatWrappers/Llama3ChatWrapper.js

@@ -0,0 +1,173 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { SpecialToken, LlamaText, SpecialTokensText } from "../utils/LlamaText.js";
+import { ChatModelFunctionsDocumentationGenerator } from "./utils/ChatModelFunctionsDocumentationGenerator.js";
+// source: https://github.com/meta-llama/llama-recipes/blob/79aa70442e97c3127e53c2d22c54438c32adcf5e/README.md
+// source: https://llama.meta.com/docs/model-cards-and-prompt-formats/meta-llama-3/
+export class Llama3ChatWrapper extends ChatWrapper {
+    wrapperName = "Llama 3";
+    settings;
+    constructor({ parallelFunctionCalling = true } = {}) {
+        super();
+        if (parallelFunctionCalling)
+            this.settings = {
+                supportsSystemMessages: true,
+                functions: {
+                    call: {
+                        optionalPrefixSpace: true,
+                        prefix: "||call: ",
+                        paramsPrefix: LlamaText(new SpecialTokensText("(")),
+                        suffix: LlamaText(new SpecialTokensText(")"))
+                    },
+                    result: {
+                        prefix: LlamaText(new SpecialTokensText("<|start_header_id|>function_call_result<|end_header_id|>\n\n")),
+                        suffix: LlamaText(new SpecialToken("EOT"))
+                    },
+                    parallelism: {
+                        call: {
+                            sectionPrefix: "",
+                            betweenCalls: "\n",
+                            sectionSuffix: LlamaText(new SpecialToken("EOT"))
+                        },
+                        result: {
+                            sectionPrefix: "",
+                            betweenResults: "",
+                            sectionSuffix: LlamaText(new SpecialTokensText("<|start_header_id|>assistant<|end_header_id|>\n\n"))
+                        }
+                    }
+                }
+            };
+        else
+            this.settings = {
+                supportsSystemMessages: true,
+                functions: {
+                    call: {
+                        optionalPrefixSpace: true,
+                        prefix: "||call: ",
+                        paramsPrefix: LlamaText(new SpecialTokensText("(")),
+                        suffix: LlamaText(new SpecialTokensText(")"))
+                    },
+                    result: {
+                        prefix: LlamaText([
+                            LlamaText(new SpecialToken("EOT")),
+                            new SpecialTokensText("<|start_header_id|>function_call_result<|end_header_id|>\n\n")
+                        ]),
+                        suffix: LlamaText([
+                            new SpecialToken("EOT"),
+                            new SpecialTokensText("<|start_header_id|>assistant<|end_header_id|>\n\n")
+                        ])
+                    }
+                }
+            };
+    }
+    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", [
+            "The assistant calls the provided functions as needed to retrieve information instead of relying on existing knowledge.",
+            "To fulfill a request, the assistant calls relevant functions in advance when needed before responding to the request, and does not tell the user prior to calling a function.",
+            "Provided functions:",
+            "```typescript",
+            functionsDocumentationGenerator.getTypeScriptFunctionSignatures({ documentParams }),
+            "```",
+            "",
+            "Calling any of the provided functions can be done like this:",
+            this.generateFunctionCall("getSomeInfo", { someKey: "someValue" }),
+            "",
+            "Note that the || prefix is mandatory.",
+            "The assistant does not inform the user about using functions and does not explain anything before calling a function.",
+            "After calling a function, the raw result appears afterwards and is not part of the conversation.",
+            "To make information be part of the conversation, the assistant paraphrases and repeats the information without the function syntax."
+        ]);
+    }
+}
+//# sourceMappingURL=Llama3ChatWrapper.js.map

package/dist/chatWrappers/Llama3ChatWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Llama3ChatWrapper.js","sourceRoot":"","sources":["../../src/chatWrappers/Llama3ChatWrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAI9C,OAAO,EAAC,YAAY,EAAE,SAAS,EAAE,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACjF,OAAO,EAAC,wCAAwC,EAAC,MAAM,qDAAqD,CAAC;AAE7G,8GAA8G;AAC9G,mFAAmF;AACnF,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAC9B,WAAW,GAAW,SAAS,CAAC;IAEvB,QAAQ,CAAsB;IAEvD,YAAmB,EACf,uBAAuB,GAAG,IAAI,KAM9B,EAAE;QACF,KAAK,EAAE,CAAC;QAER,IAAI,uBAAuB;YACvB,IAAI,CAAC,QAAQ,GAAG;gBACZ,sBAAsB,EAAE,IAAI;gBAC5B,SAAS,EAAE;oBACP,IAAI,EAAE;wBACF,mBAAmB,EAAE,IAAI;wBACzB,MAAM,EAAE,UAAU;wBAClB,YAAY,EAAE,SAAS,CAAC,IAAI,iBAAiB,CAAC,GAAG,CAAC,CAAC;wBACnD,MAAM,EAAE,SAAS,CAAC,IAAI,iBAAiB,CAAC,GAAG,CAAC,CAAC;qBAChD;oBACD,MAAM,EAAE;wBACJ,MAAM,EAAE,SAAS,CAAC,IAAI,iBAAiB,CAAC,8DAA8D,CAAC,CAAC;wBACxG,MAAM,EAAE,SAAS,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;qBAC7C;oBACD,WAAW,EAAE;wBACT,IAAI,EAAE;4BACF,aAAa,EAAE,EAAE;4BACjB,YAAY,EAAE,IAAI;4BAClB,aAAa,EAAE,SAAS,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;yBACpD;wBACD,MAAM,EAAE;4BACJ,aAAa,EAAE,EAAE;4BACjB,cAAc,EAAE,EAAE;4BAClB,aAAa,EAAE,SAAS,CAAC,IAAI,iBAAiB,CAAC,mDAAmD,CAAC,CAAC;yBACvG;qBACJ;iBACJ;aACJ,CAAC;;YAEF,IAAI,CAAC,QAAQ,GAAG;gBACZ,sBAAsB,EAAE,IAAI;gBAC5B,SAAS,EAAE;oBACP,IAAI,EAAE;wBACF,mBAAmB,EAAE,IAAI;wBACzB,MAAM,EAAE,UAAU;wBAClB,YAAY,EAAE,SAAS,CAAC,IAAI,iBAAiB,CAAC,GAAG,CAAC,CAAC;wBACnD,MAAM,EAAE,SAAS,CAAC,IAAI,iBAAiB,CAAC,GAAG,CAAC,CAAC;qBAChD;oBACD,MAAM,EAAE;wBACJ,MAAM,EAAE,SAAS,CAAC;4BACd,SAAS,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;4BAClC,IAAI,iBAAiB,CAAC,8DAA8D,CAAC;yBACxF,CAAC;wBACF,MAAM,EAAE,SAAS,CAAC;4BACd,IAAI,YAAY,CAAC,KAAK,CAAC;4BACvB,IAAI,iBAAiB,CAAC,mDAAmD,CAAC;yBAC7E,CAAC;qBACL;iBACJ;aACJ,CAAC;IACV,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,wHAAwH;YACxH,+KAA+K;YAC/K,qBAAqB;YACrB,eAAe;YACf,+BAA+B,CAAC,+BAA+B,CAAC,EAAC,cAAc,EAAC,CAAC;YACjF,KAAK;YACL,EAAE;YACF,8DAA8D;YAC9D,IAAI,CAAC,oBAAoB,CAAC,aAAa,EAAE,EAAC,OAAO,EAAE,WAAW,EAAC,CAAC;YAChE,EAAE;YACF,uCAAuC;YACvC,uHAAuH;YACvH,kGAAkG;YAClG,qIAAqI;SACxI,CAAC,CAAC;IACP,CAAC;CACJ"}