Skip to content

Commit bfd4bbd

Browse files
Merge pull request #432 from thoughtspot/main
main release sync
2 parents a3536f2 + 2f28ae2 commit bfd4bbd

14 files changed

Lines changed: 831 additions & 514 deletions
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
= ThoughtSpot AI analytics integration
2+
:toc: true
3+
:toclevels: 3
4+
5+
:page-title: AI integration options
6+
:page-pageid: ai-analytics-integration
7+
:page-description: Learn the different ways to integrate ThoughtSpot analytics and AI experiences into your applications and AI agents, including MCP Server, Spotter Embed, and Spotter APIs.
8+
9+
ThoughtSpot provides several options to bring governed analytics and AI-powered experiences into your applications, AI agents, and workflows.
10+
11+
== AI integration options
12+
13+
The primary ways to integrate ThoughtSpot analytics and AI into your environment are:
14+
15+
* xref:ai-integration-options.adoc#_thoughtspot_mcp_server[ThoughtSpot Model Context Protocol (MCP) Server]
16+
* xref:ai-integration-options.adoc#_embedding_spotter_in_your_app[Embedding Spotter in your app]
17+
* xref:ai-integration-options.adoc#_spotter_rest_apis[Spotter REST APIs]
18+
19+
[NOTE]
20+
====
21+
All options allow using your existing ThoughtSpot data models, Liveboards, Answers, row-level and column-level security, and governance. The main differences are where the UI or conversation layer exists and who orchestrates the analytics workflow.
22+
====
23+
24+
=== ThoughtSpot MCP Server
25+
26+
ThoughtSpot xref:mcp-integration.adoc[MCP Server] exposes governed analytics as MCP tools and resources to AI agents and clients. The MCP Server can be integrated with your MCP client, agent, LLM, or application UI, allowing your users to explore ThoughtSpot's agentic capabilities within the context of your application.
27+
28+
ThoughtSpot recommends using the MCP Server in these scenarios:
29+
30+
* When you want to plug ThoughtSpot into AI agents and clients that already support MCP, such as Claude, ChatGPT, Gemini, IDEs, and custom MCP clients.
31+
* If you are building your own MCP-based chatbot or application, and want to call ThoughtSpot MCP tools behind a custom web experience.
32+
33+
For more information, see the xref:mcp-integration.adoc[MCP Server] documentation.
34+
35+
=== Embedding Spotter in your app
36+
37+
Developers can embed ThoughtSpot's xref:embed-spotter.adoc[conversational UI experience and its agentic capabilities] directly into their applications using the Visual Embed SDK.
38+
39+
If your business requires you to quickly integrate the Spotter experience into your applications and workflows, and provide a native AI search and analysis experience within your app, use this option.
40+
41+
For more information, see the xref:embed-ai-analytics.adoc[Embed AI Search and Analytics] and xref:embed-spotter.adoc[Spotter embed] documentation.
42+
43+
=== Spotter REST APIs
44+
45+
Spotter REST APIs provide programmatic access to Spotter conversation sessions, analytics, and agentic workflows. REST API clients use these APIs to send questions and receive structured answers, charts, or get relevant questions for a specific data model.
46+
47+
ThoughtSpot recommends using Spotter REST APIs in the following scenarios:
48+
49+
* When you want your application, agent, or orchestration logic to interact with ThoughtSpot programmatically, without requiring MCP.
50+
* If you need to integrate ThoughtSpot responses and workflows with other systems.
51+
* For fine-grained control over the user experience.
52+
53+
//* For fine-grained control over data context, query options, and prompt structure, and .
54+
55+
For more information, see the xref:spotter-apis.adoc[Spotter AI API] documentation.
56+
57+
== Additional resources
58+
59+
* For information about MCP, see the link:https://modelcontextprotocol.io[Model Context Protocol specification, window=_blank].
60+
* For information about SDK libraries for embedding, see the link:https://github.com/thoughtspot/visual-embed-sdk[Visual Embed SDK GitHub repository, window=_blank].
61+
* To view Spotter APIs, visit the +++<a href="{{navprefix}}/restV2-playground?apiResourceId=http%2Fgetting-started%2Fintroduction">REST API v2.0 Playground</a>+++ and navigate to the **AI** section.

modules/ROOT/pages/api-changelog.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ Use this enhanced configuration to override ThoughtSpot URLs on hover or when op
6666

6767
[width="100%" cols="1,4"]
6868
|====
69-
|[tag greenBackground]#NEW FEATURE# a|**Spotter enhancements **
69+
|[tag greenBackground]#NEW FEATURE# a| **Spotter enhancements**
7070

71-
You can now embed the Spotter 3 experience in your application and use features such as Auto mode for automatic data model selection, Chat history, and a new chat prompt interface.
71+
You can now embed the Spotter 3 experience in your application and use features such as Auto mode for automatic data model selection, chat history, and a new chat prompt interface.
7272

7373
* To enable the new chat prompt interface, set `updatedSpotterChatPrompt` to `true`.
7474
* To use Auto mode, set the `worksheetId` to `auto_mode`.
@@ -91,7 +91,7 @@ On Spotter embed deployments running version 26.2.0.cl or later, the *Add to Coa
9191

9292
Styling and grouping::
9393

