Class: RetrieverQueryEngine

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

Hierarchy

• PromptMixin

  ↳ RetrieverQueryEngine

Implements

• BaseQueryEngine

Constructors

constructor

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

Parameters

Name	Type
retriever	BaseRetriever
responseSynthesizer?	BaseSynthesizer
preFilters?	unknown
nodePostprocessors?	BaseNodePostprocessor[]

Returns

RetrieverQueryEngine

Overrides

PromptMixin.constructor

Defined in

packages/core/src/engines/query/RetrieverQueryEngine.ts:26

Properties

nodePostprocessors

• nodePostprocessors: BaseNodePostprocessor[]

Defined in

packages/core/src/engines/query/RetrieverQueryEngine.ts:23

---

preFilters

• Optional preFilters: unknown

Defined in

packages/core/src/engines/query/RetrieverQueryEngine.ts:24

---

responseSynthesizer

• responseSynthesizer: BaseSynthesizer

Defined in

packages/core/src/engines/query/RetrieverQueryEngine.ts:22

---

retriever

• retriever: BaseRetriever

Defined in

packages/core/src/engines/query/RetrieverQueryEngine.ts:21

Methods

_getPromptModules

▸ _getPromptModules(): Object

Returns

Object

Name	Type
responseSynthesizer	BaseSynthesizer

Overrides

PromptMixin._getPromptModules

Defined in

packages/core/src/engines/query/RetrieverQueryEngine.ts:44

---

_getPrompts

▸ _getPrompts(): PromptsDict

Returns

PromptsDict

Inherited from

PromptMixin._getPrompts

Defined in

packages/core/src/prompts/Mixin.ts:78

---

_updatePrompts

▸ _updatePrompts(promptsDict): void

Parameters

Name	Type
promptsDict	PromptsDict

Returns

void

Inherited from

PromptMixin._updatePrompts

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:50

---

getPrompts

▸ getPrompts(): PromptsDict

Returns all prompts from the mixin and its modules

Returns

PromptsDict

Inherited from

PromptMixin.getPrompts

Defined in

packages/core/src/prompts/Mixin.ts:27

---

query

▸ query(params): Promise<AsyncIterable<Response>>

Query the query engine and get a response.

Parameters

Name	Type
params	QueryEngineParamsStreaming

Returns

Promise<AsyncIterable<Response>>

Implementation of

BaseQueryEngine.query

Defined in

packages/core/src/engines/query/RetrieverQueryEngine.ts:72

▸ 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:73

---

retrieve

▸ retrieve(query): Promise<NodeWithScore<Metadata>[]>

Parameters

Name	Type
query	string

Returns

Promise<NodeWithScore<Metadata>[]>

Defined in

packages/core/src/engines/query/RetrieverQueryEngine.ts:63

---

updatePrompts

▸ updatePrompts(promptsDict): void

Updates the prompts in the mixin and its modules

Parameters

Name	Type
promptsDict	PromptsDict

Returns

void

Inherited from

PromptMixin.updatePrompts

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

Inherited from

PromptMixin.validatePrompts

Defined in

packages/core/src/prompts/Mixin.ts:10