ContextChatEngine
Defined in: packages/core/src/chat-engine/context-chat-engine.ts:38
ContextChatEngine uses the Index to get the appropriate context for each query. The context is stored in the system prompt, and the chat history is chunk, allowing the appropriate context to be surfaced for each query.
Extends
Implements
Constructors
Constructor
new ContextChatEngine(
init):ContextChatEngine
Defined in: packages/core/src/chat-engine/context-chat-engine.ts:48
Parameters
init
Returns
ContextChatEngine
Overrides
Properties
chatModel
chatModel:
LLM
Defined in: packages/core/src/chat-engine/context-chat-engine.ts:39
memory
memory:
BaseMemory
Defined in: packages/core/src/chat-engine/context-chat-engine.ts:40
contextGenerator
contextGenerator:
ContextGenerator&PromptMixin
Defined in: packages/core/src/chat-engine/context-chat-engine.ts:41
systemPrompt?
optionalsystemPrompt:string
Defined in: packages/core/src/chat-engine/context-chat-engine.ts:42
Accessors
chatHistory
Get Signature
get chatHistory():
ChatMessage<object>[] |Promise<ChatMessage<object>[]>
Defined in: packages/core/src/chat-engine/context-chat-engine.ts:44
Returns
ChatMessage<object>[] | Promise<ChatMessage<object>[]>
Implementation of
Methods
_getPrompts()
protected_getPrompts():PromptsRecord
Defined in: packages/core/src/chat-engine/context-chat-engine.ts:62
Returns
Overrides
_updatePrompts()
protected_updatePrompts(prompts):void
Defined in: packages/core/src/chat-engine/context-chat-engine.ts:68
Parameters
prompts
contextSystemPrompt
Returns
void
Overrides
_getPromptModules()
protected_getPromptModules():ModuleRecord
Defined in: packages/core/src/chat-engine/context-chat-engine.ts:74
Return a dictionary of sub-modules within the current module that also implement PromptMixin (so that their prompts can also be get/set).
Can be blank if no sub-modules.
Returns
Overrides
chat()
Call Signature
chat(
params):Promise<EngineResponse>
Defined in: packages/core/src/chat-engine/context-chat-engine.ts:80
Parameters
params
Returns
Promise<EngineResponse>
Implementation of
Call Signature
chat(
params):Promise<AsyncIterable<EngineResponse,any,any>>
Defined in: packages/core/src/chat-engine/context-chat-engine.ts:81
Parameters
params
Returns
Promise<AsyncIterable<EngineResponse, any, any>>
Implementation of
reset()
reset():
void
Defined in: packages/core/src/chat-engine/context-chat-engine.ts:127
Returns
void
validatePrompts()
validatePrompts(
promptsDict,moduleDict):void
Defined in: packages/core/src/prompts/mixin.ts:8
Parameters
promptsDict
moduleDict
Returns
void
Inherited from
getPrompts()
getPrompts():
PromptsRecord
Defined in: packages/core/src/prompts/mixin.ts:22
Returns
Inherited from
updatePrompts()
updatePrompts(
prompts):void
Defined in: packages/core/src/prompts/mixin.ts:39
Parameters
prompts
Returns
void