From 7a053447108c551a941e60f0645c67a32a9b8ede Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Wed, 23 Apr 2025 11:46:09 +0530 Subject: [PATCH 01/74] doc change --- typedocConverter.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/typedocConverter.json b/typedocConverter.json index ce6f4a701..04404ac38 100644 --- a/typedocConverter.json +++ b/typedocConverter.json @@ -1,4 +1,4 @@ { - "branch": "main", - "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/{branch}/static/typedoc/typedoc.json" + "branch": "SCAL-246794", + "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/SCAL-246794/static/typedoc/typedoc.json" } From d2a96b78391b36ea4234077b63e810a11fde391d Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Thu, 24 Apr 2025 14:14:32 +0530 Subject: [PATCH 02/74] Renamed ConversationEmbed --- modules/ROOT/pages/embed-spotter.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/embed-spotter.adoc b/modules/ROOT/pages/embed-spotter.adoc index 12d9f7f20..0f6ced747 100644 --- a/modules/ROOT/pages/embed-spotter.adoc +++ b/modules/ROOT/pages/embed-spotter.adoc @@ -85,7 +85,7 @@ init({ }); ---- -== Create an instance of ConversationEmbed object +== Create an instance of SpotterEmbed object Create an instance of the `ConversationEmbed` object and specify the data source ID. Optionally, you can specify the search query string to generate a chart or table at load time. From c4632fc44f27b8f5e7ae1a0295a93b7da687182f Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Thu, 24 Apr 2025 14:37:00 +0530 Subject: [PATCH 03/74] spotter rename --- gatsby-config.js | 2 +- scripts/Converter/index.ts | 4 ++-- typedocConverter.json | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/gatsby-config.js b/gatsby-config.js index 166faf087..af230e15c 100644 --- a/gatsby-config.js +++ b/gatsby-config.js @@ -168,7 +168,7 @@ module.exports = { options: { name: 'htmlFiles', remote: 'https://github.com/thoughtspot/visual-embed-sdk.git', - branch: 'main', + branch: 'renameSpotter', patterns: 'static/typedoc/**', }, __key: 'htmlFiles', diff --git a/scripts/Converter/index.ts b/scripts/Converter/index.ts index 955ad1be6..6ea6e681f 100644 --- a/scripts/Converter/index.ts +++ b/scripts/Converter/index.ts @@ -1009,9 +1009,9 @@ const getFile = async (filePath: string) => { const main = async () => { const defaultCliOptions = { - branch: 'main', + branch: 'renameSpotter', typeDocFilePath: - 'https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/{branch}/static/typedoc/typedoc.json', + 'https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/renameSpotter/static/typedoc/typedoc.json', }; const cliKeys = Object.keys(defaultCliOptions).map((key) => ({ diff --git a/typedocConverter.json b/typedocConverter.json index ce6f4a701..3c065390f 100644 --- a/typedocConverter.json +++ b/typedocConverter.json @@ -1,4 +1,4 @@ { - "branch": "main", - "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/{branch}/static/typedoc/typedoc.json" + "branch": "renameSpotter", + "typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/renameSpotter/static/typedoc/typedoc.json" } From a235252469a794a67ebbadfef20ad6e805d59292 Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Thu, 24 Apr 2025 14:47:21 +0530 Subject: [PATCH 04/74] renamed bodyless conversation --- modules/ROOT/pages/api-changelog.adoc | 4 ++-- modules/ROOT/pages/developer-playground.adoc | 2 +- modules/ROOT/pages/embed-spotter.adoc | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/ROOT/pages/api-changelog.adoc b/modules/ROOT/pages/api-changelog.adoc index d01dc1e0f..9888aaeac 100644 --- a/modules/ROOT/pages/api-changelog.adoc +++ b/modules/ROOT/pages/api-changelog.adoc @@ -105,9 +105,9 @@ For more information, see xref:full-app-customize.adoc#_search_components[Search |==== |[tag greenBackground]#NEW FEATURE# a| You can now embed the following ThoughtSpot Spotter components in your app: -* `ConversationEmbed` + +* `SpotterEmbed` + Embeds Spotter conversation interface in your app -* `BodylessConversation` + +* `SpotterAgentEmbed` + Creates a conversation component without the body, which can be integrated into chatbots or other conversational apps. For more information, see xref:embed-spotter.adoc[Embed Spotter] and xref:spotter-in-custom-chatbot.adoc[Integrate Spotter into your chatbot]. diff --git a/modules/ROOT/pages/developer-playground.adoc b/modules/ROOT/pages/developer-playground.adoc index f21887e96..47bfa6898 100644 --- a/modules/ROOT/pages/developer-playground.adoc +++ b/modules/ROOT/pages/developer-playground.adoc @@ -435,7 +435,7 @@ For more information about the configuration settings and parameters, see the fo * xref:SearchViewConfig.adoc[SearchViewConfig] * xref:SageViewConfig.adoc[SageViewConfig] -* xref:BodylessConversationViewConfig.adoc[BodylessConversationViewConfig] +* xref:SpotterAgentEmbedViewConfig.adoc[SpotterAgentEmbedViewConfig] * xref:LiveboardViewConfig[LiveboardViewConfig] * xref:AppViewConfig.adoc[AppViewConfig] diff --git a/modules/ROOT/pages/embed-spotter.adoc b/modules/ROOT/pages/embed-spotter.adoc index 12d9f7f20..709fba312 100644 --- a/modules/ROOT/pages/embed-spotter.adoc +++ b/modules/ROOT/pages/embed-spotter.adoc @@ -14,7 +14,7 @@ To integrate Spotter capabilities into your application environment, the followi * `ConversationEmbed` + Allows embedding the full Spotter interface with a conversation panel and body. -* `BodylessConversation` + +* `SpotterAgentEmbed` + Allows integrating xref:spotter-in-custom-chatbot.adoc[Spotter capabilities into a chatbot]. Additionally, you can also use xref:spotter-apis.adoc[REST APIs to create a conversation session, ask follow-up questions, and generate Answers]. @@ -138,7 +138,7 @@ Hides sample questions that appear on the default Spotter page. To customize the Spotter interface, use the configuration attributes and properties available for `ConversationEmbed` in the SDK. * link:https://developers.thoughtspot.com/docs/Interface_ConversationViewConfig[ConversationViewConfig] -* link:https://developers.thoughtspot.com/docs/Interface_BodylessConversationViewConfig[BodylessConversationViewConfig] +* link:https://developers.thoughtspot.com/docs/SpotterAgentEmbedViewConfig[SpotterAgentEmbedViewConfig] === Customize style, icons, and text To customize the look and feel of the Spotter page, you can use the `customizations` settings in the SDK. The `customizations` object allows you to add xref:customize-css-styles.adoc[custom CSS definitions], xref:customize-text-strings.adoc[text strings], and xref:customize-icons.adoc[icons]. From dacfc0abfdb6da72716689594366d509e131246b Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Thu, 24 Apr 2025 15:17:45 +0530 Subject: [PATCH 05/74] rename in docs --- modules/ROOT/pages/embed-action-ref.adoc | 50 +++++++++---------- modules/ROOT/pages/embed-spotter.adoc | 24 ++++----- modules/ROOT/pages/embed-ts-react-app.adoc | 20 ++++---- modules/ROOT/pages/sf-integration.adoc | 2 +- .../ROOT/pages/spotter-in-custom-chatbot.adoc | 4 +- .../spotter/spotter-in-custom-chatbot.adoc | 8 +-- 6 files changed, 54 insertions(+), 54 deletions(-) diff --git a/modules/ROOT/pages/embed-action-ref.adoc b/modules/ROOT/pages/embed-action-ref.adoc index d69ab41a2..49042ceb1 100644 --- a/modules/ROOT/pages/embed-action-ref.adoc +++ b/modules/ROOT/pages/embed-action-ref.adoc @@ -241,24 +241,24 @@ The following action IDs are available for the Spotter component: [options='header'] |===== |Action string in SDK| Required SDK library|Action label in the UI -|xref:Action.adoc#_previewdataspotter[`Action.PreviewDataSpotter`] | `ConversationEmbed` + +|xref:Action.adoc#_previewdataspotter[`Action.PreviewDataSpotter`] | `SpotterEmbed` + `AppEmbed` |*Preview data* action on the Spotter conversation panel. Shows the underlying data used for Spotter queries. -|xref:Action.adoc#_resetspotterchat[`Action.ResetSpotterChat`] |`ConversationEmbed` + +|xref:Action.adoc#_resetspotterchat[`Action.ResetSpotterChat`] |`SpotterEmbed` + `AppEmbed` | *Preview data* action on the Spotter conversation panel. Shows the underlying data used for Spotter queries. -|xref:Action.adoc#_editpreviousprompt[`Action.EditPreviousPrompt`] |`ConversationEmbed` + +|xref:Action.adoc#_editpreviousprompt[`Action.EditPreviousPrompt`] |`SpotterEmbed` + `AppEmbed` | The edit icon on the Spotter prompt panel. Allows editing the prompt sent to Spotter. -|xref:xref:Action.adoc#_deletepreviousprompt[`Action.DeletePreviousPrompt`] |`ConversationEmbed` + +|xref:xref:Action.adoc#_deletepreviousprompt[`Action.DeletePreviousPrompt`] |`SpotterEmbed` + `AppEmbed` | The delete icon on the Spotter prompt panel. Allows deleting the prompt sent to Spotter. -|xref:xref:Action.adoc#_spotterfeedback[`Action.SpotterFeedback`] |`ConversationEmbed` + +|xref:xref:Action.adoc#_spotterfeedback[`Action.SpotterFeedback`] |`SpotterEmbed` + `AppEmbed` | The Spotter feedback widget in the generated Answer. Allows sending feedback about the response received from Spotter. |===== -For information about the action IDs available for Answers generated from Spotter (`ConversationEmbed`), see xref:embed-action-ref#answer-actions[Answers]. +For information about the action IDs available for Answers generated from Spotter (`SpotterEmbed`), see xref:embed-action-ref#answer-actions[Answers]. [#answer-actions] == Answers @@ -268,38 +268,38 @@ The following actions are available on saved Answers and the Answers generated b [options='header'] |===== |Action string in SDK| Required SDK library|Action label in the UI -|xref:Action.adoc#_choosedatasources[`Action.ChooseDataSources`]| `ConversationEmbed` + +|xref:Action.adoc#_choosedatasources[`Action.ChooseDataSources`]| `SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `SearchBarEmbed` + `AppEmbed`|The *Choose sources* option in the Search page and Spotter conversation panel. + Allows selecting data sources to query data. + -|xref:Action.adoc#_addformula[`Action.AddFormula`]| `ConversationEmbed` + +|xref:Action.adoc#_addformula[`Action.AddFormula`]| `SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `SearchBarEmbed` + `AppEmbed`| *Create formula* option on the data panel of an Answer page + Allows adding formulas to a search query. + -|xref:Action.adoc#_addparameter[`Action.AddParameter`]|`ConversationEmbed` + +|xref:Action.adoc#_addparameter[`Action.AddParameter`]|`SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed`| *Add Parameters* option in the data panel on a Search page + Allows adding parameters to an Answer. -|xref:Action.adoc#_answerchartswitcher[`Action.AnswerChartSwitcher`]|`ConversationEmbed` + +|xref:Action.adoc#_answerchartswitcher[`Action.AnswerChartSwitcher`]|`SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed` | Chart toggle icon + Allows switching to the table or chart mode. -|xref:Action.adoc#_edit[`Action.Edit`]| `ConversationEmbed` + +|xref:Action.adoc#_edit[`Action.Edit`]| `SpotterEmbed` + `AppEmbed` | *Edit* action on charts and tables generated from a Spotter query. Opens a table or chart in the edit mode. -|xref:Action.adoc#_pin[`Action.Pin`]| `ConversationEmbed` + +|xref:Action.adoc#_pin[`Action.Pin`]| `SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed` | *Pin* action on the visualization generated from a Spotter query. Allows adding a visualization generated from Spotter to a Liveboard. -|xref:Action.adoc#_save[`Action.Save`]| `ConversationEmbed` + +|xref:Action.adoc#_save[`Action.Save`]| `SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed` | *Save* action on the visualization generated from a Spotter query @@ -320,7 +320,7 @@ Allows generating SpotIQ analyses. Available as a primary button and contextual `AppEmbed`|*Share* + Allows you to share an Answer with another user or group. -|xref:Action.adoc#_querydetailsbuttons[`Action.QueryDetailsButtons`]| `ConversationEmbed` + +|xref:Action.adoc#_querydetailsbuttons[`Action.QueryDetailsButtons`]| `SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed` @@ -329,7 +329,7 @@ a|The *Query visualizer* and *Query SQL* buttons in *Query details* on the Answe * The *Query visualizer* button displays the tables and filters used in a search query. + * The *Query SQL* button displays the SQL statements used in a search query to fetch data. + -|xref:Action.adoc#_download[`Action.Download`]|`ConversationEmbed` + +|xref:Action.adoc#_download[`Action.Download`]|`SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed` a|*Download* + @@ -345,28 +345,28 @@ If you are using Visual Embed SDK version 1.21.0 or later to embed Liveboard, Se ** `Action.DownloadAsXlsx` + ** `Action.DownloadAsPng` -|xref:Action.adoc#_downloadascsv[`Action.DownloadAsCsv`]|`ConversationEmbed` + +|xref:Action.adoc#_downloadascsv[`Action.DownloadAsCsv`]|`SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed` |*Download* > *CSV* + Downloads the answer data in the CSV file format. -|xref:Action.adoc#_downloadasxlsx[`Action.DownloadAsXLSX`]|`ConversationEmbed` + +|xref:Action.adoc#_downloadasxlsx[`Action.DownloadAsXLSX`]|`SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed` | *Download* > *XLSX* + Downloads the answer data in the XLSX file format. -|xref:Action.adoc#_downloadaspdf[`Action.DownloadAsPdf`]|`ConversationEmbed` + +|xref:Action.adoc#_downloadaspdf[`Action.DownloadAsPdf`]|`SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed` |*Download* > *PDF* + Downloads the answer data as a PDF file. Available only for tables. -|xref:Action.adoc#_downloadaspng[`Action.DownloadAsPng`]|`ConversationEmbed` + +|xref:Action.adoc#_downloadaspng[`Action.DownloadAsPng`]|`SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed` |*Download* > *PNG* + Downloads the chart as a PNG file. Available only for charts. -|xref:Action.adoc#_showunderlyingdata[`Action.ShowUnderlyingData`]|`ConversationEmbed` + +|xref:Action.adoc#_showunderlyingdata[`Action.ShowUnderlyingData`]|`SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed`|*Show underlying data* + @@ -385,7 +385,7 @@ Allows creating a sync to send data to external business apps such as Slack, Sal `SearchEmbed` + `AppEmbed`| The *Manage pipelines* action in the **More** actions menu. + Allows managing data sync pipelines to external business apps set as sync destinations in ThoughtSpot. -|xref:Action.adoc#_exporttml[`Action.ExportTML`]|`ConversationEmbed` + +|xref:Action.adoc#_exporttml[`Action.ExportTML`]|`SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed` | *Export TML* + @@ -405,24 +405,24 @@ The following actions are available in the contextual menu of an Answer: [options='header'] |===== |Action string in SDK| Required SDK library|Action label in the UI -|xref:Action.adoc#_drillexclude[`Action.DrillExclude`]|`ConversationEmbed` + +|xref:Action.adoc#_drillexclude[`Action.DrillExclude`]|`SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed`|*Exclude* + Allows you to exclude a specific data point when drilling down on an Answer. -|xref:Action.adoc#_drillinclude[`Action.DrillInclude`]|`ConversationEmbed` + +|xref:Action.adoc#_drillinclude[`Action.DrillInclude`]|`SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed` |*Include* + Allows you to include a specific data point during drill down on an Answer. -|xref:Action.adoc#_drilldown[`Action.DrillDown`]|`ConversationEmbed` + +|xref:Action.adoc#_drilldown[`Action.DrillDown`]|`SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed` |*Drill down* + Allows you to drill down the data for additional details and granular information. Available as a contextual menu action. -|xref:Action.adoc#_copytoclipboard[`Action.CopyToClipboard`] |`ConversationEmbed` + +|xref:Action.adoc#_copytoclipboard[`Action.CopyToClipboard`] |`SpotterEmbed` + `SageEmbed` + `SearchEmbed` + `AppEmbed`|*Copy to clipboard* + diff --git a/modules/ROOT/pages/embed-spotter.adoc b/modules/ROOT/pages/embed-spotter.adoc index 709fba312..253fee871 100644 --- a/modules/ROOT/pages/embed-spotter.adoc +++ b/modules/ROOT/pages/embed-spotter.adoc @@ -4,7 +4,7 @@ :page-title: Embed Spotter :page-pageid: embed-spotter -:page-description: You can use the ConversationEmbed SDK library to embed Conversational analytics experience in your application. +:page-description: You can use the SpotterEmbed SDK library to embed Conversational analytics experience in your application. ThoughtSpot supports Natural Language Search queries and AI-generated Answers. With ThoughtSpot Spotter, this experience is further enhanced to a full conversational interface that users can interact with, ask follow-up questions, and get insights. @@ -12,7 +12,7 @@ Visual Embed SDK offers several options to seamlessly embed conversational analy To integrate Spotter capabilities into your application environment, the following components are available: -* `ConversationEmbed` + +* `SpotterEmbed` + Allows embedding the full Spotter interface with a conversation panel and body. * `SpotterAgentEmbed` + Allows integrating xref:spotter-in-custom-chatbot.adoc[Spotter capabilities into a chatbot]. @@ -23,7 +23,7 @@ This article describes how to embed Spotter with a conversation panel and body i === Spotter components -The `ConversationEmbed` package adds the following components to your embedding application: +The `SpotterEmbed` package adds the following components to your embedding application: * A conversation panel and prompt button to interact with Spotter. * The data source selector that allows application users to select a data source for Spotter analysis. @@ -41,13 +41,13 @@ Before you begin, check the following: == Import the SDK package -Import the `ConversationEmbed` SDK library to your application environment: +Import the `SpotterEmbed` SDK library to your application environment: **npm** [source,JavaScript] ---- import { - ConversationEmbed, + SpotterEmbed, AuthType, init, prefetch, @@ -60,7 +60,7 @@ from '@thoughtspot/visual-embed-sdk'; ----