SQrL

a. SQrL Website

You can use SQrL in the Question and Answer mode on the SQrL website even if you are not a member of any SingleStore Helios organization. SingleStore users on SingleStore Self-Managed deployments who do not have access to the Cloud Portal can also use this platform.

b. Cloud Portal

SQrL is accessible on the Cloud Portal in the following locations:

• On the Cloud Portal homepage, select Ask SQrL. You can also access SQrL from other screens on the Cloud Portal using the floating ? (question) icon. Select Ask SQrL from the list. These options allow you to access SQrL in the Question and Answer mode only.

  Note that the Chat with us option is not the same as using SQrL.

  

• With Notebooks: On the Cloud Portal, under Notebooks, open a notebook. Once the notebook is open, enable the Code with SQrL toggle switch on the upper-right corner. This option allows you to use SQrL in code-only mode.

  

c. SingleStore Documentation

You can access SQrL in the Question and Answer mode from any page in the Documentation site. Select the (SQrL) icon on the side of the page to open the SQrL pane.

a. Question and Answer Mode

In the Question and Answer mode, SQrL answers the user's queries (questions). You can ask questions about learning new features, troubleshooting specific issues, comparing approaches to a specific use case, and more. The answers may include suggestions to related questions and a list of sources from where the response is derived. After you enter your query, select Enter/Return to submit it. To add another line to your query (add a new line), use Shift+Enter or Shift+Return.

You can also provide feedback on SQrL responses to help improve its accuracy. Select Thumbs up for positive responses and Thumbs down for negative responses and provide feedback.

To share a SQrL discussion, select Share. It shares the entire SQrL discussion. When you select Share, a unique URL is generated for the discussion session. Anyone with access to the URL can view the contents of the discussion. You can also copy a specific code snippet or other blocks from the discussion with SQrL without using the Share feature.

Select Clear to clear the current discussion. To stop a SQrL response, select Stop.

b. Code-only Mode

The code-only mode is only available in SingleStore notebooks (on the Cloud Portal). In this mode, SQrL provides code suggestions that can be integrated into your notebooks. To use SQrL in the code-only mode, enable the Code with SQrL toggle switch and enter a query in the Connect with SQrL box. After you enter your query, select Generate to submit your query. Use Enter/Return to add a new line to your query.

In this mode, SQrL does not preview live responses line-by-line. Hence, the response time may seem longer. After SQrL has generated a code snippet, you can either select Add Cell to add it to a new cell at the end of your notebook, or select Add Cell & Run to add it to a new cell and run that cell.

If SQrL is unable to generate a code snippet relative to the query, it returns an error. Select Regenerate to try again, either with the same query or a different query.

c. Code Generator Mode

SQrL Code Generator helps you generate SQL queries based on your prompts, keeping your table schemas in mind. To use Code Generator mode, navigate to SQrL in the Portal and select "Code Generator". Next, you can select which tables are relevant in generating your SQL.

SingleStore does not access any of the personal information in these tables –– it just passes the schema of this table and exposes it to the LLM as context. This ensures that the SQL that is generated understands the relationships and columns between tables and that is more accurate.

Once you have selected your tables, you can ask SQrL multiple questions without having to reselect your tables again. To refresh context and select new tables, close and reopen the window.

Data Collected by SQrL

SingleStore collects and processes data from SQrL to provide the service. SingleStore continuously improves SQrL by leveraging data collected from SQrL to provide more accurate responses to your queries. This data includes prompts and responses, which are always collected, and user engagement metadata (optional). SingleStore retains some of the collected data for analysis and improvements. The collected data is not used to train large language models (LLMs).

SingleStore collects prompts, answers, and user engagement metadata from SQrL as follows:

• Prompts

  A prompt is the contextual information that SQrL gets when a user asks a question/query. Prompts are transmitted in real-time and retained to improve our product and documentation on questions asked by users.

• Responses

  SingleStore retains responses/answers from SQrL to improve the user experience of our product.

• User Engagement Metadata

  When you use SQrL, it collects user engagement data. This data consists of usage information and events generated while interacting with SQrL. These events include, but not limited to: user actions like Thumbs up or Thumbs down, feedback, and feature engagement.

  You can enable or disable user engagement metadata collection within your organization on the Cloud Portal, go to <your_organization> > Settings. Under SQrL Metadata, use the toggle switch to enable or disable metadata collection. Note that data from prompts and responses is always collected.

Sharing Collected Data

SingleStore shares the data collected from the SQrL discussions with the following AI providers (via API):

• OpenAI

• Azure OpenAI

• Anthropic

The data shared with these AI providers is NOT used to train their AI models. For information on privacy policies of each of these providers, refer to the following links:

• API data usage policies - OpenAI

• Data, privacy, and security for Azure OpenAI Service

• Anthropic Console

Data Security

Refer to Security for information.