Class: CondenseQuestionChatEngine
CondenseQuestionChatEngine is used in conjunction with a Index (for example VectorStoreIndex). It does two steps on taking a user's chat message: first, it condenses the chat message with the previous chat history into a question with more context. Then, it queries the underlying Index using the new question with context and returns the response. CondenseQuestionChatEngine performs well when the input is primarily questions about the underlying data. It performs less well when the chat messages are not questions about the data, or are very referential to previous context.
Implements
Constructors
constructor
• new CondenseQuestionChatEngine(init)
Parameters
| Name | Type |
|---|---|
init | Object |
init.chatHistory | ChatMessage[] |
init.condenseMessagePrompt? | (__namedParameters: Object) => string |
init.queryEngine | BaseQueryEngine |
init.serviceContext? | ServiceContext |
Defined in
packages/core/src/ChatEngine.ts:122
Properties
chatHistory
• chatHistory: ChatMessage[]
Defined in
packages/core/src/ChatEngine.ts:118
condenseMessagePrompt
• condenseMessagePrompt: (__namedParameters: Object) => string
Type declaration
▸ («destructured»): string
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
Returns
string
Defined in
packages/core/src/ChatEngine.ts:120
queryEngine
• queryEngine: BaseQueryEngine
Defined in
packages/core/src/ChatEngine.ts:117
serviceContext
• serviceContext: ServiceContext
Defined in
packages/core/src/ChatEngine.ts:119
Methods
chat
▸ chat<T, R>(message, chatHistory?, streaming?): Promise<R>
Send message along with the class's current chat history to the LLM.
Type parameters
| Name | Type |
|---|---|
T | extends undefined | boolean = undefined |
R | T extends true ? AsyncGenerator<string, void, unknown> : Response |
Parameters
| Name | Type | Description |
|---|---|---|
message | MessageContent | |
chatHistory? | ChatMessage[] | optional chat history if you want to customize the chat history |
streaming? | T | optional streaming flag, which auto-sets the return value if True. |
Returns
Promise<R>
Implementation of
Defined in
packages/core/src/ChatEngine.ts:147
condenseQuestion
▸ Private condenseQuestion(chatHistory, question): Promise<ChatResponse>
Parameters
| Name | Type |
|---|---|
chatHistory | ChatMessage[] |
question | string |
Returns
Promise<ChatResponse>
Defined in
packages/core/src/ChatEngine.ts:136
reset
▸ reset(): void
Resets the chat history so that it's empty.
Returns
void