Class: RetrieverQueryEngine
A query engine that uses a retriever to query an index and then synthesizes the response.
Extends
Constructors
new RetrieverQueryEngine()
new RetrieverQueryEngine(
retriever,responseSynthesizer?,nodePostprocessors?):RetrieverQueryEngine
Parameters
• retriever: BaseRetriever
• responseSynthesizer?: BaseSynthesizer
• nodePostprocessors?: BaseNodePostprocessor[]
Returns
Overrides
Defined in
packages/llamaindex/src/engines/query/RetrieverQueryEngine.ts:18
Properties
_query
protectedreadonly_query:QueryFn
Inherited from
Defined in
packages/core/query-engine/dist/index.d.ts:27
nodePostprocessors
nodePostprocessors:
BaseNodePostprocessor[]
Defined in
packages/llamaindex/src/engines/query/RetrieverQueryEngine.ts:16
responseSynthesizer
responseSynthesizer:
BaseSynthesizer
Defined in
packages/llamaindex/src/engines/query/RetrieverQueryEngine.ts:15
retriever
retriever:
BaseRetriever
Defined in
packages/llamaindex/src/engines/query/RetrieverQueryEngine.ts:14
Methods
_getPromptModules()
_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
responseSynthesizer
responseSynthesizer:
BaseSynthesizer
Overrides
BaseQueryEngine._getPromptModules
Defined in
packages/llamaindex/src/engines/query/RetrieverQueryEngine.ts:62
_getPrompts()
protected_getPrompts():object
Returns
object
Overrides
Defined in
packages/llamaindex/src/engines/query/RetrieverQueryEngine.ts:56
_updatePrompts()
protected_updatePrompts():void
Returns
void
Overrides
BaseQueryEngine._updatePrompts
Defined in
packages/llamaindex/src/engines/query/RetrieverQueryEngine.ts:60
getPrompts()
getPrompts():
PromptsRecord
Returns
Inherited from
Defined in
packages/core/prompts/dist/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
Defined in
packages/core/query-engine/dist/index.d.ts:30
query(params)
query(
params):Promise<EngineResponse>
Parameters
• params: NonStreamingQueryParams
Returns
Promise<EngineResponse>
Inherited from
Defined in
packages/core/query-engine/dist/index.d.ts:31
retrieve()
retrieve(
query):Promise<NodeWithScore<Metadata>[]>
Parameters
• query: QueryType
Returns
Promise<NodeWithScore<Metadata>[]>
Overrides
Defined in
packages/llamaindex/src/engines/query/RetrieverQueryEngine.ts:84
updatePrompts()
updatePrompts(
prompts):void
Parameters
• prompts: PromptsRecord
Returns
void
Inherited from
Defined in
packages/core/prompts/dist/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/index.d.ts:57