USER MANUALS

Assisted Query

This functionality allows the Data Catalog users to generate a query by explaining their needs in their own language. This feature is available from the Assisted query pill.

Note

This feature is only available with the subscription bundle Enterprise Plus. To find out the bundle you have, open the About dialog of Design Studio. See more about this in the section Denodo Platform - Subscription Bundles.

Important

Prior to using this feature, you will need to configure both the LLM configuration API Configuration and the Denodo Assistant Assisted Query Configuration

In this section we will see:

Generating a Query

In this section, the process of generating a query is going to be introduced.

The Natural language query input form to explain what the query has to do

The Natural language query input form to explain what the query has to do.

The Assisted query pill lets you explain your needs in natural language via the Natural language query input. Providing more details not only refines the search results but also elevates the quality of the displayed information. This extends also to the metadata of the view. This data is sent including, among other details, the following:

  1. The name of the view.

  2. The name of the view’s database.

  3. For each field, the following information:

    1. The name of the field.

    2. The logical name of the field if it is configured.

    3. The type of the field.

    4. The source type of the field.

    5. The description of the field.

    6. Information regarding if the field is a primary key.

    7. Information regarding if the field is nullable.

    8. The name and the description of the tags that are assigned to the field.

    9. If the data usage is enabled, data samples of the view are also included.

  4. The description of the view.

  5. The name and the description of the tags that are assigned to the view.

  6. For each direct association, the same information as for the view.

Warning

  • Generating a query will send metadata information to the LLM. Only if the data usage is enabled, data of the view is also going to be processed and sent to the LLM in order to improve the results. Make sure your organization is aware and agrees on this.

  • Data Catalog collects and sends the metadata of Denodo views to the LLM for processing. Only if the data usage is enabled, data of the view is also collected and sent. This metadata includes information such as view names, view descriptions, field names, field descriptions, data types, and relationships.

    If a view contains too much information, some of the view’s information may need to be excluded before being sent to the AI Services to avoid exceeding the token limit supported by the model. Please note that excluding such details may impact the accuracy or completeness of the response provided. In extreme cases this may cause the generation process to stop. When these situations occur a suitable notification will be shown.

Note

The Natural language query input accepts text to a maximum of 1000 characters.

Once the Natural language query input is set, the Ask button will have to be clicked in order to generate the query.

The generated query and its explanation

The Automatically generated query and the Query explanation fields are shown side by side.

The Automatically generated query and the Query explanation fields will be then visible. Once this action is done, the option to open the generated query in the VQL Shell will be available via the Open in VQL Shell button.

Note

The Open in VQL Shell action will append the generated query to whatever VQL you had previously introduced in the VQL Shell. This is done to prevent the loss of information.

Executing the Generated Query

Two options are possible to execute the query depending of the configuration on the execution mode: manual or automatic.

The results of the generated query visible in the **Query result** table at the bottom of the pill

The results of the generated query visible in the Query result table at the bottom of the pill.

Execution with Manual Execution Mode

When the manual execution mode is configured, the Execute button will have to be clicked. Once the query execution has finished, the results will be shown in the Query result table at the bottom of the pill.

Execution with Automatic Execution Mode

When the automatic execution mode is configured, no action is required. When the Ask button is clicked, the generated query will be executed and the results will be shown automatically in the Query result table at the bottom of the pill. Once this action is done, the option to open the generated query in the VQL Shell will be available via the Open in VQL Shell button.

Other Options

Once the query generation process has started you can stop it at any time pressing the Cancel button. You can also clear any result with the Clear all button.

Assisted Query Role

To use the Assisted Query feature the user has to have the data_catalog_assisted_query role. See the Default Roles section for more information.

Data Catalog Assisted Query

Data Catalog Assisted Query role.

Log Assisted Query HTTP information

Data Catalog allows users to see details of the HTTP requests made using the Assisted Query feature.

Amazon Bedrock is set as the LLM provider

If Amazon Bedrock is set as the LLM provider, follow these steps:

  1. Stop the Data Catalog.

  2. Edit the file <DENODO_HOME>/conf/data-catalog/log4j2.xml to set these loggers:

    <!-- Amazon Bedrock HTTP requests logging-->
<Logger name="software.amazon.awssdk.request" level="DEBUG" additivity="false">
<AppenderRef ref="ASSISTED-QUERY"/>
</Logger>
<Logger name="org.apache.http" level="DEBUG" additivity="false">
<AppenderRef ref="ASSISTED-QUERY"/>
</Logger>
<Logger name="org.apache.http.wire" level="DEBUG" additivity="false">
<AppenderRef ref="ASSISTED-QUERY"/>
</Logger>

  3. Start the Data Catalog.

  4. Use the Assisted Query feature.

  5. See the feature debug messages in the file <DENODO_HOME>/logs/vdp-data-catalog/data-catalog-assisted-query.log.

Other LLM providers

If the LLM provider is not Amazon Bedrock, follow these steps:

Add these JVM options to the web container (see section Denodo Platform Configuration):

-Djdk.internal.httpclient.debug=true -Djdk.internal.httpclient.websocket.debug=true -Djdk.httpclient.HttpClient.log=trace

Virtual DataPort Server and the Web Administration Tools Are on the Same Installation

  1. Stop the Virtual DataPort server and the Web Administration Tools.

  2. Edit the file <DENODO_HOME>/conf/vdp/log4j2.xml to set the logger:

    <Logger name="com.denodo.tomcat" level="TRACE" />

  3. Start the Virtual DataPort server.

  4. Wait until the Tomcat log stops writing in <DENODO_HOME>/logs/vdp/vdp.log.

  5. Start the Data Catalog.

  6. Use the Assisted Query feature.

  7. See the feature debug messages in the file <DENODO_HOME>/logs/vdp/vdp.log.

Virtual DataPort Server and the Web Administration Tools Are not on the Same Installation

  1. Stop the Web Administration Tools.

  2. Edit the file <DENODO_HOME>/conf/data-catalog/log4j2.xml to set the logger:

    <Logger name="com.denodo.tomcat" level="TRACE" />

  3. Start the internal Tomcat by means of a command line interface:

    <DENODO_HOME>/resources/apache-tomcat/bin/catalina.{bat|sh} start

  4. Start the Data Catalog by means of the Denodo Platform Control Center.

  5. Use the Assisted Query feature.

  6. See the feature debug messages in the command line.

Note

When the Virtual DataPort Server and the Web Administration Tools are on the same installation you could also use this option, but the first one is simpler.

Add feedback