Class: abstract ChatWrapper

Defined in: ChatWrapper.ts:10

Extended by

• EmptyChatWrapper
• Llama3_2LightweightChatWrapper
• Llama3_1ChatWrapper
• Llama3ChatWrapper
• Llama2ChatWrapper
• MistralChatWrapper
• GeneralChatWrapper
• ChatMLChatWrapper
• FalconChatWrapper
• FunctionaryChatWrapper
• GemmaChatWrapper
• TemplateChatWrapper
• JinjaTemplateChatWrapper

Constructors

new ChatWrapper()

new ChatWrapper(): ChatWrapper

Returns

ChatWrapper

Properties

defaultSettings

static defaultSettings: ChatWrapperSettings;

Defined in: ChatWrapper.ts:11

---

wrapperName

abstract readonly wrapperName: string;

Defined in: ChatWrapper.ts:27

---

settings

readonly settings: ChatWrapperSettings = ChatWrapper.defaultSettings;

Defined in: ChatWrapper.ts:28

Methods

generateContextState()

generateContextState(__namedParameters: ChatWrapperGenerateContextStateOptions): ChatWrapperGeneratedContextState

Defined in: ChatWrapper.ts:30

Parameters

Parameter	Type
__namedParameters	ChatWrapperGenerateContextStateOptions

Returns

ChatWrapperGeneratedContextState

---

generateFunctionCallsAndResults()

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

Defined in: ChatWrapper.ts:55

Parameters

Parameter	Type	Default value
functionCalls	ChatModelFunctionCall[]	undefined
useRawCall	boolean	true

Returns

LlamaText

---

generateFunctionCall()

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

Defined in: ChatWrapper.ts:102

Parameters

Parameter	Type
name	string
params	any

Returns

LlamaText

---

generateFunctionCallResult()

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

Defined in: ChatWrapper.ts:116

Parameters

Parameter	Type
functionName	string
functionParams	any
result	any

Returns

LlamaText

---

generateModelResponseText()

generateModelResponseText(modelResponse: (
  | string
  | ChatModelFunctionCall)[], useRawCall: boolean): LlamaText

Defined in: ChatWrapper.ts:140

Parameters

Parameter	Type	Default value
modelResponse	( | string | ChatModelFunctionCall)[]	undefined
useRawCall	boolean	true

Returns

LlamaText

---

generateAvailableFunctionsSystemText()

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

Defined in: ChatWrapper.ts:170

Parameters

Parameter	Type
availableFunctions	ChatModelFunctions
__namedParameters	{ documentParams: boolean; }
__namedParameters.documentParams?	boolean

Returns

LlamaText

---

addAvailableFunctionsSystemMessageToHistory()

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

Defined in: ChatWrapper.ts:196

Parameters

Parameter	Type
history	readonly ChatHistoryItem[]
availableFunctions?	ChatModelFunctions
__namedParameters?	{ documentParams: boolean; }
__namedParameters.documentParams?	boolean

Returns

readonly ChatHistoryItem[]

---

generateInitialChatHistory()

generateInitialChatHistory(__namedParameters: ChatWrapperGenerateInitialHistoryOptions): ChatHistoryItem[]

Defined in: ChatWrapper.ts:217

Parameters

Parameter	Type
__namedParameters	ChatWrapperGenerateInitialHistoryOptions

Returns

ChatHistoryItem[]