HeavyIQ Guidance

Guidance snippets are hints, tips, formulas or acronym explanations which you can optionally provide to the HeavyIQ language model. They are particularly useful in describing things which are not known to the base model but are important in your particular analytical domain. For example, the acronym TVD can stand for many different things, including “total variation distance” in statistics. But in the Oil and Gas industry, it stands for “true vertical depth.” Similarly, you may have industry or even company-specific KPIs or key performance indicators. These are all good candidates for inclusion as guidance snippets.

When HeavyIQ considers your analytical questions, it consults the guidance snippets as part of the query generation process. So in addition to proactively adding snippets based on domain knowledge up front, you can also add them “ad hoc” to clarify points which appear to be confusing the model. Administrators may wish to periodically review any unsuccessful queries and clarify terminology within them using snippets. This allows the model to learn relevant new information over time.

You can access the Guidance panel by clicking the “Guidance” tab in SQL Notebook. The Guidance panel displays a list of all guidance snippets associated with the current database, and allows superusers to create, edit, or delete snippets.

Guidance snippets can be sorted by oldest or newest updated date from the “Sort by” menu.

Creating Snippets

To create a new snippet, click “Add guidance snippets”.

This will give you an input to enter your snippet text. You can create up to 20 snippets at once by clicking the “+” button to add a text input for each additional snippet. Note that each snippet must be unique, and creation will fail if the content of a snippet is identical to any existing snippet.

Viewing and Editing Existing Snippets

The snippets list shows a truncated preview of each snippet, along with the time it was last updated. From the snippets list, click on an existing snippet to view its full text. From here, superusers can also modify the snippet.

To delete snippets, select the snippets you would like to delete by clicking the checkboxes next to them and click the “Delete” button that appears.

For a short period of time, you can restore the most recently deleted batch of snippets by clicking the “Undo” prompt displayed in the confirmation snackbar that appears.