Skip to main content

Interface: BaseSynthesizer

A BaseSynthesizer is used to generate a response from a query and a list of nodes.

Extends

Methods

_getPromptModules()

abstract protected _getPromptModules(): ModuleRecord

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

Defined in

packages/core/dist/prompts/index.d.ts:69


_getPrompts()

abstract protected _getPrompts(): PromptsRecord

Returns

PromptsRecord

Inherited from

PromptMixin._getPrompts

Defined in

packages/core/dist/prompts/index.d.ts:60


_updatePrompts()

abstract protected _updatePrompts(prompts): void

Parameters

prompts: PromptsRecord

Returns

void

Inherited from

PromptMixin._updatePrompts

Defined in

packages/core/dist/prompts/index.d.ts:61


getPrompts()

getPrompts(): PromptsRecord

Returns

PromptsRecord

Inherited from

PromptMixin.getPrompts

Defined in

packages/core/dist/prompts/index.d.ts:58


synthesize()

synthesize(query, stream)

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

Parameters

query: SynthesizeQuery

stream: true

Returns

Promise<AsyncIterable<EngineResponse, any, any>>

Defined in

packages/llamaindex/src/synthesizers/types.ts:15

synthesize(query, stream)

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

Parameters

query: SynthesizeQuery

stream?: false

Returns

Promise<EngineResponse>

Defined in

packages/llamaindex/src/synthesizers/types.ts:19


updatePrompts()

updatePrompts(prompts): void

Parameters

prompts: PromptsRecord

Returns

void

Inherited from

PromptMixin.updatePrompts

Defined in

packages/core/dist/prompts/index.d.ts:59


validatePrompts()

validatePrompts(promptsDict, moduleDict): void

Parameters

promptsDict: PromptsRecord

moduleDict: ModuleRecord

Returns

void

Inherited from

PromptMixin.validatePrompts

Defined in

packages/core/dist/prompts/index.d.ts:57