Class: Refine

A response builder that uses the query to ask the LLM generate a better response using multiple text chunks.

Hierarchy

• PromptMixin

  ↳ Refine

  ↳↳ CompactAndRefine

Implements

• ResponseBuilder

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

Refine

Overrides

PromptMixin.constructor

Defined in

packages/core/src/synthesizers/builders.ts:86

Properties

llm

• llm: LLM

Defined in

packages/core/src/synthesizers/builders.ts:81

---

promptHelper

• promptHelper: PromptHelper

Defined in

packages/core/src/synthesizers/builders.ts:82

---

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:84

---

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:83

Methods

_getPromptModules

▸ _getPromptModules(): Record<string, any>

Returns

Record<string, any>

Inherited from

PromptMixin._getPromptModules

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

PromptMixin._getPrompts

Defined in

packages/core/src/synthesizers/builders.ts:99

---

_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

PromptMixin._updatePrompts

Defined in

packages/core/src/synthesizers/builders.ts:109

---

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:230

---

getPrompts

▸ getPrompts(): PromptsDict

Returns all prompts from the mixin and its modules

Returns

PromptsDict

Implementation of

ResponseBuilder.getPrompts

Inherited from

PromptMixin.getPrompts

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

Returns

Promise<AsyncIterable<string>>

Implementation of

ResponseBuilder.getResponse

Defined in

packages/core/src/synthesizers/builders.ts:122

▸ getResponse(params): Promise<string>

Parameters

Name	Type
params	ResponseBuilderParamsNonStreaming

Returns

Promise<string>

Implementation of

ResponseBuilder.getResponse

Defined in

packages/core/src/synthesizers/builders.ts:125

---

giveResponseSingle

▸ giveResponseSingle(queryStr, textChunk, stream, parentEvent?): Promise<undefined | string | AsyncIterable<string>>

Parameters

Name	Type
queryStr	string
textChunk	string
stream	boolean
parentEvent?	Event

Returns

Promise<undefined | string | AsyncIterable<string>>

Defined in

packages/core/src/synthesizers/builders.ts:163

---

refineResponseSingle

▸ refineResponseSingle(initialReponse, queryStr, textChunk, stream, parentEvent?): Promise<string | AsyncIterable<string>>

Parameters

Name	Type
initialReponse	string
queryStr	string
textChunk	string
stream	boolean
parentEvent?	Event

Returns

Promise<string | AsyncIterable<string>>

Defined in

packages/core/src/synthesizers/builders.ts:201

---

updatePrompts

▸ updatePrompts(promptsDict): void

Updates the prompts in the mixin and its modules

Parameters

Name	Type
promptsDict	PromptsDict

Returns

void

Implementation of

ResponseBuilder.updatePrompts

Inherited from

PromptMixin.updatePrompts

Defined in

packages/core/src/prompts/Mixin.ts:48

---

validatePrompts

▸ validatePrompts(promptsDict, moduleDict): void

Validates the prompt keys and module keys

Parameters

Name	Type
promptsDict	PromptsDict
moduleDict	ModuleDict

Returns

void

Implementation of

ResponseBuilder.validatePrompts

Inherited from

PromptMixin.validatePrompts

Defined in

packages/core/src/prompts/Mixin.ts:10