SCAL-208508 : Update desc (#189)

Author: sastaachar

src/types.ts

@@ -3349,15 +3349,28 @@ export enum HostEvent {
     /**
      * Get the Answer session for a Search or
      * Liveboard visualization.
+     * 
+     * Note: This event is not typically used directly. Instead, use the 
+     * `getAnswerService()` method on the embed instance to get an AnswerService 
+     * object that provides a more convenient interface for working with answers.
+     * 
      * @example
      * ```js
+     * // Preferred way to get an AnswerService
+     * const service = await embed.getAnswerService();
+     * 
+     * // Alternative direct usage (not recommended)
      * const {session} = await embed.trigger(
      *  HostEvent.GetAnswerSession, {
      *      vizId: '123', // For Liveboard Visualization.
      *  })
      * ```
      * @example
      * ```js
+     * // Preferred way to get an AnswerService
+     * const service = await embed.getAnswerService();
+     * 
+     * // Alternative direct usage (not recommended)
      * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
      * ```
      * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw

src/utils/graphql/answerService/answerService.ts

@@ -26,29 +26,49 @@ export interface UnderlyingDataPoint {
 }
 
 /**
- * Class representing the answer service provided with the
- * custom action payload. This service could be used to run
- * graphql queries in the context of the answer on which the
- * custom action was triggered.
+ * AnswerService provides a simple way to work with ThoughtSpot Answers.
+ * 
+ * This service allows you to interact with ThoughtSpot Answers programmatically,
+ * making it easy to customize visualizations, filter data, and extract insights
+ * directly from your application.
+ * 
+ * You can use this service to:
+ * - Add or remove columns from Answers (`addColumns`, `removeColumns`, `addColumnsByName`)
+ * - Apply filters to Answers (`addFilter`)
+ * - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`, `fetchCSVBlob`, `fetchPNGBlob`)
+ * - Get data for specific points in visualizations (`getUnderlyingDataForPoint`)
+ * - Run custom queries (`executeQuery`)
+ * - Add visualizations to liveboards (`addDisplayedVizToLiveboard`)
+ * 
  * @example
  * ```js
- *  embed.on(EmbedEvent.CustomAction, e => {
- *     const underlying = await e.answerService.getUnderlyingDataForPoint([
- *       'col name 1'
- *     ]);
- *     const data = await underlying.fetchData(0, 100);
- *  })
+ * // Get the answer service
+ * embed.on(EmbedEvent.Data, async (e) => {
+ *     const service = await embed.getAnswerService();
+ *     
+ *     // Add columns to the answer
+ *     await service.addColumnsByName(["Sales", "Region"]);
+ *     
+ *     // Get the data
+ *     const data = await service.fetchData();
+ *     console.log(data);
+ * });
  * ```
+ * 
  * @example
  * ```js
- * embed.on(EmbedEvent.Data, async (e) => {
- *     const service = await embed.getAnswerService();
- *     await service.addColumns([
- *         "<column guid>"
+ * // Get data for a point in a visualization
+ * embed.on(EmbedEvent.CustomAction, async (e) => {
+ *     const underlying = await e.answerService.getUnderlyingDataForPoint([
+ *       'Product Name',
+ *       'Sales Amount'
  *     ]);
- *     console.log(await service.fetchData());
+ *     
+ *     const data = await underlying.fetchData(0, 100);
+ *     console.log(data);
  * });
  * ```
+ * 
  * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
  * @group Events
  */