RetrieverQueryEngine

Defined in: packages/core/src/query-engine/retriever.ts:12

Extends

• BaseQueryEngine

Constructors

Constructor

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

Defined in: packages/core/src/query-engine/retriever.ts:17

Parameters

retriever

BaseRetriever

responseSynthesizer?

BaseSynthesizer

nodePostprocessors?

BaseNodePostprocessor[]

Returns

RetrieverQueryEngine

Overrides

BaseQueryEngine.constructor

Properties

retriever

retriever: BaseRetriever

Defined in: packages/core/src/query-engine/retriever.ts:13

---

responseSynthesizer

responseSynthesizer: BaseSynthesizer

Defined in: packages/core/src/query-engine/retriever.ts:14

---

nodePostprocessors

nodePostprocessors: BaseNodePostprocessor[]

Defined in: packages/core/src/query-engine/retriever.ts:15

Methods

validatePrompts()

validatePrompts(promptsDict, moduleDict): void

Defined in: packages/core/src/prompts/mixin.ts:8

Parameters

promptsDict

PromptsRecord

moduleDict

ModuleRecord

Returns

void

Inherited from

BaseQueryEngine.validatePrompts

---

getPrompts()

getPrompts(): PromptsRecord

Defined in: packages/core/src/prompts/mixin.ts:22

Returns

PromptsRecord

Inherited from

BaseQueryEngine.getPrompts

---

updatePrompts()

updatePrompts(prompts): void

Defined in: packages/core/src/prompts/mixin.ts:39

Parameters

prompts

PromptsRecord

Returns

void

Inherited from

BaseQueryEngine.updatePrompts

---

query()

Call Signature

query(params): Promise<AsyncIterable<EngineResponse, any, any>>

Defined in: packages/core/src/query-engine/base.ts:50

Parameters

params

StreamingQueryParams

Returns

Promise<AsyncIterable<EngineResponse, any, any>>

Inherited from

BaseQueryEngine.query

Call Signature

query(params): Promise<EngineResponse>

Defined in: packages/core/src/query-engine/base.ts:51

Parameters

params

NonStreamingQueryParams

Returns

Promise<EngineResponse>

Inherited from

BaseQueryEngine.query

---

_query()

_query(strOrQueryBundle, stream?): Promise<EngineResponse | AsyncIterable<EngineResponse, any, any>>

Defined in: packages/core/src/query-engine/retriever.ts:30

Parameters

strOrQueryBundle

QueryType

stream?

boolean

Returns

Promise<EngineResponse | AsyncIterable<EngineResponse, any, any>>

Overrides

BaseQueryEngine._query

---

_getPrompts()

protected _getPrompts(): object

Defined in: packages/core/src/query-engine/retriever.ts:57

Returns

object

Overrides

BaseQueryEngine._getPrompts

---

_updatePrompts()

protected _updatePrompts(): void

Defined in: packages/core/src/query-engine/retriever.ts:61

Returns

void

Overrides

BaseQueryEngine._updatePrompts

---

_getPromptModules()

_getPromptModules(): object

Defined in: packages/core/src/query-engine/retriever.ts:63

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

---

retrieve()

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

Defined in: packages/core/src/query-engine/retriever.ts:85

Parameters

query

QueryType

Returns

Promise<NodeWithScore<Metadata>[]>

Overrides

BaseQueryEngine.retrieve