DOCSP-44882 Compass AI Settings (#694)

* DOCSP-44882 Compass AI Settings
mongodb · Dec 19, 2024 · 3f91658 · 3f91658
1 parent a5d1105
commit 3f91658
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/source/settings/command-line-options.txt b/source/settings/command-line-options.txt
@@ -116,6 +116,18 @@ value in the :guilabel:`Settings` panel.
 
        To learn more, see :ref:`compass-enable-dev-tools`.
 
+   * - .. option:: --enableGenAIFeatures
+     - Allow |compass-short| to use generative AI for natural language querying.
+       This feature requires an Atlas login and a deployed Atlas cluster.
+
+   * - .. option:: --enableGenAISampleDocumentPassing
+     - Allow |compass| to send sample field values with query and
+       aggregation generation requests. These values can improve
+       the results from the AI.
+
+       If ``true``, this option implicitly sets the
+       :option:`--enableGenAIFeatures` option to ``true``.
+
    * - .. option:: --enableMaps
      - Allow |compass| to make requests to a 3rd party mapping service. Use 
        ``--no-enableMaps`` to disable mapping requests.

diff --git a/source/settings/config-file.txt b/source/settings/config-file.txt
@@ -69,6 +69,14 @@ Settings
      - Allow |compass-short| to use generative AI for natural language querying.
        This feature requires an Atlas login and a deployed Atlas cluster.
 
+   * - enableGenAISampleDocumentPassing
+     - Allow |compass| to send sample field values with query and
+       aggregation generation requests. These values can improve
+       the results from the AI.
+
+       If ``true``, this setting implicitly sets the
+       ``enableGenAIFeatures`` setting to ``true``. 
+
    * - :ref:`enableDevTools <compass-enable-dev-tools>`
      - Enable Chrome DevTools in |compass-short|.