Class: MultiModalResponseSynthesizer

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

Hierarchy

• PromptMixin

  ↳ MultiModalResponseSynthesizer

Implements

• BaseSynthesizer

Constructors

constructor

• new MultiModalResponseSynthesizer(«destructured»?): MultiModalResponseSynthesizer

Parameters

Name	Type
«destructured»	Partial<MultiModalResponseSynthesizer>

Returns

MultiModalResponseSynthesizer

Overrides

PromptMixin.constructor

Defined in

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

Properties

metadataMode

• metadataMode: MetadataMode

Defined in

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

---

serviceContext

• Optional serviceContext: ServiceContext

Defined in

packages/core/src/synthesizers/MultiModalResponseSynthesizer.ts:21

---

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/MultiModalResponseSynthesizer.ts:23

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
textQATemplate	(__namedParameters: { context: undefined | string = ""; query: undefined | string = "" }) => string

Overrides

PromptMixin._getPrompts

Defined in

packages/core/src/synthesizers/MultiModalResponseSynthesizer.ts:37

---

_updatePrompts

▸ _updatePrompts(promptsDict): void

Parameters

Name	Type
promptsDict	Object
promptsDict.textQATemplate	(__namedParameters: { context: undefined | string = ""; query: undefined | string = "" }) => string

Returns

void

Overrides

PromptMixin._updatePrompts

Defined in

packages/core/src/synthesizers/MultiModalResponseSynthesizer.ts:43

---

getPrompts

▸ getPrompts(): PromptsDict

Returns all prompts from the mixin and its modules

Returns

PromptsDict

Inherited from

PromptMixin.getPrompts

Defined in

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

---

synthesize

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

Parameters

Name	Type
params	SynthesizeParamsStreaming

Returns

Promise<AsyncIterable<Response>>

Implementation of

BaseSynthesizer.synthesize

Defined in

packages/core/src/synthesizers/MultiModalResponseSynthesizer.ts:51

▸ synthesize(params): Promise<Response>

Parameters

Name	Type
params	SynthesizeParamsNonStreaming

Returns

Promise<Response>

Implementation of

BaseSynthesizer.synthesize

Defined in

packages/core/src/synthesizers/MultiModalResponseSynthesizer.ts:54

---

updatePrompts

▸ updatePrompts(promptsDict): void

Updates the prompts in the mixin and its modules

Parameters

Name	Type
promptsDict	PromptsDict

Returns

void

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

Inherited from

PromptMixin.validatePrompts

Defined in

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