@realtimex/node-llama-cpp 0.1.0

package/dist/chatWrappers/GemmaChatWrapper.d.ts

@@ -0,0 +1,7 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { ChatWrapperGenerateContextStateOptions, ChatWrapperGeneratedContextState, ChatWrapperSettings } from "../types.js";
+export declare class GemmaChatWrapper extends ChatWrapper {
+    readonly wrapperName: string;
+    readonly settings: ChatWrapperSettings;
+    generateContextState({ chatHistory, availableFunctions, documentFunctionParams }: ChatWrapperGenerateContextStateOptions): ChatWrapperGeneratedContextState;
+}

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;gBACX,CAAC;gBAED,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,KAAM,IAAqB,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

@@ -0,0 +1,19 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { ChatWrapperGenerateContextStateOptions, ChatWrapperGeneratedContextState } from "../types.js";
+/**
+ * This chat wrapper is not safe against chat syntax injection attacks
+ * ([learn more](https://node-llama-cpp.withcat.ai/guide/llama-text#input-safety-in-node-llama-cpp)).
+ */
+export declare class GeneralChatWrapper extends ChatWrapper {
+    readonly wrapperName: string;
+    constructor({ userMessageTitle, modelResponseTitle, middleSystemMessageTitle, allowSpecialTokensInTitles }?: {
+        userMessageTitle?: string;
+        modelResponseTitle?: string;
+        middleSystemMessageTitle?: string;
+        allowSpecialTokensInTitles?: boolean;
+    });
+    get userMessageTitle(): string;
+    get modelResponseTitle(): string;
+    get middleSystemMessageTitle(): string;
+    generateContextState({ chatHistory, availableFunctions, documentFunctionParams }: ChatWrapperGenerateContextStateOptions): ChatWrapperGeneratedContextState;
+}

package/dist/chatWrappers/GeneralChatWrapper.js

