const searchEmbed = new SearchEmbed(document.getElementById('ts-embed'), {
frameParams: {
width: '100%',
height: '100%',
},
dataSources: ['<%=datasourceGUID%>'],
enableSearchAssist: true,
},
});Enable Search Assist
Table of Contents
The Search Assist feature provides sample scenarios of searching data from a Worksheet. Your application users can use this feature to familiarize themselves with the search experience and get the answers they need.
To enable the Search Assist walkthrough on an embedded instance, the following steps are required:
-
Enable Search Assist in the Visual Embed SDK
-
Configure Search Assist questions and answers (Requires
Can manage dataprivilege and edit access to a worksheet)
Enable Search Assist in the SDK🔗
To enable Search Assist, set the enableSearchAssist parameter to true. The following example shows how to enable Search Assist in the SearchEmbed SDK.
Configure Search Assist content🔗
By default, the Sample Retail system Worksheet includes a Search Assist lesson with a predefined set of questions and instructions to guide your application users.
To provide Search Assist walkthrough to your users with your own data, you must create a Search Assist lesson on your Worksheet. ThoughtSpot provides sample question templates, using which you can create your own Search Assist content. Any ThoughtSpot user with Can manage data privilege and edit access to the Worksheet can configure a Search Assist lesson. For more information about configuring a sample search lesson, see Search Assist Coach.
How to use Search Assist🔗
Search Assist walks you through simple search scenarios, using data from the Search Assist lesson created for a Worksheet. If Search Assist is enabled, and your Worksheet has the Search Assist queries configured, the embedded Search page allows you to try sample search scenarios.
For example, if you are searching data from the Sample Retail Worksheet, the initial example asks What were Sales by Product in this year? and Search Assist guides you to select sales and press Enter on your keyboard. The search then returns the Answer as a table, demonstrating your total sales.
Similarly, you can add keywords, such as product and this year to your search and press Enter to get an Answer with the total sales data for each product in the current year.
Feature limitations🔗
-
Search Assist is available on instances that have ThoughtSpot Search functionality embedded using
SearchEmbedorAppEmbedSDK library. -
Sample search queries and search experience walkthrough are available to users only if a Search Assist lesson is configured at the data source level.
-
Search Assist lessons can be configured only on worksheets.
-
To configure a Search Assist lesson on a Worksheet, make sure you have embedded the ThoughtSpot Data tab in your host app.