CompactAndRefine
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:216
CompactAndRefine is a slight variation of Refine that first compacts the text chunks into the smallest possible number of chunks.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CompactAndRefine(
options):CompactAndRefine
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:42
Parameters
Section titled “Parameters”options
Section titled “options”BaseSynthesizerOptions & object
Returns
Section titled “Returns”CompactAndRefine
Inherited from
Section titled “Inherited from”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”textQATemplate
Section titled “textQATemplate”textQATemplate:
TextQAPrompt
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:39
Inherited from
Section titled “Inherited from”refineTemplate
Section titled “refineTemplate”refineTemplate:
RefinePrompt
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:40
Inherited from
Section titled “Inherited from”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”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:53
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”Inherited from
Section titled “Inherited from”_getPrompts()
Section titled “_getPrompts()”
protected_getPrompts():object
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:57
Returns
Section titled “Returns”object
textQATemplate
Section titled “textQATemplate”textQATemplate:
TextQAPrompt
refineTemplate
Section titled “refineTemplate”refineTemplate:
RefinePrompt
Inherited from
Section titled “Inherited from”_updatePrompts()
Section titled “_updatePrompts()”
protected_updatePrompts(prompts):void
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:67
Parameters
Section titled “Parameters”prompts
Section titled “prompts”textQATemplate
Section titled “textQATemplate”refineTemplate
Section titled “refineTemplate”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”complete()
Section titled “complete()”complete(
params):Promise<string|AsyncIterable<string,any,any>>
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:199
Parameters
Section titled “Parameters”params
Section titled “params”prompt
Section titled “prompt”string
stream
Section titled “stream”boolean
Returns
Section titled “Returns”Promise<string | AsyncIterable<string, any, any>>
Inherited from
Section titled “Inherited from”getResponse()
Section titled “getResponse()”Call Signature
Section titled “Call Signature”getResponse(
query,nodes,stream):Promise<AsyncIterable<EngineResponse,any,any>>
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:217
Parameters
Section titled “Parameters”stream
Section titled “stream”true
Returns
Section titled “Returns”Promise<AsyncIterable<EngineResponse, any, any>>
Overrides
Section titled “Overrides”Call Signature
Section titled “Call Signature”getResponse(
query,nodes,stream):Promise<EngineResponse>
Defined in: .build/typescript/packages/core/src/response-synthesizers/factory.ts:222
Parameters
Section titled “Parameters”stream
Section titled “stream”false
Returns
Section titled “Returns”Promise<EngineResponse>