Skip to content

Commit 928fdf7

Browse files
committed
docs: add ai agent content editing guide
1 parent 39c5460 commit 928fdf7

3 files changed

Lines changed: 74 additions & 1 deletion

File tree

docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,7 @@
154154
"guides/ai-agents/data-access",
155155
"guides/ai-agents/best-practices",
156156
"guides/ai-agents/self-improvement",
157+
"guides/ai-agents/content-tools",
157158
"guides/ai-agents/mcp-servers",
158159
"guides/ai-agents/autopilot"
159160
]

guides/ai-agents.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ This guide covers everything you need to know about AI agents in Lightdash:
4242
</Card>
4343
<Card title="Self-improvement (Beta)" icon="sparkles" horizontal href="/guides/ai-agents/self-improvement">
4444

45+
</Card>
46+
<Card title="Creating & editing content (Beta)" icon="pen-to-square" horizontal href="/guides/ai-agents/content-tools">
47+
4548
</Card>
4649
</CardGroup>
4750

@@ -63,4 +66,5 @@ This guide covers everything you need to know about AI agents in Lightdash:
6366
- **Multiple agents** - Create specialized agents for different teams or use cases
6467
- **Evaluations** - Create test suites to validate your agent’s answers and prevent regressions.
6568
- **Conversations** - Monitor all agent interactions in one place, review feedback, and build evaluation sets directly from real threads.
66-
- **Self-improvement (Beta)**- Agents can propose changes to your semantic layer
69+
- **Self-improvement (Beta)**- Agents can propose changes to your semantic layer
70+
- **Creating & editing content (Beta)** - Agents can build and edit charts and dashboards on request

guides/ai-agents/content-tools.mdx

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Creating and editing content (Beta)
3+
sidebarTitle: Creating & editing content
4+
description: Let AI agents build and edit charts and dashboards in Lightdash
5+
---
6+
7+
<Info>
8+
**Availability:** Content editing is a [Beta](/references/workspace/feature-maturity-levels) feature. Enable it for a specific agent when you are ready for that agent to create and update saved Lightdash content.
9+
</Info>
10+
11+
By default, AI agents answer questions and propose visualizations without changing your saved charts and dashboards. When content editing is enabled, an agent can also save new content and update existing content when you ask it to.
12+
13+
## What agents can do
14+
15+
When content editing is enabled, your agent can:
16+
17+
**Create saved content:**
18+
19+
- Build a new chart from a question and save it to a space
20+
- Build a new dashboard from scratch, following Lightdash dashboard best practices for chart choice, layout, filters, tabs, and supporting detail
21+
- Add charts, headings, filters, and tabs to a new or existing dashboard
22+
23+
**Edit existing content:**
24+
25+
- Add, remove, or rearrange tiles on a dashboard
26+
- Organize a dashboard into tabs
27+
- Add or change dashboard filters
28+
- Update a chart's fields, filters, or visualization
29+
- Rename content or update its description
30+
- Move charts and dashboards to another space
31+
32+
## Spaces
33+
34+
Content created by an agent is saved in a Lightdash space, just like content created from the Explore page or dashboard editor. Tell the agent which space to use when you want the content saved somewhere specific. If you do not name a space, the agent can choose the best match from the spaces it has access to.
35+
36+
The agent's access is limited by its [space access](/guides/ai-agents/getting-started). If the agent cannot access a space, it cannot create, edit, or move content there.
37+
38+
For example, ask the agent to "add this chart to the Revenue dashboard", "move this dashboard to the Finance space", or "create an executive sales dashboard in the Leadership space".
39+
40+
## Permissions
41+
42+
Content editing is available only when all of these are true:
43+
44+
1. **The agent has content editing enabled.** This is a setting on each agent.
45+
2. **The requesting user has permission to use dashboards as code.** This is included for admins and developers.
46+
47+
Turning the setting on does not give viewers or interactive viewers new permissions. If they ask the agent to create or edit saved content, the agent will not have those tools available.
48+
49+
<Info>
50+
**In the Lightdash app:** the logged-in user's permissions are used for every request.
51+
52+
**In Slack:** By default, an agent acts as the user who created it. To evaluate each Slack user's own permissions, enable the **AI Agents OAuth requirement** toggle in your [Lightdash Slack settings](/references/integrations/slack-integration#ai-agents-configuration). Until a Slack user connects their Slack account to Lightdash, content editing stays disabled for them.
53+
</Info>
54+
55+
## Enabling content editing
56+
57+
Only admins and developers can enable content editing for an agent:
58+
59+
1. Go to your agent settings
60+
2. Toggle **Allow agent to manage Lightdash content**
61+
3. Save your changes
62+
63+
## Reviewing changes
64+
65+
Content an agent creates or edits is saved like any other chart or dashboard, with the agent recorded as the editor. Because changes are saved immediately, treat content editing as you would any contributor with edit access:
66+
67+
- Scope each agent with [space access](/guides/ai-agents/getting-started) so it can only work in the spaces you intend
68+
- Use [version history](/guides/version-history) on a chart or dashboard to review or revert an agent's edits

0 commit comments

Comments
 (0)