Skip to content

Commit 7cea9b9

Browse files
authored
Merge pull request #202 from redpanda-data/claude/docs-updates-2026-08-07
docs: Agentic Data Plane docs updates (2026-08-07)
2 parents 55b44f9 + b92974d commit 7cea9b9

7 files changed

Lines changed: 47 additions & 48 deletions

File tree

modules/connect/pages/create-agent.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
:learning-objective-3: Connect to and test a running agent
99

1010
// Source: cloudv2 `proto/public/cloud/redpanda/api/adp/v1alpha1/agent.proto` (AgentCreate, ManagedAgentSpec) cross-referenced against `apps/adp-ui/src/components/agents/managed-create/` (managed-agent-canvas.tsx, model-picker.tsx, subagent-sheet.tsx, instructions-field.tsx, tool-list.tsx), `apps/adp-ui/src/components/agents/agent-detail-sections.tsx`, and `apps/adp-ui/src/routes/_authenticated/agents/$name.index.page.tsx` on cloudv2 main, verified 2026-08-01.
11-
// The managed create flow is a single canvas titled "New managed agent" with sections Identity, Model, Instructions, Tools, and a collapsible Advanced area (Subagents, Tags). The Model picker is a single model-only list; the provider that serves the chosen model is selected automatically. There is no stepper and no editable Agent ID field; the resource slug is derived from the name at submit. The managed agent detail Overview is organized into Agent, Model & runtime, System prompt, MCP servers, and Subagents sections. Managed agent detail tabs are Overview, Triggers, Inspector, Cost & Usage, Transcripts, and Permissions. Credentials and Setup tabs exist only on self-managed agents.
11+
// The managed create flow is a single canvas titled "New managed agent" with sections Identity, Model, Instructions, Tools, and a collapsible Advanced area (Subagents, Tags). The Model picker is a single model-only list; the provider that serves the chosen model is selected automatically. There is no stepper and no editable Agent ID field; the resource slug is derived from the name at submit. The managed agent detail Overview is organized into Agent, Model & runtime, System prompt, MCP servers, and Subagents sections. Managed agent detail tabs are Overview, Triggers, Playground, Cost & Usage, Transcripts, and Permissions. Credentials and Setup tabs exist only on self-managed agents. The interactive test tab, previously labeled Inspector, is now labeled Playground and its URL is `?tab=playground`. Re-verified 2026-08-07.
1212

1313
Create a new glossterm:AI agent[] declaratively through Redpanda Agentic Data Plane. No Python or JavaScript code required. This guide walks through the managed create canvas section by section, then covers how to connect to and test the running agent.
1414

@@ -155,7 +155,7 @@ When the agent is running, open its detail page. A managed agent has these tabs:
155155

156156
* *Overview*: The agent's full configuration, organized into sections that you edit and save one at a time. The *Agent* section holds the display name, description, and tags (the agent ID is fixed). The *Model & runtime* section holds the LLM provider, model, and max iterations, along with the runtime status and endpoint. The *System prompt*, *MCP servers*, and *Subagents* sections hold the instructions, attached servers, and subagents.
157157
* *Triggers*: Schedules and event sources that invoke the agent. See xref:connect:triggers/overview.adoc[].
158-
* *Inspector*: An interactive test surface. See <<test-your-agent,Test your agent>>.
158+
* *Playground*: An interactive test surface. See <<test-your-agent,Test your agent>>.
159159
* *Cost & Usage*: Spend, tokens, and latency for the agent.
160160
* *Transcripts*: A record of every conversation against the agent.
161161
* *Permissions*: The access policies that apply to the agent as a principal. See xref:control:access-policies.adoc[].
@@ -211,12 +211,12 @@ For more about agent cards and how they're consumed, see xref:connect:a2a-concep
211211

212212
Two tabs on the agent detail page support testing and observability:
213213

214-
* *Inspector*: Send test prompts interactively and inspect each step of the agent's reasoning, tool calls, and responses. Use Inspector during development and tuning. The composer shows the agent's provider and model as read-only, so a test run always uses the agent's saved configuration.
214+
* *Playground*: Send test prompts interactively and inspect each step of the agent's reasoning, tool calls, and responses. Use Playground during development and tuning. The composer shows the agent's provider and model as read-only, so a test run always uses the agent's saved configuration.
215215
* *Transcripts*: Records every conversation against the agent (prompt, tool calls, tool outputs, final response). Use transcripts to audit production behavior.
216216

217-
To test the agent in Inspector:
217+
To test the agent in Playground:
218218

219-
. Open the agent's *Inspector* tab.
219+
. Open the agent's *Playground* tab.
220220
. Enter a test prompt.
221221
. Verify the agent:
222222
+

