Class: RouterQueryEngine

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

Extends

• BaseQueryEngine

Constructors

new RouterQueryEngine()

new RouterQueryEngine(init): RouterQueryEngine

Parameters

• init

• init.queryEngineTools: RouterQueryEngineTool[]

• init.selector: BaseSelector

• init.serviceContext?: ServiceContext

• init.summarizer?: BaseSynthesizer

• init.verbose?: boolean

Returns

RouterQueryEngine

Overrides

BaseQueryEngine.constructor

Defined in

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

Properties

_query

protected readonly _query: QueryFn

Inherited from

BaseQueryEngine._query

Defined in

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

Methods

_getPromptModules()

protected _getPromptModules(): object

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

object

selector

selector: BaseSelector

summarizer

summarizer: BaseSynthesizer

Overrides

BaseQueryEngine._getPromptModules

Defined in

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

---

_getPrompts()

protected _getPrompts(): object

Returns

object

Overrides

BaseQueryEngine._getPrompts

Defined in

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

---

_updatePrompts()

protected _updatePrompts(): void

Returns

void

Overrides

BaseQueryEngine._updatePrompts

Defined in

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

---

getPrompts()

getPrompts(): PromptsRecord

Returns

PromptsRecord

Inherited from

BaseQueryEngine.getPrompts

Defined in

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

---

query()

query(strOrQueryBundle, stream)

query(strOrQueryBundle, stream): Promise<AsyncIterable<EngineResponse, any, any>>

Parameters

• strOrQueryBundle: QueryType

• stream: true

Returns

Promise<AsyncIterable<EngineResponse, any, any>>

Inherited from

BaseQueryEngine.query

Defined in

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

query(strOrQueryBundle, stream)

query(strOrQueryBundle, stream?): Promise<EngineResponse>

Parameters

• strOrQueryBundle: QueryType

• stream?: false

Returns

Promise<EngineResponse>

Inherited from

BaseQueryEngine.query

Defined in

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

---

updatePrompts()

updatePrompts(prompts): void

Parameters

• prompts: PromptsRecord

Returns

void

Inherited from

BaseQueryEngine.updatePrompts

Defined in

packages/core/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/dist/prompts/index.d.ts:57

---

fromDefaults()

static fromDefaults(init): RouterQueryEngine

Parameters

• init

• init.queryEngineTools: RouterQueryEngineTool[]

• init.selector?: BaseSelector

• init.serviceContext?: ServiceContext

• init.summarizer?: BaseSynthesizer

• init.verbose?: boolean

Returns

RouterQueryEngine

Defined in

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