Class: GeneralChatWrapper

Defined in: chatWrappers/GeneralChatWrapper.ts:9

This chat wrapper is not safe against chat syntax injection attacks (learn more).

Extends

• ChatWrapper

Extended by

• AlpacaChatWrapper

Constructors

Constructor

new GeneralChatWrapper(__namedParameters?: {
  userMessageTitle?: string;
  modelResponseTitle?: string;
  middleSystemMessageTitle?: string;
  allowSpecialTokensInTitles?: boolean;
}): GeneralChatWrapper;

Defined in: chatWrappers/GeneralChatWrapper.ts:17

Parameters

Parameter	Type
__namedParameters	{ userMessageTitle?: string; modelResponseTitle?: string; middleSystemMessageTitle?: string; allowSpecialTokensInTitles?: boolean; }
__namedParameters.userMessageTitle?	string
__namedParameters.modelResponseTitle?	string
__namedParameters.middleSystemMessageTitle?	string
__namedParameters.allowSpecialTokensInTitles?	boolean

Returns

GeneralChatWrapper

Overrides

ChatWrapper.constructor

Properties

defaultSettings

static defaultSettings: ChatWrapperSettings;

Defined in: ChatWrapper.ts:15

Inherited from

ChatWrapper.defaultSettings

---

settings

readonly settings: ChatWrapperSettings = ChatWrapper.defaultSettings;

Defined in: ChatWrapper.ts:36

Inherited from

ChatWrapper.settings

---

wrapperName

readonly wrapperName: string = "General";

Defined in: chatWrappers/GeneralChatWrapper.ts:10

Overrides

ChatWrapper.wrapperName

Accessors

userMessageTitle

Get Signature

get userMessageTitle(): string;

Defined in: chatWrappers/GeneralChatWrapper.ts:31

Returns

string

---

modelResponseTitle

Get Signature

get modelResponseTitle(): string;

Defined in: chatWrappers/GeneralChatWrapper.ts:35

Returns

string

---

middleSystemMessageTitle

Get Signature

get middleSystemMessageTitle(): string;

Defined in: chatWrappers/GeneralChatWrapper.ts:39

Returns

string

Methods

generateFunctionCallsAndResults()

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

Defined in: ChatWrapper.ts:63

Parameters

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

Returns

LlamaText

Inherited from

ChatWrapper.generateFunctionCallsAndResults

---

generateFunctionCall()

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

Defined in: ChatWrapper.ts:110

Parameters

Parameter	Type
name	string
params	any

Returns

LlamaText

Inherited from

ChatWrapper.generateFunctionCall

---

generateFunctionCallResult()

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

Defined in: ChatWrapper.ts:127

Parameters

Parameter	Type
functionName	string
functionParams	any
result	any

Returns

LlamaText

Inherited from

ChatWrapper.generateFunctionCallResult

---

generateModelResponseText()

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

Defined in: ChatWrapper.ts:158

Parameters

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

Returns

LlamaText

Inherited from

ChatWrapper.generateModelResponseText

---

generateAvailableFunctionsSystemText()

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

Defined in: ChatWrapper.ts:243

Parameters

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

Returns

LlamaText

Inherited from

ChatWrapper.generateAvailableFunctionsSystemText

---

addAvailableFunctionsSystemMessageToHistory()

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

Defined in: ChatWrapper.ts:269

Parameters

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

Returns

readonly ChatHistoryItem[]

Inherited from

ChatWrapper.addAvailableFunctionsSystemMessageToHistory

---

generateInitialChatHistory()

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

Defined in: ChatWrapper.ts:290

Parameters

Parameter	Type
__namedParameters	ChatWrapperGenerateInitialHistoryOptions

Returns

ChatHistoryItem[]

Inherited from

ChatWrapper.generateInitialChatHistory

---

generateContextState()

generateContextState(__namedParameters: ChatWrapperGenerateContextStateOptions): ChatWrapperGeneratedContextState;

Defined in: chatWrappers/GeneralChatWrapper.ts:43

Parameters

Parameter	Type
__namedParameters	ChatWrapperGenerateContextStateOptions

Returns

ChatWrapperGeneratedContextState

Overrides

ChatWrapper.generateContextState