Skip to content

Commit 58f89aa

Browse files
DOCSP-38132 Compass Generative AI Generally Available Updates (#620)
* DOCSP-38132 Compass Generative AI Generally Available Updates * remove banners * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * IR * * * * * * * * * * * * * remove sample fields * * * * * * * Apply suggestions from code review Co-authored-by: Ashley Brown <[email protected]> * * * * --------- Co-authored-by: Ashley Brown <[email protected]>
1 parent a927700 commit 58f89aa

File tree

5 files changed

+40
-40
lines changed

5 files changed

+40
-40
lines changed

snooty.toml

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -51,20 +51,6 @@ value = """
5151
For more information, see :ref:`7.0-compatibility`.
5252
"""
5353

54-
[[banners]]
55-
targets = [
56-
"query-with-natural-language/enable-natural-language-querying.txt",
57-
"query-with-natural-language/prompt-natural-language-query.txt",
58-
"query-with-natural-language/prompt-natural-language-aggregation.txt",
59-
"query-with-natural-language/query-with-natural-language.txt"
60-
]
61-
variant = "tip"
62-
value = """
63-
The MongoDB Compass natural language querying feature is currently \
64-
available as a **Public Preview** offering. The product, its features, \
65-
and the corresponding documentation may change during the Preview stage.
66-
"""
67-
6854
[substitutions]
6955
atlas = "MongoDB Atlas"
7056
compass = "MongoDB Compass"

source/query-with-natural-language/ai-and-data-usage-information.txt

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,12 @@ How Your Data is Used
2525
---------------------
2626

2727
When you query with natural language in Compass, the following
28-
information is sent to MongoDBs backend and/or the third party
28+
information is sent to MongoDB's backend and/or the third party
2929
AI provider:
3030

31-
The schema of the collection you are querying
32-
(including collection name, field names, and types).
31+
- The full text of your natural language prompt.
32+
- The schema of the collection you are querying,
33+
including database name, collection name, field names, and types.
3334

3435
The information that is sent will not be shared with any other third
3536
parties or stored by the AI provider. We do not send database
@@ -39,9 +40,10 @@ Disable Natural Language Querying
3940
---------------------------------
4041

4142
- Natural language querying in Compass is available if you have
42-
enabled the :ref:`Compass Use Generative AI setting
43+
enabled the :ref:`Generative AI setting
4344
<enable-natural-language-querying>` and logged into Atlas.
44-
- If you no longer want to use the feature, you can ignore it
45-
and no data will be sent to generative AI models. To prevent usage of
46-
this feature entirely, you can disable it in the
45+
- If you no longer want to use the feature, uncheck
46+
:guilabel:`Enable AI Features` in the
47+
:guilabel:`Artificial Intelligence` settings.
48+
- To prevent usage of this feature entirely, you can disable it in the
4749
:ref:`global configuration file <config-file>`.

source/query-with-natural-language/enable-natural-language-querying.txt

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ you must:
3939
- Install |compass-short| version 1.40.0 or later. For instructions on
4040
downloading and installing the latest version, see :ref:`download-install`.
4141

42-
4342
.. note::
4443

4544
You can also enable Natural Language Querying using the configuration
@@ -49,7 +48,7 @@ Steps
4948
-----
5049

5150
.. procedure::
52-
:style: connected
51+
:style: connected
5352

5453
.. step:: Open settings
5554

@@ -69,25 +68,33 @@ Steps
6968
- In the top menu bar, click :guilabel:`MongoDB Compass`.
7069
- ``⌘`` + ``,``
7170

72-
.. step:: Connect to your Atlas account
71+
.. step:: Enable AI Features and Log In to Atlas
72+
73+
You only need to enable AI features if it is your first time
74+
using natural language querying.
7375

74-
a. Select :guilabel:`Feature preview`.
76+
a. Select :guilabel:`Artificial Intelligence`.
77+
#. Click the :guilabel:`Enable AI Features` check box.
7578
#. Click :guilabel:`Log in with Atlas`.
7679

7780
A web browser displays the
7881
`Atlas login page <https://account.mongodb.com/account/login>`_.
7982

8083
#. Complete the login procedure.
8184

82-
Once completed a :guilabel:`Logged in with Atlas account`
85+
After you log in successfully, a
86+
:guilabel:`You can create queries and aggregations with
87+
generative AI`
8388
message displays.
89+
#. Click :guilabel:`Save`.
90+
91+
.. step:: (Optional) Read MongoDB's GenAI FAQs
8492

85-
.. step:: Enable the generative AI feature
93+
For more information about generative AI usage with MongoDB
94+
Compass, see:
8695

87-
a. The :guilabel:`Data Processing Agreement` displays.
88-
#. Read the :guilabel:`Data Processing Agreement`.
89-
#. Click :guilabel:`Agree and continue`.
90-
#. Click :guilabel:`Save`.
96+
- :ref:`compass-ai-data-usage`
97+
- `FAQ For MongoDB Generative AI Features <https://www.mongodb.com/docs/generative-ai-faq/>`__
9198

9299
Next Steps
93100
----------

source/release-notes.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ Release Notes
1010
:depth: 1
1111
:class: twocols
1212

13+
|compass| 1.43.0
14+
----------------
15+
16+
*Upcoming*
17+
18+
New Features
19+
20+
- Queries generated by Natural Language Querying have improved
21+
quality and accuracy.
22+
1323
|compass| 1.42.5
1424
----------------
1525

source/settings/settings-reference.txt

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,6 @@ You can configure the following settings on the |compass| interface:
137137
- Allow our Product team to occasionally reach out for feedback about
138138
|compass-short|.
139139

140-
* - Enable AI Features
141-
- Privacy
142-
- Allows the use of AI features in Compass which make requests
143-
to 3rd party services.
144-
145140
* - Browser command to use for OIDC Authentication
146141
- OIDC
147142
- Specify the browser that |compass-short| redirects you to when authenticating
@@ -158,10 +153,10 @@ You can configure the following settings on the |compass| interface:
158153
- Remain logged in when using the :manual:`MONGODB-OIDC </core/security-oidc/>`
159154
authentication mechanism.
160155

161-
* - Use Generative AI
162-
- Feature Preview
163-
- Enables :ref:`natural language querying <query-natural-language>`.
164-
156+
* - Enable AI Features
157+
- Artificial Intelligence
158+
- Enables :ref:`natural language querying <query-natural-language>` and allows
159+
the use of AI features in Compass which make requests to 3rd party services.
165160

166161
Learn More
167162
----------

0 commit comments

Comments
 (0)