Files
LlamaIndexTS/apps/docs/docs/api/classes/RetrieverQueryEngine.md
T
Yi Ding 7699f5432d set typedoc revision to main
In theory this will stop the API docs thrashing on every build.

Of course, there is a drawback in that if main changes but we haven't
released a new version of the docs yet the links will go out of date.

So longer term we might want to investigate some kind of variable where
we can continue to have up to date revs but keep the rev in a single
variable somewhere:

https://github.com/facebook/docusaurus/issues/395

In the meantime much smaller commits will be a relief
2023-07-25 23:06:44 -07:00

1.8 KiB

id, title, sidebar_label, sidebar_position, custom_edit_url
id title sidebar_label sidebar_position custom_edit_url
RetrieverQueryEngine Class: RetrieverQueryEngine RetrieverQueryEngine 0 null

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

Implements

Constructors

constructor

new RetrieverQueryEngine(retriever, responseSynthesizer?)

Parameters

Name Type
retriever BaseRetriever
responseSynthesizer? ResponseSynthesizer

Defined in

QueryEngine.ts:34

Properties

responseSynthesizer

responseSynthesizer: ResponseSynthesizer

Defined in

QueryEngine.ts:32


retriever

retriever: BaseRetriever

Defined in

QueryEngine.ts:31

Methods

query

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

Query the query engine and get a response.

Parameters

Name Type
query string
parentEvent? Event

Returns

Promise<Response>

Implementation of

BaseQueryEngine.query

Defined in

QueryEngine.ts:45