Skip to main content

Class: abstract BaseEngine

Constructors

new BaseEngine()

new BaseEngine(): BaseEngine

Returns

BaseEngine

Properties

PropertyModifierType
_hooksprotectedRecord<"chat", Hook[]>

Methods

callHooks()

callHooks(
event,
context,
iteration): Promise<ChatMessage[]>

Parameters

ParameterType
event"chat"
contextHookContext
iterationnumber

Returns

Promise<ChatMessage[]>


chat()

abstract chat(messages, options): Promise<ChatResult>

Parameters

ParameterType
messagesChatMessage[]
optionsChatOptions

Returns

Promise<ChatResult>


generateImage()

abstract generateImage(options): Promise<GenerateImageResult>

Parameters

ParameterType
optionsGenerateImageOptions

Returns

Promise<GenerateImageResult>


getFunctionHandlers()

abstract getFunctionHandlers(): Record<string, Command>

Returns

Record<string, Command>


getInfo()

abstract getInfo(): Record<string, unknown>

Returns

Record<string, unknown>


init()

init(): Promise<void>

Perform any initialization required by the engine here.

Returns

Promise<void>


off()

off(event, hook): void

Parameters

ParameterType
event"chat"
hookHook

Returns

void


on()

on(event, hook): void

Parameters

ParameterType
event"chat"
hookHook

Returns

void