Vaadin Docs Assistant 2.0 🤖

Building on the Documentation Service work I wrote about last week, I have released an updated version of the Vaadin Docs Assistant.

Updates:

  • Uses updated vector embeddings based on the work-in-progress Vaadin way documentation
  • Completely re-written using Spring AI, taking advantage of the new advanced RAG functionality to compress and rewrite queries for better search performance
  • Added guardrails to keep discussions on topic
  • Uses gpt-4o-mini

Known issues:

  • There are remaining issues with Flow/Hilla classification of some docs and you may get incorrect API code examples
  • The documentation is still work-in-progress and does not yet cover everything. The embeddings are re-run each night so the assistant stays up to date.

This is a research project and does not come with any warranties or guarantees. That said, I would love for you to try it out and give feedback:

  • Does it seem to give helpful answers?
  • If you run into odd behavior, please share insights in this thread to help me pinpoint issues and improve the implementation.

:robot: Try the updated Vaadin Docs Assistant
:octopus: Source Code

6 Likes

Just noticed there’s a bit of an issue. If you include anything with curly brackets (like code) in your prompt, it breaks Spring AI templating :man_facepalming:

I’ll need to rework that part so you can actually include code in your questions.

sounds nice! I’ll look definitely into your updates.
I used the first version as a template for our internal AI tool :slight_smile:

There seems to be something wrong with the page structure.
It is not possible to scroll the result with the mouse scroll wheel.
Dragging scrollbars work

Firefox 135.0.1
Windows 10

There’s a known scroll issue with the underlying chat component I’m using, hopefully it should get resolved when we sort that out.