docs: add ai component docs and update ai quickstart#5213
docs: add ai component docs and update ai quickstart#5213ugur-vaadin wants to merge 21 commits intomainfrom
Conversation
src/main/java/com/vaadin/demo/flow/aicomponents/AIOrchestratorBasic.java
Show resolved
Hide resolved
| 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 |
There was a problem hiding this comment.
I would write these section titles like we do component names, i.e. "AI Input", "AI Message List", etc.
There was a problem hiding this comment.
Updated the AI component interface section headers.
|
|
||
| [source,java] | ||
| ---- | ||
| // From a ChatModel (managed memory with 30-message window) |
There was a problem hiding this comment.
It remains unclear here where chatModel and chatClient are coming from
There was a problem hiding this comment.
Added brief clarification and short pseudo examples on how to create them
| [.example] | ||
| -- | ||
| ifdef::flow[] | ||
| [source,java] |
There was a problem hiding this comment.
The code snippet here could be expanded by default, as the render alone doesn't provide much use
There was a problem hiding this comment.
Actually I'd argue that goes for all code snippets on this page.
There was a problem hiding this comment.
Expanded the code snippets in the examples.
dcf469e to
9bb337f
Compare
Moved the docs under Flow Reference. It is currently between "Deploying to Production" and "Component Internals" |
|
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. |
rolfsmeds
left a comment
There was a problem hiding this comment.
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?
d4ebefe to
e6913ac
Compare
Continuing the AI components discussion from the internal DS team discussion; some of the options we have are: @yuriy-fix suggested “Building Apps” -> “AI & LLMs” -> “AI in Vaadin Applications”; also changing the existing page in “Building Apps” entirely |
|
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. |
Co-authored-by: Jouni Koivuviita <jouni@vaadin.com>
Co-authored-by: Tomi Virkki <tomivirkki@users.noreply.github.com>
611198c to
d141e6d
Compare
|
Updated the PR:
|
There was a problem hiding this comment.
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. |
This PR