From 097dea79dd592b5d0671aba24f9699330c1360e9 Mon Sep 17 00:00:00 2001 From: "Kenneth P. J. Dyer" Date: Tue, 5 Nov 2024 12:24:32 -0600 Subject: [PATCH 1/8] DOCSP-44882 Compass AI Settings --- source/settings/command-line-options.txt | 9 +++++++++ source/settings/config-file.txt | 5 +++++ 2 files changed, 14 insertions(+) diff --git a/source/settings/command-line-options.txt b/source/settings/command-line-options.txt index 38e7d6fb7..f1b4863c2 100644 --- a/source/settings/command-line-options.txt +++ b/source/settings/command-line-options.txt @@ -116,6 +116,15 @@ 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:: --enableGenAIDocumentPassing + - Allow |compass| to send sample field values with query and + aggregation generation requests. These values can improve + the results from the AI. + * - .. 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 index c8f18f490..e897ec4bf 100644 --- a/source/settings/config-file.txt +++ b/source/settings/config-file.txt @@ -69,6 +69,11 @@ Settings - Allow |compass-short| to use generative AI for natural language querying. This feature requires an Atlas login and a deployed Atlas cluster. + * - enableGenAIDocumentPassing + - Allow |compass| to send sample field values with query and + aggregation generation requests. These values can improve + the results from the AI. + * - :ref:`enableDevTools ` - Enable Chrome DevTools in |compass-short|. From 2bead0052262b146d8f0c7d3bc73fc0b11b48379 Mon Sep 17 00:00:00 2001 From: "Kenneth P. J. Dyer" Date: Tue, 26 Nov 2024 12:29:53 -0600 Subject: [PATCH 2/8] Fixes per Betsy --- source/settings/command-line-options.txt | 5 ++++- source/settings/config-file.txt | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/source/settings/command-line-options.txt b/source/settings/command-line-options.txt index f1b4863c2..67083a6c0 100644 --- a/source/settings/command-line-options.txt +++ b/source/settings/command-line-options.txt @@ -120,11 +120,14 @@ value in the :guilabel:`Settings` panel. - Allow |compass-short| to use generative AI for natural language querying. This feature requires an Atlas login and a deployed Atlas cluster. - * - .. option:: --enableGenAIDocumentPassing + * - .. option:: --enableGenAISampleDocumentPassing - Allow |compass| to send sample field values with query and aggregation generation requests. These values can improve the results from the AI. + This option implicitly sets the :option:`--enableGenAIFeatures` + option. + * - .. 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 index e897ec4bf..d48807e7b 100644 --- a/source/settings/config-file.txt +++ b/source/settings/config-file.txt @@ -69,11 +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. - * - enableGenAIDocumentPassing + * - enableGenAISampleDocumentPassing - Allow |compass| to send sample field values with query and aggregation generation requests. These values can improve the results from the AI. + This setting implicitly sets the ``enableGenAIFeatures`` + setting. + * - :ref:`enableDevTools ` - Enable Chrome DevTools in |compass-short|. From 6469b0752625ba900301a615532a32b0f94de0e4 Mon Sep 17 00:00:00 2001 From: "Kenneth P. J. Dyer" Date: Tue, 26 Nov 2024 13:41:42 -0600 Subject: [PATCH 3/8] Fixes per Betsy Button --- source/settings/config-file.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/settings/config-file.txt b/source/settings/config-file.txt index d48807e7b..02c06a2c0 100644 --- a/source/settings/config-file.txt +++ b/source/settings/config-file.txt @@ -74,8 +74,8 @@ Settings aggregation generation requests. These values can improve the results from the AI. - This setting implicitly sets the ``enableGenAIFeatures`` - setting. + When the ``enableGenAIFeatures`` setting is not set to + ``false``, this setting implicitly sets it to ``true``. * - :ref:`enableDevTools ` - Enable Chrome DevTools in |compass-short|. From f5b5d48d55cddfba123723221a757322f122e15f Mon Sep 17 00:00:00 2001 From: "Kenneth P. J. Dyer" Date: Tue, 26 Nov 2024 14:16:18 -0600 Subject: [PATCH 4/8] Fixes per Betsy --- source/settings/config-file.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/source/settings/config-file.txt b/source/settings/config-file.txt index 02c06a2c0..cf1b17b05 100644 --- a/source/settings/config-file.txt +++ b/source/settings/config-file.txt @@ -74,8 +74,9 @@ Settings aggregation generation requests. These values can improve the results from the AI. - When the ``enableGenAIFeatures`` setting is not set to - ``false``, this setting implicitly sets it to ``true``. + This setting implicitly sets the ``enableGenAIFeatures`` + setting to ``true``. If you don't want this setting + enabled, set ``enableGenAIFeatures`` to ``false``. * - :ref:`enableDevTools ` - Enable Chrome DevTools in |compass-short|. From 97cd5929c9cc7e0344e74c78c2c12981f36070f8 Mon Sep 17 00:00:00 2001 From: "Kenneth P. J. Dyer" Date: Tue, 26 Nov 2024 14:20:33 -0600 Subject: [PATCH 5/8] Adjusts text --- source/settings/config-file.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/settings/config-file.txt b/source/settings/config-file.txt index cf1b17b05..f42974d02 100644 --- a/source/settings/config-file.txt +++ b/source/settings/config-file.txt @@ -76,7 +76,8 @@ Settings This setting implicitly sets the ``enableGenAIFeatures`` setting to ``true``. If you don't want this setting - enabled, set ``enableGenAIFeatures`` to ``false``. + enabled, you must explicitly set ``enableGenAIFeatures`` + to ``false``. * - :ref:`enableDevTools ` - Enable Chrome DevTools in |compass-short|. From 53b87518a1760b4dd7749a112d5610322331ed0c Mon Sep 17 00:00:00 2001 From: "Kenneth P. J. Dyer" Date: Wed, 27 Nov 2024 11:23:38 -0600 Subject: [PATCH 6/8] Fixes per Betsy --- source/settings/config-file.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/settings/config-file.txt b/source/settings/config-file.txt index f42974d02..ca6a38f37 100644 --- a/source/settings/config-file.txt +++ b/source/settings/config-file.txt @@ -74,10 +74,10 @@ Settings aggregation generation requests. These values can improve the results from the AI. - This setting implicitly sets the ``enableGenAIFeatures`` - setting to ``true``. If you don't want this setting - enabled, you must explicitly set ``enableGenAIFeatures`` - to ``false``. + If ``true``, this setting implicitly sets the + ``enableGenAIFeatures`` setting to ``true``. If you don't + want this setting enabled, you must explicitly set + ``enableGenAIFeatures`` to ``false``. * - :ref:`enableDevTools ` - Enable Chrome DevTools in |compass-short|. From 14468c352d6592a29f18c65ca59f96b41e377eda Mon Sep 17 00:00:00 2001 From: "Kenneth P. J. Dyer" Date: Tue, 10 Dec 2024 16:06:59 -0600 Subject: [PATCH 7/8] Fixes per Betsy --- source/settings/command-line-options.txt | 4 ++-- source/settings/config-file.txt | 4 +--- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/source/settings/command-line-options.txt b/source/settings/command-line-options.txt index 67083a6c0..52e142429 100644 --- a/source/settings/command-line-options.txt +++ b/source/settings/command-line-options.txt @@ -125,8 +125,8 @@ value in the :guilabel:`Settings` panel. aggregation generation requests. These values can improve the results from the AI. - This option implicitly sets the :option:`--enableGenAIFeatures` - option. + If set, this option implicitly sets the + :option:`--enableGenAIFeatures` option. * - .. option:: --enableMaps - Allow |compass| to make requests to a 3rd party mapping service. Use diff --git a/source/settings/config-file.txt b/source/settings/config-file.txt index ca6a38f37..84633a14a 100644 --- a/source/settings/config-file.txt +++ b/source/settings/config-file.txt @@ -75,9 +75,7 @@ Settings the results from the AI. If ``true``, this setting implicitly sets the - ``enableGenAIFeatures`` setting to ``true``. If you don't - want this setting enabled, you must explicitly set - ``enableGenAIFeatures`` to ``false``. + ``enableGenAIFeatures`` setting to ``true``. * - :ref:`enableDevTools ` - Enable Chrome DevTools in |compass-short|. From eccfb902cf12a5c0a5158249e469fc803127c561 Mon Sep 17 00:00:00 2001 From: "Kenneth P. J. Dyer" Date: Tue, 17 Dec 2024 11:24:49 -0600 Subject: [PATCH 8/8] Fixes per Betsy --- source/settings/command-line-options.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/settings/command-line-options.txt b/source/settings/command-line-options.txt index 52e142429..8b1602206 100644 --- a/source/settings/command-line-options.txt +++ b/source/settings/command-line-options.txt @@ -125,8 +125,8 @@ value in the :guilabel:`Settings` panel. aggregation generation requests. These values can improve the results from the AI. - If set, this option implicitly sets the - :option:`--enableGenAIFeatures` option. + 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