Skip to main content

Class: abstract BaseQueryEngine

Extends​

Extended by​

Constructors​

new BaseQueryEngine()​

new BaseQueryEngine(): BaseQueryEngine

Returns​

BaseQueryEngine

Inherited from​

PromptMixin.constructor

Methods​

_getPromptModules()​

abstract protected _getPromptModules(): ModuleRecord

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

Defined in​

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

_getPrompts()​

abstract protected _getPrompts(): PromptsRecord

Returns​

PromptsRecord

Inherited from​

PromptMixin._getPrompts

Defined in​

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

_query()​

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

Parameters​

• strOrQueryBundle: QueryType

• stream?: boolean

Returns​

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

Defined in​

packages/core/query-engine/dist/index.d.ts:30

_updatePrompts()​

abstract protected _updatePrompts(prompts): void

Parameters​

• prompts: PromptsRecord

Returns​

void

Inherited from​

PromptMixin._updatePrompts

Defined in​

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

getPrompts()​

getPrompts(): PromptsRecord

Returns​

PromptsRecord

Inherited from​

PromptMixin.getPrompts

Defined in​

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

query()​

query(params)​

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

Parameters​

• params: StreamingQueryParams

Returns​

Promise<AsyncIterable<EngineResponse, any, any>>

Defined in​

packages/core/query-engine/dist/index.d.ts:32

query(params)​

query(params): Promise<EngineResponse>

Parameters​

• params: NonStreamingQueryParams

Returns​

Promise<EngineResponse>

Defined in​

packages/core/query-engine/dist/index.d.ts:33

retrieve()​

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

Parameters​

• params: QueryType

Returns​

Promise<NodeWithScore<Metadata>[]>

Defined in​

packages/core/query-engine/dist/index.d.ts:31

updatePrompts()​

updatePrompts(prompts): void

Parameters​

• prompts: PromptsRecord

Returns​

void

Inherited from​

PromptMixin.updatePrompts

Defined in​

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

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