Enumeration MessageResponseTypes

The set of possible message types in a response from IBM watsonx Assistant.

Enumeration Members

AUDIO: "audio"

Displays an audio clip to the user using an audio player.

BUTTON: "button"

Displays a button that can either send a message back to the backend, open a url, or throw a client side event.

CARD: "card"

Displays a card that can contain other response types.

CAROUSEL: "carousel"

Displays a carousel of cards that can contain other response types.

CONNECT_TO_AGENT: "connect_to_agent"

Indicates that the conversation should be escalated to a human agent and offers that opportunity to the user.

DATE: "date"

Asks the user to provide a date. This may result in a date picker being presented to the user.

GRID: "grid"

Ability to layout response types inside a grid.

IFRAME: "iframe"

Displays the contents of an iframe to the user.

IMAGE: "image"

Displays an image to the user.

INLINE_ERROR: "inline_error"

Displays a general error message to the user and include developer info to be logged and to debug.

OPTION: "option"

A response that requests the user choose an option from a list. The list of options may be presented as a list of buttons or it may be from a drop-down.

PAUSE: "pause"

Indicates that the chat should display a pause at this point in the conversation before displaying additional items.

TABLE: "table"

Displays a table of data to the user.

TEXT: "text"

Represents a basic text response. The given text may contain rich content such as markdown.

USER_DEFINED: "user_defined"

A user defined response will be displayed according to custom logic in the client.

VIDEO: "video"

Displays a video to the user using a video player.

MMNEPVFCICPMFPCPTTAAATR