BaseQueryEngine
Defined in: .build/typescript/packages/core/src/query-engine/base.ts:38
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BaseQueryEngine():
BaseQueryEngine
Returns
Section titled “Returns”BaseQueryEngine
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”validatePrompts()
Section titled “validatePrompts()”validatePrompts(
promptsDict,moduleDict):void
Defined in: .build/typescript/packages/core/src/prompts/mixin.ts:8
Parameters
Section titled “Parameters”promptsDict
Section titled “promptsDict”moduleDict
Section titled “moduleDict”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getPrompts()
Section titled “getPrompts()”getPrompts():
PromptsRecord
Defined in: .build/typescript/packages/core/src/prompts/mixin.ts:22
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”updatePrompts()
Section titled “updatePrompts()”updatePrompts(
prompts):void
Defined in: .build/typescript/packages/core/src/prompts/mixin.ts:39
Parameters
Section titled “Parameters”prompts
Section titled “prompts”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_getPrompts()
Section titled “_getPrompts()”
abstractprotected_getPrompts():PromptsRecord
Defined in: .build/typescript/packages/core/src/prompts/mixin.ts:68
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”_updatePrompts()
Section titled “_updatePrompts()”
abstractprotected_updatePrompts(prompts):void
Defined in: .build/typescript/packages/core/src/prompts/mixin.ts:69
Parameters
Section titled “Parameters”prompts
Section titled “prompts”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_getPromptModules()
Section titled “_getPromptModules()”
abstractprotected_getPromptModules():ModuleRecord
Defined in: .build/typescript/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
Section titled “Returns”Inherited from
Section titled “Inherited from”_query()
Section titled “_query()”
abstract_query(strOrQueryBundle,stream?):Promise<EngineResponse|AsyncIterable<EngineResponse,any,any>>
Defined in: .build/typescript/packages/core/src/query-engine/base.ts:39
Parameters
Section titled “Parameters”strOrQueryBundle
Section titled “strOrQueryBundle”stream?
Section titled “stream?”boolean
Returns
Section titled “Returns”Promise<EngineResponse | AsyncIterable<EngineResponse, any, any>>
retrieve()
Section titled “retrieve()”retrieve(
params):Promise<NodeWithScore<Metadata>[]>
Defined in: .build/typescript/packages/core/src/query-engine/base.ts:44
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<NodeWithScore<Metadata>[]>
query()
Section titled “query()”Call Signature
Section titled “Call Signature”query(
params):Promise<AsyncIterable<EngineResponse,any,any>>
Defined in: .build/typescript/packages/core/src/query-engine/base.ts:50
Parameters
Section titled “Parameters”params
Section titled “params”StreamingQueryParams
Returns
Section titled “Returns”Promise<AsyncIterable<EngineResponse, any, any>>
Call Signature
Section titled “Call Signature”query(
params):Promise<EngineResponse>
Defined in: .build/typescript/packages/core/src/query-engine/base.ts:51
Parameters
Section titled “Parameters”params
Section titled “params”NonStreamingQueryParams
Returns
Section titled “Returns”Promise<EngineResponse>