These settings are used for configuring Jarvis chat Modules in Chatterbox.
Whether the module is enabled for data flow. Defaults to true.
Whether the module is enabled for query flow. Defaults to true.
Blacklisted queries for the module.
No Additional ItemsMust be at least 1 characters long
Used to break ties between answers of different modules. Defaults to 0.
Stop words applied at the module level.
No Additional ItemsMust be at least 1 characters long
Optional sorry message to display if there is an intent present without answers.
Title primitive element.
No Additional PropertiesThe type of this element.
Specific value:"title"
Title content.
Must be at least 1 characters long
Subtitle primitive element.
No Additional PropertiesThe type of this element.
Specific value:"subtitle"
Subtitle content.
Must be at least 1 characters long
Text primitive element.
No Additional PropertiesThe type of this element.
Specific value:"text"
Text content.
Must be at least 1 characters long
Image primitive element.
No Additional PropertiesThe type of this element.
Specific value:"image"
Image element metadata.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See <code>scalpel.messages.url.ContentTypeMixin</code> for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAudio primitive element.
No Additional PropertiesThe type of this element.
Specific value:"audio"
Audio element metadata.
URL to the audio file.
Preview image of audio. Defaults to a generic audio icon.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See <code>scalpel.messages.url.ContentTypeMixin</code> for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectVideo primitive element.
No Additional PropertiesThe type of this element.
Specific value:"video"
Video element metadata.
URL to the video file.
Preview image of video. Defaults to first frame of video.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See <code>scalpel.messages.url.ContentTypeMixin</code> for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectWhether to auto play video in preview view. Defaults to false.
Additional Properties of any type are allowed.
Type: objectAttachment primitive element.
No Additional PropertiesThe type of this element.
Specific value:"attachment"
Attachment element metadata.
No Additional PropertiesURL to the attachment file.
Must match regular expression:^((https|s3|gs|file)\:\/\/|\$)
Filename for attachment. This is useful when the filename cannot be inferred from the URL.
Must be at least 1 characters long
The MIME type of the attachment. This is guessed from the extension of the filename followed by the url. See <code>scalpel.messages.url.ContentTypeMixin</code> for content type guessing logic.
Must be at least 1 characters long
Preview image of attachment. Defaults to first frame of attachment.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See <code>scalpel.messages.url.ContentTypeMixin</code> for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectEinstein-specific metadata for this attachment
Einstein Document UID for attachment.
Must be at least 1 characters long
Button action primitive element.
No Additional PropertiesThe type of this element.
Specific value:"button"
Quick reply primitive element.
No Additional PropertiesThe type of this element.
Specific value:"quick_reply"
Quick reply element metadata.
Metadata to describe the visual aspect of a quick reply.
Display text.
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectMetadata to describe actions that are taken when a UI element is triggered (e.g., tapped, clicked, etc).
Same definition as actionableLocation request primitive element.
No Additional PropertiesThe type of this element.
Specific value:"location_request"
Location request element metadata.
No Additional PropertiesPrompt for the user when requesting for location.
Must be at least 1 characters long
Location request primitive element.
No Additional PropertiesThe type of this element.
Specific value:"location_response"
Location response element metadata.
No Additional PropertiesLocation latitude.
Location longitude.
Name of the location.
Must be at least 1 characters long
Human-readable address of the location.
Must be at least 1 characters long
Container types wrap around other primitive types.
Quick replies container element.
No Additional PropertiesThe type of this element.
Specific value:"quick_replies"
Array of quick replys.
Must contain a minimum of 1 items
Must contain a maximum of 16 items
Sections are container types for up to at most 3 elements. These are most likely to be used for rich messages that include media, paragraphs, and actions.
No Additional PropertiesThe type of this element.
Specific value:"sections"
An array of section elements.
Must contain a minimum of 1 items
Must contain a maximum of 5 items
Paragraphs container element.
No Additional PropertiesThe type of this element.
Specific value:"paragraphs"
An array of paragraph elements.
Must contain a minimum of 1 items
Must contain a maximum of 3 items
When specified, the message / carousel item can be favorited on the frontend.
No Additional PropertiesTitle to show in the favorites menu.
Must be at least 1 characters long
URL to favorite item. This could be an internal botmd:// link or an external link.
Must be at least 1 characters long
This is used with botmd://hospital/jarvisQuery links using uids. If frontend decides to cache the content of this favorite message, it should be refreshed against the backend after the expiry.
Actions container element.
No Additional PropertiesThe type of this element.
Specific value:"actions"
An array of action elements.
Must contain a minimum of 1 items
Must contain a maximum of 8 items
When specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteWhen specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteCarousel container element.
No Additional PropertiesThe type of this element.
Specific value:"carousel"
Carousel element metadata.
Must contain a minimum of 1 items
Must contain a maximum of 10 items
Container types wrap around other primitive types. These types are used in carousels.
Sections are container types for up to at most 3 elements. These are most likely to be used for rich messages that include media, paragraphs, and actions.
Same definition as SectionsApplication payload message.
No Additional PropertiesThe type of this element.
Specific value:"application_payload"
Application payload element metadata.
No Additional PropertiesApplication origin of the data payload
Must be at least 1 characters long
Arbitrary payload to be used by application. Can be any JSON object.
Additional Properties of any type are allowed.
Type: objectThis is a high level representation of MIME emails.
No Additional PropertiesThe type of this element.
Specific value:"email"
Email element metadata.
A short string identifying the topic of the message (RFC 2822).
Must be at least 1 characters long
The main body of the email in plain text.
The main body of the email in HTML.
Must be at least 1 characters long
Attachments to the email.
Must contain a minimum of 1 items
An empty message with no content whatsoever.
No Additional PropertiesThe type of this element.
Specific value:"empty"
Used to support more than 1 message (eg. Text and Quick Reply)
No Additional Items