Skip to main content

Class: RetrieverQueryEngine

A query engine that uses a retriever to query an index and then synthesizes the response.

Implements

Constructors

constructor

new RetrieverQueryEngine(retriever, responseSynthesizer?, preFilters?, nodePostprocessors?)

Parameters

NameType
retrieverBaseRetriever
responseSynthesizer?ResponseSynthesizer
preFilters?unknown
nodePostprocessors?BaseNodePostprocessor[]

Defined in

packages/core/src/QueryEngine.ts:37

Properties

nodePostprocessors

nodePostprocessors: BaseNodePostprocessor[]

Defined in

packages/core/src/QueryEngine.ts:34


preFilters

Optional preFilters: unknown

Defined in

packages/core/src/QueryEngine.ts:35


responseSynthesizer

responseSynthesizer: ResponseSynthesizer

Defined in

packages/core/src/QueryEngine.ts:33


retriever

retriever: BaseRetriever

Defined in

packages/core/src/QueryEngine.ts:32

Methods

applyNodePostprocessors

Private applyNodePostprocessors(nodes): NodeWithScore<Metadata>[]

Parameters

NameType
nodesNodeWithScore<Metadata>[]

Returns

NodeWithScore<Metadata>[]

Defined in

packages/core/src/QueryEngine.ts:52


query

query(query, parentEvent?): Promise<Response>

Query the query engine and get a response.

Parameters

NameType
querystring
parentEvent?Event

Returns

Promise<Response>

Implementation of

BaseQueryEngine.query

Defined in

packages/core/src/QueryEngine.ts:69


retrieve

Private retrieve(query, parentEvent): Promise<NodeWithScore<Metadata>[]>

Parameters

NameType
querystring
parentEventEvent

Returns

Promise<NodeWithScore<Metadata>[]>

Defined in

packages/core/src/QueryEngine.ts:59