DOCSP-41673 nlc ga updates (#678)

kyuan-mongodb · web-flow · commit 16da5003d3fd · 2024-07-29T16:53:30.000-04:00
* nlc ga updates
diff --git a/snooty.toml b/snooty.toml
@@ -37,7 +37,8 @@ toc_landing_pages = ["/installation",
                      "/embedding-charts-sdk",
                      "/manage-data-sources",
                      "/bin-data", "/encoding-channels", 
-                     "/experimental-features"]
+                     "/experimental-features",
+                     "/faq"]
 
 [constants]
 version = "v0.10.0"
@@ -76,16 +77,3 @@ css = ":abbr:`CSS (Cascading Style Sheets)`"
 pdf = ":abbr:`PDF (Portable Document Format)`"
 png = ":abbr:`PNG (Portable Network Graphic)`"
 iot = ":abbr:`IoT (Internet of Things)`"
-
-[[banners]]
-# NLC in public preview
-targets = [
-    "index.txt",
-    "chart-types.txt",
-    "chart-type-reference/*.txt"
-]
-
-variant = "warning"
-value = """
-        Natural Language Charts is available as a Preview feature. The feature and the corresponding documentation might change at any time during the Preview period.
-        """
diff --git a/source/ai-and-data-usage-information.txt b/source/ai-and-data-usage-information.txt
@@ -24,19 +24,7 @@ hosted by Microsoft. This is subject to change in the future.
 How Your Data is Used
 ---------------------
 
-When you use Natural Language Charts, |charts| sends the following information
-to MongoDB's backend and/or the third-party AI provider:
-
-- The full text of your natural language prompt.
-- The schema of the collection used to generate the chart,
-  including collection names, field names, and field data types.
-- Sample field values to improve the quality of chart recommendations.
-
-The information sent will not be shared with any other third parties 
-or stored by the AI provider. We do not share database connection 
-strings or credentials from your databases. By default, your original 
-query text will be stored by MongoDB for up to one year to help us 
-provide support to customers and improve the service. 
+.. include:: /includes/nlc-how-your-data-is-used.rst
 
 Disable Natural Language Charts
 -------------------------------
diff --git a/source/chart-type-reference/natural-language-charts.txt b/source/chart-type-reference/natural-language-charts.txt
@@ -12,6 +12,8 @@ Natural Language Charts
    :depth: 1
    :class: singlecol
 
