Class: Refine
A response builder that uses the query to ask the LLM generate a better response using multiple text chunks.
Hierarchy
-
↳
Refine
Implements
Constructors
constructor
• new Refine(serviceContext
, textQATemplate?
, refineTemplate?
): Refine
Parameters
Name | Type |
---|---|
serviceContext | ServiceContext |
textQATemplate? | (__namedParameters : { context : undefined | string = ""; query : undefined | string = "" }) => string |
refineTemplate? | (__namedParameters : { context : undefined | string = ""; existingAnswer : undefined | string = ""; query : undefined | string = "" }) => string |
Returns
Overrides
Defined in
packages/core/src/synthesizers/builders.ts:83
Properties
llm
• llm: LLM
Defined in
packages/core/src/synthesizers/builders.ts:78
promptHelper
• promptHelper: PromptHelper
Defined in
packages/core/src/synthesizers/builders.ts:79
refineTemplate
• refineTemplate: (__namedParameters
: { context
: undefined
| string
= ""; existingAnswer
: undefined
| string
= ""; query
: undefined
| string
= "" }) => string
Type declaration
▸ («destructured»
): string
Parameters
Name | Type | Default value |
---|---|---|
«destructured» | Object | undefined |
› context | undefined | string | "" |
› existingAnswer | undefined | string | "" |
› query | undefined | string | "" |
Returns
string
Defined in
packages/core/src/synthesizers/builders.ts:81
textQATemplate
• textQATemplate: (__namedParameters
: { context
: undefined
| string
= ""; query
: undefined
| string
= "" }) => string
Type declaration
▸ («destructured»
): string
Parameters
Name | Type | Default value |
---|---|---|
«destructured» | Object | undefined |
› context | undefined | string | "" |
› query | undefined | string | "" |
Returns
string
Defined in
packages/core/src/synthesizers/builders.ts:80
Methods
_getPromptModules
▸ _getPromptModules(): Record
<string
, any
>
Returns
Record
<string
, any
>
Inherited from
Defined in
packages/core/src/prompts/Mixin.ts:82
_getPrompts
▸ _getPrompts(): Object
Returns
Object
Name | Type |
---|---|
refineTemplate | (__namedParameters : { context : undefined | string = ""; existingAnswer : undefined | string = ""; query : undefined | string = "" }) => string |
textQATemplate | (__namedParameters : { context : undefined | string = ""; existingAnswer : undefined | string = ""; query : undefined | string = "" }) => string |
Overrides
Defined in
packages/core/src/synthesizers/builders.ts:96
_updatePrompts
▸ _updatePrompts(prompts
): void
Parameters
Name | Type |
---|---|
prompts | Object |
prompts.refineTemplate | (__namedParameters : { context : undefined | string = ""; existingAnswer : undefined | string = ""; query : undefined | string = "" }) => string |
prompts.textQATemplate | (__namedParameters : { context : undefined | string = ""; existingAnswer : undefined | string = ""; query : undefined | string = "" }) => string |
Returns
void
Overrides
Defined in
packages/core/src/synthesizers/builders.ts:106
complete
▸ complete(params
): Promise
<string
| AsyncIterable
<string
>>
Parameters
Name | Type |
---|---|
params | Object |
params.parentEvent? | Event |
params.prompt | string |
params.stream | boolean |
Returns
Promise
<string
| AsyncIterable
<string
>>
Defined in
packages/core/src/synthesizers/builders.ts:227
getPrompts
▸ getPrompts(): PromptsDict
Returns all prompts from the mixin and its modules
Returns
PromptsDict
Implementation of
Inherited from
Defined in
packages/core/src/prompts/Mixin.ts:27
getResponse
▸ getResponse(params
): Promise
<AsyncIterable
<string
>>
Get the response from a query and a list of text chunks.
Parameters
Name | Type |
---|---|
params | ResponseBuilderParamsStreaming |