Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCSP-37108 Add Compass AI and Data Usage Info Page #604

Merged
merged 14 commits into from
Mar 5, 2024
Merged

DOCSP-37108 Add Compass AI and Data Usage Info Page #604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
318a7ff
DOCSP-37108 Add Compass AI and Data Usage Info Page
ianf-mongodb Feb 22, 2024
635169f
*
ianf-mongodb Feb 22, 2024
b933fb6
*
ianf-mongodb Feb 22, 2024
ab4f30c
*
ianf-mongodb Feb 22, 2024
682ec3f
*
ianf-mongodb Feb 22, 2024
3dc4b30
*
ianf-mongodb Feb 22, 2024
c3f43c0
Apply suggestions from code review
ianf-mongodb Feb 23, 2024
281a44e
so feedback
ianf-mongodb Feb 23, 2024
1df496a
Apply suggestions from code review
ianf-mongodb Feb 27, 2024
acf77e6
*
ianf-mongodb Feb 27, 2024
cb8d944
*
ianf-mongodb Feb 27, 2024
5a381f6
*
ianf-mongodb Feb 27, 2024
fde2759
*
ianf-mongodb Feb 27, 2024
b378847
Apply suggestions from code review
ianf-mongodb Feb 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions source/query-with-natural-language/ai-and-data-usage-information.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
.. _compass-ai-data-usage:

=============================
AI and Data Usage Information
=============================

.. contents:: On this page
:local:
:backlinks: none
:depth: 1

Querying with natural language in Compass is powered by Generative AI
(Gen AI), and may give inaccurate responses. See our `Generative AI FAQ
<https://dochub.mongodb.org/core/faq-ai-features>`__
for more information about Gen AI in MongoDB products.

Third Party Providers
---------------------

Querying with natural language in Compass currently uses the `Azure OpenAI Service

Check failure on line 20 in source/query-with-natural-language/ai-and-data-usage-information.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.ConciseTerms] 'now' is preferred over 'currently'.

Raw Output:
{"message": "[MongoDB.ConciseTerms] 'now' is preferred over 'currently'.", "location": {"path": "source/query-with-natural-language/ai-and-data-usage-information.txt", "range": {"start": {"line": 20, "column": 43}}}, "severity": "ERROR"}
<https://azure.microsoft.com/en-us/products/ai-services/openai-service>`__
hosted by Microsoft. This is subject to change in the future.

How Your Data is Used
---------------------

When you query with natural language in Compass, the following
information is sent to MongoDB’s backend and/or the third party

Check failure on line 28 in source/query-with-natural-language/ai-and-data-usage-information.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.Avoid] Don't use 'and/or'.

Raw Output:
{"message": "[MongoDB.Avoid] Don't use 'and/or'.", "location": {"path": "source/query-with-natural-language/ai-and-data-usage-information.txt", "range": {"start": {"line": 28, "column": 42}}}, "severity": "ERROR"}
AI provider:

The schema of the collection you are querying
(including collection name, field names, and types).

The information that is sent will not be shared with any other third
parties or stored by the AI provider. We do not send database
connection strings, credentials, or rows/documents from your databases.

Disable Natural Language Querying
---------------------------------

- Natural language querying in Compass is available if you have
enabled the :ref:`Compass Use Generative AI setting
<enable-natural-language-querying>` and logged into Atlas.
- If you no longer want to use the feature, you can ignore it
and no data will be sent to generative AI models. To prevent usage of
this feature entirely, you can disable it in the
:ref:`global configuration file <config-file>`.
5 changes: 3 additions & 2 deletions source/query-with-natural-language/query-with-natural-language.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ is subject to MongoDB's:

.. toctree::
:titlesonly:

/query-with-natural-language/enable-natural-language-querying
/query-with-natural-language/prompt-natural-language-query
/query-with-natural-language/prompt-natural-language-aggregation
/query-with-natural-language/prompt-natural-language-aggregation
/query-with-natural-language/ai-and-data-usage-information
Loading