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?: TextQAPrompt
• refineTemplate?: RefinePrompt
Returns
Inherited from
Defined in
packages/llamaindex/src/synthesizers/builders.ts:95
Properties
llm
llm:
LLM<object,object>
Inherited from
Defined in
packages/llamaindex/src/synthesizers/builders.ts:90
promptHelper
promptHelper:
PromptHelper
Inherited from
Defined in
packages/llamaindex/src/synthesizers/builders.ts:91
refineTemplate
refineTemplate:
RefinePrompt
Inherited from
Defined in
packages/llamaindex/src/synthesizers/builders.ts:93
textQATemplate
textQATemplate:
TextQAPrompt
Inherited from
Defined in
packages/llamaindex/src/synthesizers/builders.ts:92
Methods
_getPromptModules()
protected_getPromptModules():ModuleRecord
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
Inherited from
Defined in
packages/llamaindex/src/synthesizers/builders.ts:108
_getPrompts()
protected_getPrompts():object
Returns
object
refineTemplate
refineTemplate:
RefinePrompt
textQATemplate
textQATemplate:
TextQAPrompt
Inherited from
Defined in
packages/llamaindex/src/synthesizers/builders.ts:112
_updatePrompts()
protected_updatePrompts(prompts):void
Parameters
• prompts
• prompts.refineTemplate: RefinePrompt
• prompts.textQATemplate: TextQAPrompt
Returns
void
Inherited from
Defined in
packages/llamaindex/src/synthesizers/builders.ts:122
complete()
complete(
params):Promise<string|AsyncIterable<string>>
Parameters
• params
• params.prompt: string
• params.stream: boolean
Returns
Promise<string | AsyncIterable<string>>
Inherited from
Defined in
packages/llamaindex/src/synthesizers/builders.ts:232
getPrompts()
getPrompts():
PromptsRecord
Returns
Inherited from
Defined in
packages/core/dist/prompts/index.d.ts:58
getResponse()
getResponse(query, stream)
getResponse(
query,stream):Promise<AsyncIterable<string>>
Get the response from a query and a list of text chunks.
Parameters
• query: ResponseBuilderQuery
• stream: true
Returns
Promise<AsyncIterable<string>>
Overrides
Defined in
packages/llamaindex/src/synthesizers/builders.ts:250
getResponse(query, stream)
getResponse(
query,stream?):Promise<string>
Get the response from a query and a list of text chunks.
Parameters
• query: ResponseBuilderQuery
• stream?: false
Returns
Promise<string>
Overrides
Defined in
packages/llamaindex/src/synthesizers/builders.ts:254
updatePrompts()
updatePrompts(
prompts):void
Parameters
• prompts: PromptsRecord
Returns
void
Inherited from
Defined in
packages/core/dist/prompts/index.d.ts:59
validatePrompts()
validatePrompts(
promptsDict,moduleDict):void
Parameters
• promptsDict: PromptsRecord
• moduleDict: ModuleRecord
Returns
void
Inherited from
Defined in
packages/core/dist/prompts/index.d.ts:57