Skip to content

Commit f5a574e

Browse files
kyuan-mongodbkyuan-mongodb
authored
DOCSP-37085 removed nlc from experimental features (#651)
* removed nlc from experimental features
1 parent 0d17b2c commit f5a574e

File tree

4 files changed

+174
-145
lines changed

4 files changed

+174
-145
lines changed

‎source/chart-type-reference/natural-language-charts.txt

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
.. _nlc:
2+
3+
=======================
4+
Natural Language Charts
5+
=======================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Natural language charts simplifies the chart creation process.
16+
It supports the following chart types, which are built with :ref:`series
17+
<charts-series-encoding>` and :ref:`aggregation
18+
<building-charts-aggregation>` :ref:`encoding channels
19+
<encoding-channels>`:
20+
21+
- Grouped Bar
22+
- Stacked Bar
23+
- Stacked 100% Bar
24+
- Grouped Column
25+
- Stacked Column
26+
- Stacked 100% Column
27+
- Discrete Line
28+
- Discrete Area
29+
- Stacked 100% Area
30+
- Number
31+
- Table
32+
- Donut
33+
34+
These types of charts support boolean, date, string, and number
35+
:ref:`filtering <interactive-filtering>`, :ref:`sorting
36+
<charts-sort-data>`, :ref:`binning <charts-bin-data>`, and
37+
:ref:`limiting <charts-limit-data>`.
38+
39+
After you enter a prompt about a chart you would like to see, the AI
40+
model creates the chart.
41+
42+
Procedure
43+
---------
44+
45+
.. procedure::
46+
:style: normal
47+
48+
.. step:: Add a natural language chart.
49+
50+
.. procedure::
51+
:style: connected
52+
53+
.. step:: From the :guilabel:`Dashboards` page, select the dashboard
54+
where you want to add a new chart. For instructions on setting
55+
up a dashboard, see :doc:`Dashboards </dashboards>`.
56+
57+
.. step:: Click the :guilabel:`Add Chart` button.
58+
59+
.. step:: In the :guilabel:`Select Data Source` modal, click the
60+
:guilabel:`Project` tab.
61+
62+
.. step:: In the cluster where you loaded the
63+
sample data, select the ``listingsAndReviews`` collection
64+
in the ``sample_airbnb`` database.
65+
66+
.. step:: Toggle the switch on the top navigation from :guilabel:`Classic` to :guilabel:`Natural Language`.
67+
68+
When you toggle this, you must click the :guilabel:`Use
69+
Natural Language Mode` button in the :guilabel:`Natural
70+
Language Mode` modal to accept the `MongoDB Acceptable
71+
Use Policy
72+
<https://www.mongodb.com/legal/acceptable-use-policy>`__ and
73+
`Privacy Policy
74+
<https://www.mongodb.com/legal/privacy-policy>`__.
75+
76+
.. figure:: /images/charts/nl-mode-modal.png
77+
:figwidth: 300px
78+
:alt: Natural Language Mode Modal
79+
80+
If you click :guilabel:`Back to Classic Mode`, |charts|
81+
switches you back to :guilabel:`Classic` mode.
82+
83+
.. note::
84+
85+
You can seamlessly switch between :guilabel:`Classic`
86+
and :guilabel:`Natural Language` mode. |charts| retains
87+
the prompts and suggestions when you change modes as long
88+
as you keep the encoding and filter tabs the same in the
89+
chart builder.
90+
91+
.. step:: Describe the chart you want to create.
92+
93+
In the :guilabel:`Prompt` box, specify the chart you want |charts|
94+
to create.
95+
96+
We recommend that you write clear prompts and tag the fields from
97+
your collection with ``@``. The following list provides examples
98+
of clear prompts:
99+
100+
- Use a line chart to display trends in quarterly sales data.
101+
- Display monthly sales revenue for the last year.
102+
- Visualize weekly sales data in year 2022 using a discrete line chart.
103+
- Show the age distribution of our customers.
104+
- Show me the top 3 property_type and all other properties grouped together with the highest price.
105+
106+
.. note::
107+
108+
Your prompt cannot exceed 500 characters.
109+
110+
If you're unsure of what chart you would like to see, you can
111+
choose one of the :guilabel:`Suggested Prompts` and click
112+
:guilabel:`Select`.
113+
114+
.. tip::
115+
116+
If your :guilabel:`Suggested Prompts` section doesn't load,
117+
click :guilabel:`Retry`.
118+
119+
.. figure:: /images/charts/nlc-suggested-prompts.png
120+
:figwidth: 508px
121+
:alt: Natural Language Charts Suggested Prompts Load Error
122+
123+
.. step:: Click :guilabel:`Generate chart`.
124+
125+
|charts| displays your chart and also generates a title based
126+
on your prompt.
127+
128+
.. step:: (Optional) Customize your chart.
129+
130+
To :ref:`customize your chart <customize-charts>`, toggle the
131+
switch on the top navigation from :guilabel:`Natural Language`
132+
to :guilabel:`Classic`.
133+
134+
.. step:: (Optional) Give feedback about your generated chart.
135+
136+
On the bottom-left corner of your generated chart, click the
137+
thumbs up or thumbs down button.
138+
139+
.. step:: Click :guilabel:`Save and Close`.
140+
141+
Disable AI Features
142+
-------------------
143+
144+
If you want to prevent users in your project from using AI features,
145+
disable the AI feature:
146+
147+
.. procedure::
148+
:style: normal
149+
150+
.. step:: In your left navigation menu, click :guilabel:`AI features`.
151+
152+
.. step:: Set the toggle to off.
153+
154+
To learn more, see :website:`New Intelligent Developer Experiences
155+
Compass Atlas Charts Relational Migrator
156+
</blog/post/new-intelligent-developer-experiences-compass-atlas-charts-relational-migrator>`
157+
and :ref:`charts-ai-data-usage`.

‎source/chart-types.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ Chart Types
1414
:depth: 2
1515
:class: singlecol
1616

17+
Natural Language Charts
18+
-----------------------
19+
20+
Natural language charts uses an AI model to create one of the charts
21+
listed below based on a prompt you provide.
22+
1723
Column and Bar Charts
1824
---------------------
1925

@@ -155,6 +161,7 @@ particular chart type.
155161
.. toctree::
156162
:titlesonly:
157163

164+
/chart-type-reference/natural-language-charts
158165
/chart-type-reference/column-bar-chart
159166
/chart-type-reference/line-area-chart
160167
/chart-type-reference/combo-charts

‎source/experimental-features.txt

Lines changed: 3 additions & 145 deletions
Original file line numberDiff line numberDiff line change
@@ -17,151 +17,9 @@ when a |charts| feature is available for evaluation purpose and not
1717
recommended for production deployments. The feature and its
1818
corresponding documentation can change at any time.
1919

20-
.. _nlc:
2120

22-
Natural Language Charts
23-
-----------------------
21+
.. comment the note below out when there are experimental features
2422

25-
Natural language charts simplifies the chart creation process.
26-
It supports the following chart types built with :ref:`series
27-
<charts-series-encoding>` and :ref:`aggregation
28-
<building-charts-aggregation>` :ref:`encoding channels
29-
<encoding-channels>`:
23+
.. note::
3024

31-
- Grouped Bar
32-
- Stacked Bar
33-
- Stacked 100% Bar
34-
- Grouped Column
35-
- Stacked Column
36-
- Stacked 100% Column
37-
- Discrete Line
38-
- Discrete Area
39-
- Stacked 100% Area
40-
- Number
41-
- Table
42-
- Donut
43-
44-
The chart types above support boolean, date, string, and number
45-
:ref:`filtering <interactive-filtering>`, :ref:`sorting
46-
<charts-sort-data>`, :ref:`binning <charts-bin-data>`, and
47-
:ref:`limiting <charts-limit-data>`.
48-
49-
After you enter a prompt about a chart you would like to see, the AI
50-
model creates the chart.
51-
52-
Procedure
53-
~~~~~~~~~
54-
55-
.. procedure::
56-
:style: normal
57-
58-
.. step:: Add a natural language chart.
59-
60-
.. procedure::
61-
:style: connected
62-
63-
.. step:: From the :guilabel:`Dashboards` page, select the dashboard
64-
where you want to add a new chart. For instructions on setting
65-
up a dashboard, see :doc:`Dashboards </dashboards>`.
66-
67-
.. step:: Click the :guilabel:`Add Chart` button.
68-
69-
.. step:: In the :guilabel:`Select Data Source` modal, click the
70-
:guilabel:`Project` tab.
71-
72-
.. step:: In the cluster where you loaded the
73-
sample data, select the ``listingsAndReviews`` collection
74-
in the ``sample_airbnb`` database.
75-
76-
.. step:: Toggle the switch on the top navigation from :guilabel:`Classic` to :guilabel:`Natural Language`.
77-
78-
When you toggle this, you must click the :guilabel:`Use
79-
Natural Language Mode` button in the :guilabel:`Natural
80-
Language Mode` modal to accept the `MongoDB Acceptable
81-
Use Policy
82-
<https://www.mongodb.com/legal/acceptable-use-policy>`__ and
83-
`Privacy Policy
84-
<https://www.mongodb.com/legal/privacy-policy>`__.
85-
86-
.. figure:: /images/charts/nl-mode-modal.png
87-
:figwidth: 300px
88-
:alt: Natural Language Mode Modal
89-
90-
If you click :guilabel:`Back to Classic Mode`, |charts|
91-
switches you back to :guilabel:`Classic` mode.
92-
93-
.. note::
94-
95-
You can seamlessly switch between :guilabel:`Classic`
96-
and :guilabel:`Natural Language` mode. |charts| retains
97-
the prompts and suggestions when you change modes as long
98-
as you keep the encoding and filter tabs the same in the
99-
chart builder.
100-
101-
.. step:: Describe the chart you want to create.
102-
103-
In the :guilabel:`Prompt` box, specify the chart you want |charts|
104-
to create.
105-
106-
We recommend that you write clear prompts and tag the fields from
107-
your collection with ``@``. The following list provides examples
108-
of clear prompts:
109-
110-
- Use a line chart to display trends in quarterly sales data.
111-
- Display monthly sales revenue for the last year.
112-
- Visualize weekly sales data in year 2022 using a discrete line chart.
113-
- Show the age distribution of our customers.
114-
- Show me the top 3 property_type and all other properties grouped together with the highest price.
115-
116-
.. note::
117-
118-
Your prompt cannot exceed 500 characters.
119-
120-
If you're unsure of what chart you would like to see, you can
121-
choose one of the :guilabel:`Suggested Prompts` and click
122-
:guilabel:`Select`.
123-
124-
.. tip::
125-
126-
If your :guilabel:`Suggested Prompts` section does not load,
127-
click :guilabel:`Retry`.
128-
129-
.. figure:: /images/charts/nlc-suggested-prompts.png
130-
:figwidth: 508px
131-
:alt: Natural Language Charts Suggested Prompts Load Error
132-
133-
.. step:: Click :guilabel:`Generate chart`.
134-
135-
|charts| displays your chart and also generates a title based
136-
on your prompt.
137-
138-
.. step:: (Optional) Customize your chart.
139-
140-
To :ref:`customize your chart <customize-charts>`, toggle the
141-
switch on the top navigation from :guilabel:`Natural Language`
142-
to :guilabel:`Classic`.
143-
144-
.. step:: (Optional) Give feedback about your generated chart.
145-
146-
On the bottom-left corner of your generated chart, click the
147-
thumbs up or thumbs down button.
148-
149-
.. step:: Click :guilabel:`Save and Close`.
150-
151-
Disable AI Features
152-
~~~~~~~~~~~~~~~~~~~
153-
154-
If you want to prevent users in your project from using AI features,
155-
disable the AI feature:
156-
157-
.. procedure::
158-
:style: normal
159-
160-
.. step:: In your left navigation menu, click :guilabel:`AI features`.
161-
162-
.. step:: Set the toggle to off.
163-
164-
To learn more, see :website:`New Intelligent Developer Experiences
165-
Compass Atlas Charts Relational Migrator
166-
</blog/post/new-intelligent-developer-experiences-compass-atlas-charts-relational-migrator>`
167-
and :ref:`charts-ai-data-usage`.
25+
Currently, |charts| does not have any experimental features.

‎source/includes/steps-build-new-chart.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,13 @@ content: |
6161
After applying a suggested chart, you can make changes to the chart
6262
type and add or remove fields if you wish to customize the prebuilt
6363
chart.
64+
65+
.. tip::
66+
67+
You can also create a natural language chart by toggling the switch
68+
on the top navigation from :guilabel:`Classic` to
69+
:guilabel:`Natural Language`. To learn more, see :ref:`nlc`.
70+
6471
---
6572
title: Choose your chart type.
6673
ref: new-chart-type

0 commit comments

Comments
 (0)