@@ -0,0 +1,140 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { SpecialToken, LlamaText, SpecialTokensText } from "../utils/LlamaText.js";
+/**
+ * This chat wrapper is not safe against chat syntax injection attacks
+ * ([learn more](https://node-llama-cpp.withcat.ai/guide/llama-text#input-safety-in-node-llama-cpp)).
+ */
+export class GeneralChatWrapper extends ChatWrapper {
+    wrapperName = "General";
+    /** @internal */ _userMessageTitle;
+    /** @internal */ _modelResponseTitle;
+    /** @internal */ _middleSystemMessageTitle;
+    /** @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;
+    }
+    get modelResponseTitle() {
+        return this._modelResponseTitle;
+    }
+    get middleSystemMessageTitle() {
+        return this._middleSystemMessageTitle;
+    }
+    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: LlamaText.joinValues("\n\n", systemTexts),
+                    user: LlamaText.joinValues("\n\n", userTexts),
+                    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") {
+                flush();
+                currentAggregateFocus = null;
+                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 SpecialToken("BOS"), resultItems.map(({ system, user, model }, index) => {
+            const isFirstItem = index === 0;
+            const isLastItem = index === resultItems.length - 1;
+            return LlamaText([
+                (system.values.length === 0)
+                    ? LlamaText([])
+                    : LlamaText([
+                        isFirstItem
+                            ? LlamaText([])
+                            : SpecialTokensText.wrapIf(this._allowSpecialTokensInTitles, `### ${this._middleSystemMessageTitle}\n`),
+                        system,
+                        SpecialTokensText.wrapIf(this._allowSpecialTokensInTitles, "\n\n")
+                    ]),
+                (user.values.length === 0)
+                    ? LlamaText([])
+                    : LlamaText([
+                        SpecialTokensText.wrapIf(this._allowSpecialTokensInTitles, `### ${this._userMessageTitle}\n`),
+                        user,
+                        SpecialTokensText.wrapIf(this._allowSpecialTokensInTitles, "\n\n")
+                    ]),
+                (model.values.length === 0 && !isLastItem)
+                    ? LlamaText([])
+                    : LlamaText([
+                        SpecialTokensText.wrapIf(this._allowSpecialTokensInTitles, `### ${this._modelResponseTitle}\n`),
+                        model,
+                        isLastItem
+                            ? LlamaText([])
+                            : SpecialTokensText.wrapIf(this._allowSpecialTokensInTitles, "\n\n")
+                    ])
+            ]);
+        }));
+        return {
+            contextText,
+            stopGenerationTriggers: [
+                LlamaText(new SpecialToken("EOS")),
+                LlamaText(new SpecialTokensText("<end>")),
+                LlamaText("<end>"),
+                LlamaText(`### ${this._userMessageTitle}`),
+                LlamaText(`\n### ${this._userMessageTitle}`),
+                LlamaText(`\n\n### ${this._userMessageTitle}`),
+                LlamaText(`### ${this._modelResponseTitle}`),
+                LlamaText(`\n### ${this._modelResponseTitle}`),
+                LlamaText(`\n\n### ${this._modelResponseTitle}`),
+                LlamaText(`### ${this._middleSystemMessageTitle}`),
+                LlamaText(`\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

@@ -0,0 +1 @@
+{"version":3,"file":"GeneralChatWrapper.js","sourceRoot":"","sources":["../../src/chatWrappers/GeneralChatWrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAqC,MAAM,mBAAmB,CAAC;AAElF,OAAO,EAAC,YAAY,EAAE,SAAS,EAAE,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAEjF;;;GAGG;AACH,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,KAAM,IAAqB,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;YACH,EAAE;YACF,EAAC,0BAA0B,EAAE,IAAI,EAAC;SACrC,CAAC;IACN,CAAC;CACJ"}

package/dist/chatWrappers/HarmonyChatWrapper.d.ts

@@ -0,0 +1,78 @@
+import { ChatWrapper } from "../ChatWrapper.js";
+import { ChatModelFunctions, ChatModelResponse, ChatWrapperGenerateContextStateOptions, ChatWrapperGeneratedContextState, ChatWrapperSettings } from "../types.js";
+import { LlamaText } from "../utils/LlamaText.js";
+export declare class HarmonyChatWrapper extends ChatWrapper {
+    readonly wrapperName: string;
+    readonly modelIdentity: string | null;
+    readonly cuttingKnowledgeDate?: Date | (() => Date) | null;
+    readonly todayDate: Date | (() => Date) | null;
+    readonly reasoningEffort: "high" | "medium" | "low" | null;
+    readonly requiredChannels: {
+        analysis: boolean;
+        commentary: boolean;
+        final: boolean;
+    };
+    readonly keepOnlyLastThought: boolean;
+    readonly settings: ChatWrapperSettings;
+    constructor(options?: {
+        /**
+         * The model identity to use in the internal system message.
+         *
+         * Set to `null` to disable.
+         *
+         * Defaults to `"You are ChatGPT, a large language model trained by OpenAI."`
+         */
+        modelIdentity?: string | null;
+        /**
+         * Set to `null` to disable
+         *
+         * Defaults to `new Date("2024-06-01T00:00:00Z")`
+         */
+        cuttingKnowledgeDate?: Date | (() => Date) | number | string | null;
+        /**
+         * Set to `null` to disable
+         *
+         * Defaults to the current date
+         */
+        todayDate?: Date | (() => Date) | number | string | null;
+        /**
+         * The amount of reasoning to instruct the model to use.
+         *
+         * Not enforced, it's up to the model to follow this instruction.
+         *
+         * Set to `null` to omit the instruction.
+         *
+         * Defaults to `"medium"`.
+         */
+        reasoningEffort?: "high" | "medium" | "low" | null;
+        requiredChannels?: {
+            /**
+             * Defaults to `true`
+             */
+            analysis?: boolean;
+            /**
+             * Defaults to `true`
+             */
+            commentary?: boolean;
+            /**
+             * Defaults to `true`
+             */
+            final?: boolean;
+        };
+        /**
+         * Whether to keep only the chain of thought from the last model response.
+         *
+         * Setting this to `false` will keep all the chain of thoughts from the model responses in the context state.
+         *
+         * Defaults to `true`.
+         */
+        keepOnlyLastThought?: boolean;
+    });
+    generateContextState({ chatHistory, availableFunctions, documentFunctionParams }: ChatWrapperGenerateContextStateOptions): ChatWrapperGeneratedContextState;
+    generateFunctionCall(name: string, params: any): LlamaText;
+    generateFunctionCallResult(functionName: string, functionParams: any, result: any): LlamaText;
+    generateModelResponseText(modelResponse: ChatModelResponse["response"], useRawValues?: boolean): LlamaText;
+    generateAvailableFunctionsSystemText(availableFunctions: ChatModelFunctions, { documentParams }: {
+        documentParams?: boolean;
+    }): import("../utils/LlamaText.js")._LlamaText;
+}