DOCSP-46262 Prep Compass Natural Language Content for DE Migration

Author: ajhuh-mdb

source/includes/fact-natural-language-feedback.rst renamed to source/includes/shared/fact-natural-language-feedback.rst

@@ -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 

source/includes/fact-natural-language-query.rst renamed to source/includes/shared/fact-natural-language-query.rst

@@ -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
-
 - 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
 ---------------------------------
 
@@ -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

source/query-with-natural-language.txt

@@ -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
-
 - Install |compass-short| version 1.40.0 or later. For instructions on 
   downloading and installing the latest version, see :ref:`download-install`.
 
@@ -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
 -----
 

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

@@ -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>`.
@@ -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
 -----
@@ -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.

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

@@ -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 
@@ -74,7 +74,7 @@ Steps
 
       .. tip::
 
-         .. include:: /includes/fact-natural-language-feedback.rst
+         .. include:: /includes/shared/fact-natural-language-feedback.rst
 
 Example
 -------