94-
* The `isLiveboardStylingAndGrouping` attribute, used for enabling the Liveboard styling and grouping feature, is now replaced with `isLiveboardMasterpiecesEnabled`. While your existing configuration with the deprecated attribute, `isLiveboardStylingAndGrouping` continues to work, we recommend switching to the new configuration setting.
94+
* The `isLiveboardStylingAndGrouping` attribute, used to enable the Liveboard styling and grouping feature, is now replaced with `isLiveboardMasterpiecesEnabled`. While your existing configuration with the deprecated `isLiveboardStylingAndGrouping` attribute continues to work, we recommend switching to the new configuration setting.
9595
* The following action IDs are now available to show, disable, or hide the grouping menu actions on a Liveboard:
9696
** `Action.MoveToGroup` for the **Move to Group** menu action.
9797
** `Action.MoveOutOfGroup` for the **Move out of Group** menu action.
@@ -105,21 +105,21 @@ For more information, see link:https://docs.thoughtspot.com/cloud/latest/securit
105105
+
106106
The `showMaskedFilterChip` setting is also available in full application embedding.
107107

108-
|[tag greenBackground]#NEW FEATURE# a|**Publishing objects**
108+
|[tag greenBackground]#NEW FEATURE# a| **Publishing objects**
109109

110110
The following action IDs are available for the data publishing menu actions in the *Data workspace* page:
111111

112112
* `Action.Publish` for *Publish*
113-
* `Action.ManagePublishing` for *Manange publishing*
114-
* `Action.Unpublish` foe *Unpublish*
113+
* `Action.ManagePublishing` for *Manage publishing*
114+
* `Action.Unpublish` for *Unpublish*
115115
* `Action.Parameterize` for *Parameterize*
116116
|[tag greenBackground]#NEW FEATURE# a| **Error handling improvements**
117117

118118
To handle errors in the embedding workflows, the SDK includes the following features:
119119

120-
* `ErrorDetailsTypes` enum for categorizing error types, such as `API`, `VALIDATION_ERROR`, `NETWORK` error.
121-
* `EmbedErrorCodes` enum with specific error codes for programmatic error handling
122-
* `EmbedErrorDetailsEvent` interface for structured error event handling
120+
* `ErrorDetailsTypes` enum for categorizing error types, such as `API`, `VALIDATION_ERROR`, and `NETWORK`.
121+
* `EmbedErrorCodes` enum with specific error codes for programmatic error handling.
122+
* `EmbedErrorDetailsEvent` interface for structured error event handling.
123123

124124
For more information, see link:https://developers.thoughtspot.com/docs/Enumeration_EmbedErrorCodes[EmbedErrorCodes] and link:https://developers.thoughtspot.com/docs/Enumeration_ErrorDetailsTypes[ErrorDetailsTypes].
125125
|====
@@ -129,7 +129,7 @@ For more information, see link:https://developers.thoughtspot.com/docs/Enumerati
129129
[width="100%" cols="1,4"]
130130
|====
131131

132-
|[tag redBackground]#DEPRECATED# | ** Use `minimumHeight` instead of `defaultHeight` ** +
132+
|[tag redBackground]#DEPRECATED# | **Use `minimumHeight` instead of `defaultHeight`** +
133133

134134
The `defaultHeight` parameter is deprecated in Visual Embed SDK v1.44.2 and later.
135135
To set the minimum height of the embed container for ThoughtSpot components such as a Liveboard, use the `minimumHeight` attribute instead.
@@ -144,7 +144,7 @@ Allows configuring which API calls to intercept.
144144
* `interceptTimeout` +
145145
Sets the timeout duration for handling interception.
146146
* `isOnBeforeGetVizDataInterceptEnabled` +
147-
When set to true, it enables the use of `EmbedEvent.OnBeforeGetVizDataIntercept` event to emit and intercept search execution calls initiated by the users and implement custom logic or workflow to allow or restrict search execution.
147+
When set to true, it enables use of `EmbedEvent.OnBeforeGetVizDataIntercept` to emit and intercept search execution calls initiated by users and implement custom logic or workflows to allow or restrict search execution.
148148
* `EmbedEvent.ApiIntercept` +
149149
Emits when an API call matching the conditions defined in `interceptUrls` is detected.
150150

@@ -157,7 +157,7 @@ For more information, see xref:api-intercept.adoc[Intercept API calls and search
157157
|====
158158
|[tag greenBackground]#NEW FEATURE# a| *Code-based custom actions*
159159

160-
The following enumerations are available for code based custom actions:
160+
The following enumerations are available for code-based custom actions:
161161

162162
* `CustomActionTarget` +
163163
To define the target object for the custom action, such as on a Liveboard, visualization, Answer, or in Spotter.

modules/ROOT/pages/common/nav.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,10 @@ include::generated/typedoc/CustomSideNav.adoc[]
219219
** link:{{navprefix}}/SpotterCode[SpotterCode for IDEs]
220220
*** link:{{navprefix}}/integrate-SpotterCode[Integrating SpotterCode]
221221
*** link:{{navprefix}}/spottercode-prompting-guide[SpotterCode prompting guide]
222-
** link:{{navprefix}}/mcp-integration[ThoughtSpot MCP server]
222+
** link:{{navprefix}}/ai-analytics-integration[ThoughtSpot AI analytics integration]
223+
*** link:{{navprefix}}/mcp-integration[ThoughtSpot MCP server]
224+
*** link:{{navprefix}}/connect-mcp-server-to-clients[Connecting MCP Server to MCP clients]
225+
*** link:{{navprefix}}/custom-chatbot-integration-mcp[Integrating MCP Server in a custom application or chatbot]
223226

224227
* link:{{navprefix}}/development-and-deployment[Deployment and integration]
225228
** link:{{navprefix}}/development-and-deployment[Development and deployment]

0 commit comments

Comments
 (0)