Class: CompactAndRefine
CompactAndRefine is a slight variation of Refine that first compacts the text chunks into the smallest possible number of chunks.
Extends
Constructors
new CompactAndRefine()
new CompactAndRefine(
serviceContext?,textQATemplate?,refineTemplate?):CompactAndRefine
Parameters
• serviceContext?: ServiceContext
• textQATemplate?
• refineTemplate?
Returns
Inherited from
Source
packages/llamaindex/src/synthesizers/builders.ts:88
Properties
llm
llm:
LLM<object,object>
Inherited from
Source
packages/llamaindex/src/synthesizers/builders.ts:83
promptHelper
promptHelper:
PromptHelper
Inherited from
Source
packages/llamaindex/src/synthesizers/builders.ts:84
refineTemplate()
refineTemplate: (
__namedParameters) =>string
Parameters
• __namedParameters
• __namedParameters.context: undefined | string= ""
• __namedParameters.existingAnswer: undefined | string= ""
• __namedParameters.query: undefined | string= ""
Returns
string
Inherited from
Source
packages/llamaindex/src/synthesizers/builders.ts:86
textQATemplate()
textQATemplate: (
__namedParameters) =>string
Parameters
• __namedParameters
• __namedParameters.context: undefined | string= ""
• __namedParameters.query: undefined | string= ""
Returns
string
Inherited from
Source
packages/llamaindex/src/synthesizers/builders.ts:85
Methods
_getPromptModules()
protected_getPromptModules():Record<string,any>
Returns
Record<string, any>
Inherited from
Source
packages/llamaindex/src/prompts/Mixin.ts:82
_getPrompts()
protected_getPrompts():object
Returns
object
refineTemplate()
refineTemplate: (
__namedParameters) =>string
Parameters
• __namedParameters
• __namedParameters.context: undefined | string= ""
• __namedParameters.existingAnswer: undefined | string= ""
• __namedParameters.query: undefined | string= ""
Returns
string
textQATemplate()
textQATemplate: (
__namedParameters) =>string
Parameters
• __namedParameters
• __namedParameters.context: undefined | string= ""
• __namedParameters.existingAnswer: undefined | string= ""
• __namedParameters.query: undefined | string= ""
Returns
string
Inherited from
Source
packages/llamaindex/src/synthesizers/builders.ts:101
_updatePrompts()
protected_updatePrompts(prompts):void
Parameters
• prompts
• prompts.refineTemplate
• prompts.textQATemplate
Returns
void
Inherited from
Source
packages/llamaindex/src/synthesizers/builders.ts:111
complete()
complete(
params):Promise<string|AsyncIterable<string>>
Parameters
• params
• params.prompt: string
• params.stream: boolean
Returns
Promise<string | AsyncIterable<string>>
Inherited from
Source
packages/llamaindex/src/synthesizers/builders.ts:224
getPrompts()
getPrompts():
PromptsDict
Returns all prompts from the mixin and its modules
Returns
PromptsDict
Inherited from
Source
packages/llamaindex/src/prompts/Mixin.ts:27
getResponse()
getResponse(params)
getResponse(
params):Promise<AsyncIterable<string>>
Get the response from a query and a list of text chunks.
Parameters
• params: ResponseBuilderParamsStreaming
Returns
Promise<AsyncIterable<string>>
Overrides
Source
packages/llamaindex/src/synthesizers/builders.ts:242
getResponse(params)
getResponse(
params):Promise<string>
Parameters
• params: ResponseBuilderParamsNonStreaming
Returns
Promise<string>
Overrides
Source
packages/llamaindex/src/synthesizers/builders.ts:245
updatePrompts()
updatePrompts(
promptsDict):void
Updates the prompts in the mixin and its modules
Parameters
• promptsDict: PromptsDict
Returns
void
Inherited from
Source
packages/llamaindex/src/prompts/Mixin.ts:48
validatePrompts()
validatePrompts(
promptsDict,moduleDict):void
Validates the prompt keys and module keys
Parameters
• promptsDict: PromptsDict
• moduleDict: ModuleDict
Returns
void