BaseRetriever

Defined in: packages/core/src/retriever/index.ts:24

Extends

• PromptMixin

Constructors

Constructor

protected new BaseRetriever(): BaseRetriever

Defined in: packages/core/src/retriever/index.ts:36

Returns

BaseRetriever

Overrides

PromptMixin.constructor

Properties

objectMap

objectMap: Map<string, unknown>

Defined in: packages/core/src/retriever/index.ts:25

Methods

validatePrompts()

validatePrompts(promptsDict, moduleDict): void

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

Parameters

promptsDict

PromptsRecord

moduleDict

ModuleRecord

Returns

void

Inherited from

PromptMixin.validatePrompts

---

getPrompts()

getPrompts(): PromptsRecord

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

Returns

PromptsRecord

Inherited from

PromptMixin.getPrompts

---

updatePrompts()

updatePrompts(prompts): void

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

Parameters

prompts

PromptsRecord

Returns

void

Inherited from

PromptMixin.updatePrompts

---

_updatePrompts()

protected _updatePrompts(): void

Defined in: packages/core/src/retriever/index.ts:27

Returns

void

Overrides

PromptMixin._updatePrompts

---

_getPrompts()

protected _getPrompts(): object

Defined in: packages/core/src/retriever/index.ts:28

Returns

object

Overrides

PromptMixin._getPrompts

---

_getPromptModules()

protected _getPromptModules(): object

Defined in: packages/core/src/retriever/index.ts:32

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

---

retrieve()

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

Defined in: packages/core/src/retriever/index.ts:40

Parameters

params

QueryType

Returns

Promise<NodeWithScore<Metadata>[]>

---

_retrieve()

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

Defined in: packages/core/src/retriever/index.ts:55

Parameters

params

QueryBundle

Returns

Promise<NodeWithScore<Metadata>[]>

---

_handleRecursiveRetrieval()

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

Defined in: packages/core/src/retriever/index.ts:57

Parameters

params

QueryBundle

nodes

NodeWithScore<Metadata>[]

Returns

Promise<NodeWithScore<Metadata>[]>

---

_retrieveFromObject()

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

Defined in: packages/core/src/retriever/index.ts:80

Parameters

object

unknown

queryBundle

QueryBundle

score

number

Returns

NodeWithScore<Metadata>[]