Refine

Defined in: packages/core/src/response-synthesizers/factory.ts:38

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

Extends

• BaseSynthesizer

Extended by

• CompactAndRefine

Constructors

Constructor

new Refine(options): Refine

Defined in: packages/core/src/response-synthesizers/factory.ts:42

Parameters

options

BaseSynthesizerOptions & object

Returns

Refine

Overrides

BaseSynthesizer.constructor

Properties

llm

llm: LLM

Defined in: packages/core/src/response-synthesizers/base-synthesizer.ts:15

Inherited from

BaseSynthesizer.llm

---

promptHelper

promptHelper: PromptHelper

Defined in: packages/core/src/response-synthesizers/base-synthesizer.ts:16

Inherited from

BaseSynthesizer.promptHelper

---

textQATemplate

textQATemplate: TextQAPrompt

Defined in: packages/core/src/response-synthesizers/factory.ts:39

---

refineTemplate

refineTemplate: RefinePrompt

Defined in: packages/core/src/response-synthesizers/factory.ts:40

Methods

validatePrompts()

validatePrompts(promptsDict, moduleDict): void

Defined in: packages/core/src/prompts/mixin.ts:8

Parameters

promptsDict

PromptsRecord

moduleDict

ModuleRecord

Returns

void

Inherited from

BaseSynthesizer.validatePrompts

---

getPrompts()

getPrompts(): PromptsRecord

Defined in: packages/core/src/prompts/mixin.ts:22

Returns

PromptsRecord

Inherited from

BaseSynthesizer.getPrompts

---

updatePrompts()

updatePrompts(prompts): void

Defined in: packages/core/src/prompts/mixin.ts:39

Parameters

prompts

PromptsRecord

Returns

void

Inherited from

BaseSynthesizer.updatePrompts

---

synthesize()

Call Signature

synthesize(query, stream): Promise<AsyncIterable<EngineResponse, any, any>>

Defined in: packages/core/src/response-synthesizers/base-synthesizer.ts:31

Parameters

query

SynthesizeQuery

stream

true

Returns

Promise<AsyncIterable<EngineResponse, any, any>>

Inherited from

BaseSynthesizer.synthesize

Call Signature

synthesize(query, stream?): Promise<EngineResponse>

Defined in: packages/core/src/response-synthesizers/base-synthesizer.ts:35

Parameters

query

SynthesizeQuery

stream?

false

Returns

Promise<EngineResponse>

Inherited from

BaseSynthesizer.synthesize

---

_getPromptModules()

protected _getPromptModules(): ModuleRecord

Defined in: packages/core/src/response-synthesizers/factory.ts:53

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

ModuleRecord

Overrides

BaseSynthesizer._getPromptModules

---

_getPrompts()

protected _getPrompts(): object

Defined in: packages/core/src/response-synthesizers/factory.ts:57

Returns

object

textQATemplate

textQATemplate: TextQAPrompt

refineTemplate

refineTemplate: RefinePrompt

Overrides

BaseSynthesizer._getPrompts

---

_updatePrompts()

protected _updatePrompts(prompts): void

Defined in: packages/core/src/response-synthesizers/factory.ts:67

Parameters

prompts

textQATemplate

TextQAPrompt

refineTemplate

RefinePrompt

Returns

void

Overrides

BaseSynthesizer._updatePrompts

---

getResponse()

Call Signature

getResponse(query, nodes, stream): Promise<AsyncIterable<EngineResponse, any, any>>

Defined in: packages/core/src/response-synthesizers/factory.ts:80

Parameters

query

MessageContent

nodes

NodeWithScore<Metadata>[]

stream

true

Returns

Promise<AsyncIterable<EngineResponse, any, any>>

Overrides

BaseSynthesizer.getResponse

Call Signature

getResponse(query, nodes, stream): Promise<EngineResponse>

Defined in: packages/core/src/response-synthesizers/factory.ts:85

Parameters

query

MessageContent

nodes

NodeWithScore<Metadata>[]

stream

false

Returns

Promise<EngineResponse>

Overrides

BaseSynthesizer.getResponse

---

complete()

complete(params): Promise<string | AsyncIterable<string, any, any>>

Defined in: packages/core/src/response-synthesizers/factory.ts:199

Parameters

params

prompt

string

stream

boolean

Returns

Promise<string | AsyncIterable<string, any, any>>