Skip to main content

Class: abstract BaseQueryEngine

Extends

Extended by

Constructors

new BaseQueryEngine()

protected new BaseQueryEngine(_query): BaseQueryEngine

Parameters

_query: QueryFn

Returns

BaseQueryEngine

Overrides

PromptMixin.constructor

Defined in

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

Properties

_query

protected readonly _query: QueryFn

Defined in

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

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/prompts/index.d.ts:69


_getPrompts()

abstract protected _getPrompts(): PromptsRecord

Returns

PromptsRecord

Inherited from

PromptMixin._getPrompts

Defined in

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


_updatePrompts()

abstract protected _updatePrompts(prompts): void

Parameters

prompts: PromptsRecord

Returns

void

Inherited from

PromptMixin._updatePrompts

Defined in

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


getPrompts()

getPrompts(): PromptsRecord

Returns

PromptsRecord

Inherited from

PromptMixin.getPrompts

Defined in

packages/core/prompts/dist/prompts/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/query-engine/index.d.ts:30

query(params)

query(params): Promise<EngineResponse>

Parameters

params: NonStreamingQueryParams

Returns

Promise<EngineResponse>

Defined in

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


retrieve()

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

Parameters

params: QueryType

Returns

Promise<NodeWithScore<Metadata>[]>

Defined in

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


updatePrompts()

updatePrompts(prompts): void

Parameters

prompts: PromptsRecord

Returns

void

Inherited from

PromptMixin.updatePrompts

Defined in

packages/core/prompts/dist/prompts/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/prompts/index.d.ts:57