Saltar al contenido principal

Class: RetrieverQueryEngine

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

Hierarchy

Implements

Constructors

constructor

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

Parameters

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

Returns

RetrieverQueryEngine

Overrides

PromptMixin.constructor

Defined in

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

Properties

nodePostprocessors

nodePostprocessors: BaseNodePostprocessor[]

Defined in

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


preFilters

Optional preFilters: unknown

Defined in

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


responseSynthesizer

responseSynthesizer: BaseSynthesizer

Defined in

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


retriever

retriever: BaseRetriever

Defined in

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

Methods

_getPromptModules

_getPromptModules(): Object

Returns

Object

NameType
responseSynthesizerBaseSynthesizer

Overrides

PromptMixin._getPromptModules

Defined in

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


_getPrompts

_getPrompts(): PromptsDict

Returns

PromptsDict

Inherited from

PromptMixin._getPrompts

Defined in

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


_updatePrompts

_updatePrompts(promptsDict): void

Parameters

NameType
promptsDictPromptsDict

Returns

void

Inherited from

PromptMixin._updatePrompts

Defined in

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


applyNodePostprocessors

applyNodePostprocessors(nodes, query): Promise<NodeWithScore<Metadata>[]>

Parameters

NameType
nodesNodeWithScore<Metadata>[]
querystring

Returns

Promise<NodeWithScore<Metadata>[]>

Defined in

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


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

NameType
paramsQueryEngineParamsStreaming

Returns

Promise<AsyncIterable<Response>>

Implementation of

QueryEngine.query

Defined in

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

query(params): Promise<Response>

Parameters

NameType
paramsQueryEngineParamsNonStreaming

Returns

Promise<Response>

Implementation of

QueryEngine.query

Defined in

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


retrieve

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

Parameters

NameType
querystring

Returns

Promise<NodeWithScore<Metadata>[]>

Defined in

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


updatePrompts

updatePrompts(promptsDict): void

Updates the prompts in the mixin and its modules

Parameters

NameType
promptsDictPromptsDict

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

NameType
promptsDictPromptsDict
moduleDictModuleDict

Returns

void

Inherited from

PromptMixin.validatePrompts

Defined in

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