Skip to content

Commit 4b8e5b9

Browse files
DOCSP-33097 nlc experimental feature (#627)
* nlc experimental feature
1 parent 82e8343 commit 4b8e5b9

File tree

5 files changed

+137
-1
lines changed

5 files changed

+137
-1
lines changed

snooty.toml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ toc_landing_pages = ["/installation", "/dashboards",
2323
"/embedding-tutorials",
2424
"/embedding-charts-sdk",
2525
"/manage-data-sources",
26-
"/bin-data", "/encoding-channels"]
26+
"/bin-data", "/encoding-channels",
27+
"/experimental-features"]
2728

2829
[constants]
2930
version = "v0.10.0"
@@ -62,3 +63,16 @@ css = ":abbr:`CSS (Cascading Style Sheets)`"
6263
pdf = ":abbr:`PDF (Portable Document Format)`"
6364
png = ":abbr:`PNG (Portable Network Graphic)`"
6465
iot = ":abbr:`IoT (Internet of Things)`"
66+
67+
[[banners]]
68+
# NLC in public preview
69+
targets = [
70+
"index.txt",
71+
"chart-types.txt",
72+
"chart-type-reference/*.txt"
73+
]
74+
75+
variant = "warning"
76+
value = """
77+
Natural Language Charts is available as a Preview feature. The feature and the corresponding documentation might change at any time during the Preview period.
78+
"""

source/experimental-features.txt

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
.. _charts-experimental-features:
2+
3+
=====================
4+
Experimental Features
5+
=====================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
15+
This page lists |charts| current preview features. A preview feature is
16+
when a |charts| feature is available for evaluation purpose and not
17+
recommended for production deployments. The feature and its
18+
corresponding documentation can change at any time.
19+
20+
Natural Language Charts
21+
-----------------------
22+
23+
Natural language charts simplifies the chart creation process. After you
24+
enter a prompt about a chart you would like to see, the AI model
25+
creates the chart.
26+
27+
To use this feature, you can sign up at :website:`the MongoDB Charts product page </products/charts>`.
28+
29+
To learn more, see :website:`New Intelligent Developer Experiences
30+
Compass Atlas Charts Relational Migrator
31+
</blog/post/new-intelligent-developer-experiences-compass-atlas-charts-relational-migrator>`.
32+
33+
Limitations
34+
~~~~~~~~~~~
35+
36+
Natural language charts only supports grouped bar charts,
37+
:ref:`single-series charts <single-series-multiple-fields>`, and
38+
:ref:`multi-series charts <multi-series-charts>` built with :ref:`series
39+
<charts-series-encoding>` and :ref:`aggregation
40+
<building-charts-aggregation>` :ref:`encoding channels
41+
<encoding-channels>`.
42+
43+
Natural language charts do not support :ref:`filtering
44+
<dashboard-filtering>`, :ref:`sorting <charts-sort-data>`, :ref:`binning
45+
<charts-bin-data>`, or :ref:`limiting <charts-limit-data>`.
46+
47+
Procedure
48+
~~~~~~~~~
49+
50+
.. procedure::
51+
:style: normal
52+
53+
.. step:: Add a natural language chart.
54+
55+
.. procedure::
56+
:style: connected
57+
58+
.. step:: From the :guilabel:`Dashboards` page, select the dashboard
59+
where you want to add a new chart. For instructions on setting
60+
up a dashboard, see :doc:`Dashboards </dashboards>`.
61+
62+
.. step:: Click the :guilabel:`Add Chart` button.
63+
64+
.. step:: In the :guilabel:`Select Data Source` modal, click the
65+
:guilabel:`Project` tab.
66+
67+
.. step:: In the cluster where you loaded the
68+
sample data, select the ``listingsAndReviews`` collection
69+
in the ``sample_airbnb`` database.
70+
71+
.. step:: Toggle the switch on the top navigation from :guilabel:`Classic` to :guilabel:`Natural Language`.
72+
73+
When you toggle this, you must click the :guilabel:`Use
74+
Natural Language Mode` button in the :guilabel:`Natural
75+
Language Mode` modal to accept the `MongoDB Acceptable
76+
Use Policy
77+
<https://www.mongodb.com/legal/acceptable-use-policy>`__ and
78+
`Privacy Policy
79+
<https://www.mongodb.com/legal/privacy-policy>`__.
80+
81+
.. figure:: /images/charts/nl-mode-modal.png
82+
:figwidth: 300px
83+
:alt: Natural Language Mode Modal
84+
85+
If you click :guilabel:`Back to Classic Mode`, |charts|
86+
switches you back to :guilabel:`Classic` mode.
87+
88+
.. step:: Describe the chart you want to create.
89+
90+
In the :guilabel:`Prompt` box, specify the chart you want |charts|
91+
to create.
92+
93+
.. note::
94+
95+
Your prompt cannot exceed 500 characters.
96+
97+
If you're unsure of what chart you would like to see, you can
98+
choose one of the :guilabel:`Suggested Prompts` and click
99+
:guilabel:`Select`.
100+
101+
.. tip::
102+
103+
If your :guilabel:`Suggested Prompts` section does not load,
104+
click :guilabel:`Retry`.
105+
106+
.. figure:: /images/charts/nlc-suggested-prompts.png
107+
:figwidth: 508px
108+
:alt: Natural Language Charts Suggested Prompts Load Error
109+
110+
.. step:: Click :guilabel:`Generate chart`.
111+
112+
|charts| displays your chart and also generates a title based
113+
on your prompt.
114+
115+
.. step:: (Optional) Customize your chart.
116+
117+
To :ref:`customize your chart <customize-charts>`, toggle the
118+
switch on the top navigation from :guilabel:`Natural Language`
119+
to :guilabel:`Classic`.
120+
121+
.. step:: Click :guilabel:`Save and Close`.
364 KB
Loading
31.2 KB
Loading

source/index.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,3 +122,4 @@ data and explore key features offered by |charts|:
122122
/pricing
123123
/release-notes
124124
/third-party-licenses
125+
/experimental-features

0 commit comments

Comments
 (0)