@thoughtspot/visual-embed-sdk 1.38.0-alpha.1 → 1.38.1

package/src/embed/conversation.ts

@@ -1,10 +1,10 @@
 import isUndefined from 'lodash/isUndefined';
 import { ERROR_MESSAGE } from '../errors';
-import { ViewConfig, Param } from '../types';
+import { Param, BaseViewConfig } from '../types';
 import { TsEmbed } from './ts-embed';
 import { getQueryParamString } from '../utils';
 
-/**
+/** 
  * Configuration for search options
  */
 export interface SearchOptions {
@@ -18,9 +18,9 @@ export interface SearchOptions {
  * The configuration for the embedded spotterEmbed options.
  * @group Embed components
  */
-export interface SpotterEmbedViewConfig extends ViewConfig {
+export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
     /**
-     * The ID of the worksheet to use for the conversation.
+     * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
      */
     worksheetId: string;
     /**
@@ -30,10 +30,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
     /**
      * disableSourceSelection : Disables data source selection
      * but still display the selected data source.
+     * 
+     * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
      * const embed = new SpotterEmbed('#tsEmbed', {
-     *    ... // other options
+     *    ... //other embed view config
      *    disableSourceSelection : true,
      * })
      * ```
@@ -42,10 +44,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
     disableSourceSelection?: boolean;
     /**
      * hideSourceSelection : Hide data source selection
+     * 
+     * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
      * const embed = new SpotterEmbed('#tsEmbed', {
-     *    ... // other options
+     *    ... //other embed view config
      *    hideSourceSelection : true,
      * })
      * ```
@@ -54,12 +58,15 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
     hideSourceSelection?: boolean;
     /**
      * Flag to control Data panel experience
+     * 
+     * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
      * @default false
      * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.4.0.cl
      * @example
      * ```js
-     * const embed = new AppEmbed('#tsEmbed', {
-     *    ... // other options
+     * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
      *    dataPanelV2: true,
      * })
      * ```
@@ -69,10 +76,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
      * showSpotterLimitations : show limitation text
      * of the spotter underneath the chat input.
      * default is false.
+     * 
+     * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
      * const embed = new SpotterEmbed('#tsEmbed', {
-     *    ... // other options
+     *    ... //other embed view config
      *    showSpotterLimitations : true,
      * })
      * ```
@@ -82,10 +91,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
     /**
      * hideSampleQuestions : Hide sample questions on
      * the initial screen of the conversation.
+     * 
+     * Supported embed types: `SpotterEmbed`
      * @example
      * ```js
      * const embed = new SpotterEmbed('#tsEmbed', {
-     *    ... // other options
+     *    ... //other embed view config
      *    hideSampleQuestions : true,
      * })
      * ```
@@ -96,7 +107,7 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
 
 /**
  * The configuration for the embedded spotterEmbed options.
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
  * Use {@link SpotterEmbedViewConfig} instead
  * @group Embed components
  */
@@ -183,7 +194,7 @@ export class SpotterEmbed extends TsEmbed {
 
 /**
  * Embed ThoughtSpot AI Conversation.
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
  * Use {@link SpotterEmbed} instead
  * @group Embed components
  * @example

package/src/embed/liveboard.spec.ts

@@ -142,6 +142,21 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
+    test('should set isLiveboardStylingAndGroupingEnabled to true in url', async () => {
+        const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+            isLiveboardStylingAndGroupingEnabled: true,
+            ...defaultViewConfig,
+            liveboardId,
+        } as LiveboardViewConfig);
+        liveboardEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}&isLiveboardStylingAndGroupingEnabled=true${prefixParams}#/embed/viz/${liveboardId}`,
+            );
+        });
+    });
+
     test('should set visible actions as empty array', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             visibleActions: [],

package/src/embed/liveboard.ts

@@ -17,7 +17,9 @@ import {
     RuntimeFilter,
     DOMSelector,
     HostEvent,
-    ViewConfig,
+    SearchLiveboardCommonViewConfig as LiveboardOtherViewConfig,
+    BaseViewConfig,
+    LiveboardAppEmbedViewConfig,
 } from '../types';
 import { getQueryParamString, isUndefined } from '../utils';
 import { getAuthPromise } from './base';
@@ -31,11 +33,7 @@ import { logger } from '../utils/logger';
  * The configuration for the embedded Liveboard or visualization page view.
  * @group Embed components
  */
-export interface LiveboardViewConfig
-    extends Omit<
-        ViewConfig,
-        'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'
-    > {
+export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewConfig, LiveboardAppEmbedViewConfig {
     /**
      * If set to true, the embedded object container dynamically resizes
      * according to the height of the Liveboard.
@@ -48,6 +46,8 @@ export interface LiveboardViewConfig
      * incrementally as users scroll the page to view the charts and tables.
      *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
+     * 
+     * Supported embed types: `LiveboardEmbed`
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -61,6 +61,8 @@ export interface LiveboardViewConfig
      * This is the minimum height(in pixels) for a full-height Liveboard.
      * Setting this height helps resolve issues with empty Liveboards and
      * other screens navigable from a Liveboard.
+     * 
+     * Supported embed types: `LiveboardEmbed`
      * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      * @default 500
      * @example
@@ -78,7 +80,7 @@ export interface LiveboardViewConfig
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#tsEmbed', {
-     *    ... // other options
+     *    ... //other embed view config
      *    enableVizTransformations:true,
      * })
      * ```
@@ -88,11 +90,13 @@ export interface LiveboardViewConfig
     /**
      * The Liveboard to display in the embedded view.
      * Use either liveboardId or pinboardId to reference the Liveboard to embed.
+     * 
+     * Supported embed types: `LiveboardEmbed`
      * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... //other embed view config
      *    liveboardId:id of liveboard,
      * })
      */
@@ -104,11 +108,13 @@ export interface LiveboardViewConfig
     pinboardId?: string;
     /**
      * The visualization within the Liveboard to display.
+     * 
+     * Supported embed types: `LiveboardEmbed`
      * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... //other embed view config
      *    vizId:'430496d6-6903-4601-937e-2c691821af3c',
      * })
      * ```
@@ -117,11 +123,13 @@ export interface LiveboardViewConfig
     /**
      * If set to true, all filter chips from a
      * Liveboard page will be read-only (no X buttons)
+     * 
+     * Supported embed types: `LiveboardEmbed`
      * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... //other embed view config
      *    preventLiveboardFilterRemoval:true,
      * })
      * ```
@@ -131,11 +139,13 @@ export interface LiveboardViewConfig
      * Array of visualization IDs which should be visible when the Liveboard
      * renders. This can be changed by triggering the `SetVisibleVizs`
      * event.
+     * 
+     * Supported embed types: `LiveboardEmbed`
      * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... //other embed view config
      *    visibleVizs: [
      *       '430496d6-6903-4601-937e-2c691821af3c',
      *       'f547ec54-2a37-4516-a222-2b06719af726'
@@ -151,11 +161,13 @@ export interface LiveboardViewConfig
     /**
      * Render embedded Liveboards and visualizations in the
      * new Liveboard experience mode.
+     * 
+     * Supported embed types: `LiveboardEmbed`
      * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... //other embed view config
      *    liveboardV2:true,
      * })
      * ```
@@ -164,10 +176,12 @@ export interface LiveboardViewConfig
     /**
      * Set a Liveboard tab as an active tab.
      * Specify the tab ID.
+     * 
+     * Supported embed types: `LiveboardEmbed`
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#tsEmbed', {
-     *    ... // other options
+     *    ... //other embed view config
      *    activeTabId:'id-1234',
      * })
      * ```
@@ -176,96 +190,18 @@ export interface LiveboardViewConfig
     activeTabId?: string;
     /**
      * Show or hide the tab panel of the embedded Liveboard.
+     * 
+     * Supported embed types: `LiveboardEmbed`
      * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... //other embed view config
      *    hideTabPanel:true,
      * })
      * ```
      */
     hideTabPanel?: boolean;
-    /**
-     * Show or hide the Liveboard header.
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
-     * @default false
-     * @example
-     * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   ... // other liveboard view config
-     *   hideLiveboardHeader:true,
-     * });
-     * ```
-     */
-    hideLiveboardHeader?: boolean;
-    /**
-     * Show or hide the Liveboard title.
-     * @default false
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
-     * @example
-     * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
-     *    showLiveboardTitle:true,
-     * })
-     * ```
-     */
-    showLiveboardTitle?: boolean;
-    /**
-     * Show or hide the Liveboard description.
-     * @default false
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
-     * @example
-     * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
-     *    showLiveboardDescription:true,
-     * })
-     * ```
-     */
-    showLiveboardDescription?: boolean;
-    /**
-     * Control the position and visibility of
-     * the Liveboard header as the users scroll down the
-     * embedded Liveboard page.
-     * @example
-     * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   ... // other Liveboard view config
-     *   isLiveboardHeaderSticky: true,
-     * });
-     * ```
-     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
-     */
-    isLiveboardHeaderSticky?: boolean;
-    /**
-     * enable or disable ask sage
-     * @default false
-     * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
-     * @example
-     * ```js
-     * const embed = new SearchEmbed('#tsEmbed', {
-     *    ... // other options
-     *    enableAskSage:true,
-     * })
-     * ```
-     */
-    enableAskSage?: boolean;
-    /**
-     * This flag is used to enable the 2 column layout on a Liveboard
-     * @type {boolean}
-     * @default false
-     * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
-     * @example
-     * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
-     *    enable2ColumnLayout: true,
-     * })
-     * ```
-     */
-    enable2ColumnLayout?: boolean;
     /**
      * Show a preview image of the visualization before the visualization loads.
      * Only works for visualizations embeds with a viz id.
@@ -275,9 +211,11 @@ export interface LiveboardViewConfig
      *
      * Since, this will show preview images, be careful that it may show
      * undesired data to the user when using row level security.
+     * 
+     * Supported embed types: `LiveboardEmbed`
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
+     * const embed = new LiveboardEmbed('#tsEmbed', {
      *   liveboardId: 'liveboard-id',
      *   vizId: 'viz-id',
      *   showPreviewLoader: true,
@@ -287,75 +225,16 @@ export interface LiveboardViewConfig
      * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
      */
     showPreviewLoader?: boolean;
-    /**
-     * Enables or disables the compact header feature on a Liveboard.
-     * Compact Liveboard header is turned off by default on Liveboards in
-     * ThoughtSpot Embedded apps.
-     *
-     * @type {boolean}
-     * @default false
-     * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
-     * @example
-     * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
-     *    isLiveboardCompactHeaderEnabled: true,
-     * })
-     * ```
-     */
-    isLiveboardCompactHeaderEnabled?: boolean;
-    /**
-     * This flag is used to show/hide verified icon in the Liveboard compact header
-     * @type {boolean}
-     * @default true
-     * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
-     * @example
-     * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
-     *    showLiveboardVerifiedBadge: true,
-     * })
-     * ```
-     */
-    showLiveboardVerifiedBadge?: boolean;
-    /**
-     * This flag is used to show/hide the re-verify banner
-     * in Liveboard compact header
-     * @type {boolean}
-     * @default true
-     * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
-     * @example
-     * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
-     *    showLiveboardReverifyBanner: true,
-     * })
-     * ```
-     */
-    showLiveboardReverifyBanner?: boolean;
-    /**
-     * This flag is used to enable/disable hide irrelevant filters in a Liveboard tab
-     * @type {boolean}
-     * @default false
-     * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
-     * @example
-     * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
-     *    hideIrrelevantChipsInLiveboardTabs: true,
-     * })
-     * ```
-     */
-    hideIrrelevantChipsInLiveboardTabs?: boolean;
-
     /**
      * The Liveboard to run on regular intervals to fetch the cdw token.
+     * 
+     * Supported embed types: `LiveboardEmbed`  
      * @hidden
      * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... //other embed view config
      *    oAuthPollingInterval: value in milliseconds,
      * })
      */
@@ -363,12 +242,14 @@ export interface LiveboardViewConfig
 
     /**
      * The Liveboard is set to force a token fetch during the initial load.
+     * 
+     * Supported embed types: `LiveboardEmbed`
      * @hidden
      * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... //other embed view config
      *    isForceRedirect: false,
      * })
      */
@@ -378,10 +259,12 @@ export interface LiveboardViewConfig
      * The source connection ID for authentication.
      * @hidden
      * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
+     * 
+     * Supported embed types: `LiveboardEmbed`
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... //other embed view config
      *    dataSourceId: '',
      * })
      */
@@ -390,18 +273,75 @@ export interface LiveboardViewConfig
     /**
      * This flag is for show/hide checkboxes for include or exclude
      * cover page and filters in the Liveboard PDF.
-     * @type {boolean}
-     * @default true
+     * 
+     * Supported embed types: `LiveboardEmbed`
      * @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
+     * @default true
+     * Supported embed types: `LiveboardEmbed`
      * @example
      * ```js
-     * const embed = new LiveboardEmbed('#embed-container', {
-     *    ... // other options
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... //other embed view config
      *    coverAndFilterOptionInPDF: false,
      * })
      * ```
      */
     coverAndFilterOptionInPDF?: boolean;
+    /**
+     * The list of tab IDs to hide from the embedded.
+     * This Tabs will be hidden from their respective LBs.
+     * Use this to hide an tabID.
+     * 
+     * Supported embed types: `LiveboardEmbed`
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *   hiddenTabs: [
+     *    '430496d6-6903-4601-937e-2c691821af3c',
+     *    'f547ec54-2a37-4516-a222-2b06719af726'
+     *   ]
+     * });
+     * ```
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
+     */
+    hiddenTabs?: string[];
+    /**
+     * The list of tab IDs to show in the embedded Liveboard.
+     * Only the tabs specified in the array will be shown in the Liveboard.
+     *
+     * Use either `visibleTabs` or `hiddenTabs`.
+     * 
+     * Supported embed types: `LiveboardEmbed`
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *    visibleTabs: [
+     *       '430496d6-6903-4601-937e-2c691821af3c',
+     *       'f547ec54-2a37-4516-a222-2b06719af726'
+     *     ]
+     * })
+     * ```
+     */
+    visibleTabs?: string[];
+    /**
+     * This flag is used to enable/disable the styling and grouping in a Liveboard
+     * 
+     * Supported embed types: `LiveboardEmbed`, `AppEmbed`
+     * @type {boolean}
+     * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    isLiveboardStylingAndGroupingEnabled: true,
+     * })
+     * ```
+     */
+    isLiveboardStylingAndGroupingEnabled?: boolean;
 }
 
 /**
@@ -472,6 +412,7 @@ export class LiveboardEmbed extends V1Embed {
             isForceRedirect,
             dataSourceId,
             coverAndFilterOptionInPDF,
+            isLiveboardStylingAndGroupingEnabled,
         } = this.viewConfig;
 
         const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval
@@ -534,6 +475,10 @@ export class LiveboardEmbed extends V1Embed {
             params[Param.CoverAndFilterOptionInPDF] = coverAndFilterOptionInPDF;
         }
 
+        if (isLiveboardStylingAndGroupingEnabled !== undefined) {
+            params[Param.IsLiveboardStylingAndGroupingEnabled] = isLiveboardStylingAndGroupingEnabled;
+        }
+
         params[Param.LiveboardHeaderSticky] = isLiveboardHeaderSticky;
         params[Param.LiveboardHeaderV2] = isLiveboardCompactHeaderEnabled;
         params[Param.ShowLiveboardVerifiedBadge] = showLiveboardVerifiedBadge;

package/src/embed/sage.ts

@@ -6,7 +6,7 @@
  * @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
  */
 
-import { DOMSelector, Param, ViewConfig } from '../types';
+import { DOMSelector, Param, BaseViewConfig, SearchLiveboardCommonViewConfig } from '../types';
 import { getQueryParamString } from '../utils';
 import { V1Embed } from './ts-embed';
 
@@ -31,13 +31,12 @@ export interface SearchOptions {
  * The configuration attributes for the embedded Natural language search view. Based on
  * GPT and LLM.
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
+ * 
+ * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
  * @group Embed components
  */
 export interface SageViewConfig
-    extends Omit<
-        ViewConfig,
-        'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'
-    > {
+    extends SearchLiveboardCommonViewConfig, Omit<BaseViewConfig, 'primaryAction' | 'runtimeFilters' | 'runtimeParameters' | 'excludeRuntimeFiltersfromURL' | 'excludeRuntimeParametersfromURL'> {
     /**
      * If set to true, a list of Liveboard and Answers related
      * to the natural language search will be shown below the
@@ -95,7 +94,16 @@ export interface SageViewConfig
      * Show or hide sample questions.
      * The sample questions are autogenerated based on the worksheet
      * selected for the search operation.
+     * 
+     * Supported embed types: `SageEmbed`
      * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
+     * @example
+     * ```js
+     * const embed = new SageEmbed('#tsEmbed', {
+     *    ... //other embed view config
+     *    hideSampleQuestions : true,
+     * })
+     * ```
      */
     hideSampleQuestions?: boolean;
     /**
@@ -112,6 +120,8 @@ export interface SageViewConfig
      * If it is executed, the focus is placed on the results.
      * If it’s not executed, the focus is placed at the end of
      * the token string in the search bar.
+     * 
+     * Supported embed types: `SageEmbed`
      * @example
      * ```js
      * searchOptions: {
@@ -126,6 +136,8 @@ export interface SageViewConfig
 /**
  * Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
+ * 
+ * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
  * @group Embed components
  */
 export class SageEmbed extends V1Embed {