Class: RetrieverQueryEngine
A query engine that uses a retriever to query an index and then synthesizes the response.
Hierarchy
-
↳
RetrieverQueryEngine
Implements
BaseQueryEngine
Constructors
constructor
• new RetrieverQueryEngine(retriever
, responseSynthesizer?
, preFilters?
, nodePostprocessors?
): RetrieverQueryEngine
Parameters
Name | Type |
---|---|
retriever | BaseRetriever |
responseSynthesizer? | BaseSynthesizer |
preFilters? | unknown |
nodePostprocessors? | BaseNodePostprocessor [] |
Returns
Overrides
Defined in
packages/core/src/engines/query/RetrieverQueryEngine.ts:28
Properties
nodePostprocessors
• nodePostprocessors: BaseNodePostprocessor
[]
Defined in
packages/core/src/engines/query/RetrieverQueryEngine.ts:25
preFilters
• Optional
preFilters: unknown
Defined in
packages/core/src/engines/query/RetrieverQueryEngine.ts:26
responseSynthesizer
• responseSynthesizer: BaseSynthesizer
Defined in
packages/core/src/engines/query/RetrieverQueryEngine.ts:24
retriever
• retriever: BaseRetriever
Defined in
packages/core/src/engines/query/RetrieverQueryEngine.ts:23
Methods
_getPromptModules
▸ _getPromptModules(): Object
Returns
Object
Name | Type |
---|---|
responseSynthesizer | BaseSynthesizer |
Overrides
Defined in
packages/core/src/engines/query/RetrieverQueryEngine.ts:45
_getPrompts
▸ _getPrompts(): PromptsDict
Returns
PromptsDict
Inherited from
Defined in
packages/core/src/prompts/Mixin.ts:78
_updatePrompts
▸ _updatePrompts(promptsDict
): void
Parameters
Name | Type |
---|---|
promptsDict | PromptsDict |
Returns
void
Inherited from
Defined in
packages/core/src/prompts/Mixin.ts:86
applyNodePostprocessors
▸ applyNodePostprocessors(nodes
, query
): Promise
<NodeWithScore
<Metadata
>[]>
Parameters
Name | Type |
---|---|
nodes | NodeWithScore <Metadata >[] |
query | string |
Returns
Promise
<NodeWithScore
<Metadata
>[]>
Defined in
packages/core/src/engines/query/RetrieverQueryEngine.ts:51
getPrompts
▸ getPrompts(): PromptsDict
Returns all prompts from the mixin and its modules
Returns
PromptsDict
Inherited from
Defined in
packages/core/src/prompts/Mixin.ts:27
query
▸ query(params
): Promise
<AsyncIterable
<Response
>>
Parameters
Name | Type |
---|---|
params | QueryEngineParamsStreaming |
Returns
Promise
<AsyncIterable
<Response
>>
Implementation of
BaseQueryEngine.query
Defined in
packages/core/src/engines/query/RetrieverQueryEngine.ts:74
▸ query(params
): Promise
<Response
>
Parameters
Name | Type |
---|---|
params | QueryEngineParamsNonStreaming |
Returns
Promise
<Response
>
Implementation of
BaseQueryEngine.query
Defined in
packages/core/src/engines/query/RetrieverQueryEngine.ts:75
retrieve
▸ retrieve(query
, parentEvent
): Promise
<NodeWithScore
<Metadata
>[]>
Parameters
Name | Type |
---|---|
query | string |
parentEvent | Event |
Returns
Promise
<NodeWithScore
<Metadata
>[]>
Defined in
packages/core/src/engines/query/RetrieverQueryEngine.ts:64
updatePrompts
▸ updatePrompts(promptsDict
): void
Updates the prompts in the mixin and its modules
Parameters
Name | Type |
---|---|
promptsDict | PromptsDict |
Returns
void
Inherited from
Defined in
packages/core/src/prompts/Mixin.ts:48
validatePrompts
▸ validatePrompts(promptsDict
, moduleDict
): void
Validates the prompt keys and module keys
Parameters
Name | Type |
---|---|
promptsDict | PromptsDict |
moduleDict | ModuleDict |
Returns
void