SpotterChatViewConfig

Table of Contents

Index
Properties

Version : SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl

Configuration for customizing Spotter chat UI branding.

Index🔗

Properties🔗

enableStarterPrompts🔗

enableStarterPrompts: boolean Optional

Version : SDK: 1.51.0 | ThoughtSpot: 26.8.0.cl

Enables starter prompts in the Spotter chat interface.

Either this or starterPrompts.enable turns the surface on, so it stays on while this is true even if starterPrompts.enable is false.

Supported embed types: SpotterEmbed, LiveboardEmbed, AppEmbed

default : false

hideToolResponseCardBranding🔗

hideToolResponseCardBranding: boolean Optional

Hides the ThoughtSpot logo/icon in tool response cards. The branding label prefix is controlled separately via toolResponseCardBrandingLabel. External MCP tool branding is not affected.

default : false

openSpotterOnLiveboardByDefault🔗

openSpotterOnLiveboardByDefault: boolean Optional

Version : SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl

Opens the Spotter chat panel when the Liveboard loads.

Supported embed types: LiveboardEmbed, AppEmbed

default : true

const embed = new LiveboardEmbed('#tsEmbed', {
   liveboardId: 'liveboard-id',
   spotterChatConfig: {
       openSpotterOnLiveboardByDefault: false,
   },
})

spotterFileUploadEnabled🔗

spotterFileUploadEnabled: boolean Optional

Version : SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl

Enables file upload in the Spotter chat interface.

Supported embed types: SpotterEmbed, LiveboardEmbed, AppEmbed

default : false

spotterFileUploadFileTypes🔗

spotterFileUploadFileTypes: SpotterFileUploadFileTypes Optional

Version : SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl

Restricts the allowed file types for Spotter file upload.

Supported embed types: SpotterEmbed, LiveboardEmbed, AppEmbed

starterPrompts🔗

starterPrompts: StarterPromptsConfig Optional

Version : SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl

Customizes the labels and questions of the Spotter starter prompts. Individual pills are hidden or shown with hiddenActions / visibleActions using Action.QuickSearchPill, Action.DeepAnalysisPill and Action.DataLiteracyPill.

Supported embed types: SpotterEmbed, LiveboardEmbed, AppEmbed

const embed = new SpotterEmbed('#tsEmbed', {
   worksheetId: 'worksheet-id',
   hiddenActions: [Action.DeepAnalysisPill],
   spotterChatConfig: {
       starterPrompts: {
           enable: true,
           quick: {
               label: 'Quick questions',
               questions: [
                   { label: 'Top products', prompt: 'What are the top products by revenue?' },
               ],
           },
           previewData: { label: 'Explore your data' },
       },
   },
})

toolResponseCardBrandingLabel🔗

toolResponseCardBrandingLabel: string Optional

Custom label to replace the "ThoughtSpot" prefix in tool response cards. Set to an empty string '' to hide the prefix entirely. Works independently of hideToolResponseCardBranding. External MCP tool branding is not affected.