Class: RouterQueryEngine

A query engine that uses multiple query engines and selects the best one.

Extends

• PromptMixin

Implements

• QueryEngine

Constructors

new RouterQueryEngine()

new RouterQueryEngine(init): RouterQueryEngine

Parameters

• init

• init.queryEngineTools: RouterQueryEngineTool[]

• init.selector: BaseSelector

• init.serviceContext?: ServiceContext

• init.summarizer?: TreeSummarize

• init.verbose?: boolean

Returns

RouterQueryEngine

Overrides

PromptMixin . constructor

Source

packages/llamaindex/src/engines/query/RouterQueryEngine.ts:64

Properties

metadatas

private metadatas: RouterQueryEngineMetadata[]

Source

packages/llamaindex/src/engines/query/RouterQueryEngine.ts:60

---

queryEngines

private queryEngines: QueryEngine[]

Source

packages/llamaindex/src/engines/query/RouterQueryEngine.ts:59

---

selector

private selector: BaseSelector

Source

packages/llamaindex/src/engines/query/RouterQueryEngine.ts:58

---

summarizer

private summarizer: TreeSummarize

Source

packages/llamaindex/src/engines/query/RouterQueryEngine.ts:61

---

verbose

private verbose: boolean

Source

packages/llamaindex/src/engines/query/RouterQueryEngine.ts:62

Methods

_getPromptModules()

_getPromptModules(): Record<string, any>

Returns

Record<string, any>

Overrides

PromptMixin . _getPromptModules

Source

packages/llamaindex/src/engines/query/RouterQueryEngine.ts:82

---

_getPrompts()

protected _getPrompts(): PromptsDict

Returns

PromptsDict

Inherited from

PromptMixin . _getPrompts

Source

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

---

_updatePrompts()

protected _updatePrompts(promptsDict): void

Parameters

• promptsDict: PromptsDict

Returns

void

Inherited from

PromptMixin . _updatePrompts

Source

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

---

getPrompts()

getPrompts(): PromptsDict

Returns all prompts from the mixin and its modules

Returns

PromptsDict

Inherited from

PromptMixin . getPrompts

Source

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

---

query()

query(params)

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

Query the query engine and get a response.

Parameters

• params: QueryEngineParamsStreaming

Returns

Promise<AsyncIterable <EngineResponse>>

Implementation of

QueryEngine . query

Source

packages/llamaindex/src/engines/query/RouterQueryEngine.ts:111

query(params)

query(params): Promise <EngineResponse>

Parameters

• params: QueryEngineParamsNonStreaming

Returns

Promise <EngineResponse>

Implementation of

QueryEngine . query

Source

packages/llamaindex/src/engines/query/RouterQueryEngine.ts:114

---

queryRoute()

private queryRoute(queryBundle): Promise <EngineResponse>

Parameters

• queryBundle: QueryBundle

Returns

Promise <EngineResponse>

Source

packages/llamaindex/src/engines/query/RouterQueryEngine.ts:129

---

updatePrompts()

updatePrompts(promptsDict): void

Updates the prompts in the mixin and its modules

Parameters

• promptsDict: PromptsDict

Returns

void

Inherited from

PromptMixin . updatePrompts

Source

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

---

validatePrompts()

validatePrompts(promptsDict, moduleDict): void

Validates the prompt keys and module keys

Parameters

• promptsDict: PromptsDict

• moduleDict: ModuleDict

Returns

void

Inherited from

PromptMixin . validatePrompts

Source

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

---

fromDefaults()

static fromDefaults(init): RouterQueryEngine

Parameters

• init

• init.queryEngineTools: RouterQueryEngineTool[]

• init.selector?: BaseSelector

• init.serviceContext?: ServiceContext

• init.summarizer?: TreeSummarize

• init.verbose?: boolean

Returns

RouterQueryEngine

Source

packages/llamaindex/src/engines/query/RouterQueryEngine.ts:89