Skip to content

Class: MuseChatWrapper ​

Defined in: chatWrappers/MuseChatWrapper.ts:13

Extends ​

Constructors ​

Constructor ​

ts
new MuseChatWrapper(options?: {
  reasoningStrength?: "medium" | "high" | "low" | "xhigh";
  keepOnlyLastThought?: boolean;
  knowledgeCutoff?:   | string
     | Date
     | () => Date
     | null;
  todayDate?:   | string
     | number
     | Date
     | () => Date
     | null;
}): MuseChatWrapper;

Defined in: chatWrappers/MuseChatWrapper.ts:63

Parameters ​

ParameterTypeDescription
options{ reasoningStrength?: "medium" | "high" | "low" | "xhigh"; keepOnlyLastThought?: boolean; knowledgeCutoff?: | string | Date | () => Date | null; todayDate?: | string | number | Date | () => Date | null; }-
options.reasoningStrength?"medium" | "high" | "low" | "xhigh"The amount of reasoning to instruct the model to use. Defaults to "high".
options.keepOnlyLastThought?booleanWhether to keep only the chain of thought from the last model response. Defaults to false, matching the original chat template.
options.knowledgeCutoff?| string | Date | () => Date | nullThe knowledge cutoff used by the default system message. The default system message is applied only when you supply a chat history that don't have a system message at the beginning. Set to null to omit it. Defaults to "2026-01-04".
options.todayDate?| string | number | Date | () => Date | nullThe current date used by the default system message. The default system message is applied only when you supply a chat history that don't have a system message at the beginning. Set to null to omit it. Defaults to the current date.

Returns ​

MuseChatWrapper

Overrides ​

ChatWrapper.constructor

Properties ​

defaultSettings ​

ts
static defaultSettings: ChatWrapperSettings;

Defined in: ChatWrapper.ts:15

Inherited from ​

ChatWrapper.defaultSettings


wrapperName ​

ts
readonly wrapperName: string = "Muse";

Defined in: chatWrappers/MuseChatWrapper.ts:14

Overrides ​

ChatWrapper.wrapperName


reasoningStrength ​

ts
readonly reasoningStrength: "medium" | "high" | "low" | "xhigh";

Defined in: chatWrappers/MuseChatWrapper.ts:16


keepOnlyLastThought ​

ts
readonly keepOnlyLastThought: boolean;

Defined in: chatWrappers/MuseChatWrapper.ts:17


knowledgeCutoff ​

ts
readonly knowledgeCutoff: 
  | Date
  | () => Date
  | null;

Defined in: chatWrappers/MuseChatWrapper.ts:18


todayDate ​

ts
readonly todayDate: 
  | Date
  | () => Date
  | null;

Defined in: chatWrappers/MuseChatWrapper.ts:19


settings ​

ts
readonly settings: ChatWrapperSettings;

Defined in: chatWrappers/MuseChatWrapper.ts:23

Overrides ​

ChatWrapper.settings

Methods ​

generateFunctionCallsAndResults() ​

ts
generateFunctionCallsAndResults(functionCalls: ChatModelFunctionCall[], useRawCall?: boolean): LlamaText;

Defined in: ChatWrapper.ts:63

Parameters ​

ParameterTypeDefault value
functionCallsChatModelFunctionCall[]undefined
useRawCallbooleantrue

Returns ​

LlamaText

Inherited from ​

ChatWrapper.generateFunctionCallsAndResults


addAvailableFunctionsSystemMessageToHistory() ​

ts
addAvailableFunctionsSystemMessageToHistory(
   history: readonly ChatHistoryItem[], 
   availableFunctions?: ChatModelFunctions, 
   __namedParameters?: {
  documentParams?: boolean;
}): readonly ChatHistoryItem[];

Defined in: ChatWrapper.ts:269

Parameters ​

ParameterType
historyreadonly ChatHistoryItem[]
availableFunctions?ChatModelFunctions
__namedParameters?{ documentParams?: boolean; }
__namedParameters.documentParams?boolean

Returns ​

readonly ChatHistoryItem[]

Inherited from ​

ChatWrapper.addAvailableFunctionsSystemMessageToHistory


generateContextState() ​

Defined in: chatWrappers/MuseChatWrapper.ts:127

Parameters ​

ParameterType
__namedParametersChatWrapperGenerateContextStateOptions

Returns ​

ChatWrapperGeneratedContextState

Overrides ​

ChatWrapper.generateContextState


generateFunctionCall() ​

ts
generateFunctionCall(name: string, params: any): LlamaText;

Defined in: chatWrappers/MuseChatWrapper.ts:248

Parameters ​

ParameterType
namestring
paramsany

Returns ​

LlamaText

Overrides ​

ChatWrapper.generateFunctionCall


generateFunctionCallResult() ​

ts
generateFunctionCallResult(
   functionName: string, 
   functionParams: any, 
   result: any): LlamaText;

Defined in: chatWrappers/MuseChatWrapper.ts:266

Parameters ​

ParameterType
functionNamestring
functionParamsany
resultany

Returns ​

LlamaText

Overrides ​

ChatWrapper.generateFunctionCallResult


generateModelResponseText() ​

ts
generateModelResponseText(modelResponse: (
  | string
  | ChatModelFunctionCall
  | ChatModelSegment)[], useRawValues?: boolean): LlamaText;

Defined in: chatWrappers/MuseChatWrapper.ts:281

Parameters ​

ParameterTypeDefault value
modelResponse( | string | ChatModelFunctionCall | ChatModelSegment)[]undefined
useRawValuesbooleantrue

Returns ​

LlamaText

Overrides ​

ChatWrapper.generateModelResponseText


generateAvailableFunctionsSystemText() ​

ts
generateAvailableFunctionsSystemText(availableFunctions: ChatModelFunctions, __namedParameters: {
  documentParams?: boolean;
}): LlamaText;

Defined in: chatWrappers/MuseChatWrapper.ts:300

Parameters ​

ParameterType
availableFunctionsChatModelFunctions
__namedParameters{ documentParams?: boolean; }
__namedParameters.documentParams?boolean

Returns ​

LlamaText

Overrides ​

ChatWrapper.generateAvailableFunctionsSystemText


generateInitialChatHistory() ​

ts
generateInitialChatHistory(__namedParameters?: ChatWrapperGenerateInitialHistoryOptions): ChatHistoryItem[];

Defined in: chatWrappers/MuseChatWrapper.ts:373

Parameters ​

ParameterType
__namedParametersChatWrapperGenerateInitialHistoryOptions

Returns ​

ChatHistoryItem[]

Overrides ​

ChatWrapper.generateInitialChatHistory