Skip to content

Commit 0466912

Browse files
committed
DOCSP-43493 adding ai and data usage
1 parent f3311af commit 0466912

File tree

2 files changed

+58
-14
lines changed

2 files changed

+58
-14
lines changed

source/ai-data-usage.txt

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.. vscode-ai-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+
12+
The MongoDB Github Copilot Participant is powered by Generative AI (Gen
13+
AI), and may give inaccurate responses. See our `Generative AI FAQ
14+
<https://dochub.mongodb.org/core/faq-ai-features>`__ for more
15+
information about Gen AI in MongoDB products.
16+
17+
Third Party Providers
18+
---------------------
19+
20+
The MongoDB Github Copilot Participant is powered by Github Copilot.
21+
This is subject to change in the future.
22+
23+
How Your Data is Used
24+
---------------------
25+
26+
When you use the MongoDB Github Copilot Participant, the following
27+
information is sent to MongoDB's backend and/or the third party AI
28+
provider:
29+
30+
- The full text of your natural language prompt.
31+
- The schema of the collection you are using,
32+
including database name, collection name, field names, and types.
33+
- Enable sending sample field values. This is an optional setting to
34+
improve the quality of recommendations. You can manage this through the
35+
``Enable sending sample field values`` setting in
36+
:ref:`Compass settings <compass-settings-reference>`. This setting
37+
is off by default.
38+
39+
The information that is sent will not be shared with any other third
40+
parties or stored by the AI provider. We do not send database
41+
connection strings, credentials, or rows/documents from your databases.

source/copilot.txt

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ MongoDB Github Copilot Participant
1313
:class: singlecol
1414

1515

16-
|vsce-full| automatically includes a MongoDB Github Copilot Participant
16+
|vsce-full| includes a MongoDB Github Copilot Participant
1717
to assist in using Copilot with your MongoDB deployments. Through
1818
Copilot's chat feature, users with |vsce| can interact their MongoDB
1919
clusters and generate code with MongoDB domain-specific knowledge on top
@@ -22,15 +22,18 @@ of VSCode Copilot's LLM.
2222
/query
2323
------
2424

25-
Users can use the ``/query`` command to generate queries from a natural
26-
language against a connected MongoDB cluster. The MongoDB Participant
27-
provides underlying schema information of the relevant collections and
28-
MongoDB domain specific knowledge to Copilot to generate a response.
25+
Users can use the ``/query`` command in the Copilot chat to
26+
generate queries from a natural language against a connected MongoDB
27+
cluster. The MongoDB Participant provides underlying schema information
28+
of the relevant collections to Copilot to generate a response. If you do
29+
not specify a collection in your prompt to Copilot, the MongoDB
30+
Participant prompts you to select a relevant collection.
31+
2932
When the LLM generates a query, users can open the query in a playground
3033
file or run the query directly in their collection.
3134

32-
/query Example
33-
~~~~~~~~~~~~~~
35+
Example
36+
~~~~~~~
3437

3538
Consider a ``fruits`` collection that contains documents with the
3639
following structure:
@@ -44,10 +47,9 @@ following structure:
4447
type: "citrus"
4548
}
4649

47-
48-
In the Github Copilot Chat tab, you can ask the MongoDB Copilot
49-
participant to generate a query to find all documents in the ``fruits``
50-
collection that have the type ``citrus``.
50+
Once you connet to the databse that contains the ``fruits`` collection,
51+
you can ask the Copilot chat to generate a query that finds all documents
52+
in the ``fruits`` collection that have the type ``citrus``.
5153

5254
.. code-block:: javascript
5355
:copyable: false
@@ -60,11 +62,12 @@ the following query using knowledge of your database schema:
6062

6163
.. code-block:: javascript
6264

63-
use('fruits');
64-
db.getCollection('fruits').find({ type: 'citrus' });
65-
65+
db.getCollection('fruits').find({ type: 'citrus' })
6666

6767

68+
.. toctree::
69+
:titlesonly:
6870

71+
/ai-data-usage
6972

7073

0 commit comments

Comments
 (0)