Saltar al contenido principal

Class: SubQuestionQueryEngine

SubQuestionQueryEngine decomposes a question into subquestions and then

Hierarchy

Implements

Constructors

constructor

new SubQuestionQueryEngine(init): SubQuestionQueryEngine

Parameters

NameType
initObject
init.queryEngineToolsBaseTool<any>[]
init.questionGenBaseQuestionGenerator
init.responseSynthesizerBaseSynthesizer

Returns

SubQuestionQueryEngine

Overrides

PromptMixin.constructor

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:37

Properties

metadatas

metadatas: ToolMetadata[]

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:35


queryEngines

queryEngines: BaseTool<any>[]

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:34


questionGen

questionGen: BaseQuestionGenerator

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:33


responseSynthesizer

responseSynthesizer: BaseSynthesizer

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:32

Methods

_getPromptModules

_getPromptModules(): Record<string, any>

Returns

Record<string, any>

Overrides

PromptMixin._getPromptModules

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:51


_getPrompts

_getPrompts(): PromptsDict

Returns

PromptsDict

Inherited from

PromptMixin._getPrompts

Defined in

packages/core/src/prompts/Mixin.ts:79


_updatePrompts

_updatePrompts(promptsDict): void

Parameters

NameType
promptsDictPromptsDict

Returns

void

Inherited from

PromptMixin._updatePrompts

Defined in

packages/core/src/prompts/Mixin.ts:87


getPrompts

getPrompts(): PromptsDict

Returns all prompts from the mixin and its modules

Returns

PromptsDict

Inherited from

PromptMixin.getPrompts

Defined in

packages/core/src/prompts/Mixin.ts:27


query

query(params): Promise<AsyncIterable<Response>>

Query the query engine and get a response.

Parameters

NameType
paramsQueryEngineParamsStreaming

Returns

Promise<AsyncIterable<Response>>

Implementation of

BaseQueryEngine.query

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:81

query(params): Promise<Response>

Parameters

NameType
paramsQueryEngineParamsNonStreaming

Returns

Promise<Response>

Implementation of

BaseQueryEngine.query

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:82


querySubQ

querySubQ(subQ): Promise<null | NodeWithScore<Metadata>>

Parameters

NameType
subQSubQuestion

Returns

Promise<null | NodeWithScore<Metadata>>

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:113


updatePrompts

updatePrompts(promptsDict): void

Updates the prompts in the mixin and its modules

Parameters

NameType
promptsDictPromptsDict

Returns

void

Inherited from

PromptMixin.updatePrompts

Defined in

packages/core/src/prompts/Mixin.ts:48


validatePrompts

validatePrompts(promptsDict, moduleDict): void

Validates the prompt keys and module keys

Parameters

NameType
promptsDictPromptsDict
moduleDictModuleDict

Returns

void

Inherited from

PromptMixin.validatePrompts

Defined in

packages/core/src/prompts/Mixin.ts:10


fromDefaults

fromDefaults(init): SubQuestionQueryEngine

Parameters

NameType
initObject
init.queryEngineToolsBaseTool<any>[]
init.questionGen?BaseQuestionGenerator
init.responseSynthesizer?BaseSynthesizer
init.serviceContext?ServiceContext

Returns

SubQuestionQueryEngine

Defined in

packages/core/src/engines/query/SubQuestionQueryEngine.ts:58