docs: add ai controller documentation by ugur-vaadin · Pull Request #5473 · vaadin/docs

ugur-vaadin · 2026-04-13T15:51:32Z

No description provided.

github-actions · 2026-04-13T16:03:58Z

Preview Deployment

This PR has been deployed for preview.

URL: https://docs-preview-pr-5473.fly.dev

Built from e7d1cb7

jouni · 2026-04-14T10:57:41Z

+
+= [since:com.vaadin:vaadin@V25.2]#AI-Powered Chart#
+
+ifdef::flow[]


I don't see any point with these conditionals.

Suggested change

ifdef::flow[]

jouni · 2026-04-14T10:57:53Z

+
+[classname]`ChartAIController` manages a single chart. To expose several charts to the same orchestrator -- for example in a dashboard -- implement a custom [classname]`AIController` that builds its tool list from [classname]`ChartAITools.createAll()` with a [classname]`ChartAITools.Callbacks` implementation that returns a stable ID per chart.
+
+endif::flow[]


Suggested change

endif::flow[]

jouni · 2026-04-14T10:58:01Z

+
+= [since:com.vaadin:vaadin@V25.2]#AI-Powered Grid#
+
+ifdef::flow[]


Suggested change

ifdef::flow[]

jouni · 2026-04-14T10:58:09Z

+
+[classname]`GridAIController` manages a single grid. To coordinate several grids from the same orchestrator, implement a custom [classname]`AIController` that builds its tool list from [classname]`GridAITools.createAll()` with a custom [classname]`GridAITools.Callbacks` implementation. The callbacks -- [methodname]`getGridIds()`, [methodname]`getState(gridId)`, and [methodname]`updateData(gridId, query)` -- let the LLM address each grid by its ID.
+
+endif::flow[]


Suggested change

endif::flow[]

jouni · 2026-04-14T10:58:21Z

+
+= [since:com.vaadin:vaadin@V25.2]#Controllers#
+
+ifdef::flow[]


Suggested change

ifdef::flow[]

jouni · 2026-04-14T10:58:31Z

+[TIP]
+Return only the tables, columns, and relationships the LLM needs. A smaller, well-described schema produces better queries, uses fewer tokens, and reduces the chance of leaking sensitive columns.
+
+endif::flow[]


Suggested change

endif::flow[]

jouni · 2026-04-14T10:58:49Z

 :feature-flag: com.vaadin.experimental.aiComponents
 include::{articles}/_preview-banner.adoc[opts=optional]

 ifdef::flow[]


Suggested change

jouni · 2026-04-14T10:59:45Z

 section_outline::[]


 endif::flow[]


Suggested change

jouni · 2026-04-14T11:02:39Z


 = Tool Calling & Programmatic Prompts

 ifdef::flow[]


Suggested change

jouni · 2026-04-14T11:02:45Z

 [IMPORTANT]
 [methodname]`prompt()` requires an active UI context. If called from a background thread or outside a Vaadin request, it throws an [classname]`IllegalStateException`. Always call [methodname]`prompt()` from within a UI event handler or wrap the call in `ui.access()`.

 endif::flow[]


Suggested change

tomivirkki · 2026-04-15T09:49:03Z

+ChartState saved = sessionStore.load(sessionId);
+if (saved != null) {
+    controller.restoreState(saved);
+}


I think this step isn't necessary, the chart's own state survives the serialization and doesn't need to be explicitly restored. Same thing with Grid

tomivirkki · 2026-04-15T09:51:47Z

+[source,java]
+----
+controller.addStateChangeListener(state ->
+        sessionStore.save(sessionId, state));


Maybe sessionStore isn't ideal here since the primary use-case for state persistence is to restore the state across separate sessions (e.g. when a user logs in later and the original component no longer exists)

docs: add ai controller docoumentation

e5fcc24

ugur-vaadin requested a review from tomivirkki April 13, 2026 16:05

ugur-vaadin changed the title ~~docs: add ai controller docoumentation~~ docs: add ai controller documentation Apr 13, 2026

jouni reviewed Apr 14, 2026

View reviewed changes

tomivirkki reviewed Apr 15, 2026

View reviewed changes


		= [since:com.vaadin:vaadin@V25.2]#AI-Powered Chart#

		ifdef::flow[]


		[classname]`ChartAIController` manages a single chart. To expose several charts to the same orchestrator -- for example in a dashboard -- implement a custom [classname]`AIController` that builds its tool list from [classname]`ChartAITools.createAll()` with a [classname]`ChartAITools.Callbacks` implementation that returns a stable ID per chart.

		endif::flow[]


		[classname]`GridAIController` manages a single grid. To coordinate several grids from the same orchestrator, implement a custom [classname]`AIController` that builds its tool list from [classname]`GridAITools.createAll()` with a custom [classname]`GridAITools.Callbacks` implementation. The callbacks -- [methodname]`getGridIds()`, [methodname]`getState(gridId)`, and [methodname]`updateData(gridId, query)` -- let the LLM address each grid by its ID.

		endif::flow[]

Conversation

ugur-vaadin commented Apr 13, 2026

Uh oh!

github-actions bot commented Apr 13, 2026

Preview Deployment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants