TreeSummarize
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:270
TreeSummarize repacks the text chunks into the smallest possible number of chunks and then summarizes them, then recursively does so until there’s one chunk left.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new TreeSummarize(
options):TreeSummarize
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:273
Parameters
Section titled “Parameters”options
Section titled “options”BaseSynthesizerOptions & object
Returns
Section titled “Returns”TreeSummarize
Overrides
Section titled “Overrides”Properties
Section titled “Properties”llm:
LLM
Defined in: .build/typescript/packages/core/src/response-synthesizers/base-synthesizer.ts:15
Inherited from
Section titled “Inherited from”promptHelper
Section titled “promptHelper”promptHelper:
PromptHelper
Defined in: .build/typescript/packages/core/src/response-synthesizers/base-synthesizer.ts:16
Inherited from
Section titled “Inherited from”summaryTemplate
Section titled “summaryTemplate”summaryTemplate:
TreeSummarizePrompt
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:271
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”BaseSynthesizer.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”synthesize()
Section titled “synthesize()”Call Signature
Section titled “Call Signature”synthesize(
query,stream):Promise<AsyncIterable<EngineResponse,any,any>>
Defined in: .build/typescript/packages/core/src/response-synthesizers/base-synthesizer.ts:31
Parameters
Section titled “Parameters”stream
Section titled “stream”true
Returns
Section titled “Returns”Promise<AsyncIterable<EngineResponse, any, any>>
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”synthesize(
query,stream?):Promise<EngineResponse>
Defined in: .build/typescript/packages/core/src/response-synthesizers/base-synthesizer.ts:35
Parameters
Section titled “Parameters”stream?
Section titled “stream?”false
Returns
Section titled “Returns”Promise<EngineResponse>
Inherited from
Section titled “Inherited from”_getPromptModules()
Section titled “_getPromptModules()”
protected_getPromptModules():ModuleRecord
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:283
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”Overrides
Section titled “Overrides”BaseSynthesizer._getPromptModules
_getPrompts()
Section titled “_getPrompts()”
protected_getPrompts():object
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:287
Returns
Section titled “Returns”object
summaryTemplate
Section titled “summaryTemplate”summaryTemplate:
TreeSummarizePrompt
Overrides
Section titled “Overrides”_updatePrompts()
Section titled “_updatePrompts()”
protected_updatePrompts(prompts):void
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:293
Parameters
Section titled “Parameters”prompts
Section titled “prompts”summaryTemplate
Section titled “summaryTemplate”Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”BaseSynthesizer._updatePrompts
getResponse()
Section titled “getResponse()”getResponse(
query,nodes,stream):Promise<EngineResponse|AsyncIterable<EngineResponse,any,any>>
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:301
Parameters
Section titled “Parameters”stream
Section titled “stream”boolean
Returns
Section titled “Returns”Promise<EngineResponse | AsyncIterable<EngineResponse, any, any>>