SpotterVizConfig

Table of Contents

Index
Properties

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

Configuration for the SpotterViz interface shown on the Liveboard. Supported embed types: AppEmbed, LiveboardEmbed

const embed = new AppEmbed('#embed-container', {
   ... // other options,
   spotterViz: {
       brandName: 'MyBrand',
       brandHeadline: 'Hi, there! I\'m',
       description: 'Ask questions about your data',
       inputChatPlaceholder: 'Ask a question...',
       hideStarterPrompts: false,
       customStarterPrompts: [
           { id: '1', displayText: 'Top products', fullPrompt: 'What are the top products by revenue?' }
       ],
       // The options below require SDK: 1.51.0
       loaderHeadline: 'Crunching the numbers...',
       loaderTips: [
           { label: 'Tip', text: 'try asking about revenue by region' },
           { label: 'Tip', text: 'use natural language' },
       ],
       liveboardBrandName: 'Reports',
       spotterBrandName: 'Analyst',
       insightTileBrandName: 'Insight card',
       insightTileViewPlanLabel: 'View plan',
       insightTileLoaderText: 'Generating insight',
   },
})

Index🔗

Properties🔗

brandHeadline🔗

brandHeadline: string Optional

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

Custom headline text shown before the brand name in the SpotterViz interface. Replaces the default greeting prefix (e.g. "Hi, there! I’m").

default : ''

brandName🔗

brandName: string Optional

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

Rename the default "SpotterViz" label shown in the SpotterViz interface with a custom brand name.

default : ''

customStarterPrompts🔗

customStarterPrompts: SpotterVizStarterPrompt[] Optional

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

Overrides the starter prompts with a custom list. Each entry must match the SpotterVizStarterPrompt shape. Has no effect when hideStarterPrompts is true.

description🔗

description: string Optional

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

Custom description text shown in the SpotterViz interface. Replaces the default SpotterViz description.

fileUploadEnabled🔗

fileUploadEnabled: boolean Optional

Version : SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl

Set to false to hide the file upload feature in the SpotterViz chat input on a cluster where the feature is available.

default : true

fileUploadFileTypes🔗

fileUploadFileTypes: string[] Optional

Version : SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl

Restricts the allowed file types for SpotterViz file upload to a subset of the types SpotterViz supports, e.g. ['csv', 'pdf']. Entries are file extensions (with or without the leading dot); types SpotterViz does not support are ignored, as are empty lists.

hideStarterPrompts🔗

hideStarterPrompts: boolean Optional

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

Hides the starter prompts section entirely in the SpotterViz interface. When set to true, the starter prompts are not displayed.

default : false

inputChatPlaceholder🔗

inputChatPlaceholder: string Optional

Version : SDK: 1.50.0 | ThoughtSpot Cloud: 26.7.0.cl

Custom placeholder text for the chat input in the SpotterViz interface. Replaces the default chat input placeholder text.

insightTileBrandName🔗

insightTileBrandName: string Optional

Version : SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl

Custom term used to replace "Insight tile" in the UI and in the agent’s responses.

default : ''

insightTileLoaderText🔗

insightTileLoaderText: string Optional

Version : SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl

Custom loader text shown on the insight tile.

insightTileViewPlanLabel🔗

insightTileViewPlanLabel: string Optional

Version : SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl

Custom term used to replace "View plan" in the insight tile menu.

liveboardBrandName🔗

liveboardBrandName: string Optional

Version : SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl

Custom term used to replace "Liveboard" in the agent’s responses.

default : ''

loaderHeadline🔗

loaderHeadline: string Optional

Version : SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl

Custom headline text shown in the SpotterViz loading state. Replaces the default loading headline.

loaderTips🔗

loaderTips: SpotterVizLoaderTip[] Optional

Version : SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl

Custom tips shown in the SpotterViz loading state. Replaces the default loading tips with the provided list.

spotterBrandName🔗

spotterBrandName: string Optional

Version : SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl

Custom term used to replace "Spotter" in the agent’s responses.

default : ''