Skip to content

Commit a79fe68

Browse files
authored
Merge pull request #94 from ianf-mongodb/DOCSP-36049
DOCSP-36049 AI and Data Usage Page
2 parents b2bfc85 + ff3b051 commit a79fe68

File tree

5 files changed

+76
-25
lines changed

5 files changed

+76
-25
lines changed

source/code-generation.txt

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,6 @@ application code:
4242
-
4343
- ``C#``, ``Java``, ``JavaScript``, and ``JSON`` application code
4444

45-
46-
.. note::
47-
48-
Query Converter is currently in private preview. For sign-up details,
49-
see :ref:`rm-query-converter`.
50-
5145
Get Started
5246
-----------
5347

source/code-generation/query-converter.txt

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,11 @@ procedures to MongoDB syntax. Relational Migrator considers the mapping
1515
rules and schema transformations defined in your project when converting
1616
your SQL code.
1717

18-
Sign Up for Private Preview
19-
---------------------------
20-
21-
The Query Converter feature is in private
22-
preview. To request private preview access, use the sign-up form within the
23-
Relational Migrator application:
24-
25-
.. include:: /includes/fact-request-private-preview.rst
26-
2718
.. toctree::
2819
:hidden:
2920
:titlesonly:
3021

22+
/code-generation/query-converter/ai-and-data-usage-information
3123
/code-generation/query-converter/enable-query-converter
3224
/code-generation/query-converter/convert-queries
3325
/code-generation/query-converter/convert-stored-procedures
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
.. _rm-ai-and-data-usage:
2+
3+
=============================
4+
AI and Data Usage Information
5+
=============================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
The Query Converter feature is powered by Generative AI
14+
(Gen AI), and may give inaccurate responses. Please see our `Generative AI FAQ
15+
<https://dochub.mongodb.org/core/faq-ai-features>`__
16+
for more information about Gen AI in MongoDB products.
17+
18+
Third Party Providers
19+
---------------------
20+
21+
Query Converter currently uses the `Azure OpenAI Service
22+
<https://azure.microsoft.com/en-us/products/ai-services/openai-service>`__
23+
hosted by Microsoft. This is subject to change in the future.
24+
25+
How Your Data is Used
26+
---------------------
27+
28+
When you use Query Converter, the following information is sent to
29+
MongoDB's backend and/or the third party AI provider:
30+
31+
- The full text of your query or stored procedure.
32+
- The definition of any relational database tables used in the query.
33+
These definitions include the table names, column names, data types,
34+
and any primary or foreign key relationships.
35+
- The definition of your MongoDB collections and mapping rules.
36+
These definitions include the relationships between the collections
37+
and tables used in the query and the collection names, field names
38+
and data types.
39+
40+
The information that is sent is not shared with any other third
41+
parties or stored by the AI provider. Relational Migrator does not send
42+
database connection strings, credentials, or any raw data from your
43+
databases.
44+
45+
By default, your original query text and the AI-converted query
46+
telemetry data is stored by MongoDB for up to one year to help us
47+
provide support and improve the service. If you do not want
48+
your data to be stored, you have the option to opt out:
49+
50+
.. include:: /includes/fact-disable-query-converter.rst
51+
52+
Disable Query Converter
53+
-----------------------
54+
55+
Query Converter is available in the Relational Migrator UI once you have
56+
:ref:`enabled the query converter feature <rm-enable-query-converter>`.
57+
If you no longer want to use the feature, you can ignore it and no data
58+
will be sent to generative AI models. If needed, you can hide the
59+
feature by clearing all browser data for the Relational Migrator host.

source/code-generation/query-converter/enable-query-converter.txt

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,6 @@ stored procedures to MongoDB syntax. The query converter considers the
1515
mapping rules and schema transformations defined in your project when converting
1616
your SQL code.
1717

18-
Before you Begin
19-
----------------
20-
21-
The query converter feature is in private
22-
preview. To request private preview access, use the sign-up form within the
23-
Relational Migrator application. For instructions, see
24-
:ref:`rm-query-converter`.
25-
2618
Steps
2719
-----
2820

@@ -36,10 +28,19 @@ Steps
3628

3729
.. step:: Read the user agreement
3830

31+
.. step:: (Optional) Review telemetry preferences
32+
33+
Telemetry data about the source and converted queries are
34+
temporarily stored by MongoDB to improve the query converter
35+
feature. If you do not want your data to be stored, you have
36+
the option to opt out:
37+
38+
.. include:: /includes/fact-disable-query-converter.rst
39+
3940
.. step:: Enable the query converter feature
4041

41-
Click :guilabel:`Use Query Converter`.
42-
The :guilabel:`Query Converter` pane displays.
42+
Click :guilabel:`Start Using Query Converter`.
43+
The :guilabel:`Query Converter` pane is displayed.
4344

4445
Next Steps
4546
----------
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
- You can disable the :guilabel:`Allow queries to be stored temporarily`
2+
toggle switch in the global project settings.
3+
- You can uncheck the :guilabel:`Allow MongoDB to temporarily store the
4+
source and converted queries to import the product feature` setting
5+
when you enable the query converter.

0 commit comments

Comments
 (0)