Skip to content

Commit 0a0e326

Browse files
authored
DOCSP-46262 Prep Compass Natural Language Content for DE Migration (#712)
1 parent 25fb907 commit 0a0e326

7 files changed

+12
-19
lines changed

source/query-with-natural-language.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,13 @@ You may want to use natural language to query in |compass-short| to:
2828
Behavior
2929
--------
3030

31+
.. BEGIN-COMPASS-ONLY
32+
3133
- |compass-short| natural language querying is available starting in version
3234
``1.40.x``.
3335

36+
.. END-COMPASS-ONLY
37+
3438
- Natural language querying utilizes `Azure Open AI
3539
<https://azure.microsoft.com/en-us/products/ai-services/openai-service>`__
3640
as its current provider. This provider may be subject to change in

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

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,22 +32,16 @@ AI provider:
3232
- The schema of the collection you are querying,
3333
including database name, collection name, field names, and types.
3434

35-
.. BEGIN-COMPASS-ONLY
36-
3735
- Enable sending sample field values. This is an optional setting to
3836
improve the quality of recommendations. You can manage this through the
3937
``Enable sending sample field values`` setting in
4038
:ref:`Compass settings <compass-settings-reference>`. This setting
4139
is off by default.
4240

43-
.. END-COMPASS-ONLY
44-
4541
The information that is sent will not be shared with any other third
4642
parties or stored by the AI provider. We do not send database
4743
connection strings, credentials, or rows/documents from your databases.
4844

49-
.. BEGIN-COMPASS-ONLY
50-
5145
Disable Natural Language Querying
5246
---------------------------------
5347

@@ -59,5 +53,3 @@ Disable Natural Language Querying
5953
:guilabel:`Artificial Intelligence` settings.
6054
- To prevent usage of this feature entirely, you can disable it in the
6155
:ref:`global configuration file <config-file>`.
62-
63-
.. END-COMPASS-ONLY

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@ you must:
3636
- Sign into Atlas. For details on how to get a free Atlas
3737
account and deploy a free M0 cluster, see :ref:`atlas-getting-started`.
3838

39-
.. BEGIN-COMPASS-ONLY
40-
4139
- Install |compass-short| version 1.40.0 or later. For instructions on
4240
downloading and installing the latest version, see :ref:`download-install`.
4341

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

49-
.. END-COMPASS-ONLY
50-
5147
Steps
5248
-----
5349

source/query-with-natural-language/prompt-natural-language-aggregation.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ About this Task
2121

2222
.. note::
2323

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

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

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

3940
Steps
4041
-----
@@ -78,10 +79,10 @@ Steps
7879

7980
.. tip::
8081

81-
.. include:: /includes/fact-natural-language-feedback.rst
82+
.. include:: /includes/shared/fact-natural-language-feedback.rst
8283

83-
Example
84-
-------
84+
Examples
85+
--------
8586

8687
Below are examples of prompts to help you understand expected results
8788
when using natural language prompts for aggregation.

source/query-with-natural-language/prompt-natural-language-query.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ About this Task
2121

2222
.. note::
2323

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

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

7575
.. tip::
7676

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

7979
Example
8080
-------

0 commit comments

Comments
 (0)