Class: SubQuestionQueryEngine

SubQuestionQueryEngine decomposes a question into subquestions and then

Extends

• BaseQueryEngine

Constructors

new SubQuestionQueryEngine()

new SubQuestionQueryEngine(init): SubQuestionQueryEngine

Parameters

• init

• init.queryEngineTools: BaseTool<any>[]

• init.questionGen: BaseQuestionGenerator

• init.responseSynthesizer: BaseSynthesizer

Returns

SubQuestionQueryEngine

Overrides

BaseQueryEngine.constructor

Defined in

packages/llamaindex/src/engines/query/SubQuestionQueryEngine.ts:24

Properties

_query

protected readonly _query: QueryFn

Inherited from

BaseQueryEngine._query

Defined in

packages/core/query-engine/dist/query-engine/index.d.ts:27

---

metadatas

metadatas: ToolMetadata[]

Defined in

packages/llamaindex/src/engines/query/SubQuestionQueryEngine.ts:22

---

queryEngines

queryEngines: BaseTool<any>[]

Defined in

packages/llamaindex/src/engines/query/SubQuestionQueryEngine.ts:21

---

questionGen

questionGen: BaseQuestionGenerator

Defined in

packages/llamaindex/src/engines/query/SubQuestionQueryEngine.ts:20

---

responseSynthesizer

responseSynthesizer: BaseSynthesizer

Defined in

packages/llamaindex/src/engines/query/SubQuestionQueryEngine.ts:19

Methods

_getPromptModules()

protected _getPromptModules(): Record<string, any>

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

Record<string, any>

Overrides

BaseQueryEngine._getPromptModules

Defined in

packages/llamaindex/src/engines/query/SubQuestionQueryEngine.ts:81

---

_getPrompts()

protected _getPrompts(): PromptsRecord

Returns

PromptsRecord

Overrides

BaseQueryEngine._getPrompts

Defined in

packages/llamaindex/src/engines/query/SubQuestionQueryEngine.ts:75

---

_updatePrompts()

protected _updatePrompts(): void

Returns

void

Overrides

BaseQueryEngine._updatePrompts

Defined in

packages/llamaindex/src/engines/query/SubQuestionQueryEngine.ts:79

---

getPrompts()

getPrompts(): PromptsRecord

Returns

PromptsRecord

Inherited from

BaseQueryEngine.getPrompts

Defined in

packages/core/prompts/dist/prompts/index.d.ts:58

---

query()

query(params)

query(params): Promise<AsyncIterable<EngineResponse, any, any>>

Parameters

• params: StreamingQueryParams

Returns

Promise<AsyncIterable<EngineResponse, any, any>>

Inherited from

BaseQueryEngine.query

Defined in

packages/core/query-engine/dist/query-engine/index.d.ts:30

query(params)

query(params): Promise<EngineResponse>

Parameters

• params: NonStreamingQueryParams

Returns

Promise<EngineResponse>

Inherited from

BaseQueryEngine.query

Defined in

packages/core/query-engine/dist/query-engine/index.d.ts:31

---

retrieve()

retrieve(params): Promise<NodeWithScore<Metadata>[]>

Parameters

• params: QueryType

Returns

Promise<NodeWithScore<Metadata>[]>

Inherited from

BaseQueryEngine.retrieve

Defined in

packages/core/query-engine/dist/query-engine/index.d.ts:29

---

updatePrompts()

updatePrompts(prompts): void

Parameters

• prompts: PromptsRecord

Returns

void

Inherited from

BaseQueryEngine.updatePrompts

Defined in

packages/core/prompts/dist/prompts/index.d.ts:59

---

validatePrompts()

validatePrompts(promptsDict, moduleDict): void

Parameters

• promptsDict: PromptsRecord

• moduleDict: ModuleRecord

Returns

void

Inherited from

BaseQueryEngine.validatePrompts

Defined in

packages/core/prompts/dist/prompts/index.d.ts:57

---

fromDefaults()

static fromDefaults(init): SubQuestionQueryEngine

Parameters

• init

• init.queryEngineTools: BaseTool<any>[]

• init.questionGen?: BaseQuestionGenerator

• init.responseSynthesizer?: BaseSynthesizer

• init.serviceContext?: ServiceContext

Returns

SubQuestionQueryEngine

Defined in

packages/llamaindex/src/engines/query/SubQuestionQueryEngine.ts:88