-
Notifications
You must be signed in to change notification settings - Fork 2.1k
docs: fill four small customer-facing doc gaps #11593
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
a02d0c6
39dbb23
7d32b8f
0198097
77d1194
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,13 @@ | ||
| --- | ||
| title: AI summary | ||
| title: Analysis | ||
| description: Generate natural-language summaries of dashboard data on demand using an AI agent. | ||
| --- | ||
|
|
||
| AI summary widgets generate a natural-language summary of the data shown on the dashboard. Write a prompt — for example, _"Summarize the key trends and call out anything unusual"_ — and the configured [AI agent][ref-agents] produces a Markdown narrative based on the current dashboard state, including the data behind every chart and the values of any active [controls][ref-controls]. | ||
| Analysis widgets generate a natural-language summary of the data shown on the dashboard. Write a prompt — for example, _"Summarize the key trends and call out anything unusual"_ — and the configured [AI agent][ref-agents] produces a Markdown narrative based on the current dashboard state, including the data behind every chart and the values of any active [controls][ref-controls]. | ||
|
|
||
| ## Adding an AI summary | ||
| ## Adding an Analysis widget | ||
|
|
||
| In the [dashboard builder][ref-workbooks], add an AI summary from the **Add Widgets** menu in the toolbar. The widget opens with a prompt editor — write your prompt and click **Generate Summary** to produce the first response. | ||
| In the [dashboard builder][ref-workbooks], add an Analysis widget from the **Add Widgets** menu in the toolbar. The widget opens with a prompt editor — write your prompt and click **Run** to produce the first response. A widget that hasn't been run yet shows "Analysis is not run yet" with a **Run** button. | ||
|
|
||
| ## Use cases | ||
|
|
||
|
|
@@ -28,11 +28,11 @@ Once generated, the summary is **cached** with the widget. Viewers loading the d | |
|
|
||
| The widget keeps a checksum of the dashboard state at the time of generation: the queries behind each chart, the active control values, and the chart configuration. When any of those change, the widget marks the cached summary as **stale** and shows a refresh prompt so viewers know the narrative may no longer match the data. | ||
|
|
||
| Click the refresh icon (or open the widget menu and choose **Refresh**) to regenerate using the saved prompt against the latest state. | ||
| On a published dashboard, a widget that has run shows a freshness indicator instead of a menu — colored by how old the data is, with a tooltip reading "Refreshed *N* ago". Open it and choose **Refresh** to regenerate using the saved prompt against the latest state. The dashboard's **Refresh all charts** control also refreshes any Analysis widget that has already run at least once. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Two small issues with this replacement:
|
||
|
|
||
| ## Choosing the agent | ||
|
|
||
| By default, AI summaries use the agent configured at the dashboard level. You can override the agent per widget when you need a particular [agent's][ref-agents] tooling, model, or guardrails for a specific summary. | ||
| By default, Analysis widgets use the agent configured at the dashboard level. You can override the agent per widget when you need a particular [agent's][ref-agents] tooling, model, or guardrails for a specific summary. | ||
|
|
||
| [ref-workbooks]: /docs/explore-analyze/workbooks | ||
| [ref-agents]: /admin/ai | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -187,23 +187,29 @@ For any MCP-compatible client: | |||||||||||||
|
|
||||||||||||||
| An MCP client is not locked to a single deployment for the whole session. After | ||||||||||||||
| connecting, it can discover the deployments and agents you can access and target a | ||||||||||||||
| specific one on each request. | ||||||||||||||
|
|
||||||||||||||
| Three tools work together: | ||||||||||||||
| specific one on each request — every tool except `listDeployments` accepts an optional | ||||||||||||||
| **`deploymentId`**, and falls back to the deployment resolved at connect time when it's | ||||||||||||||
| omitted. | ||||||||||||||
|
Comment on lines
+190
to
+192
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The blanket rule here is contradicted by the "Resuming a conversation" paragraph 20 lines down. This says every tool except Suggest forward-referencing the exception here:
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| - **`listDeployments`** — discovery. Returns every deployment you can access via MCP | ||||||||||||||
| (already filtered by the admin's deployment-access settings and your permissions) and | ||||||||||||||
| each deployment's agents. Use it to find valid `deploymentId` and `agentId` values | ||||||||||||||
| before calling `chat`. Every deployment offers an **Auto** agent (`agentId: null`) in | ||||||||||||||
| addition to any configured agents. | ||||||||||||||
| each deployment's agents. Use it to find valid `deploymentId` and `agentId` values. | ||||||||||||||
| Every deployment offers an **Auto** agent (`agentId: null`) in addition to any | ||||||||||||||
| configured agents. | ||||||||||||||
| - **`chat`** — accepts two optional selection parameters: | ||||||||||||||
| - **`deploymentId`** — the deployment to use for this request. When omitted, the chat | ||||||||||||||
| uses the deployment from the current session (the default resolved at connect time). | ||||||||||||||
| - **`agentId`** — the agent to use for this request. When omitted or `null`, the | ||||||||||||||
| deployment's **Auto** agent is used. Pass a specific `agentId` to route to a | ||||||||||||||
| configured agent. | ||||||||||||||
| - **`loadQueryResults`** — paginates through the results of a previous query on the same | ||||||||||||||
| deployment context. | ||||||||||||||
| - **Every other tool** — dashboard authoring, data model editing, query and discovery, | ||||||||||||||
| and pre-aggregation tools all accept the same optional `deploymentId`, resolved and | ||||||||||||||
| permission-checked the same way as for `chat`. | ||||||||||||||
|
|
||||||||||||||
| **Resuming a conversation.** `loadQueryResults` and `visualize`, and `chat` when it's | ||||||||||||||
| passed an existing `chatId`, act on a thread that already belongs to one deployment — | ||||||||||||||
| they derive `deploymentId` from that thread instead of accepting an arbitrary one, and | ||||||||||||||
| reject a `deploymentId` that conflicts with it. | ||||||||||||||
|
|
||||||||||||||
| A typical client workflow: | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"the largest grid is 5 × 5, or twenty-five panels" is stated unconditionally, but per the Options table Rows is only shown once a Second dimension is chosen. So with a single split dimension the ceiling is 5 panels (Columns alone), not 25 — the 25-panel maximum is reachable only in the two-dimension case. Worth qualifying so a reader with one dimension doesn't expect to be able to draw 25 panels.