node-llama-cpp 3.5.0 → 3.7.0

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

@@ -1,6 +1,8 @@
-import { ChatWrapperGenerateContextStateOptions, ChatWrapperGeneratedContextState, ChatWrapperSettings } from "../../types.js";
+import { ChatHistoryItem, ChatModelFunctions, ChatWrapperGenerateContextStateOptions, ChatWrapperGeneratedContextState, ChatWrapperSettings, Tokenizer } from "../../types.js";
+import { LlamaText } from "../../utils/LlamaText.js";
 import { ChatWrapper } from "../../ChatWrapper.js";
 import { ChatHistoryFunctionCallMessageTemplate } from "./utils/chatHistoryFunctionCallMessageTemplate.js";
+import { TemplateChatWrapperSegmentsOptions } from "./utils/templateSegmentOptionsToChatWrapperSettings.js";
 export type JinjaTemplateChatWrapperOptions = {
     template: string;
     /**
@@ -31,7 +33,18 @@ export type JinjaTemplateChatWrapperOptions = {
      * Defaults to `"auto"`.
      */
     convertUnsupportedSystemMessagesToUserMessages?: "auto" | boolean | JinjaTemplateChatWrapperOptionsConvertMessageFormat;
-    functionCallMessageTemplate?: ChatHistoryFunctionCallMessageTemplate;
+    /**
+     * Template format for how functions can be called by the model and how their results are fed to the model after function calls.
+     *
+     * - **`"auto"`**: Extract the function call message template from the Jinja template.
+     *   Fallback to the default template if not found.
+     * - **`"noJinja"`**: Use the default template.
+     * - **Custom template**: Use the specified {@link ChatHistoryFunctionCallMessageTemplate template}.
+     *   See {@link ChatHistoryFunctionCallMessageTemplate `ChatHistoryFunctionCallMessageTemplate`} for more details.
+     *
+     * Defaults to `"auto"`.
+     */
+    functionCallMessageTemplate?: "auto" | "noJinja" | ChatHistoryFunctionCallMessageTemplate;
     /**
      * Whether to join adjacent messages of the same type.
      * Some Jinja templates may throw an error if this is not set to `true`.
@@ -49,6 +62,16 @@ export type JinjaTemplateChatWrapperOptions = {
      * Additional parameters to use for rendering the Jinja template.
      */
     additionalRenderParameters?: Record<string, any>;
+    /**
+     * Format of the segments generated by the model (like thought segments)
+     */
+    segments?: TemplateChatWrapperSegmentsOptions;
+    /**
+     * Pass a model's tokenizer to attempt to detect common tokens used for chat formatting from it.
+     *
+     * Currently only used for detecting support for `<think>` tags for thought segments.
+     */
+    tokenizer?: Tokenizer;
 };
 export type JinjaTemplateChatWrapperOptionsConvertMessageFormat = {
     use?: "always" | "ifNeeded";
@@ -73,6 +96,10 @@ export type JinjaTemplateChatWrapperOptionsConvertMessageFormat = {
  *     // functionCallMessageTemplate: { // optional
  *     //     call: "[[call: {{functionName}}({{functionParams}})]]",
  *     //     result: " [[result: {{functionCallResult}}]]"
+ *     // },
+ *     // segments: {
+ *     //     thoughtTemplate: "<think>{{content}}</think>",
+ *     //     reopenThoughtAfterFunctionCalls: true
  *     // }
  * });
  * ```
@@ -93,8 +120,19 @@ export declare class JinjaTemplateChatWrapper extends ChatWrapper {
     /**
      * @param options
      */
-    constructor({ template, modelRoleName, userRoleName, systemRoleName, convertUnsupportedSystemMessagesToUserMessages, functionCallMessageTemplate, joinAdjacentMessagesOfTheSameType, trimLeadingWhitespaceInResponses, additionalRenderParameters }: JinjaTemplateChatWrapperOptions);
+    constructor(options: JinjaTemplateChatWrapperOptions);
+    /**
+     * Whether the function call syntax settings were extracted from the given Jinja template.
+     *
+     * The function call syntax settings can be accessed using the `.settings.functions` property.
+     */
+    get usingJinjaFunctionCallTemplate(): boolean;
     generateContextState({ chatHistory, availableFunctions, documentFunctionParams }: ChatWrapperGenerateContextStateOptions): ChatWrapperGeneratedContextState & {
         transformedSystemMessagesToUserMessages: boolean;
     };
+    addAvailableFunctionsSystemMessageToHistory(history: readonly ChatHistoryItem[], availableFunctions?: ChatModelFunctions, options?: {
+        documentParams?: boolean;
+    }): readonly ChatHistoryItem[];
+    generateFunctionCall(name: string, params: any): LlamaText;
+    generateFunctionCallResult(functionName: string, functionParams: any, result: any): LlamaText;
 }