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

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

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

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

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

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

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

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

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

package/dist/chatWrappers/utils/ChatModelFunctionsDocumentationGenerator.js

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

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

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

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

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

package/dist/chatWrappers/utils/isJinjaTemplateEquivalentToSpecializedChatWrapper.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"isJinjaTemplateEquivalentToSpecializedChatWrapper.js","sourceRoot":"","sources":["../../../src/chatWrappers/utils/isJinjaTemplateEquivalentToSpecializedChatWrapper.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,wBAAwB,EAAkC,MAAM,wCAAwC,CAAC;AACjH,OAAO,EAAC,YAAY,EAAE,SAAS,EAAC,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAC,aAAa,EAAC,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAC,sBAAsB,EAAC,MAAM,uCAAuC,CAAC;AAE7E,MAAM,UAAU,iDAAiD,CAC7D,2BAA4D,EAC5D,sBAAmC,EACnC,SAAqB;IAErB,MAAM,kDAAkD,GACpD,2BAA2B,CAAC,8CAA8C,IAAI,IAAI;QAClF,2BAA2B,CAAC,8CAA8C,KAAK,MAAM,CAAC;IAE1F,IAAI;QACA,MAAM,gBAAgB,GAAG,IAAI,wBAAwB,CAAC;YAClD,GAAG,2BAA2B;YAC9B,8CAA8C,EAAE,kDAAkD;gBAC9F,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,2BAA2B,CAAC,8CAA8C;YAChF,gCAAgC,EAAE,KAAK;SAC1C,CAAC,CAAC;QAEH,IAAI,gBAAgB,CAAC,gBAAgB,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,SAAS,CAAC;YACxF,OAAO,IAAI,CAAC;QAGhB,MAAM,6CAA6C,GAAG,IAAI,wBAAwB,CAAC;YAC/E,GAAG,2BAA2B;YAC9B,8CAA8C,EAAE,kDAAkD;gBAC9F,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,2BAA2B,CAAC,8CAA8C;YAChF,gCAAgC,EAAE,IAAI;SACzC,CAAC,CAAC;QAEH,IAAI,gBAAgB,CAAC,6CAA6C,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,SAAS,CAAC;YACrH,OAAO,IAAI,CAAC;KACnB;IAAC,OAAO,GAAG,EAAE;QACV,aAAa;KAChB;IAED,IAAI,CAAC,kDAAkD;QACnD,OAAO,KAAK,CAAC;IAEjB,IAAI;QACA,MAAM,2CAA2C,GAAG,2CAA2C,CAAC;QAChG,MAAM,gBAAgB,GAAG,IAAI,wBAAwB,CAAC;YAClD,GAAG,2BAA2B;YAC9B,8CAA8C,EAAE;gBAC5C,GAAG,EAAE,QAAQ;gBACb,MAAM,EAAE,2CAA2C;aACtD;YACD,gCAAgC,EAAE,KAAK;SAC1C,CAAC,CAAC;QAEH,MAAM,4BAA4B,GAAG,iBAAiB;aACjD,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CACd,OAAO;aACF,KAAK,EAAE;aACP,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YACxB,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;gBACxB,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE;oBAC7D,KAAK,CAAC,CAAC,CAAC,GAAG;wBACP,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,2CAA2C,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI;qBACrF,CAAC;oBAC5B,OAAO,IAAI,CAAC;iBACf;gBAED,OAAO;oBACH,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,2CAA2C,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC;iBAC5D,CAAC;aAC/B;YAED,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,IAAI,EAA+C,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC,CACnF,CAAC,CAAC;QAEP,IAAI,gBAAgB,CAAC,gBAAgB,EAAE,sBAAsB,EAAE,4BAA4B,EAAE,SAAS,CAAC;YACnG,OAAO,IAAI,CAAC;QAGhB,MAAM,6CAA6C,GAAG,IAAI,wBAAwB,CAAC;YAC/E,GAAG,2BAA2B;YAC9B,8CAA8C,EAAE;gBAC5C,GAAG,EAAE,QAAQ;gBACb,MAAM,EAAE,2CAA2C;aACtD;YACD,gCAAgC,EAAE,IAAI;SACzC,CAAC,CAAC;QAEH,IAAI,gBAAgB,CAChB,6CAA6C,EAAE,sBAAsB,EAAE,4BAA4B,EAAE,SAAS,CACjH;YACG,OAAO,IAAI,CAAC;KACnB;IAAC,OAAO,GAAG,EAAE;QACV,aAAa;KAChB;IAED,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,SAAS,gBAAgB,CACrB,gBAA0C,EAC1C,sBAAmC,EACnC,iBAAsC,EACtC,SAAqB;IAErB,KAAK,MAAM,eAAe,IAAI,iBAAiB,EAAE;QAC7C,MAAM,QAAQ,GAAG,gBAAgB,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;QACvE,MAAM,qBAAqB,GAAG,sBAAsB,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;QAE1F,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,WAAW,EAAE,qBAAqB,CAAC,WAAW,EAAE,SAAS,CAAC;YACxF,OAAO,KAAK,CAAC;QAEjB,MAAM,4CAA4C,GAAG,QAAQ,CAAC,sBAAsB;aAC/E,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE;YACf,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,SAAS,EAAE,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,sBAAsB,EAAE,EAAE;gBACpH,IAAI,sBAAsB,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;oBAC1C,OAAO,IAAI,CAAC;gBAEhB,MAAM,oBAAoB,GAAI,qBAAqB,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,kBAAkB,EAAE,EAAE,CAAC,CACpG,sBAAsB,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CACtD,CAAC,CAAC;gBAEH,IAAI,oBAAoB;oBACpB,OAAO,IAAI,CAAC;gBAEhB,IAAI,SAAS,IAAI,IAAI,EAAE;oBACnB,MAAM,6BAA6B,GAAG,sBAAsB,CAAC,uBAAuB,CAChF,sBAAsB,EACtB,SAAS,CACZ,CAAC;oBAEF,MAAM,sCAAsC,GAAG,qBAAqB,CAAC,sBAAsB;yBACtF,IAAI,CAAC,CAAC,kBAAkB,EAAE,EAAE;wBACzB,MAAM,0BAA0B,GAAG,sBAAsB,CAAC,uBAAuB,CAC7E,kBAAkB,EAClB,SAAS,CACZ,CAAC;wBAEF,OAAO,0BAA0B,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;4BACpD,MAAM,kBAAkB,GAAG,6BAA6B,CAAC,KAAK,CAAC,CAAC;4BAEhE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,kBAAkB,KAAK,QAAQ;gCAClE,OAAO,IAAI,KAAK,kBAAkB,CAAC;iCAClC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,kBAAkB,KAAK,QAAQ;gCACvE,OAAO,KAAK,CAAC;4BAEjB,OAAO,aAAa,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;wBACnD,CAAC,CAAC,CAAC;oBACP,CAAC,CAAC,CAAC;oBAEP,IAAI,sCAAsC;wBACtC,OAAO,IAAI,CAAC;iBACnB;gBAED,OAAO,KAAK,CAAC;YACjB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEP,IAAI,CAAC,4CAA4C;YAC7C,OAAO,KAAK,CAAC;KACpB;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAgB,EAAE,KAAgB,EAAE,SAAqB;IAClF,SAAS,OAAO,CAAC,KAAgB,EAAE,KAAgB;QAC/C,IAAI,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;YAC/B,OAAO,IAAI,CAAC;QAEhB,IAAI,SAAS,IAAI,IAAI,EAAE;YACnB,MAAM,cAAc,GAAG,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YACjD,MAAM,cAAc,GAAG,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YAEjD,IAAI,cAAc,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM;gBAC/C,OAAO,cAAc,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAClG;QAED,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;IACrC,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;IAErC,MAAM,eAAe,GAAG,gBAAgB,CAAC,YAAY,CAAC,CAAC;IACvD,MAAM,eAAe,GAAG,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAEvD,MAAM,MAAM,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM,CAAC,MAAM,IAAI,SAAS,IAAI,IAAI,CAAC;QAC9F,CAAC,CAAC,CAAC,YAAY,EAAE,eAAe,CAAC;QACjC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;IAExB,MAAM,MAAM,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM,CAAC,MAAM,IAAI,SAAS,IAAI,IAAI,CAAC;QAC9F,CAAC,CAAC,CAAC,YAAY,EAAE,eAAe,CAAC;QACjC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;IAExB,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAC1B,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CACnB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CACxB,CAAC,CACL,CAAC,CAAC;AACP,CAAC;AAED,MAAM,iBAAiB,GAAwB;IAC3C,CAAC;YACG,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,+BAA+B;SACxC,EAAE;YACC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,sDAAsD;SAC/D,EAAE;YACC,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC,EAAE,CAAC;SACjB,CAAC;IAEF,CAAC;YACG,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,+BAA+B;SACxC,EAAE;YACC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,sDAAsD;SAC/D,EAAE;YACC,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC,qDAAqD,CAAC;SACpE,CAAC;IAEF,CAAC;YACG,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,+BAA+B;SACxC,EAAE;YACC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,sDAAsD;SAC/D,EAAE;YACC,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC,qDAAqD,CAAC;SACpE,EAAE;YACC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,uDAAuD;SAChE,EAAE;YACC,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC,EAAE,CAAC;SACjB,CAAC;IAEF,CAAC;YACG,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,+BAA+B;SACxC,EAAE;YACC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,sDAAsD;SAC/D,EAAE;YACC,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC,qDAAqD,CAAC;SACpE,EAAE;YACC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,uDAAuD;SAChE,EAAE;YACC,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC,sDAAsD,CAAC;SACrE,CAAC;CACL,CAAC;AAEF,SAAS,gBAAgB,CAAC,SAAoB;IAC1C,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;QAC7B,OAAO,SAAS,CAAC;IAErB,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAEvC,IAAI,UAAU,YAAY,YAAY,IAAI,UAAU,CAAC,KAAK,KAAK,KAAK;QAChE,OAAO,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhD,OAAO,SAAS,CAAC;AACrB,CAAC"}

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

