ResponseOutput

Stentor API Reference

---

Stentor API Reference / stentor-models/src / ResponseOutput

Interface: ResponseOutput

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

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

• Localizable\<LocaleSpecificResponseOutput>

Properties

ssml?

optional ssml: string

Defined in: packages/stentor-models/src/Response/ResponseOutput.ts:20

The SSML

---

textToSpeech?

optional textToSpeech: string

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

Text to speech

Deprecated

Do not use, instead use both ssml and displayText

---

displayText?

optional displayText: string

Defined in: packages/stentor-models/src/Response/ResponseOutput.ts:30

Used only display/chat capable surfaces

---

html?

optional html: string

Defined in: packages/stentor-models/src/Response/ResponseOutput.ts:38

Beta

Sanitized HTML, suitable for displaying within a web environment.

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

---

suggestions?

optional suggestions: SuggestionTypes[]

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

Used where suggestions can be displayed to the user.

Note: These only apply to prompts, not reprompts.

---

defaultLocale?

optional defaultLocale: Locale

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

The locale for the response, defaults to "en"

Overrides

Localizable.defaultLocale

---

locales?

optional locales: Partial\<Record\<Locale, LocaleSpecificResponseOutput>>

Defined in: packages/stentor-models/src/Response/ResponseOutput.ts:52

The language code for the response output.

Overrides

Localizable.locales