modules/connect/pages/draw-charts.adoc

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
= Draw Charts from an Agent
2-
:description: Make an agent render inline bar and line charts in the Inspector by emitting a chart code block that follows the Agentic Data Plane chart contract.
2+
:description: Make an agent render inline bar and line charts in the Playground by emitting a chart code block that follows the Agentic Data Plane chart contract.
33
:page-topic-type: how-to
44
:personas: agent_builder
55
:learning-objective-1: Instruct an agent to draw a bar or line chart by emitting a chart code block
66
:learning-objective-2: Migrate an earlier chart prompt to the Agentic Data Plane chart contract
77
:learning-objective-3: Diagnose a chart that renders as an error or stays a placeholder
88

9-
// Source: cloudv2 `apps/adp-ui/src/components/agents/inspector/components/chart-block.tsx`, `chart-block-renderer.tsx`, and `ai-elements/response.tsx` on origin/main. Verified 2026-07-28.
9+
// Source: cloudv2 `apps/adp-ui/src/components/agents/inspector/components/chart-block.tsx`, `chart-block-renderer.tsx`, and `ai-elements/response.tsx` on origin/main. Verified 2026-07-28; the agent interaction tab is now labeled Playground (route `?tab=playground`), re-verified 2026-08-07.
1010

1111
An agent draws a chart by emitting a fenced code block tagged `chart` whose body is strict JSON that follows the Agentic Data Plane chart contract.
12-
The Inspector renders the data with the Agentic Data Plane chart components.
12+
The Playground renders the data with the Agentic Data Plane chart components.
1313
The fence body contains data, not Recharts component code.
14-
The agent's *Inspector* tab renders that block with Chart, Data, and Code views.
15-
This is a rendering convention: the agent decides when a chart helps and writes the data, and the Inspector draws it.
14+
The agent's *Playground* tab renders that block with Chart, Data, and Code views.
15+
This is a rendering convention: the agent decides when a chart helps and writes the data, and the Playground draws it.
1616
No tool call or application setup is required.
1717

1818
[IMPORTANT]
@@ -39,14 +39,14 @@ After reading this page, you will be able to:
3939

4040
== How chart rendering works
4141

42-
When the agent's response contains a fenced code block tagged `chart`, the Inspector parses the block body as a chart configuration and draws the chart in place of the code.
42+
When the agent's response contains a fenced code block tagged `chart`, the Playground parses the block body as a chart configuration and draws the chart in place of the code.
4343
Every other code block renders as plain code, so a `chart` block is the agent's only departure from ordinary output.
4444

4545
The renderer supplies the visual presentation.
4646
A valid configuration renders as a responsive SVG chart with the Redpanda theme, a tooltip, and a legend.
4747
The agent supplies the chart type, optional title, labels, series names, and numeric values.
4848

49-
Agentic Data Plane draws a `chart` block wherever it shows the agent's response: the agent's *Inspector* tab and the *Transcripts* tab.
49+
Agentic Data Plane draws a `chart` block wherever it shows the agent's response: the agent's *Playground* tab and the *Transcripts* tab.
5050
When an external application calls the agent, whether that application draws the chart depends on how it renders the agent's output.
5151

5252
== Write the chart block
@@ -57,15 +57,15 @@ Unsupported chart types or invalid values show an error.
5757
* Tag the fence `chart`.
5858
The opening fence is three backticks followed by the word `chart`, with no other language tag.
5959
* Write the body as strict JSON.
60-
The Inspector parses the body with a JSON parser, not a JavaScript evaluator, so use double-quoted keys and strings, unquoted numbers, no trailing commas, no comments, and no JavaScript expressions, functions, or callbacks.
60+
The Playground parses the body with a JSON parser, not a JavaScript evaluator, so use double-quoted keys and strings, unquoted numbers, no trailing commas, no comments, and no JavaScript expressions, functions, or callbacks.
6161
* Set the top-level `type` to `bar` or `line`.
6262
* Add a top-level `data` object with `labels` and `datasets` arrays.
6363
Each dataset contains a `data` array and can include a `label`.
64-
Without a `label`, the Inspector names the series `Series 1`, `Series 2`, and so on.
64+
Without a `label`, the Playground names the series `Series 1`, `Series 2`, and so on.
6565
Values in a dataset must be finite numbers or `null`.
6666
* To display a title, add a top-level `title` string.
6767
* Do not add renderer-specific `options`, plugins, scales, animations, or color properties.
68-
The Inspector controls those presentation details.
68+
The Playground controls those presentation details.
6969

7070
A bar chart:
7171

@@ -121,7 +121,7 @@ Rules for the chart block:
121121
"data" array and can include a "label".
122122
- Do not emit renderer-specific options, plugins, scales, animations, or colors.
123123
- Put a brief plain-text explanation (1 or 2 sentences) before the chart block.
124-
Do not also paste a data table; the Inspector has a built-in Data view.
124+
Do not also paste a data table; the Playground has a built-in Data view.
125125
126126
Example response to "show last quarter's orders by month":
127127
@@ -143,21 +143,21 @@ Orders peaked in February:
143143