+.. _nlc-supported-charts:
+
 Natural language charts simplifies the chart creation process. 
 It supports the following chart types, which are built with :ref:`series
 <charts-series-encoding>` and :ref:`aggregation
@@ -93,15 +95,7 @@ Procedure
       In the :guilabel:`Prompt` box, specify the chart you want |charts|
       to create.
 
-      We recommend that you write clear prompts and tag the fields from
-      your collection with ``@``. The following list provides examples
-      of clear prompts:
-
-      - Use a line chart to display trends in quarterly sales data.
-      - Display monthly sales revenue for the last year.
-      - Visualize weekly sales data in year 2022 using a discrete line chart.
-      - Show the age distribution of our customers.
-      - Show me the top 3 property_type and all other properties grouped together with the highest price.
+      .. include:: /includes/nlc-prompt-writing-tips.rst
 
       .. note::
 
diff --git a/source/faq.txt b/source/faq.txt
@@ -0,0 +1,104 @@
+:noprevnext:
+
+.. _faq:
+
+==========================
+Frequently Asked Questions
+==========================
+
+.. default-domain:: mongodb
+
+.. facet::
+   :name: genre
+   :values: reference
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+.. _nlc-error-messages:
+
+What should I do if the chart generated looks incorrect, or |charts-short| doesn't generate a chart from the prompt?
+--------------------------------------------------------------------------------------------------------------------
+
+We are improving :guilabel:`Natural Language` mode to reduce the
+occurrence of incorrect responses. In the meantime, we provide a message
+that helps you understand how to improve the response.
+
+The following table lists the possible messages you can receive and the 
+underlying cause of each.
+
+.. list-table::
+   :header-rows: 1
+   :stub-columns: 1
+   :widths: 35 65
+
+   * - Message
+     - Further Explanation
+
+   * - Some chart types are currently not supported in the Natural
+       Language mode. Grouped Bar chart has been selected. Switch to the
+       Classic mode to change this.
+     - We currently do not supoort the chart type you requested in the
+       prompt. When you write a prompt, leave the chart type selection to
+       |charts-short|, or specify another :ref:`supported chart type
+       <nlc-supported-charts>`.
+
+   * - Customization options are currently not supported in the Natural
+       Language mode. Switch to the Classic mode to continue.
+     - We currently do not support customization options in the
+       :guilabel:`Customize` section of the :guilabel:`Classic` mode for
+       chart generation.
+
+   * - The prompt is not specific enough. Edit the prompt and try again.
+     - There is not enough information in the prompt to generate a
+       chart. 
+       
+       .. include:: /includes/nlc-prompt-writing-tips.rst
+
+   * - Couldn't find 'field_name' in the data source. Edit the prompt
+       and try again. 
+     - You entered a field that doesn't exist in the data schema. To see
+       the exisiting fields you can tag from the data source, press the
+       ``@`` key when writing the prompt.
+
+In the bottom-left corner of your generated chart, please give us
+feedback to help improve the response.
+
+What functionality in :guilabel:`Classic` mode are currently not supported in :guilabel:`Natural Language` mode?
+----------------------------------------------------------------------------------------------------------------
+
+- :ref:`Count by value <count-by-value-agg>` aggregation option
+- :ref:`Customizations options <customize-charts>`
+- Chart types:
+  
+  - :ref:`Candlestick Chart <candlestick-chart-ref>`
+  - :ref:`Heatmap <heatmap-chart-ref>`
+  - :ref:`Scatter Chart <scatter-chart-ref>`
+  - :ref:`Top Item Chart <top-item-ref>`
+  - :ref:`Geospatial Charts <geo-spatial-charts>`
+  - :ref:`Continuous Line and Continuous Area <continuous-charts>`
+  - :ref:`Gauge <gauge-chart-ref>`
+  - :ref:`Word Cloud <word-cloud-ref>`
+  - :ref:`Colored Bar and Colored Column <column-bar-chart-ref>`
+
+- :ref:`Lookup Fields <add-lookup-field>`
+- :ref:`Calculated fields <calculated-fields>`
+- :ref:`Missed Fields <missing-fields>`
+
+Does Natural Language Charts rely on a service?
+-----------------------------------------------
+
+Yes, Natural Language Charts currently uses the `Azure OpenAI Service
+<https://azure.microsoft.com/en-us/products/ai-services/openai-service>`__
+hosted by Microsoft. This is subject to change in the future.
+
+To learn more, see `What Services Do MongoDB's GenAI Features Rely On
+<https://www.mongodb.com/docs/generative-ai-faq/#what-services-do-these-genai-features-rely-on->`__.
+
+What data does |charts-short| send to the model?
+------------------------------------------------
+
+.. include:: /includes/nlc-how-your-data-is-used.rst
diff --git a/source/includes/nlc-how-your-data-is-used.rst b/source/includes/nlc-how-your-data-is-used.rst
@@ -0,0 +1,13 @@
+When you use Natural Language Charts, |charts| sends the following information
+to MongoDB's backend and/or the third-party AI provider:
+
+- The full text of your natural language prompt.
+- The schema of the collection used to generate the chart,
+  including collection names, field names, and field data types.
+- Sample field values to improve the quality of chart recommendations.
+
+The information sent will not be shared with any other third parties 
+or stored by the AI provider. We do not share database connection 
+strings or database credentials. By default, your original 
+query text will be stored by MongoDB for up to one year to help us 
+provide support to customers and improve the service. 
diff --git a/source/includes/nlc-prompt-writing-tips.rst b/source/includes/nlc-prompt-writing-tips.rst
@@ -0,0 +1,10 @@
+We recommend that you write clear prompts and tag the fields from
+your collection with ``@``. The following list provides examples
+of clear prompts:
+
+- Use a line chart to display trends in quarterly sales data.
+- Display monthly sales revenue for the last year.
+- Visualize weekly sales data in year 2022 using a discrete line chart.
+- Show the age distribution of our customers.
+- Show me the top 3 property_type and all other properties grouped
+  together with the highest price.
diff --git a/source/index.txt b/source/index.txt
@@ -120,6 +120,7 @@ data and explore key features offered by |charts|:
    Embedding </embed-charts-and-dashboards>
    /admin-settings
    /pricing
+   /faq
    /release-notes
    /third-party-licenses
    /ai-and-data-usage-information
diff --git a/source/release-notes.txt b/source/release-notes.txt
@@ -10,6 +10,15 @@ Atlas Charts Release Notes
    :depth: 1
    :class: twocols
 
+|charts| v1.45.3
+----------------
+
+*Released July 30th, 2024*
+
+Improvements in this release:
+
+- :ref:`Natural Language Charts <nlc>` is generally available.
+
 |charts| v1.45.0
 ----------------
 
