Skip to main content

TemplatedResponseOutput

Stentor API Reference

Stentor API Reference / stentor-response/src / TemplatedResponseOutput

Interface: TemplatedResponseOutput<T>

Defined in: packages/stentor-response/src/TemplatedResponseOutput.ts:6

A response object which contains all the necessary information to communicate a particular response for multiple surfaces.

Note: We may want to change this to SimpleResponse and then have multiple levels of this object to also account for cards, lists, etc.

Extends​

Type Parameters​

T​

T

Properties​

ssml?​

optional ssml?: string

Defined in: packages/stentor-models/lib/Response/ResponseOutput.d.ts:16

The SSML

Inherited from​

ResponseOutput.ssml

textToSpeech?​

optional textToSpeech?: string

Defined in: packages/stentor-models/lib/Response/ResponseOutput.d.ts:22

Text to speech

Deprecated​

Do not use, instead use both ssml and displayText

Inherited from​

ResponseOutput.textToSpeech

displayText?​

optional displayText?: string

Defined in: packages/stentor-models/lib/Response/ResponseOutput.d.ts:26

Used only display/chat capable surfaces

Inherited from​

ResponseOutput.displayText

html?​

optional html?: string

Defined in: packages/stentor-models/lib/Response/ResponseOutput.d.ts:34

Beta

Sanitized HTML, suitable for displaying within a web environment.

This is typically generated from the displayText based on markdown found within.

Inherited from​

ResponseOutput.html

suggestions?​

optional suggestions?: SuggestionTypes[]

Defined in: packages/stentor-models/lib/Response/ResponseOutput.d.ts:40

Used where suggestions can be displayed to the user.

Note: These only apply to prompts, not reprompts.

Inherited from​

ResponseOutput.suggestions

defaultLocale?​

optional defaultLocale?: Locale

Defined in: packages/stentor-models/lib/Response/ResponseOutput.d.ts:44

The locale for the response, defaults to "en"

Inherited from​

ResponseOutput.defaultLocale

locales?​

optional locales?: Partial<Record<Locale, Partial<Pick<ResponseOutput, "displayText" | "ssml" | "textToSpeech" | "suggestions">>>>

Defined in: packages/stentor-models/lib/Response/ResponseOutput.d.ts:48

The language code for the response output.

Inherited from​

ResponseOutput.locales

data?​

optional data?: T

Defined in: packages/stentor-response/src/TemplatedResponseOutput.ts:7