144144
For prompt-writing patterns that make this output reliable, see xref:connect:system-prompts.adoc#output-formatting[Output formatting].
145145

146-
== Test the chart in the Inspector
146+
== Test the chart in the Playground
147147

148-
. Open the agent and switch to the *Inspector* tab.
148+
. Open the agent and switch to the *Playground* tab.
149149
. Enter a prompt that calls for a chart, such as `Show the broker count for the demo cluster over the last 3 months as a bar chart`.
150150
. Wait for the agent to finish its response.
151151
The chart appears in place of the `chart` block.
152152

153-
image::connect:agent-chart-rendered.png[alt="The Inspector rendering a bar chart titled Broker count / demo cluster / 3 months, with a Chart, Data, and Code view selector above bars for January, February, and March."]
153+
image::connect:agent-chart-rendered.png[alt="The Playground rendering a bar chart titled Broker count / demo cluster / 3 months, with a Chart, Data, and Code view selector above bars for January, February, and March."]
154154

155155
Use the view selector to switch between:
156156

157157
* *Chart*: The responsive bar or line chart.
158158
Hover over the chart to inspect values.
159159
* *Data*: The chart's values as a table, reconstructed from the configuration.
160-
* *Code*: The JSON configuration the Inspector parsed.
160+
* *Code*: The JSON configuration the Playground parsed.
161161

162162
Zoom, pan, and PNG export are not available.
163163

@@ -186,7 +186,7 @@ Convert other chart types to `bar` or `line`.
186186

187187
|`options`, `plugins`, `scales`, animations, or colors
188188
|Remove them.
189-
The Inspector supplies the presentation.
189+
The Playground supplies the presentation.
190190

191191
|Zoom, pan, or PNG export instructions
192192
|Remove them.
@@ -256,7 +256,7 @@ Common causes include invalid JSON, a missing `type` field, a missing `data` obj
256256
For migration guidance, see <<migrate-chart-js-prompt>>.
257257

258258
|A Building chart… placeholder remains visible
259-
|The placeholder shows while the `chart` block streams in, because the Inspector cannot parse the configuration until the closing fence arrives.
259+
|The placeholder shows while the `chart` block streams in, because the Playground cannot parse the configuration until the closing fence arrives.
260260
The chart replaces the placeholder when the agent finishes the response.
261261
If the response finishes and the body cannot be parsed, the Failed to render chart error replaces the placeholder.
262262
If the placeholder remains after the agent stops responding, instruct the agent to emit one complete `chart` block with a closing fence.

modules/control/pages/cost-usage.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Use *Download full report* when you need the whole dataset rather than the chart
8383

8484
The *Activity* tab answers a different question from the report: instead of what something cost, it shows what's running right now. It ranks the agents with traffic over a window of the last hour (the default), the last 24 hours, or the last 7 days, and shows each agent's change against the previous window. Select an agent to see its recent requests and open a conversation.
8585

86-
The Inspector's live view also hands off to this tab: when an agent task is still running after several minutes, the Inspector points you here to follow it to completion.
86+
The Playground's live view also hands off to this tab: when an agent task is still running after several minutes, the Playground points you here to follow it to completion.
8787

8888
== Next steps
8989

modules/gateway/pages/configure-provider.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ For Bedrock, the picker exposes inference profiles, not raw foundation-model IDs
204204
Redpanda stores models as structured `ProviderModel` entries (one entry per model, with the model name as the only required field). Each model can carry custom pricing overrides that replace the catalog rates for that model in cost reporting; see <<pricing-overrides>>. The legacy flat `models` field still works on writes for backward compatibility.
205205
====
206206

207-
Beyond pricing, the catalog carries each model's capabilities and context-window limits. The model discovery API (the `ListModels` and `GetModel` methods on `ModelService`) reports `max_input_tokens` (the largest context the model accepts) and `max_output_tokens` (the most it can generate in a single response) for each model. Both are read-only catalog metadata: a limit the catalog doesn't declare stays unset rather than reported as zero. Clients read `max_input_tokens` to show how full an agent's context window is, such as the context-window indicator on the agent's *Inspector* tab.
207+
Beyond pricing, the catalog carries each model's capabilities and context-window limits. The model discovery API (the `ListModels` and `GetModel` methods on `ModelService`) reports `max_input_tokens` (the largest context the model accepts) and `max_output_tokens` (the most it can generate in a single response) for each model. Both are read-only catalog metadata: a limit the catalog doesn't declare stays unset rather than reported as zero. Clients read `max_input_tokens` to show how full an agent's context window is, such as the context-window indicator on the agent's *Playground* tab.
208208

209209
[[pricing-overrides]]
210210
=== Override per-model pricing

0 commit comments

Comments
 (0)