HHH-19880 Move Hibernate Tools' hibernate-assistant module to Hibernate ORM
#11156
+1,548
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mbellade
force-pushed
the
language-module
branch
from
a2b92a1 to
b6b6d0e
Compare
yrodiere
reviewed
Oct 28, 2025
documentation/src/main/asciidoc/userguide/chapters/assistant/Assistant.adoc
Show resolved
Hide resolved
documentation/src/main/asciidoc/userguide/chapters/assistant/Assistant.adoc
Outdated
Show resolved
Hide resolved
documentation/src/main/asciidoc/userguide/chapters/assistant/Assistant.adoc
Outdated
Show resolved
Hide resolved
documentation/src/main/asciidoc/userguide/chapters/assistant/Assistant.adoc
Outdated
Show resolved
Hide resolved
documentation/src/main/asciidoc/userguide/chapters/assistant/Assistant.adoc
Outdated
Show resolved
Hide resolved
Comment on lines
17
to
21
| - Access to data is *constrained to the mapped domain model*. The only tables the LLM will be able to access are the ones that have a corresponding entity class, and only columns listed as fields in your objects can be read. Furthermore, custom filters and SQL restrictions can be applied to further restrict the scope of the data exposed through these tools. You don’t have to worry about creating custom database-level users or permissions only to ensure sensitive information is not exposed to AI services; | ||
| - Natively maps results to *Java objects* for direct application consumption, but can also be serialized and passed back to the model to obtain an *informed natural language response based on your existing data*; | ||
| - Hibernate’s query language parsing can identify the *type of query* being executed and prevent accidental data modifications when the user only meant to read data; | ||
| - *Fail-early* in case generative AI produces incorrect statements. Thanks to Hibernate’s advanced query validation and type-safety features, we don’t need to make a round-trip to the database before noticing a problem, increasing both reliability and overall performance. It’s also easy to understand what the problem with the generated query is thanks to clear error messages, and attempt to solve it either manually or with subsequent prompts; | ||
| - With HQL it’s easier to write more *complex queries* involving multiple entities (i.e. tables) thanks to associations, embeddable values and inheritance. LLMs have an easier time generating valid queries that provide useful information to the user when compared to plain SQL, since Hibernate's query language is closer to natural language. |
There was a problem hiding this comment.
I think it's fine to list features, to say what this think can help you with, and how it does so.
But I wouldn't try to make claims about safety or to compare ease of use with other solutions. That would belong in a blog post IMO.
There was a problem hiding this comment.
Sure, I didn't know what to add here apart from possible use-cases / advantages of using this module, so that's what I did. If we want to keep this brief, just for reference, we can definitely remove this whole paragraph.
mbellade
force-pushed
the
language-module
branch
from
b6b6d0e to
b993588
Compare
mbellade
force-pushed
the
language-module
branch
from
b993588 to
9ddcf11
Compare
yrodiere
reviewed
Oct 30, 2025
| No implementation is included, but the above provides the building blocks for integration with generative AI services/APIs. | ||
|
|
||
| [[assistant-gen-ai]] | ||
| ==== Generative AI integration considerations |
There was a problem hiding this comment.
Incorrect heading level
Suggested change
| ==== Generative AI integration considerations | |
| === Generative AI integration considerations |
|
|
||
|
|
||
| [[assistant-serialization]] | ||
| ==== Serialization Components |
There was a problem hiding this comment.
Incorrect heading level
Suggested change
| ==== Serialization Components | |
| === Serialization Components |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://hibernate.atlassian.net/browse/HHH-19880
Opening as draft, TBD:
tooling/assistantfor now)hibernate-tools-language)By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license
and can be relicensed under the terms of the LGPL v2.1 license in the future at the maintainers' discretion.
For more information on licensing, please check here.