BaseQueryEngine

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

Extends

• PromptMixin

Extended by

• RetrieverQueryEngine

Constructors

Constructor

new BaseQueryEngine(): BaseQueryEngine

Returns

BaseQueryEngine

Inherited from

PromptMixin.constructor

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

---

_getPrompts()

abstract protected _getPrompts(): PromptsRecord

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

Returns

PromptsRecord

Inherited from

PromptMixin._getPrompts

---

_updatePrompts()

abstract protected _updatePrompts(prompts): void

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

Parameters

prompts

PromptsRecord

Returns

void

Inherited from

PromptMixin._updatePrompts

---

_getPromptModules()

abstract protected _getPromptModules(): ModuleRecord

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

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

ModuleRecord

Inherited from

PromptMixin._getPromptModules

---

_query()

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

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

Parameters

strOrQueryBundle

QueryType

stream?

boolean

Returns

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

---

retrieve()

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

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

Parameters

params

QueryType

Returns

Promise<NodeWithScore<Metadata>[]>

---

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

Call Signature

query(params): Promise<EngineResponse>

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

Parameters

params

NonStreamingQueryParams

Returns

Promise<EngineResponse>