@@ -0,0 +1,69 @@
+import { Llama3ChatWrapper } from "../Llama3ChatWrapper.js";
+import { Llama2ChatWrapper } from "../Llama2ChatWrapper.js";
+import { ChatMLChatWrapper } from "../ChatMLChatWrapper.js";
+import { GeneralChatWrapper } from "../GeneralChatWrapper.js";
+import { FalconChatWrapper } from "../FalconChatWrapper.js";
+import { FunctionaryChatWrapper } from "../FunctionaryChatWrapper.js";
+import { AlpacaChatWrapper } from "../AlpacaChatWrapper.js";
+import { GemmaChatWrapper } from "../GemmaChatWrapper.js";
+import { JinjaTemplateChatWrapper } from "../generic/JinjaTemplateChatWrapper.js";
+import { TemplateChatWrapper } from "../generic/TemplateChatWrapper.js";
+import { Tokenizer } from "../../types.js";
+import type { GgufFileInfo } from "../../gguf/types/GgufFileInfoTypes.js";
+export declare const specializedChatWrapperTypeNames: readonly ["general", "llama3Chat", "llama2Chat", "alpacaChat", "functionary", "chatML", "falconChat", "gemma"];
+export type SpecializedChatWrapperTypeName = (typeof specializedChatWrapperTypeNames)[number];
+export declare const templateChatWrapperTypeNames: readonly ["template", "jinjaTemplate"];
+export type TemplateChatWrapperTypeName = (typeof templateChatWrapperTypeNames)[number];
+export declare const resolvableChatWrapperTypeNames: readonly ["auto", "general", "llama3Chat", "llama2Chat", "alpacaChat", "functionary", "chatML", "falconChat", "gemma", "template", "jinjaTemplate"];
+export type ResolvableChatWrapperTypeName = (typeof resolvableChatWrapperTypeNames)[number];
+declare const chatWrappers: {
+    readonly general: typeof GeneralChatWrapper;
+    readonly llama3Chat: typeof Llama3ChatWrapper;
+    readonly llama2Chat: typeof Llama2ChatWrapper;
+    readonly alpacaChat: typeof AlpacaChatWrapper;
+    readonly functionary: typeof FunctionaryChatWrapper;
+    readonly chatML: typeof ChatMLChatWrapper;
+    readonly falconChat: typeof FalconChatWrapper;
+    readonly gemma: typeof GemmaChatWrapper;
+    readonly template: typeof TemplateChatWrapper;
+    readonly jinjaTemplate: typeof JinjaTemplateChatWrapper;
+};
+export type ResolveChatWrapperOptions = {
+    /**
+     * Resolve to a specific chat wrapper type.
+     * You better not set this option unless you need to force a specific chat wrapper type.
+     *
+     * Defaults to `"auto"`.
+     */
+    type?: "auto" | SpecializedChatWrapperTypeName | TemplateChatWrapperTypeName;
+    bosString?: string | null;
+    filename?: string;
+    fileInfo?: GgufFileInfo;
+    tokenizer?: Tokenizer;
+    customWrapperSettings?: {
+        [wrapper in keyof typeof chatWrappers]?: ConstructorParameters<(typeof chatWrappers)[wrapper]>[0];
+    };
+    warningLogs?: boolean;
+    fallbackToOtherWrappersOnJinjaError?: boolean;
+    /**
+     * Don't resolve to a Jinja chat wrapper unless `type` is set to a Jinja chat wrapper type.
+     */
+    noJinja?: boolean;
+};
+/**
+ * Resolve to a chat wrapper instance based on the provided information.
+ * The more information provided, the better the resolution will be (except for `type`).
+ *
+ * It's recommended to not set `type` to a specific chat wrapper in order for the resolution to be more flexible, but it is useful for when
+ * you need to provide the ability to force a specific chat wrapper type.
+ * Note that when setting `type` to a generic chat wrapper type (such as `"template"` or `"jinjaTemplate"`), the `customWrapperSettings`
+ * must contain the necessary settings for that chat wrapper to be created.
+ *
+ * When loading a Jinja chat template from either `fileInfo` or `customWrapperSettings.jinjaTemplate.template`,
+ * if the chat template format is invalid, it fallbacks to resolve other chat wrappers,
+ * unless `fallbackToOtherWrappersOnJinjaError` is set to `false` (in which case, it will throw an error).
+ */
+export declare function resolveChatWrapper({ type, bosString, filename, fileInfo, tokenizer, customWrapperSettings, warningLogs, fallbackToOtherWrappersOnJinjaError, noJinja }: ResolveChatWrapperOptions): any;
+export declare function isSpecializedChatWrapperType(type: string): type is SpecializedChatWrapperTypeName;
+export declare function isTemplateChatWrapperType(type: string): type is TemplateChatWrapperTypeName;
+export {};