Skip to content

docs: add ai component docs and update ai quickstart#5213

Open
ugur-vaadin wants to merge 21 commits intomainfrom
docs-add-ai-component-docs-and-update-ai-quickstart
Open

docs: add ai component docs and update ai quickstart#5213
ugur-vaadin wants to merge 21 commits intomainfrom
docs-add-ai-component-docs-and-update-ai-quickstart

Conversation

@ugur-vaadin
Copy link
Contributor

@ugur-vaadin ugur-vaadin commented Feb 24, 2026

This PR

  • adds AI components documentation
  • updates the "Building apps" AI section and the quick start guide

Copy link
Contributor

@rolfsmeds rolfsmeds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly LGTM. However, I can't help but feel that Components is a weird place for this.
An AI subsection in the Flow Reference top-level section would seem more logical. Does @peholmst have opinions?

The orchestrator's builder accepts both standard Vaadin components and custom implementations of the AI interfaces. This allows you to swap in custom UI components without changing the orchestrator wiring.


=== AIInput
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would write these section titles like we do component names, i.e. "AI Input", "AI Message List", etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the AI component interface section headers.


[source,java]
----
// From a ChatModel (managed memory with 30-message window)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It remains unclear here where chatModel and chatClient are coming from

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added brief clarification and short pseudo examples on how to create them

[.example]
--
ifdef::flow[]
[source,java]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code snippet here could be expanded by default, as the render alone doesn't provide much use

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I'd argue that goes for all code snippets on this page.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Expanded the code snippets in the examples.

@ugur-vaadin ugur-vaadin force-pushed the docs-add-ai-component-docs-and-update-ai-quickstart branch from dcf469e to 9bb337f Compare February 25, 2026 13:18
@ugur-vaadin
Copy link
Contributor Author

Mostly LGTM. However, I can't help but feel that Components is a weird place for this. An AI subsection in the Flow Reference top-level section would seem more logical. Does @peholmst have opinions?

Moved the docs under Flow Reference. It is currently between "Deploying to Production" and "Component Internals"

@peholmst
Copy link
Member

Putting this article in the Flow reference seems right. Let's do that. We can change it later if it turns out not to work.

Copy link
Contributor

@rolfsmeds rolfsmeds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, although I wonder if we should call this "AI Components" – does "components" give too much "UI components" vibes? I mean, these features are in a package called com.vaadin.flow.component.ai, but would there be a better umbrella term for these features? Something like AI Helpers or something?

@ugur-vaadin ugur-vaadin force-pushed the docs-add-ai-component-docs-and-update-ai-quickstart branch from d4ebefe to e6913ac Compare February 27, 2026 16:53
@ugur-vaadin ugur-vaadin removed the request for review from yuriy-fix March 2, 2026 08:26
@ugur-vaadin
Copy link
Contributor Author

ugur-vaadin commented Mar 3, 2026

LGTM, although I wonder if we should call this "AI Components" – does "components" give too much "UI components" vibes? I mean, these features are in a package called com.vaadin.flow.component.ai, but would there be a better umbrella term for these features? Something like AI Helpers or something?

Continuing the AI components discussion from the internal DS team discussion; some of the options we have are:
Nav name:AI & LLMs” (same with “Building Apps”) vs “AI” vs “AI Integration
Page name:AI in Vaadin Applications” (same with “Building Apps”) vs “Integrating AI into Vaadin Applications
Location: Under “Integrations” vs “Flow Reference” vs “Building Apps

@yuriy-fix suggested “Building Apps” -> “AI & LLMs” -> “AI in Vaadin Applications”; also changing the existing page in “Building Apps” entirely

@peholmst
Copy link
Member

peholmst commented Mar 3, 2026

I have now looked at the articles. Here are my two cents.

First, I noticed the AI Components page under Flow is very long. I think splitting it up into smaller sub-pages would be beneficial. The location for this is correct, because this is reference-style material.

Second, the "AI Components" title feels a bit misleading. Maybe "AI Support" or "AI Integration" or "AI Enabled Apps" would be better. I don't think it should be under Integrations because that's not where I would look for it. Its current level and position in the nav tree is fine.

@ugur-vaadin ugur-vaadin force-pushed the docs-add-ai-component-docs-and-update-ai-quickstart branch from 611198c to d141e6d Compare March 4, 2026 08:44
@ugur-vaadin
Copy link
Contributor Author

Updated the PR:

  • The page name is now "AI Support"

  • Still under "Flow Reference"

  • Split the page into smaller sections:

    • Overview
    • Component Interfaces
    • LLM Providers
    • File Attachments
    • Tool Calling & Programmatic Prompts
    • Conversation History & Session Persistence

Copy link
Contributor

@rolfsmeds rolfsmeds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Just a couple of things I think we should add:

  • Add a link to this section from components/message-list#usage-for-ai-chats
  • Replace the term "AI Components" in the quick start guide with something like AI support features
  • Replace the term "AI Components" in the preview admonitions to something like that too
  • On the Component Interfaces page
    • Link from the mentions of MessageList and MessageInput to those component pages
    • Link from the mentions of Upload / UploadManager to the Upload component page.

@ugur-vaadin
Copy link
Contributor Author

LGTM. Just a couple of things I think we should add:

  • Add a link to this section from components/message-list#usage-for-ai-chats

  • Replace the term "AI Components" in the quick start guide with something like AI support features

  • Replace the term "AI Components" in the preview admonitions to something like that too

  • On the Component Interfaces page

    • Link from the mentions of MessageList and MessageInput to those component pages
    • Link from the mentions of Upload / UploadManager to the Upload component page.

Updated the naming and added the links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants