BaseSynthesizer

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

Extends

• PromptMixin

Extended by

• MultiModal
• Refine
• TreeSummarize

Constructors

Constructor

protected new BaseSynthesizer(options): BaseSynthesizer

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

Parameters

options

Partial<BaseSynthesizerOptions>

Returns

BaseSynthesizer

Overrides

PromptMixin.constructor

Properties

llm

llm: LLM

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

---

promptHelper

promptHelper: PromptHelper

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

Methods

validatePrompts()

validatePrompts(promptsDict, moduleDict): void

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

Parameters

promptsDict

PromptsRecord

moduleDict

ModuleRecord

Returns

void

Inherited from

PromptMixin.validatePrompts

---

getPrompts()

getPrompts(): PromptsRecord

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

Returns

PromptsRecord

Inherited from

PromptMixin.getPrompts

---

updatePrompts()

updatePrompts(prompts): void

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

Parameters

prompts

PromptsRecord

Returns

void

Inherited from

PromptMixin.updatePrompts

---

_getPrompts()

abstract protected _getPrompts(): PromptsRecord

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

Returns

PromptsRecord

Inherited from

PromptMixin._getPrompts

---

_updatePrompts()

abstract protected _updatePrompts(prompts): void

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

Parameters

prompts

PromptsRecord

Returns

void

Inherited from

PromptMixin._updatePrompts

---

_getPromptModules()

abstract protected _getPromptModules(): ModuleRecord

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

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

Inherited from

PromptMixin._getPromptModules

---

getResponse()

abstract protected getResponse(query, textChunks, stream): Promise<EngineResponse | AsyncIterable<EngineResponse, any, any>>

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

Parameters

query

MessageContent

textChunks

NodeWithScore<Metadata>[]

stream

boolean

Returns

Promise<EngineResponse | AsyncIterable<EngineResponse, any, any>>

---

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

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>