Skip to main content

Class: abstract BaseRetriever

Extends​

Extended by​

Constructors​

new BaseRetriever()​

protected new BaseRetriever(): BaseRetriever

Returns​

BaseRetriever

Overrides​

PromptMixin.constructor

Defined in​

packages/core/retriever/dist/index.d.ts:24

Properties​

objectMap​

objectMap: Map<string, unknown>

Defined in​

packages/core/retriever/dist/index.d.ts:20

Methods​

_getPromptModules()​

protected _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

Overrides​

PromptMixin._getPromptModules

Defined in​

packages/core/retriever/dist/index.d.ts:23

_getPrompts()​

protected _getPrompts(): object

Returns​

object

Overrides​

PromptMixin._getPrompts

Defined in​

packages/core/retriever/dist/index.d.ts:22

_handleRecursiveRetrieval()​

_handleRecursiveRetrieval(params, nodes): Promise<NodeWithScore<Metadata>[]>

Parameters​

• params: QueryBundle

• nodes: NodeWithScore<Metadata>[]

Returns​

Promise<NodeWithScore<Metadata>[]>

Defined in​

packages/core/retriever/dist/index.d.ts:27

_retrieve()​

abstract _retrieve(params): Promise<NodeWithScore<Metadata>[]>

Parameters​

• params: QueryBundle

Returns​

Promise<NodeWithScore<Metadata>[]>

Defined in​

packages/core/retriever/dist/index.d.ts:26

_retrieveFromObject()​

_retrieveFromObject(object, queryBundle, score): NodeWithScore<Metadata>[]

Parameters​

• object: unknown

• queryBundle: QueryBundle

• score: number

Returns​

NodeWithScore<Metadata>[]

Defined in​

packages/core/retriever/dist/index.d.ts:28

_updatePrompts()​

protected _updatePrompts(): void

Returns​

void

Overrides​

PromptMixin._updatePrompts

Defined in​

packages/core/retriever/dist/index.d.ts:21

getPrompts()​

getPrompts(): PromptsRecord

Returns​

PromptsRecord

Inherited from​

PromptMixin.getPrompts

Defined in​

packages/core/prompts/dist/index.d.ts:66

retrieve()​

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

Parameters​

• params: QueryType

Returns​

Promise<NodeWithScore<Metadata>[]>

Defined in​

packages/core/retriever/dist/index.d.ts:25

updatePrompts()​

updatePrompts(prompts): void

Parameters​

• prompts: PromptsRecord

Returns​

void

Inherited from​

PromptMixin.updatePrompts

Defined in​

packages/core/prompts/dist/index.d.ts:67

validatePrompts()​

validatePrompts(promptsDict, moduleDict): void

Parameters​

• promptsDict: PromptsRecord

• moduleDict: ModuleRecord

Returns​

void

Inherited from​

PromptMixin.validatePrompts

Defined in​

packages/core/prompts/dist/index.d.ts:65