Class: Refine
A response builder that uses the query to ask the LLM generate a better response using multiple text chunks.
Extends
Extended by
Implements
Constructors
new Refine()
new Refine(
serviceContext?,textQATemplate?,refineTemplate?):Refine
Parameters
• serviceContext?: ServiceContext
• textQATemplate?
• refineTemplate?
Returns
Overrides
Defined in
packages/llamaindex/src/synthesizers/builders.ts:81
Properties
llm
llm:
LLM<object,object>
Defined in
packages/llamaindex/src/synthesizers/builders.ts:76
promptHelper
promptHelper:
PromptHelper
Defined in
packages/llamaindex/src/synthesizers/builders.ts:77
refineTemplate()
refineTemplate: (
__namedParameters) =>string
Parameters
• __namedParameters
• __namedParameters.context: undefined | string = ""
• __namedParameters.existingAnswer: undefined | string = ""
• __namedParameters.query: undefined | string = ""
Returns
string
Defined in
packages/llamaindex/src/synthesizers/builders.ts:79
textQATemplate()
textQATemplate: (
__namedParameters) =>string
Parameters
• __namedParameters
• __namedParameters.context: undefined | string = ""
• __namedParameters.query: undefined | string = ""
Returns
string
Defined in
packages/llamaindex/src/synthesizers/builders.ts:78
Methods
_getPromptModules()
protected_getPromptModules():Record<string,any>
Returns
Record<string, any>
Inherited from
Defined in
packages/llamaindex/src/prompts/Mixin.ts:83
_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
Overrides
Defined in
packages/llamaindex/src/synthesizers/builders.ts:94
_updatePrompts()
protected_updatePrompts(prompts):void
Parameters
• prompts
• prompts.refineTemplate
• prompts.textQATemplate
Returns
void
Overrides
Defined in
packages/llamaindex/src/synthesizers/builders.ts:104
complete()
complete(
params):Promise<string|AsyncIterable<string>>
Parameters
• params
• params.prompt: string
• params.stream: boolean
Returns
Promise<string | AsyncIterable<string>>
Defined in
packages/llamaindex/src/synthesizers/builders.ts:212
getPrompts()
getPrompts():
PromptsDict
Returns all prompts from the mixin and its modules
Returns
PromptsDict
Implementation of
Inherited from
Defined in
packages/llamaindex/src/prompts/Mixin.ts:27
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>>
Implementation of
Defined in
packages/llamaindex/src/synthesizers/builders.ts:117
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>
Implementation of
Defined in
packages/llamaindex/src/synthesizers/builders.ts:121
updatePrompts()
updatePrompts(
promptsDict):void
Updates the prompts in the mixin and its modules
Parameters
• promptsDict: PromptsDict
Returns
void
Implementation of
Inherited from
Defined in
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
Implementation of
ResponseBuilder.validatePrompts