Class: SubQuestionQueryEngine
SubQuestionQueryEngine decomposes a question into subquestions and then
Hierarchy
-
↳
SubQuestionQueryEngine
Implements
Constructors
constructor
• new SubQuestionQueryEngine(init
): SubQuestionQueryEngine
Parameters
Name | Type |
---|---|
init | Object |
init.queryEngineTools | BaseTool <any >[] |
init.questionGen | BaseQuestionGenerator |
init.responseSynthesizer | BaseSynthesizer |
Returns
Overrides
Defined in
packages/core/src/engines/query/SubQuestionQueryEngine.ts:33
Properties
metadatas
• metadatas: ToolMetadata
[]
Defined in
packages/core/src/engines/query/SubQuestionQueryEngine.ts:31
queryEngines
• queryEngines: BaseTool
<any
>[]
Defined in
packages/core/src/engines/query/SubQuestionQueryEngine.ts:30
questionGen
• questionGen: BaseQuestionGenerator
Defined in
packages/core/src/engines/query/SubQuestionQueryEngine.ts:29
responseSynthesizer
• responseSynthesizer: BaseSynthesizer
Defined in
packages/core/src/engines/query/SubQuestionQueryEngine.ts:28
Methods
_getPromptModules
▸ _getPromptModules(): Record
<string
, any
>
Returns
Record
<string
, any
>
Overrides
Defined in
packages/core/src/engines/query/SubQuestionQueryEngine.ts:47
_getPrompts
▸ _getPrompts(): PromptsDict
Returns
PromptsDict
Inherited from
Defined in
packages/core/src/prompts/Mixin.ts:78
_updatePrompts
▸ _updatePrompts(promptsDict
): void
Parameters
Name | Type |
---|---|
promptsDict | PromptsDict |
Returns
void
Inherited from
Defined in
packages/core/src/prompts/Mixin.ts:86
getPrompts
▸ getPrompts(): PromptsDict
Returns all prompts from the mixin and its modules
Returns
PromptsDict
Inherited from
Defined in
packages/core/src/prompts/Mixin.ts:27
query
▸ query(params
): Promise
<AsyncIterable
<Response
>>
Query the query engine and get a response.
Parameters
Name | Type |
---|---|
params | QueryEngineParamsStreaming |
Returns
Promise
<AsyncIterable
<Response
>>
Implementation of
Defined in
packages/core/src/engines/query/SubQuestionQueryEngine.ts:77
▸ query(params
): Promise
<Response
>
Parameters
Name | Type |
---|---|
params | QueryEngineParamsNonStreaming |
Returns
Promise
<Response
>
Implementation of
Defined in
packages/core/src/engines/query/SubQuestionQueryEngine.ts:78
querySubQ
▸ querySubQ(subQ
): Promise
<null
| NodeWithScore
<Metadata
>>
Parameters
Name | Type |
---|---|
subQ | SubQuestion |
Returns
Promise
<null
| NodeWithScore
<Metadata
>>
Defined in
packages/core/src/engines/query/SubQuestionQueryEngine.ts:106
updatePrompts
▸ updatePrompts(promptsDict
): void
Updates the prompts in the mixin and its modules
Parameters
Name | Type |
---|---|
promptsDict | PromptsDict |
Returns
void
Inherited from
Defined in
packages/core/src/prompts/Mixin.ts:48
validatePrompts
▸ validatePrompts(promptsDict
, moduleDict
): void
Validates the prompt keys and module keys
Parameters
Name | Type |
---|---|
promptsDict | PromptsDict |
moduleDict | ModuleDict |
Returns
void
Inherited from
Defined in
packages/core/src/prompts/Mixin.ts:10
fromDefaults
▸ fromDefaults(init
): SubQuestionQueryEngine
Parameters
Name | Type |
---|---|
init | Object |
init.queryEngineTools | BaseTool <any >[] |
init.questionGen? | BaseQuestionGenerator |
init.responseSynthesizer? | BaseSynthesizer |
init.serviceContext? | ServiceContext |
Returns
Defined in
packages/core/src/engines/query/SubQuestionQueryEngine.ts:54