Class: FunctionaryChatWrapper

Extends

• ChatWrapper

Constructors

new FunctionaryChatWrapper()

new FunctionaryChatWrapper(__namedParameters: {
  variation: "v3";
 }): FunctionaryChatWrapper

Parameters

Parameter	Type
__namedParameters	object
__namedParameters.variation?	"v3" | "v2.llama3" | "v2"

Returns

FunctionaryChatWrapper

Overrides

ChatWrapper.constructor

Defined in

chatWrappers/FunctionaryChatWrapper.ts:17

Properties

defaultSettings

static defaultSettings: ChatWrapperSettings;

Inherited from

ChatWrapper.defaultSettings

Defined in

ChatWrapper.ts:11

---

wrapperName

readonly wrapperName: string = "Functionary";

Overrides

ChatWrapper.wrapperName

Defined in

chatWrappers/FunctionaryChatWrapper.ts:12

---

variation

readonly variation: "v3" | "v2.llama3" | "v2";

Defined in

chatWrappers/FunctionaryChatWrapper.ts:13

---

settings

readonly settings: ChatWrapperSettings;

Overrides

ChatWrapper.settings

Defined in

chatWrappers/FunctionaryChatWrapper.ts:15

Methods

generateFunctionCallsAndResults()

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

Parameters

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

Returns

LlamaText

Inherited from

ChatWrapper.generateFunctionCallsAndResults

Defined in

ChatWrapper.ts:55

---

generateFunctionCall()

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

Parameters

Parameter	Type
name	string
params	any

Returns

LlamaText

Inherited from

ChatWrapper.generateFunctionCall

Defined in

ChatWrapper.ts:102

---

generateFunctionCallResult()

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

Parameters

Parameter	Type
functionName	string
functionParams	any
result	any

Returns

LlamaText

Inherited from

ChatWrapper.generateFunctionCallResult

Defined in

ChatWrapper.ts:116

---

generateModelResponseText()

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

Parameters

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

Returns

LlamaText

Inherited from

ChatWrapper.generateModelResponseText

Defined in

ChatWrapper.ts:140

---

generateInitialChatHistory()

generateInitialChatHistory(__namedParameters: ChatWrapperGenerateInitialHistoryOptions): ChatHistoryItem[]

Parameters

Parameter	Type
__namedParameters	ChatWrapperGenerateInitialHistoryOptions

Returns

ChatHistoryItem[]

Inherited from

ChatWrapper.generateInitialChatHistory

Defined in

ChatWrapper.ts:217

---

generateContextState()

generateContextState(__namedParameters: ChatWrapperGenerateContextStateOptions): ChatWrapperGeneratedContextState

Parameters

Parameter	Type
__namedParameters	ChatWrapperGenerateContextStateOptions

Returns

ChatWrapperGeneratedContextState

Overrides

ChatWrapper.generateContextState

Defined in

chatWrappers/FunctionaryChatWrapper.ts:121

---

generateAvailableFunctionsSystemText()

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

Parameters

Parameter	Type
availableFunctions	ChatModelFunctions
__namedParameters	object
__namedParameters.documentParams?	boolean

Returns

LlamaText

Overrides

ChatWrapper.generateAvailableFunctionsSystemText

Defined in

chatWrappers/FunctionaryChatWrapper.ts:647

---

addAvailableFunctionsSystemMessageToHistory()

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

Parameters

Parameter	Type
history	readonly ChatHistoryItem[]
availableFunctions?	ChatModelFunctions
__namedParameters?	object
__namedParameters.documentParams?	boolean

Returns

readonly ChatHistoryItem[]

Overrides

ChatWrapper.addAvailableFunctionsSystemMessageToHistory

Defined in

chatWrappers/FunctionaryChatWrapper.ts:689