Files
LlamaIndexTS/apps/docs/docs/api/classes/SubQuestionQueryEngine.md
T
Yi Ding 7699f5432d set typedoc revision to main
In theory this will stop the API docs thrashing on every build.

Of course, there is a drawback in that if main changes but we haven't
released a new version of the docs yet the links will go out of date.

So longer term we might want to investigate some kind of variable where
we can continue to have up to date revs but keep the rev in a single
variable somewhere:

https://github.com/facebook/docusaurus/issues/395

In the meantime much smaller commits will be a relief
2023-07-25 23:06:44 -07:00

3.5 KiB

id, title, sidebar_label, sidebar_position, custom_edit_url
id title sidebar_label sidebar_position custom_edit_url
SubQuestionQueryEngine Class: SubQuestionQueryEngine SubQuestionQueryEngine 0 null

SubQuestionQueryEngine decomposes a question into subquestions and then

Implements

Constructors

constructor

new SubQuestionQueryEngine(init)

Parameters

Name Type
init Object
init.queryEngineTools QueryEngineTool[]
init.questionGen BaseQuestionGenerator
init.responseSynthesizer ResponseSynthesizer

Defined in

QueryEngine.ts:65

Properties

metadatas

metadatas: ToolMetadata[]

Defined in

QueryEngine.ts:63


queryEngines

queryEngines: Record<string, BaseQueryEngine>

Defined in

QueryEngine.ts:62


questionGen

questionGen: BaseQuestionGenerator

Defined in

QueryEngine.ts:61


responseSynthesizer

responseSynthesizer: ResponseSynthesizer

Defined in

QueryEngine.ts:60

Methods

query

query(query): Promise<Response>

Query the query engine and get a response.

Parameters

Name Type
query string

Returns

Promise<Response>

Implementation of

BaseQueryEngine.query

Defined in

QueryEngine.ts:106


querySubQ

Private querySubQ(subQ, parentEvent?): Promise<null | NodeWithScore>

Parameters

Name Type
subQ SubQuestion
parentEvent? Event

Returns

Promise<null | NodeWithScore>

Defined in

QueryEngine.ts:134


fromDefaults

Static fromDefaults(init): SubQuestionQueryEngine

Parameters

Name Type
init Object
init.queryEngineTools QueryEngineTool[]
init.questionGen? BaseQuestionGenerator
init.responseSynthesizer? ResponseSynthesizer
init.serviceContext? ServiceContext

Returns

SubQuestionQueryEngine

Defined in

QueryEngine.ts:82