RetrieverQueryEngine
Defined in: .build/typescript/packages/core/src/query-engine/retriever.ts:12
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RetrieverQueryEngine(
retriever,responseSynthesizer?,nodePostprocessors?):RetrieverQueryEngine
Defined in: .build/typescript/packages/core/src/query-engine/retriever.ts:17
Parameters
Section titled “Parameters”retriever
Section titled “retriever”responseSynthesizer?
Section titled “responseSynthesizer?”nodePostprocessors?
Section titled “nodePostprocessors?”Returns
Section titled “Returns”RetrieverQueryEngine
Overrides
Section titled “Overrides”Properties
Section titled “Properties”retriever
Section titled “retriever”retriever:
BaseRetriever
Defined in: .build/typescript/packages/core/src/query-engine/retriever.ts:13
responseSynthesizer
Section titled “responseSynthesizer”responseSynthesizer:
BaseSynthesizer
Defined in: .build/typescript/packages/core/src/query-engine/retriever.ts:14
nodePostprocessors
Section titled “nodePostprocessors”nodePostprocessors:
BaseNodePostprocessor[]
Defined in: .build/typescript/packages/core/src/query-engine/retriever.ts:15
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”BaseQueryEngine.validatePrompts
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”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>>
Inherited from
Section titled “Inherited from”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>
Inherited from
Section titled “Inherited from”_query()
Section titled “_query()”_query(
strOrQueryBundle,stream?):Promise<EngineResponse|AsyncIterable<EngineResponse,any,any>>
Defined in: .build/typescript/packages/core/src/query-engine/retriever.ts:30
Parameters
Section titled “Parameters”strOrQueryBundle
Section titled “strOrQueryBundle”stream?
Section titled “stream?”boolean
Returns
Section titled “Returns”Promise<EngineResponse | AsyncIterable<EngineResponse, any, any>>
Overrides
Section titled “Overrides”_getPrompts()
Section titled “_getPrompts()”
protected_getPrompts():object
Defined in: .build/typescript/packages/core/src/query-engine/retriever.ts:57
Returns
Section titled “Returns”object
Overrides
Section titled “Overrides”_updatePrompts()
Section titled “_updatePrompts()”
protected_updatePrompts():void
Defined in: .build/typescript/packages/core/src/query-engine/retriever.ts:61
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”BaseQueryEngine._updatePrompts
_getPromptModules()
Section titled “_getPromptModules()”_getPromptModules():
object
Defined in: .build/typescript/packages/core/src/query-engine/retriever.ts:63
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”object
responseSynthesizer
Section titled “responseSynthesizer”responseSynthesizer:
BaseSynthesizer
Overrides
Section titled “Overrides”BaseQueryEngine._getPromptModules
retrieve()
Section titled “retrieve()”retrieve(
query):Promise<NodeWithScore<Metadata>[]>
Defined in: .build/typescript/packages/core/src/query-engine/retriever.ts:85
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<NodeWithScore<Metadata>[]>