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.

Hierarchy

• PromptMixin

  ↳ CondenseQuestionChatEngine

Implements

• ChatEngine

Constructors

constructor

• new CondenseQuestionChatEngine(init): CondenseQuestionChatEngine

Parameters

Name	Type
init	Object
init.chatHistory	ChatMessage[]
init.condenseMessagePrompt?	(__namedParameters: { chatHistory: undefined | string = ""; question: undefined | string = "" }) => string
init.queryEngine	QueryEngine
init.serviceContext?	ServiceContext

Returns

CondenseQuestionChatEngine

Overrides

PromptMixin.constructor

Defined in

packages/core/src/engines/chat/CondenseQuestionChatEngine.ts:41

Properties

chatHistory

• chatHistory: ChatHistory<object>

Defined in

packages/core/src/engines/chat/CondenseQuestionChatEngine.ts:37

---

condenseMessagePrompt

• condenseMessagePrompt: (__namedParameters: { chatHistory: undefined | string = ""; question: undefined | string = "" }) => string

Type declaration

▸ («destructured»): string

Parameters

Name	Type	Default value
«destructured»	Object	undefined
› chatHistory	undefined | string	""
› question	undefined | string	""

Returns

string

Defined in

packages/core/src/engines/chat/CondenseQuestionChatEngine.ts:39

---

llm

• llm: LLM<object, object>

Defined in

packages/core/src/engines/chat/CondenseQuestionChatEngine.ts:38

---

queryEngine

• queryEngine: QueryEngine

Defined in

packages/core/src/engines/chat/CondenseQuestionChatEngine.ts:36

Methods

_getPromptModules

▸ _getPromptModules(): Record<string, any>

Returns

Record<string, any>

Inherited from

PromptMixin._getPromptModules

Defined in

packages/core/src/prompts/Mixin.ts:82

---

_getPrompts

▸ _getPrompts(): Object

Returns

Object

Name	Type
condenseMessagePrompt	(__namedParameters: { chatHistory: undefined | string = ""; question: undefined | string = "" }) => string

Overrides

PromptMixin._getPrompts

Defined in

packages/core/src/engines/chat/CondenseQuestionChatEngine.ts:56

---

_updatePrompts

▸ _updatePrompts(promptsDict): void

Parameters

Name	Type
promptsDict	Object
promptsDict.condenseMessagePrompt	(__namedParameters: { chatHistory: undefined | string = ""; question: undefined | string = "" }) => string

Returns

void

Overrides

PromptMixin._updatePrompts

Defined in

packages/core/src/engines/chat/CondenseQuestionChatEngine.ts:62

---

chat

▸ chat(params): Promise<AsyncIterable<Response>>

Send message along with the class's current chat history to the LLM.

Parameters

Name	Type
params	ChatEngineParamsStreaming

Returns

Promise<AsyncIterable<Response>>

Implementation of

ChatEngine.chat

Defined in

packages/core/src/engines/chat/CondenseQuestionChatEngine.ts:83

▸ chat(params): Promise<Response>

Parameters

Name	Type
params	ChatEngineParamsNonStreaming

Returns

Promise<Response>

Implementation of

ChatEngine.chat

Defined in

packages/core/src/engines/chat/CondenseQuestionChatEngine.ts:84

---

condenseQuestion

▸ condenseQuestion(chatHistory, question): Promise<CompletionResponse>

Parameters

Name	Type
chatHistory	ChatHistory<object>
question	string

Returns

Promise<CompletionResponse>

Defined in

packages/core/src/engines/chat/CondenseQuestionChatEngine.ts:70

---

getPrompts

▸ getPrompts(): PromptsDict

Returns all prompts from the mixin and its modules

Returns

PromptsDict

Inherited from

PromptMixin.getPrompts

Defined in

packages/core/src/prompts/Mixin.ts:27

---

reset

▸ reset(): void

Resets the chat history so that it's empty.

Returns

void

Implementation of

ChatEngine.reset

Defined in

packages/core/src/engines/chat/CondenseQuestionChatEngine.ts:121

---

updatePrompts

▸ updatePrompts(promptsDict): void

Updates the prompts in the mixin and its modules

Parameters

Name	Type
promptsDict	PromptsDict

Returns

void

Inherited from

PromptMixin.updatePrompts

Defined in

packages/core/src/prompts/Mixin.ts:48

---

validatePrompts

▸ validatePrompts(promptsDict, moduleDict): void

Validates the prompt keys and module keys

Parameters

Name	Type
promptsDict	PromptsDict
moduleDict	ModuleDict

Returns

void

Inherited from

PromptMixin.validatePrompts

Defined in

packages/core/src/prompts/Mixin.ts:10