Enable/disable field suggestions in the NLQ (Simple Ask)

For the latest version of Sisense like L2024.x to have a field suggestion, you need to enable it.

First of all, what is the field suggestion, as illustrated by the picture below, if you want to get the revenue not for all Brands, but just for the brand APPLES. You type "revenue for APPL" and get the field suggestion.

ALT text: A screenshot of a user interface showing a dropdown menu labeled "Widget" with options such as "Duplicate," "Delete," "Export," and "Simply Ask (NLQ)." Arrows highlight "Simply Ask (NLQ)" and "Modify NLQ Model" options within the menu. On the right, a panel labeled "Filters" displays an option to "Include all" under the "Brand" section.

To enable this feature, you can do it in 2 ways.

1. Via REST API

Go to Admin - REST API - 1.0 - nlq
Find - POST /nlq/nlqAdvancedMode

Press the button Try it out and after this Execute button

After this, go to the dashboard, you should republish it

After this, you should see the suggestions.

2. Changing the NLQ Model

Go to simply ask and click on ‘Modify NLQ Model’.

Look for the column we want to set the index to true and save it.

Go to the dashboard, you should republish it.

After this, our field suggestion should work perfectly.

Why do we republish the dashboard after the changes, please check the article - Simply Ask (NLQ) Not Showing New Fields After Enabling

Update

For the versions L2024.2.x go to Admin - System Management - Configuration - 5 clicks on the logo - Ai-Integration - SimplyAsk

and disable option - Hide Table Names

May the force be with you

OleksandrB

Posted 1 year ago·Last reply 1 year ago

2 comments

OleksandrB

OP1 year ago

In order for NLQ (Simple Ask) in Sisense version L2024.x to have field suggestions, you need to enable it.

First of all, what is the field suggestion? As illustrated by the picture below, if you don't want to get the revenue for all Brands, just for the brand APPLES, You type "revenue for APPL" and get the field suggestion.

Screenshot of a data query interface with a search bar at the top where the text 'revenue for APPL' is entered. Below the search bar, a suggestion labeled 'APPLES' appears. The central area of the screen features a magnifying glass icon with a plus symbol, along with a prompt that reads, 'Ask any questions about your dashboard data in the search field above.' On the left side, a partially visible list shows brand names in a table format, starting with 'ABC' and including other brand names like 'Adbananor WorldWide' and 'Ademegistor Inc.' The 'Run' button is grayed out in the top right corner.

To enable this feature, you can do in 2 ways.

1. Via REST API

Go to Admin - REST API - 1.0 - nlq
Find - POST /nlq/nlqAdvancedMode

Screenshot of an API documentation interface for the POST /nlq/nlqAdvancedMode endpoint, which enables or disables the NLQ Advanced Mode. The description explains that this action can only be called by system or admin users. Setting enabled=false will remove indexing and synonyms from all NLQ specs and delete live schedulers. Parameters include 'authorization' (a required string for the user's API token) and 'params' (an object with an 'enabled' status set to true or false). A JSON example displays { 'enabled': true }. A red 'Cancel' button is shown on the right side.

Press button Try it out and after this Execute button

Screenshot of an API documentation interface for the POST /nlq/nlqAdvancedMode endpoint, which enables or disables NLQ Advanced Mode. The description explains that this action can only be called by system or admin users. Setting enabled=false will remove indexing and synonyms from all NLQ specs, and delete live schedulers. The parameters section includes 'authorization' (a required string for the user's API token) and 'params' (an object with an 'enabled' status set to true or false). An example JSON displays { 'enabled': true }. Below this is a dropdown to select the 'Parameter content type' (set to 'application/json') and an optional 'x-tenant-id' field. A red 'Cancel' button is on the right, and a large blue 'Execute' button is at the bottom. Red arrows point to the 'Cancel' and 'Execute' buttons.

After this, go to the dashboard, you should republish it

Screenshot of the 'Email reporting settings' popup in a dashboard application for 'Sample ECommerce.' The popup allows users to enter names, email addresses, groups, or tenants to set up email reporting. The recipient list includes 'Autotest' with an email partially obscured, set as the Owner with notifications turned off. At the bottom, links for 'Subscribe All,' 'Unsubscribe All,' and options for users to change subscription settings are available, along with a 'Dashboard URL' field with a URL partially redacted. A yellow 'Save' button is highlighted, with a 'Cancel' button next to it. Red arrows point to the 'Save' button and a 'Share' icon in the top right of the main dashboard interface.

After this you should see the suggestions.

2. Changing the NLQ Model

Go to simply ask and click on ‘Modify NLQ Model’.

Screenshot of a dashboard interface showing a dropdown menu opened from the options icon (three dots) near the top. The menu includes options like Duplicate, Delete, Export, Simply Ask (NLQ), Download, Columns, Edit Script, Embed code, Dashboard Settings, and Exploration Paths. The 'Simply Ask (NLQ)' option is highlighted, with a submenu showing options for 'Disable Simply Ask,' 'Disable Filters,' and 'Modify NLQ Model.' Red arrows point to the 'Simply Ask (NLQ)' menu item and the 'Modify NLQ Model' option within the submenu. On the right, there is a 'Filters' panel showing a filter labeled 'Brand' with an 'Include all' option.

Look for the column we want to set index to true and save it.

Screenshot of the 'Modify Simply Ask Model' interface displaying a JSON script editor. The JSON code specifies data configuration details, including tables like 'Brand' and 'Commerce,' with properties for each column such as 'name,' 'type,' 'aliases,' 'indexed,' 'applySynonyms,' and 'autoCreated.' There is also a 'formula' section with context details, referencing columns like 'Revenue' from the 'Commerce' table and aggregating it as 'Total Revenue.' At the top right, there is a 'Copy' button, and at the bottom, options for 'Restore to default,' 'Cancel,' and 'Update' are visible.

Go to the dashboard, you should republish it.

After this our field suggestion should work perfectly.

Why we republish the dashboard after the changes, please check article - Simply Ask (NLQ) Not Showing New Fields After Enabling

Simply Ask Sisense AI to Generate Personalized Insights!

DRay

·1 year ago

Thank you OleksandrB. This is a great KB doc, and has been selected as the KB doc of the week!