Skip to content

DOCSP-46262 Prep Compass Natural Language Content for DE Migration #712

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

Merged
merged 1 commit into from
Jan 24, 2025
Merged

DOCSP-46262 Prep Compass Natural Language Content for DE Migration #712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
0 ...cludes/fact-natural-language-feedback.rst → ...shared/fact-natural-language-feedback.rst
View file
Open in desktop
File renamed without changes.
0 .../includes/fact-natural-language-query.rst → ...es/shared/fact-natural-language-query.rst
View file
Open in desktop
File renamed without changes.
4 changes: 4 additions & 0 deletions source/query-with-natural-language.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,13 @@ You may want to use natural language to query in |compass-short| to:
Behavior
--------

.. BEGIN-COMPASS-ONLY

- |compass-short| natural language querying is available starting in version
``1.40.x``.

.. END-COMPASS-ONLY

- Natural language querying utilizes `Azure Open AI
<https://azure.microsoft.com/en-us/products/ai-services/openai-service>`__
as its current provider. This provider may be subject to change in
Expand Down
8 changes: 0 additions & 8 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
Expand Up @@ -32,22 +32,16 @@ AI provider:
- The schema of the collection you are querying,
including database name, collection name, field names, and types.

.. BEGIN-COMPASS-ONLY
Copy link
Collaborator Author

@ajhuh-mdb ajhuh-mdb Jan 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed these tags from this page since Atlas docs will have it's own version of this page that isn't migrated from Compass.


- Enable sending sample field values. This is an optional setting to
improve the quality of recommendations. You can manage this through the
``Enable sending sample field values`` setting in
:ref:`Compass settings <compass-settings-reference>`. This setting
is off by default.

.. END-COMPASS-ONLY

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.

.. BEGIN-COMPASS-ONLY

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

Expand All @@ -59,5 +53,3 @@ Disable Natural Language Querying
:guilabel:`Artificial Intelligence` settings.
- To prevent usage of this feature entirely, you can disable it in the
:ref:`global configuration file <config-file>`.

.. END-COMPASS-ONLY
4 changes: 0 additions & 4 deletions source/query-with-natural-language/enable-natural-language-querying.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ you must:
- Sign into Atlas. For details on how to get a free Atlas
account and deploy a free M0 cluster, see :ref:`atlas-getting-started`.

.. BEGIN-COMPASS-ONLY
Copy link
Collaborator Author

@ajhuh-mdb ajhuh-mdb Jan 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed these tags from this page since Atlas docs will have it's own version of this page that isn't migrated from Compass.


- Install |compass-short| version 1.40.0 or later. For instructions on
downloading and installing the latest version, see :ref:`download-install`.

Expand All @@ -46,8 +44,6 @@ you must:
You can also enable Natural Language Querying using the configuration
file. For details, see :ref:`config-file`.

.. END-COMPASS-ONLY

Steps
-----

Expand Down
11 changes: 6 additions & 5 deletions source/query-with-natural-language/prompt-natural-language-aggregation.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ About this Task

.. note::

.. include:: /includes/fact-natural-language-query.rst
.. include:: /includes/shared/fact-natural-language-query.rst

- You can also provide natural language prompts on the
:ref:`documents tab <compass-prompt-natural-language-query>`.
Expand All @@ -34,7 +34,8 @@ About this Task
Before you Begin
----------------

You must :ref:`enable natural language querying in Compass <compass-enable-natural-language-querying>`.
You must :ref:`enable natural language querying
<compass-enable-natural-language-querying>` in |compass-short|.

Steps
-----
Expand Down Expand Up @@ -78,10 +79,10 @@ Steps

.. tip::

.. include:: /includes/fact-natural-language-feedback.rst
.. include:: /includes/shared/fact-natural-language-feedback.rst

Example
-------
Examples
--------

Below are examples of prompts to help you understand expected results
when using natural language prompts for aggregation.
Expand Down
4 changes: 2 additions & 2 deletions source/query-with-natural-language/prompt-natural-language-query.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ About this Task

.. note::

.. include:: /includes/fact-natural-language-query.rst
.. include:: /includes/shared/fact-natural-language-query.rst

- You can query with natural language to create both queries and
aggregations. If your prompt results in an aggregation, you are
Expand Down Expand Up @@ -74,7 +74,7 @@ Steps

.. tip::

.. include:: /includes/fact-natural-language-feedback.rst
.. include:: /includes/shared/fact-natural-language-feedback.rst

Example
-------
Expand Down
Loading