Skip to main content

Class: ResponseSynthesizer

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

Extends

Implements

Constructors

new ResponseSynthesizer()

new ResponseSynthesizer(__namedParameters): ResponseSynthesizer

Parameters

__namedParameters= {}

__namedParameters.metadataMode?: MetadataMode= MetadataMode.NONE

__namedParameters.responseBuilder?: ResponseBuilder

__namedParameters.serviceContext?: ServiceContext

Returns

ResponseSynthesizer

Overrides

PromptMixin . constructor

Source

packages/core/src/synthesizers/ResponseSynthesizer.ts:25

Properties

metadataMode

metadataMode: MetadataMode

Source

packages/core/src/synthesizers/ResponseSynthesizer.ts:23


responseBuilder

responseBuilder: ResponseBuilder

Source

packages/core/src/synthesizers/ResponseSynthesizer.ts:22

Methods

_getPromptModules()

_getPromptModules(): object

Returns

object

Overrides

PromptMixin . _getPromptModules

Source

packages/core/src/synthesizers/ResponseSynthesizer.ts:41


_getPrompts()

protected _getPrompts(): object

Returns

object

Overrides

PromptMixin . _getPrompts

Source

packages/core/src/synthesizers/ResponseSynthesizer.ts:45


_updatePrompts()

protected _updatePrompts(promptsDict): void

Parameters

promptsDict

Returns

void

Overrides

PromptMixin . _updatePrompts

Source

packages/core/src/synthesizers/ResponseSynthesizer.ts:52


getPrompts()

getPrompts(): PromptsDict

Returns all prompts from the mixin and its modules

Returns

PromptsDict

Inherited from

PromptMixin . getPrompts

Source

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


synthesize()

synthesize(params)

synthesize(params): Promise<AsyncIterable <Response>>

Parameters

params: SynthesizeParamsStreaming

Returns

Promise<AsyncIterable <Response>>

Implementation of

BaseSynthesizer . synthesize

Source

packages/core/src/synthesizers/ResponseSynthesizer.ts:58

synthesize(params)

synthesize(params): Promise <Response>

Parameters

params: SynthesizeParamsNonStreaming

Returns

Promise <Response>

Implementation of

BaseSynthesizer . synthesize

Source

packages/core/src/synthesizers/ResponseSynthesizer.ts:61


updatePrompts()

updatePrompts(promptsDict): void

Updates the prompts in the mixin and its modules

Parameters

promptsDict: PromptsDict

Returns

void

Inherited from

PromptMixin . updatePrompts

Source

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


validatePrompts()

validatePrompts(promptsDict, moduleDict): void

Validates the prompt keys and module keys

Parameters

promptsDict: PromptsDict

moduleDict: ModuleDict

Returns

void

Inherited from

PromptMixin . validatePrompts

Source

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