-
Notifications
You must be signed in to change notification settings - Fork 142
Quarkus SQL-based RAG recipe #826
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jmartisk
wants to merge
1
commit into
containers:main
Choose a base branch
from
jmartisk:quarkus-rag
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,3 +14,4 @@ training/cloud/examples | |
| training/instructlab/instructlab | ||
| vector_dbs/milvus/volumes/milvus/* | ||
| .idea | ||
| target | ||
15 changes: 15 additions & 0 deletions
15
recipes/natural_language_processing/chatbot-java-quarkus-rag/README.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Java-based chatbot application with SQL-based RAG - Quarkus | ||
|
|
||
| This application implements a chatbot with SQL RAG functionality backed by | ||
| Quarkus and its LangChain4j extension. The UI communicates with the backend | ||
| application via web sockets and the backend uses the OpenAI API to talk to | ||
| the model served by Podman AI Lab. | ||
|
|
||
| The RAG data is stored in a PostgreSQL database. The application always asks | ||
| the model in the background to generate a SQL query that yields data | ||
| necessary to ask a question. Then, the application executes that query and | ||
| passes the result, encoded as a JSON object, to the model along with | ||
| the original user prompt. | ||
|
|
||
| Documentation for Quarkus+LangChain4j can be found at | ||
| https://docs.quarkiverse.io/quarkus-langchain4j/dev/. |
35 changes: 35 additions & 0 deletions
35
recipes/natural_language_processing/chatbot-java-quarkus-rag/ai-lab.yaml
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| version: v1.0 | ||
| application: | ||
| type: language | ||
| name: ChatBot_Java_Quarkus_SQL_RAG | ||
| description: Chatbot sample with SQL-based RAG based on Quarkus | ||
| containers: | ||
| - name: llamacpp-server | ||
| contextdir: ../../../model_servers/llamacpp_python | ||
| containerfile: ./base/Containerfile | ||
| model-service: true | ||
| backend: | ||
| - llama-cpp | ||
| arch: | ||
| - arm64 | ||
| - amd64 | ||
| ports: | ||
| - 8001 | ||
| image: quay.io/ai-lab/llamacpp_python:latest | ||
| - name: postgresql-server | ||
| contextdir: ../../../relational_dbs/postgresql | ||
| containerfile: Containerfile | ||
| arch: | ||
| - arm64 | ||
| - amd64 | ||
| ports: | ||
| - 5432 | ||
| image: quay.io/ai-lab/postgresql:latest | ||
| - name: quarkus-chat-app | ||
| contextdir: app | ||
| containerfile: Containerfile | ||
| arch: | ||
| - arm64 | ||
| - amd64 | ||
| ports: | ||
| - 8080 |
19 changes: 19 additions & 0 deletions
19
...al_language_processing/chatbot-java-quarkus-rag/app/.mvn/wrapper/maven-wrapper.properties
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. | ||
| wrapperVersion=3.3.2 | ||
| distributionType=only-script | ||
| distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip |
12 changes: 12 additions & 0 deletions
12
recipes/natural_language_processing/chatbot-java-quarkus-rag/app/Containerfile
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| FROM registry.access.redhat.com/ubi8/openjdk-21:latest | ||
| WORKDIR /deployments | ||
| COPY --chown=185 . . | ||
| RUN mvn package | ||
| EXPOSE 8080 | ||
| ENV JAVA_OPTS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" | ||
| ENV JAVA_APP_JAR="/deployments/target/quarkus-app/quarkus-run.jar" | ||
| # FIXME: the sleep is to allow the postgresql container to start first and | ||
| # should be replaced with a mechanism to declare that the application | ||
| # container depends on the database container, once something like that is | ||
| # supported... | ||
| CMD echo "sleeping for 10 seconds..."; sleep 10; /usr/local/s2i/run | ||
259 changes: 259 additions & 0 deletions
259
recipes/natural_language_processing/chatbot-java-quarkus-rag/app/mvnw
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The recipes should following the cloud native pattern so should implement retry if the targeted service is not available or handle propertly failures so is this required ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately, Quarkus itself does not support retries like this (it relies on it being restarted if the database isn't ready yet) and just refuses to boot if it can't connect :( I know this is a terrible solution, but I don't have any better idea.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or is it possible to declare somewhere (in
ai-lab.yaml) that the Quarkus pod should be restarted until it boots properly?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No because the design has been made so that there is no synchronisation between the containers that are started. There is no way to delay the connection to the database ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@yrodiere could you advise if there is a way to let Quarkus boot even when the database is not available yet, and let Hibernate execute its database generation strategy more lazily? I checked the configuration properties and nothing came to my mind.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's no built-in way to let db generation execute lazily -- among other reasons because that could be very dangerous (you don't want that to happen twice).
Also, booting with an offline DB is technically not supported yet (it's WIP: quarkusio/quarkus#43396), but if you're not using anything exotic it'll probably work anyway.
The way to go would be to disable DB generation/validation, and execute it explicitly through custom code relying on
org.hibernate.SessionFactory#getSchemaManager.The problem will be to detect when you should initialize the DB... Maybe Agroal provides a "first connection" event that could be used for that, I don't know. That's probably something that should be filed as a new feature, as a follow-up to 43396 -- but it's not limited to Hibernate ORM, you'd have the same problem with Flyway schema management (which, by the way, is what you should be using in prod).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, in any case, none of this looks like something we want to do in this recipe that should be kept as simple as possible. IMO, AI lab should provide a way to declare dependencies between pods. Without it, I have no better idea than a dumb sleep command
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, or maybe, add some piece of a shell script to wait for the database port to be open before calling
/usr/local/s2i/run?? Would that be ok?