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 4a1b56e

rolfsmeds

Could mention somewhere on AI-Powered Charts page that it can be combined with Dashboard (link) to create persistable, end-user configurable AI-generated dashboards.
The Building Apps > AI > Quick Start Guide could link to AI charts & grids pages in the Next Possible Steps section.
Grid docs page should link to AI-Powered Grid page somewhere (e.g. below Related Components table)
Charts docs should link to AI-Powered Charts page somewhere (it's such a big deal that I think we should create a new sub-page for it that repeats the basic example and links to the AI Grid page)
File Attachments page should linkn to UploadManager docs.
On the LLM Providers page, one sentence explaining what AI frameworks are, and how they relate to LLM models, would be good for the non-initiated.
In the Basic Usage example, getLLMProvider seems superfluous as it just initializes one class. Would be better for understandability to just initialize the Mock provider right there instead of a separate method.

rolfsmeds · 2026-05-12T15:46:32Z


 * **Orchestrator** -- [classname]`AIOrchestrator` is a non-visual coordination engine that connects UI components to an LLM provider. It has no DOM element and should not be added to a layout.
-* **Provider** -- [classname]`LLMProvider` is the interface for communicating with LLM frameworks. Create a provider by instantiating [classname]`SpringAILLMProvider` or [classname]`LangChain4JLLMProvider` directly. You can also implement this interface to connect to any other LLM framework.
+* **Provider** -- plugs the orchestrator into any LLM framework. Spring AI and LangChain4j are built in via [classname]`SpringAILLMProvider` and [classname]`LangChain4JLLMProvider`; add others by implementing the [classname]`LLMProvider` interface.


Maybe better to use the term LLM Provider here?

Updated to use "LLM Provider".

rolfsmeds · 2026-05-12T15:48:26Z

@@ -8,8 +8,6 @@ order: 40

 = Tool Calling & Programmatic Prompts



One sentence explainer of what tools are would be good for the non-initiated. Maybe also mention (and link to) Controllers, as they are related.

Added:

an intro paragraph at the top of the page

note that controllers are the framework-agnostic alternative

the link

rolfsmeds · 2026-05-12T15:50:28Z

+    }
+
+    @Override
+    public String getSchema() {


Should we also mention here that you can get the schema automagically through a query, so that you don't have to paste everything here in a hardcoded string and remember to update it whenever it changes?

Should also clearly indicate that you can add whatever free-form additional information here e.g. explaining the fields etc.

Added a paragraph after the JdbcDatabaseProvider example explaining that getSchema() can return whatever helps the LLM. It includes building the description at runtime and adding free-form info.

rolfsmeds · 2026-05-12T15:51:25Z

+= [since:com.vaadin:vaadin@V25.2]#AI-Powered Grid#
+
+
+[classname]`GridAIController` populates a [classname]`Grid` with data from the application database based on natural-language requests. Backed by a <<controllers#database-provider,[classname]`DatabaseProvider`>>, the controller lets the LLM inspect the database schema and run SQL queries that drive the grid.


Link to Grid docs page.
Explain what Grid is ("table or datagrid component") for those ending up here from Google without familiarity with Vaadin.

Added the link and a description of the Grid.

rolfsmeds · 2026-05-12T15:52:06Z

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


Can we assume everyone is familiar with sessionStore? If not, should briefly explain and mention other alternatives.

Added a follow-up sentence after the listener snippet noting that it is a placeholder for the developer's own storage.

rolfsmeds · 2026-05-12T15:52:27Z

+= [since:com.vaadin:vaadin@V25.2]#AI-Powered Chart#
+
+
+[classname]`ChartAIController` creates and updates a [classname]`Chart` visualization based on natural-language requests. Backed by a <<controllers#database-provider,[classname]`DatabaseProvider`>>, the controller lets the LLM inspect the database schema, write SQL queries for one or more series, and update the Highcharts configuration independently of the data.


Link to Chart docs.

Added the link.

rolfsmeds · 2026-05-12T15:52:50Z

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


Same as for Grid: can we assume everybody knows sessionStore?

Added a follow-up sentence here too.

ugur-vaadin · 2026-05-15T10:47:27Z

Could mention somewhere on AI-Powered Charts page that it can be combined with Dashboard (link) to create persistable, end-user configurable AI-generated dashboards.

Added a "Combining with Dashboard" section at the end of the page, with a link to the Dashboard component docs.

The Building Apps > AI > Quick Start Guide could link to AI charts & grids pages in the Next Possible Steps section.

Added links to the "Next Possible Steps" section.

Grid docs page should link to AI-Powered Grid page somewhere (e.g. below Related Components table)

Added a bullet to the sub-pages list linking to AI-Powered Grid.

Charts docs should link to AI-Powered Charts page somewhere (it's such a big deal that I think we should create a new sub-page for it that repeats the basic example and links to the AI Grid page)

Created a dedicated sub-page under the Charts section. It repeats the basic example and links to the full AI-Powered Chart page, as well as to AI-Powered Grid.

File Attachments page should linkn to UploadManager docs.

Added links to the Upload component docs.

On the LLM Providers page, one sentence explaining what AI frameworks are, and how they relate to LLM models, would be good for the non-initiated.

Added an opening sentence.

In the Basic Usage example, getLLMProvider seems superfluous as it just initializes one class. Would be better for understandability to just initialize the Mock provider right there instead of a separate method.

Removed `getLLMProvider().

Co-authored-by: Jouni Koivuviita <jouni@vaadin.com>

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

Comment thread articles/flow/ai-support/ai-powered-chart.adoc Outdated

ugur-vaadin force-pushed the docs-add-ai-controller-docoumentation branch from e5fcc24 to a1bb498 Compare April 22, 2026 11:32

tomivirkki reviewed Apr 23, 2026

View reviewed changes

Comment thread articles/flow/ai-support/controllers.adoc Outdated

ugur-vaadin marked this pull request as ready for review April 23, 2026 14:52

tomivirkki reviewed Apr 27, 2026

View reviewed changes

Comment thread articles/flow/ai-support/controllers.adoc Outdated

rolfsmeds reviewed May 12, 2026

View reviewed changes

ugur-vaadin force-pushed the docs-add-ai-controller-docoumentation branch from a144bc5 to 6633c77 Compare May 15, 2026 10:40

rolfsmeds approved these changes May 22, 2026

View reviewed changes

ugur-vaadin and others added 16 commits May 22, 2026 15:25

docs: add ai controller docoumentation

9291421

Update articles/flow/ai-support/ai-powered-chart.adoc

d4bd01f

Co-authored-by: Jouni Koivuviita <jouni@vaadin.com>

Update articles/flow/ai-support/ai-powered-chart.adoc

4059f84

Co-authored-by: Jouni Koivuviita <jouni@vaadin.com>

Update articles/flow/ai-support/ai-powered-grid.adoc

ee50e9a

Co-authored-by: Jouni Koivuviita <jouni@vaadin.com>

Update articles/flow/ai-support/controllers.adoc

4b8df58

Co-authored-by: Jouni Koivuviita <jouni@vaadin.com>

Update articles/flow/ai-support/ai-powered-grid.adoc

9fe413c

Co-authored-by: Jouni Koivuviita <jouni@vaadin.com>

Update articles/flow/ai-support/controllers.adoc

bf0ba0d

Co-authored-by: Jouni Koivuviita <jouni@vaadin.com>

docs: remove unnecessary lines

dc40dc2

docs: move tools to end of controller pages

0b65547

docs: remove unnecessary restore state from examples

229d07e

docs: cleanup chart tools description

bea3331

docs: update articles based on changes

99648fc

docs: polish based on updates

a8064c4

docs: fix issues with documentation

36a7c80

docs: update method name

aa5f71b

docs: link ai features from related components and quickstart

426ae89

ugur-vaadin added 8 commits May 22, 2026 15:25

docs: explain components and ai frameworks

83ee926

docs: rename provider to llm provider

e8836c4

docs: introduce tool calling for newcomers

329e214

docs: note schema flexibility on db example

969aa49

docs: explain sessionstore placeholder

382e64f

docs: describe combining ai chart with dashboard

e3b8f28

docs: simplify basic orchestrator example

17c7c37

docs: reword to address vale lint warnings

280fbb4

ugur-vaadin force-pushed the docs-add-ai-controller-docoumentation branch from a744646 to 280fbb4 Compare May 22, 2026 12:25

		@@ -8,8 +8,6 @@ order: 40

		= Tool Calling & Programmatic Prompts

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


		[classname]`GridAIController` populates a [classname]`Grid` with data from the application database based on natural-language requests. Backed by a <<controllers#database-provider,[classname]`DatabaseProvider`>>, the controller lets the LLM inspect the database schema and run SQL queries that drive the grid.

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


		[classname]`ChartAIController` creates and updates a [classname]`Chart` visualization based on natural-language requests. Backed by a <<controllers#database-provider,[classname]`DatabaseProvider`>>, the controller lets the LLM inspect the database schema, write SQL queries for one or more series, and update the Highcharts configuration independently of the data.

Conversation

ugur-vaadin commented Apr 13, 2026

Uh oh!

github-actions Bot commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Preview Deployment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rolfsmeds left a comment

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!

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!

ugur-vaadin commented May 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions Bot commented Apr 13, 2026 •

edited

Loading