Class: SubQuestionQueryEngine

SubQuestionQueryEngine decomposes a question into subquestions and then

Hierarchy

• PromptMixin

  ↳ SubQuestionQueryEngine

Implements

• BaseQueryEngine

Constructors

constructor

• new SubQuestionQueryEngine(init): SubQuestionQueryEngine

Parameters

Name	Type
init	Object
init.queryEngineTools	BaseTool[]
init.questionGen	BaseQuestionGenerator
init.responseSynthesizer	BaseSynthesizer

Returns

SubQuestionQueryEngine

Overrides

PromptMixin.constructor

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:38

Properties

metadatas

• metadatas: ToolMetadata[]

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:36

---

queryEngines

• queryEngines: BaseTool[]

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:35

---

questionGen

• questionGen: BaseQuestionGenerator

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:34

---

responseSynthesizer

• responseSynthesizer: BaseSynthesizer

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:33

Methods

_getPromptModules

▸ _getPromptModules(): Record<string, any>

Returns

Record<string, any>

Overrides

PromptMixin._getPromptModules

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:52

---

_getPrompts

▸ _getPrompts(): PromptsDict

Returns

PromptsDict

Inherited from

PromptMixin._getPrompts

Defined in

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

---

_updatePrompts

▸ _updatePrompts(promptsDict): void

Parameters

Name	Type
promptsDict	PromptsDict

Returns

void

Inherited from

PromptMixin._updatePrompts

Defined in

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

---

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

---

query

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

Query the query engine and get a response.

Parameters

Name	Type
params	QueryEngineParamsStreaming

Returns

Promise<AsyncIterable<Response>>

Implementation of

BaseQueryEngine.query

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:83

▸ query(params): Promise<Response>

Parameters

Name	Type
params	QueryEngineParamsNonStreaming

Returns

Promise<Response>

Implementation of

BaseQueryEngine.query

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:84

---

querySubQ

▸ querySubQ(subQ, parentEvent?): Promise<null | NodeWithScore<Metadata>>

Parameters

Name	Type
subQ	SubQuestion
parentEvent?	Event

Returns

Promise<null | NodeWithScore<Metadata>>

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:128

---

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

---

fromDefaults

▸ fromDefaults(init): SubQuestionQueryEngine

Parameters

Name	Type
init	Object
init.queryEngineTools	BaseTool[]
init.questionGen?	BaseQuestionGenerator
init.responseSynthesizer?	BaseSynthesizer
init.serviceContext?	ServiceContext

Returns

SubQuestionQueryEngine

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:59