feat: pass a model to resolveChatWrapper

Author: giladgd

docs/guide/chat-wrapper.md

@@ -254,3 +254,38 @@ console.log("User: " + q2);
 const a2 = await session.prompt(q2);
 console.log("AI: " + a2);
 ```
+
+## Default Chat Wrapper Options
+You can use the [`resolveChatWrapper(...)`](../api/functions/resolveChatWrapper.md) function to resolve the best chat wrapper for a given model,
+and configure the default options for each of the builtin chat wrappers it may resolve to. 
+
+```typescript
+import {fileURLToPath} from "url";
+import path from "path";
+import {getLlama, LlamaChatSession, resolveChatWrapper} from "node-llama-cpp";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+const llama = await getLlama();
+const model = await llama.loadModel({
+    modelPath: path.join(__dirname, "models", "Meta-Llama-3-8B-Instruct.Q4_K_M.gguf")
+});
+const context = await model.createContext();
+const session = new LlamaChatSession({
+    contextSequence: context.getSequence(),
+    chatWrapper: resolveChatWrapper(model, {// [!code highlight]
+        customWrapperSettings: {// [!code highlight]
+            "llama3.1": {// [!code highlight]
+                cuttingKnowledgeDate: new Date("2025-01-01T00:00:00Z")// [!code highlight]
+            }// [!code highlight]
+        }// [!code highlight]
+    })// [!code highlight]
+});
+
+
+const q1 = "Hi there, how are you?";
+console.log("User: " + q1);
+
+const a1 = await session.prompt(q1);
+console.log("AI: " + a1);
+```

src/chatWrappers/utils/resolveChatWrapper.ts

@@ -100,6 +100,37 @@ export type ResolveChatWrapperOptions = {
     noJinja?: boolean
 };
 
+export type ResolveChatWrapperWithModelOptions = {
+    /**
+     * 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,
+
+    customWrapperSettings?: {
+        [wrapper in keyof typeof chatWrappers]?: ConstructorParameters<(typeof chatWrappers)[wrapper]>[0]
+    },
+
+    /**
+     * Defaults to `true`.
+     */
+    warningLogs?: boolean,
+
+    /**
+     * Defaults to `true`.
+     */
+    fallbackToOtherWrappersOnJinjaError?: boolean,
+
+    /**
+     * Don't resolve to a Jinja chat wrapper unless `type` is set to a Jinja chat wrapper type.
+     *
+     * Defaults to `false`.
+     */
+    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`).
@@ -113,6 +144,21 @@ export type ResolveChatWrapperOptions = {
  * 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).
  * @example
+ * ```typescript
+ * import {getLlama, resolveChatWrapper, GeneralChatWrapper} from "node-llama-cpp";
+ *
+ * const llama = await getLlama();
+ * const model = await llama.loadModel({modelPath: "path/to/model.gguf"});
+ *
+ * const chatWrapper = resolveChatWrapper(model, {
+ *     customWrapperSettings: {
+ *         "llama3.1": {
+ *             cuttingKnowledgeDate: new Date("2025-01-01T00:00:00Z")
+ *         }
+ *     }
+ * }) ?? new GeneralChatWrapper()
+ * ```
+ * @example
  *```typescript
  * import {getLlama, resolveChatWrapper, GeneralChatWrapper} from "node-llama-cpp";
  *
@@ -127,11 +173,15 @@ export type ResolveChatWrapperOptions = {
  * }) ?? new GeneralChatWrapper()
  * ```
  */
+export function resolveChatWrapper(model: LlamaModel, options?: ResolveChatWrapperWithModelOptions): BuiltInChatWrapperType;
 export function resolveChatWrapper(options: ResolveChatWrapperOptions): BuiltInChatWrapperType | null;
-export function resolveChatWrapper(options: LlamaModel): BuiltInChatWrapperType;
-export function resolveChatWrapper(options: ResolveChatWrapperOptions | LlamaModel): BuiltInChatWrapperType | null {
+export function resolveChatWrapper(
+    options: ResolveChatWrapperOptions | LlamaModel,
+    modelOptions?: ResolveChatWrapperWithModelOptions
+): BuiltInChatWrapperType | null {
     if (options instanceof LlamaModel)
         return resolveChatWrapper({
+            ...(modelOptions ?? {}),
             bosString: options.tokens.bosString,
             filename: options.filename,
             fileInfo: options.fileInfo,

src/index.ts

@@ -66,7 +66,7 @@ import {ChatHistoryFunctionCallMessageTemplate} from "./chatWrappers/generic/uti
 import {
     resolvableChatWrapperTypeNames, type ResolvableChatWrapperTypeName, specializedChatWrapperTypeNames,
     type SpecializedChatWrapperTypeName, templateChatWrapperTypeNames, type TemplateChatWrapperTypeName, resolveChatWrapper,
-    type ResolveChatWrapperOptions, type BuiltInChatWrapperType, chatWrappers
+    type ResolveChatWrapperOptions, type ResolveChatWrapperWithModelOptions, type BuiltInChatWrapperType, chatWrappers
 } from "./chatWrappers/utils/resolveChatWrapper.js";
 import {ChatModelFunctionsDocumentationGenerator} from "./chatWrappers/utils/ChatModelFunctionsDocumentationGenerator.js";
 import {
@@ -90,8 +90,8 @@ import {jsonDumps} from "./chatWrappers/utils/jsonDumps.js";
 import {experimentalChunkDocument} from "./evaluator/utils/chunkDocument.js";
 
 import {
-    type ChatHistoryItem, type ChatModelFunctionCall, type ChatModelSegmentType, type ChatModelFunctions, type ChatModelResponse,
-    type ChatSessionModelFunction, type ChatSessionModelFunctions, type ChatSystemMessage, type ChatUserMessage,
+    type ChatHistoryItem, type ChatModelFunctionCall, type ChatModelSegmentType, type ChatModelSegment, type ChatModelFunctions,
+    type ChatModelResponse, type ChatSessionModelFunction, type ChatSessionModelFunctions, type ChatSystemMessage, type ChatUserMessage,
     type Token, type Tokenizer, type Detokenizer, isChatModelResponseFunctionCall, isChatModelResponseSegment,
     type LLamaContextualRepeatPenalty, type ChatWrapperSettings, type ChatWrapperSettingsSegment,
     type ChatWrapperGenerateContextStateOptions, type ChatWrapperGeneratedContextState, type ChatWrapperGenerateInitialHistoryOptions
@@ -222,6 +222,7 @@ export {
     resolveChatWrapper,
     type BuiltInChatWrapperType,
     type ResolveChatWrapperOptions,
+    type ResolveChatWrapperWithModelOptions,
     resolvableChatWrapperTypeNames,
     type ResolvableChatWrapperTypeName,
     specializedChatWrapperTypeNames,
@@ -250,6 +251,7 @@ export {
     type ChatHistoryItem,
     type ChatModelFunctionCall,
     type ChatModelSegmentType,
+    type ChatModelSegment,
     type ChatModelFunctions,
     type ChatModelResponse,
     type ChatSessionModelFunction,