├── .gitignore ├── .mvn └── wrapper │ ├── maven-wrapper.jar │ └── maven-wrapper.properties ├── Dockerfile ├── README.adoc ├── docker-compose.yml ├── frontend ├── .gitignore ├── package-lock.json ├── package.json ├── public │ ├── favicon.ico │ ├── index.html │ ├── logo192.png │ ├── logo512.png │ ├── manifest.json │ └── robots.txt └── src │ ├── App.css │ ├── App.js │ ├── App.test.js │ ├── Components │ ├── ChatBubble.js │ └── ChatWindow.js │ ├── Services │ └── ChatService.js │ ├── api.js │ ├── index.css │ ├── index.js │ ├── logo.svg │ ├── reportWebVitals.js │ └── setupTests.js ├── mvnw ├── mvnw.cmd ├── pom.xml └── src ├── docs └── asciidoc │ ├── .gitignore │ ├── blog-spring-ai-redis.adoc │ └── spring-ai-redis-screenshot.png └── main ├── java └── com │ └── redis │ └── demo │ └── spring │ └── ai │ ├── RagApplication.java │ ├── RagConfiguration.java │ ├── RagController.java │ ├── RagDataLoader.java │ └── RagService.java └── resources ├── application.properties ├── data └── beers.json.gz └── prompts └── system-qa.st /.gitignore: -------------------------------------------------------------------------------- 1 | HELP.md 2 | target/ 3 | !.mvn/wrapper/maven-wrapper.jar 4 | !**/src/main/**/target/ 5 | !**/src/test/**/target/ 6 | 7 | ### STS ### 8 | .apt_generated 9 | .classpath 10 | .factorypath 11 | .project 12 | .settings 13 | .springBeans 14 | .sts4-cache 15 | 16 | ### IntelliJ IDEA ### 17 | .idea 18 | *.iws 19 | *.iml 20 | *.ipr 21 | 22 | ### NetBeans ### 23 | /nbproject/private/ 24 | /nbbuild/ 25 | /dist/ 26 | /nbdist/ 27 | /.nb-gradle/ 28 | build/ 29 | !**/src/main/**/build/ 30 | !**/src/test/**/build/ 31 | 32 | ### VS Code ### 33 | .vscode/ 34 | .DS_Store -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redis-developer/spring-ai-redis-demo/69f38a121461cb064fa72d40c8886216fdf56c08/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.4/apache-maven-3.8.4-bin.zip 2 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar 3 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM eclipse-temurin:21 AS build 2 | WORKDIR /app 3 | COPY . /app 4 | RUN ./mvnw verify 5 | 6 | FROM eclipse-temurin:21 7 | 8 | EXPOSE 8080 9 | 10 | RUN mkdir /app 11 | 12 | COPY --from=build /app/target/*.jar /app/app.jar 13 | 14 | ENTRYPOINT ["java","-jar","/app/app.jar"] -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | = Spring AI Redis Demo 2 | :linkattrs: 3 | :project-owner: redis-developer 4 | :project-name: spring-ai-redis-demo 5 | :project-group: com.redis 6 | :project-version: 0.0.1-SNAPSHOT 7 | :project-title: Spring AI Redis Demo 8 | 9 | --- 10 | 11 | A Retrieval Augmented Generation demo using link:https://docs.spring.io/spring-ai/reference/[Spring AI] and link:https://redis.io/docs/interact/search-and-query/advanced-concepts/vectors/[Redis Vector Search]. 12 | 13 | == Pre-requisites 14 | 15 | === Docker 16 | 17 | This demo requires Docker to build and run the application. 18 | 19 | === Azure OpenAI 20 | 21 | Obtain your Azure OpenAI `endpoint` (e.g. `https://demo-us-west.openai.azure.com/`) and `api-key` from the Azure OpenAI Service section on https://portal.azure.com[Azure Portal]. 22 | 23 | The Spring AI project defines a configuration property named `spring.ai.azure.openai.api-key` that you should set to the value of the `API Key` obtained from Azure. 24 | 25 | If your model deployment name is not the default `gpt-35-turbo` you can specify it using the configuration property named `spring.ai.azure.openai.chat.options.model`. 26 | 27 | Exporting an environment variable is one way to set these configuration properties. 28 | [source,console] 29 | ---- 30 | export SPRING_AI_AZURE_OPENAI_API_KEY= 31 | export SPRING_AI_AZURE_OPENAI_ENDPOINT= 32 | export SPRING_AI_AZURE_OPENAI_CHAT_OPTIONS_MODEL= 33 | ---- 34 | 35 | == Run the demo 36 | 37 | [source,console] 38 | ---- 39 | git clone https://github.com/{project-owner}/{project-name}.git 40 | cd {project-name} 41 | docker compose up 42 | ---- 43 | 44 | Once the Spring application is running (`com.....Application: Started Application in ...`), point your browser to link:http://localhost:8080[localhost:8080] and ask a question around beers: 45 | 46 | image:src/docs/asciidoc/spring-ai-redis-screenshot.png[] 47 | 48 | 49 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3.8' 2 | 3 | services: 4 | redis: 5 | image: redis/redis-stack-server 6 | hostname: redis 7 | spring: 8 | build: . 9 | ports: 10 | - "8080:8080" 11 | depends_on: 12 | - redis 13 | deploy: 14 | restart_policy: 15 | condition: on-failure 16 | max_attempts: 10 17 | environment: 18 | - SPRING_AI_VECTORSTORE_REDIS_URI=redis://redis:6379 19 | - SPRING_AI_AZURE_OPENAI_API_KEY=${SPRING_AI_AZURE_OPENAI_API_KEY} 20 | - SPRING_AI_AZURE_OPENAI_CHAT_OPTIONS_MODEL=${SPRING_AI_AZURE_OPENAI_CHAT_OPTIONS_MODEL} 21 | - SPRING_AI_AZURE_OPENAI_ENDPOINT=${SPRING_AI_AZURE_OPENAI_ENDPOINT} -------------------------------------------------------------------------------- /frontend/.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | .vscode/ 3 | node/ 4 | node_modules/ 5 | build/ 6 | .DS_Store 7 | *.tgz 8 | my-app* 9 | template/src/__tests__/__snapshots__/ 10 | lerna-debug.log 11 | npm-debug.log* 12 | yarn-debug.log* 13 | yarn-error.log* 14 | /.changelog 15 | .npm/ 16 | yarn.lock -------------------------------------------------------------------------------- /frontend/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "redis-rag-chat", 3 | "version": "0.1.0", 4 | "private": true, 5 | "dependencies": { 6 | "@testing-library/jest-dom": "^5.17.0", 7 | "@testing-library/react": "^13.4.0", 8 | "@testing-library/user-event": "^13.5.0", 9 | "bootstrap": "^5.3.2", 10 | "react": "^18.2.0", 11 | "react-bootstrap": "^2.9.2", 12 | "react-dom": "^18.2.0", 13 | "react-scripts": "5.0.1", 14 | "web-vitals": "^2.1.4" 15 | }, 16 | "scripts": { 17 | "start": "react-scripts start", 18 | "build": "react-scripts build", 19 | "test": "react-scripts test", 20 | "eject": "react-scripts eject" 21 | }, 22 | "proxy": "http://localhost:8080", 23 | "eslintConfig": { 24 | "extends": [ 25 | "react-app", 26 | "react-app/jest" 27 | ] 28 | }, 29 | "browserslist": { 30 | "production": [ 31 | ">0.2%", 32 | "not dead", 33 | "not op_mini all" 34 | ], 35 | "development": [ 36 | "last 1 chrome version", 37 | "last 1 firefox version", 38 | "last 1 safari version" 39 | ] 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /frontend/public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redis-developer/spring-ai-redis-demo/69f38a121461cb064fa72d40c8886216fdf56c08/frontend/public/favicon.ico -------------------------------------------------------------------------------- /frontend/public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 12 | 13 | 17 | 18 | 27 | React App 28 | 29 | 30 | 31 |
32 | 42 | 43 | 44 | -------------------------------------------------------------------------------- /frontend/public/logo192.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redis-developer/spring-ai-redis-demo/69f38a121461cb064fa72d40c8886216fdf56c08/frontend/public/logo192.png -------------------------------------------------------------------------------- /frontend/public/logo512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redis-developer/spring-ai-redis-demo/69f38a121461cb064fa72d40c8886216fdf56c08/frontend/public/logo512.png -------------------------------------------------------------------------------- /frontend/public/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "short_name": "React App", 3 | "name": "Create React App Sample", 4 | "icons": [ 5 | { 6 | "src": "favicon.ico", 7 | "sizes": "64x64 32x32 24x24 16x16", 8 | "type": "image/x-icon" 9 | }, 10 | { 11 | "src": "logo192.png", 12 | "type": "image/png", 13 | "sizes": "192x192" 14 | }, 15 | { 16 | "src": "logo512.png", 17 | "type": "image/png", 18 | "sizes": "512x512" 19 | } 20 | ], 21 | "start_url": ".", 22 | "display": "standalone", 23 | "theme_color": "#000000", 24 | "background_color": "#ffffff" 25 | } 26 | -------------------------------------------------------------------------------- /frontend/public/robots.txt: -------------------------------------------------------------------------------- 1 | # https://www.robotstxt.org/robotstxt.html 2 | User-agent: * 3 | Disallow: 4 | -------------------------------------------------------------------------------- /frontend/src/App.css: -------------------------------------------------------------------------------- 1 | .App { 2 | text-align: center; 3 | } 4 | 5 | .App-logo { 6 | height: 40vmin; 7 | pointer-events: none; 8 | } 9 | 10 | @media (prefers-reduced-motion: no-preference) { 11 | .App-logo { 12 | animation: App-logo-spin infinite 20s linear; 13 | } 14 | } 15 | 16 | .App-header { 17 | background-color: #282c34; 18 | min-height: 100vh; 19 | display: flex; 20 | flex-direction: column; 21 | align-items: center; 22 | justify-content: center; 23 | font-size: calc(10px + 2vmin); 24 | color: white; 25 | } 26 | 27 | .App-link { 28 | color: #61dafb; 29 | } 30 | 31 | @keyframes App-logo-spin { 32 | from { 33 | transform: rotate(0deg); 34 | } 35 | to { 36 | transform: rotate(360deg); 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /frontend/src/App.js: -------------------------------------------------------------------------------- 1 | import logo from './logo.svg'; 2 | import './App.css'; 3 | import './Components/ChatWindow'; 4 | import { ChatWindow } from './Components/ChatWindow'; 5 | import 'bootstrap/dist/css/bootstrap.min.css'; 6 | function App() { 7 | return ( 8 | 9 | ); 10 | } 11 | 12 | export default App; 13 | -------------------------------------------------------------------------------- /frontend/src/App.test.js: -------------------------------------------------------------------------------- 1 | import { render, screen } from '@testing-library/react'; 2 | import App from './App'; 3 | 4 | test('renders learn react link', () => { 5 | render(); 6 | const linkElement = screen.getByText(/learn react/i); 7 | expect(linkElement).toBeInTheDocument(); 8 | }); 9 | -------------------------------------------------------------------------------- /frontend/src/Components/ChatBubble.js: -------------------------------------------------------------------------------- 1 | import React, {Component} from 'react'; 2 | 3 | export class ChatBubble extends Component{ 4 | render(){ 5 | let backgroundColor; 6 | let alignSelf; 7 | switch(this.props.userType){ 8 | case 'user': 9 | backgroundColor = 'blue'; 10 | alignSelf = 'flex-end'; 11 | break; 12 | case 'bot': 13 | backgroundColor = 'green'; 14 | alignSelf = 'flex-start'; 15 | break; 16 | case 'system': 17 | backgroundColor = 'lightGray'; 18 | alignSelf = 'flex-start'; 19 | break; 20 | default: 21 | alignSelf = 'flex-start'; 22 | } 23 | 24 | const style = { 25 | maxWidth: '45%', 26 | backgroundColor: backgroundColor, 27 | padding: '8px', 28 | margin: '4px', 29 | borderRadius: '10px', 30 | alignSelf: alignSelf 31 | }; 32 | 33 | return( 34 |
35 | 36 | {this.props.message} 37 | 38 |
39 | ) 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /frontend/src/Components/ChatWindow.js: -------------------------------------------------------------------------------- 1 | import React, {Component, useEffect, useState, usestate, createRef} from 'react'; 2 | import Button from 'react-bootstrap/Button' 3 | import Form from 'react-bootstrap/Form'; 4 | import {ChatBubble} from './ChatBubble'; 5 | import { SendMessage, StartChat } from '../api'; 6 | 7 | export class ChatWindow extends Component{ 8 | static displayName = ChatWindow.name; 9 | constructor(props){ 10 | super(props) 11 | this.state = {messages:[], input:'', chatId:'', awaitingServer: true, textAreaRows: 1} 12 | this.fileRef = createRef(); 13 | } 14 | 15 | async componentDidMount(){ 16 | await this.start(); 17 | } 18 | 19 | sendMessage = async () => { 20 | if(this.state.input.trim() !== ''){ 21 | this.setState({messages:[...this.state.messages, {message:this.state.input, userType:'user'}]}); 22 | this.setState({input:'', messagePending: true}); 23 | const response = await SendMessage(this.state.input, this.state.chatId); 24 | console.log(response); 25 | this.setState({messagePending:false}); 26 | this.setState({messages:[...this.state.messages, {message:response.message, userType:'bot'}]}) 27 | } 28 | } 29 | 30 | uiDisabled = () =>{ 31 | return this.state.messagePending; 32 | } 33 | 34 | start = async () => { 35 | try{ 36 | const response = await StartChat(); 37 | this.setState({messages:[], input:'', chatId: response.chatId, messagePending: false, awaitingServer: false}) 38 | } 39 | catch(e){ 40 | this.setState({messages:[], input:'', chatId:'', messagePending:false, awaitingServer: true}) 41 | setTimeout(this.start, 5000); 42 | } 43 | } 44 | 45 | handleKeyPress = (event)=>{ 46 | if (event.key === 'Enter') { 47 | this.sendMessage(); 48 | } 49 | }; 50 | 51 | calculateRows = (text) => { 52 | const lines = text.split('\n'); 53 | let numLines = 0; 54 | if(lines){ 55 | lines.forEach(element => { 56 | numLines += 1 57 | numLines += element.length / 65 58 | }); 59 | } 60 | 61 | return Math.min(Math.max(numLines, 1), 5); 62 | }; 63 | 64 | handleTextAreaChange = (e) => { 65 | const value = e.target.value; 66 | const rows = this.calculateRows(value); 67 | this.setState({input:value, textAreaRows: rows}); 68 | } 69 | 70 | render(){ 71 | if(this.state.awaitingServer){ 72 | return( 73 |
74 | Awaiting Server to start up... 75 |
76 | ) 77 | } 78 | 79 | 80 | return( 81 |
82 |
83 | {this.state.messages.map((msg, index) => ( 84 | 85 | ))} 86 | { 87 | this.state.messagePending && 88 | () 89 | } 90 |
91 | 92 |
93 | 94 | Ask a question 95 |
96 | this.handleTextAreaChange(e)} 104 | style={{margin: '5px', flexGrow: 1, maxWidth: '600px', borderRadius: '10px', overflowWrap: 'break-word', overflowX: 'hidden', overflowY: 'auto'}} 105 | /> 106 | 107 |
108 | 109 | 110 | 111 |
112 |
113 | ); 114 | } 115 | } -------------------------------------------------------------------------------- /frontend/src/Services/ChatService.js: -------------------------------------------------------------------------------- 1 | 2 | const ChatService = () =>{ 3 | const SendMessage = async function(message){ 4 | try{ 5 | return await fetch("/chat",{ 6 | method: 'POST', 7 | headers: { 8 | 'Content-Type': 'application/json' 9 | }, 10 | body: JSON.stringify({ 11 | prompt:message 12 | }) 13 | }) 14 | } 15 | catch(e){ 16 | console.log(e); 17 | return e; 18 | } 19 | 20 | } 21 | } 22 | 23 | export default ChatService; -------------------------------------------------------------------------------- /frontend/src/api.js: -------------------------------------------------------------------------------- 1 | export const SendMessage = async function(message, chatId){ 2 | const responseMessage = await fetch(`chat/${chatId}`,{ 3 | method: 'POST', 4 | headers: { 5 | 'Content-Type': 'application/json' 6 | }, 7 | body: JSON.stringify({ 8 | prompt:message 9 | }) 10 | }); 11 | 12 | return responseMessage.json(); 13 | } 14 | 15 | export const StartChat = async function(){ 16 | const responseMessage = await fetch("chat/startChat", { 17 | headers: { 18 | 'Content-Type': 'application/json' 19 | }, 20 | method: 'POST' 21 | }) 22 | return responseMessage.json(); 23 | } -------------------------------------------------------------------------------- /frontend/src/index.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 4 | 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', 5 | sans-serif; 6 | -webkit-font-smoothing: antialiased; 7 | -moz-osx-font-smoothing: grayscale; 8 | } 9 | 10 | code { 11 | font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New', 12 | monospace; 13 | } 14 | -------------------------------------------------------------------------------- /frontend/src/index.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import ReactDOM from 'react-dom/client'; 3 | import './index.css'; 4 | import App from './App'; 5 | import reportWebVitals from './reportWebVitals'; 6 | 7 | const root = ReactDOM.createRoot(document.getElementById('root')); 8 | root.render( 9 | 10 | 11 | 12 | ); 13 | 14 | // If you want to start measuring performance in your app, pass a function 15 | // to log results (for example: reportWebVitals(console.log)) 16 | // or send to an analytics endpoint. Learn more: https://bit.ly/CRA-vitals 17 | reportWebVitals(); 18 | -------------------------------------------------------------------------------- /frontend/src/logo.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /frontend/src/reportWebVitals.js: -------------------------------------------------------------------------------- 1 | const reportWebVitals = onPerfEntry => { 2 | if (onPerfEntry && onPerfEntry instanceof Function) { 3 | import('web-vitals').then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => { 4 | getCLS(onPerfEntry); 5 | getFID(onPerfEntry); 6 | getFCP(onPerfEntry); 7 | getLCP(onPerfEntry); 8 | getTTFB(onPerfEntry); 9 | }); 10 | } 11 | }; 12 | 13 | export default reportWebVitals; 14 | -------------------------------------------------------------------------------- /frontend/src/setupTests.js: -------------------------------------------------------------------------------- 1 | // jest-dom adds custom jest matchers for asserting on DOM nodes. 2 | // allows you to do things like: 3 | // expect(element).toHaveTextContent(/react/i) 4 | // learn more: https://github.com/testing-library/jest-dom 5 | import '@testing-library/jest-dom'; 6 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven2 Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /etc/mavenrc ] ; then 40 | . /etc/mavenrc 41 | fi 42 | 43 | if [ -f "$HOME/.mavenrc" ] ; then 44 | . "$HOME/.mavenrc" 45 | fi 46 | 47 | fi 48 | 49 | # OS specific support. $var _must_ be set to either true or false. 50 | cygwin=false; 51 | darwin=false; 52 | mingw=false 53 | case "`uname`" in 54 | CYGWIN*) cygwin=true ;; 55 | MINGW*) mingw=true;; 56 | Darwin*) darwin=true 57 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 58 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 59 | if [ -z "$JAVA_HOME" ]; then 60 | if [ -x "/usr/libexec/java_home" ]; then 61 | export JAVA_HOME="`/usr/libexec/java_home`" 62 | else 63 | export JAVA_HOME="/Library/Java/Home" 64 | fi 65 | fi 66 | ;; 67 | esac 68 | 69 | if [ -z "$JAVA_HOME" ] ; then 70 | if [ -r /etc/gentoo-release ] ; then 71 | JAVA_HOME=`java-config --jre-home` 72 | fi 73 | fi 74 | 75 | if [ -z "$M2_HOME" ] ; then 76 | ## resolve links - $0 may be a link to maven's home 77 | PRG="$0" 78 | 79 | # need this for relative symlinks 80 | while [ -h "$PRG" ] ; do 81 | ls=`ls -ld "$PRG"` 82 | link=`expr "$ls" : '.*-> \(.*\)$'` 83 | if expr "$link" : '/.*' > /dev/null; then 84 | PRG="$link" 85 | else 86 | PRG="`dirname "$PRG"`/$link" 87 | fi 88 | done 89 | 90 | saveddir=`pwd` 91 | 92 | M2_HOME=`dirname "$PRG"`/.. 93 | 94 | # make it fully qualified 95 | M2_HOME=`cd "$M2_HOME" && pwd` 96 | 97 | cd "$saveddir" 98 | # echo Using m2 at $M2_HOME 99 | fi 100 | 101 | # For Cygwin, ensure paths are in UNIX format before anything is touched 102 | if $cygwin ; then 103 | [ -n "$M2_HOME" ] && 104 | M2_HOME=`cygpath --unix "$M2_HOME"` 105 | [ -n "$JAVA_HOME" ] && 106 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 107 | [ -n "$CLASSPATH" ] && 108 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 109 | fi 110 | 111 | # For Mingw, ensure paths are in UNIX format before anything is touched 112 | if $mingw ; then 113 | [ -n "$M2_HOME" ] && 114 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 115 | [ -n "$JAVA_HOME" ] && 116 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 117 | fi 118 | 119 | if [ -z "$JAVA_HOME" ]; then 120 | javaExecutable="`which javac`" 121 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 122 | # readlink(1) is not available as standard on Solaris 10. 123 | readLink=`which readlink` 124 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 125 | if $darwin ; then 126 | javaHome="`dirname \"$javaExecutable\"`" 127 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 128 | else 129 | javaExecutable="`readlink -f \"$javaExecutable\"`" 130 | fi 131 | javaHome="`dirname \"$javaExecutable\"`" 132 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 133 | JAVA_HOME="$javaHome" 134 | export JAVA_HOME 135 | fi 136 | fi 137 | fi 138 | 139 | if [ -z "$JAVACMD" ] ; then 140 | if [ -n "$JAVA_HOME" ] ; then 141 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 142 | # IBM's JDK on AIX uses strange locations for the executables 143 | JAVACMD="$JAVA_HOME/jre/sh/java" 144 | else 145 | JAVACMD="$JAVA_HOME/bin/java" 146 | fi 147 | else 148 | JAVACMD="`which java`" 149 | fi 150 | fi 151 | 152 | if [ ! -x "$JAVACMD" ] ; then 153 | echo "Error: JAVA_HOME is not defined correctly." >&2 154 | echo " We cannot execute $JAVACMD" >&2 155 | exit 1 156 | fi 157 | 158 | if [ -z "$JAVA_HOME" ] ; then 159 | echo "Warning: JAVA_HOME environment variable is not set." 160 | fi 161 | 162 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 163 | 164 | # traverses directory structure from process work directory to filesystem root 165 | # first directory with .mvn subdirectory is considered project base directory 166 | find_maven_basedir() { 167 | 168 | if [ -z "$1" ] 169 | then 170 | echo "Path not specified to find_maven_basedir" 171 | return 1 172 | fi 173 | 174 | basedir="$1" 175 | wdir="$1" 176 | while [ "$wdir" != '/' ] ; do 177 | if [ -d "$wdir"/.mvn ] ; then 178 | basedir=$wdir 179 | break 180 | fi 181 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 182 | if [ -d "${wdir}" ]; then 183 | wdir=`cd "$wdir/.."; pwd` 184 | fi 185 | # end of workaround 186 | done 187 | echo "${basedir}" 188 | } 189 | 190 | # concatenates all lines of a file 191 | concat_lines() { 192 | if [ -f "$1" ]; then 193 | echo "$(tr -s '\n' ' ' < "$1")" 194 | fi 195 | } 196 | 197 | BASE_DIR=`find_maven_basedir "$(pwd)"` 198 | if [ -z "$BASE_DIR" ]; then 199 | exit 1; 200 | fi 201 | 202 | ########################################################################################## 203 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 204 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 205 | ########################################################################################## 206 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 207 | if [ "$MVNW_VERBOSE" = true ]; then 208 | echo "Found .mvn/wrapper/maven-wrapper.jar" 209 | fi 210 | else 211 | if [ "$MVNW_VERBOSE" = true ]; then 212 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 213 | fi 214 | if [ "$MVNW_REPOURL" = true]; then 215 | jarUrl="$MVNW_REPOURL/io/takari/maven-wrapper/0.5.2/maven-wrapper-0.5.2.jar" 216 | else 217 | jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.2/maven-wrapper-0.5.2.jar" 218 | fi 219 | while IFS="=" read key value; do 220 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;; 221 | esac 222 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 223 | if [ "$MVNW_VERBOSE" = true ]; then 224 | echo "Downloading from: $jarUrl" 225 | fi 226 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 227 | if $cygwin; then 228 | wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` 229 | fi 230 | 231 | if command -v wget > /dev/null; then 232 | if [ "$MVNW_VERBOSE" = true ]; then 233 | echo "Found wget ... using wget" 234 | fi 235 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 236 | wget "$jarUrl" -O "$wrapperJarPath" 237 | else 238 | wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" 239 | fi 240 | elif command -v curl > /dev/null; then 241 | if [ "$MVNW_VERBOSE" = true ]; then 242 | echo "Found curl ... using curl" 243 | fi 244 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 245 | curl -o "$wrapperJarPath" "$jarUrl" -f 246 | else 247 | curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f 248 | fi 249 | 250 | else 251 | if [ "$MVNW_VERBOSE" = true ]; then 252 | echo "Falling back to using Java to download" 253 | fi 254 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 255 | # For Cygwin, switch paths to Windows format before running javac 256 | if $cygwin; then 257 | javaClass=`cygpath --path --windows "$javaClass"` 258 | fi 259 | if [ -e "$javaClass" ]; then 260 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 261 | if [ "$MVNW_VERBOSE" = true ]; then 262 | echo " - Compiling MavenWrapperDownloader.java ..." 263 | fi 264 | # Compiling the Java class 265 | ("$JAVA_HOME/bin/javac" "$javaClass") 266 | fi 267 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 268 | # Running the downloader 269 | if [ "$MVNW_VERBOSE" = true ]; then 270 | echo " - Running MavenWrapperDownloader.java ..." 271 | fi 272 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 273 | fi 274 | fi 275 | fi 276 | fi 277 | ########################################################################################## 278 | # End of extension 279 | ########################################################################################## 280 | 281 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 282 | if [ "$MVNW_VERBOSE" = true ]; then 283 | echo $MAVEN_PROJECTBASEDIR 284 | fi 285 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 286 | 287 | # For Cygwin, switch paths to Windows format before running java 288 | if $cygwin; then 289 | [ -n "$M2_HOME" ] && 290 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 291 | [ -n "$JAVA_HOME" ] && 292 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 293 | [ -n "$CLASSPATH" ] && 294 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 295 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 296 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 297 | fi 298 | 299 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 300 | 301 | exec "$JAVACMD" \ 302 | $MAVEN_OPTS \ 303 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 304 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 305 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 306 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM http://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven2 Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM set title of command window 39 | title %0 40 | @REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" 50 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.2/maven-wrapper-0.5.2.jar" 124 | 125 | FOR /F "tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 126 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 127 | ) 128 | 129 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 130 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 131 | if exist %WRAPPER_JAR% ( 132 | echo Found %WRAPPER_JAR% 133 | ) else ( 134 | if not "%MVNW_REPOURL%" == "" ( 135 | SET DOWNLOAD_URL="%MVNW_REPOURL%/io/takari/maven-wrapper/0.5.2/maven-wrapper-0.5.2.jar" 136 | ) 137 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 138 | echo Downloading from: %DOWNLOAD_URL% 139 | 140 | powershell -Command "&{"^ 141 | "$webclient = new-object System.Net.WebClient;"^ 142 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ 143 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ 144 | "}"^ 145 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ 146 | "}" 147 | echo Finished downloading %WRAPPER_JAR% 148 | ) 149 | @REM End of extension 150 | 151 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 152 | if ERRORLEVEL 1 goto error 153 | goto end 154 | 155 | :error 156 | set ERROR_CODE=1 157 | 158 | :end 159 | @endlocal & set ERROR_CODE=%ERROR_CODE% 160 | 161 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost 162 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 163 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" 164 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" 165 | :skipRcPost 166 | 167 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 168 | if "%MAVEN_BATCH_PAUSE%" == "on" pause 169 | 170 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% 171 | 172 | exit /B %ERROR_CODE% 173 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | org.springframework.boot 8 | spring-boot-starter-parent 9 | 3.2.3 10 | 11 | 12 | com.redis.demo 13 | spring-ai-redis-demo 14 | 0.0.1-SNAPSHOT 15 | spring-ai-redis-demo 16 | Simple AI application using Redis vector search 17 | 18 | 17 19 | 0.8.1 20 | 1.15.0 21 | v18.16.0 22 | 9.5.1 23 | 24 | 25 | 26 | 27 | org.springframework.boot 28 | spring-boot-starter-web 29 | 30 | 31 | org.springframework.ai 32 | spring-ai-azure-openai-spring-boot-starter 33 | ${spring-ai.version} 34 | 35 | 36 | org.springframework.ai 37 | spring-ai-transformers-spring-boot-starter 38 | ${spring-ai.version} 39 | 40 | 41 | org.springframework.ai 42 | spring-ai-redis-spring-boot-starter 43 | ${spring-ai.version} 44 | 45 | 46 | redis.clients 47 | jedis 48 | 5.1.0 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | org.springframework.boot 57 | spring-boot-maven-plugin 58 | 59 | 60 | maven-resources-plugin 61 | 62 | 63 | copy-resources 64 | process-classes 65 | 66 | copy-resources 67 | 68 | 69 | ${basedir}/target/classes/static 70 | 71 | 72 | frontend/build 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | com.github.eirslett 81 | frontend-maven-plugin 82 | ${frontend-maven-plugin.version} 83 | 84 | frontend 85 | 86 | 87 | 88 | install node 89 | 90 | install-node-and-npm 91 | 92 | 93 | ${node.version} 94 | ${npm.version} 95 | 96 | 97 | 98 | npm-install 99 | 100 | npm 101 | 102 | 103 | ci --no-save --no-progress --no-audit 104 | --quiet --silent 105 | 106 | 107 | 108 | npm-build 109 | 110 | npm 111 | 112 | 113 | run build 114 | 115 | ${project.version} 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | spring-milestones 127 | Spring Milestones 128 | https://repo.spring.io/milestone 129 | 130 | false 131 | 132 | 133 | 134 | spring-snapshots 135 | Spring Snapshots 136 | https://repo.spring.io/snapshot 137 | 138 | false 139 | 140 | 141 | 142 | 143 | 144 | spring-milestones 145 | Spring Milestones 146 | https://repo.spring.io/milestone 147 | 148 | false 149 | 150 | 151 | 152 | spring-snapshots 153 | Spring Snapshots 154 | https://repo.spring.io/snapshot 155 | 156 | false 157 | 158 | 159 | 160 | 161 | -------------------------------------------------------------------------------- /src/docs/asciidoc/.gitignore: -------------------------------------------------------------------------------- 1 | /blog-spring-ai-redis.html 2 | /blog-spring-ai-redis.docx 3 | -------------------------------------------------------------------------------- /src/docs/asciidoc/blog-spring-ai-redis.adoc: -------------------------------------------------------------------------------- 1 | = Building a RAG application with Redis and Spring AI 2 | :author: Julien Ruaux 3 | :revnumber: 0.1.0 4 | :toclevels: 3 5 | :docinfo1: 6 | :source-highlighter: prettify 7 | :icons: font 8 | :project-owner: redis-developer 9 | :project-name: spring-ai-redis-demo 10 | 11 | == Introduction 12 | 13 | Vector databases are crucial for AI applications, especially when it comes to performing similarity searches instead of exact matches. 14 | This distinction is key for applications where finding similar items or documents is more relevant than precise matches, which is a common scenario in recommendation systems and natural language processing tasks. 15 | Redis, a popular in-memory data store, has gained traction as a reliable option for vector databases due to its performance and ease of use. 16 | 17 | The Spring community recently introduced a new project called https://docs.spring.io/spring-ai/reference/index.html[Spring AI], which aims to simplify the development of AI-powered applications, including those that leverage vector databases. 18 | In this article, we will demonstrate how to build a Spring AI application that utilizes Redis as the vector database, focusing on implementing a Retrieval Augmented Generation (RAG) workflow. 19 | 20 | == Retrieval Augmented Generation 21 | 22 | Retrieval Augmented Generation (RAG) is a technique used to integrate data with AI models. 23 | In a RAG workflow, the first step involves loading data into a vector database, such as Redis. 24 | When a user query is received, the vector database retrieves a set of documents similar to the query. 25 | These documents then serve as the context for the user's question and are used in conjunction with the user's query to generate a response, typically through an AI model. 26 | 27 | In our demonstration, we will use a dataset containing information about beers, including attributes such as name, Alcohol By Volume (ABV), International Bitterness Units (IBU), and a description for each beer. 28 | This dataset will be loaded into Redis to demonstrate the RAG workflow. 29 | 30 | == Dependencies 31 | 32 | This project uses the following dependencies: 33 | 34 | [source,xml,indent=0] 35 | ---- 36 | include::../../../pom.xml[tag=dependencies] 37 | ---- 38 | 39 | == Data Load 40 | 41 | The data we will use for our application consists of JSON documents providing information about beers. 42 | Each document has the following structure: 43 | 44 | [source,json] 45 | ---- 46 | { 47 | "id": "00gkb9", 48 | "name": "Smoked Porter Ale", 49 | "description": "The Porter Pounder Smoked Porter is a dark rich flavored ale that is made with 5 malts that include smoked and chocolate roasted malts. It has coffee and mocha notes that create a long finish that ends clean with the use of just a bit of dry hopping", 50 | "abv": 8, 51 | "ibu": 36 52 | } 53 | ---- 54 | 55 | To load this beer dataset into Redis, we will use the `RagDataLoader` class. 56 | This class contains a run method that is executed at application startup. 57 | Within this method, we use a `JsonReader` to parse the dataset and then insert the documents into Redis using the autowired `VectorStore`. 58 | 59 | [source,java,indent=0] 60 | ---- 61 | include::../../../src/main/java/com/redis/demo/spring/ai/RagDataLoader.java[tag=loader] 62 | ---- 63 | 64 | What we have at this point is a dataset of about 22,000 beers with their corresponding embeddings. 65 | 66 | == RAG Service 67 | 68 | The `RagService` class implements the RAG workflow. 69 | When a user prompt is received, the retrieve method is called, which performs the following steps: 70 | 71 | * Computes the vector of the user prompt 72 | * Queries the Redis database to retrieve the most relevant documents 73 | * Constructs a prompt using the retrieved documents and the user prompt 74 | * Calls a `ChatClient` with the prompt to generate a response 75 | 76 | [source,java,indent=0] 77 | ---- 78 | include::../../../src/main/java/com/redis/demo/spring/ai/RagService.java[tag=retrieve] 79 | ---- 80 | 81 | == Controller 82 | 83 | Now that we have implemented our RAG service we can wrap it in a HTTP endpoint. 84 | 85 | The `RagController` class exposes it as a `POST` endpoint: 86 | 87 | [source,java,indent=0] 88 | ---- 89 | include::../../../src/main/java/com/redis/demo/spring/ai/RagController.java[tag=chatMessage] 90 | ---- 91 | 92 | == User Interface 93 | 94 | For the user interface, we have created a simple React frontend that allows users to ask questions about beers. 95 | The frontend interacts with the Spring backend by sending HTTP requests to the `/chat/{chatId}` endpoint and displaying the responses. 96 | 97 | image::spring-ai-redis-screenshot.png[] 98 | 99 | Voilà! With just a few classes we have implemented a RAG application with Spring AI and Redis. 100 | 101 | == Related Resources 102 | 103 | * The code presented in this article is available on https://github.com/{project-owner}/{project-name}.git[GitHub]. 104 | * For more information about Spring AI, visit the https://docs.spring.io/spring-ai/reference[project homepage]. 105 | * Learn more about the Redis vector search API in the https://redis.io/docs/interact/search-and-query/advanced-concepts/vectors/[Redis vector documentation]. 106 | -------------------------------------------------------------------------------- /src/docs/asciidoc/spring-ai-redis-screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redis-developer/spring-ai-redis-demo/69f38a121461cb064fa72d40c8886216fdf56c08/src/docs/asciidoc/spring-ai-redis-screenshot.png -------------------------------------------------------------------------------- /src/main/java/com/redis/demo/spring/ai/RagApplication.java: -------------------------------------------------------------------------------- 1 | package com.redis.demo.spring.ai; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class RagApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(RagApplication.class, args); 11 | } 12 | 13 | } -------------------------------------------------------------------------------- /src/main/java/com/redis/demo/spring/ai/RagConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.redis.demo.spring.ai; 2 | 3 | import org.springframework.ai.autoconfigure.vectorstore.redis.RedisVectorStoreProperties; 4 | import org.springframework.ai.chat.ChatClient; 5 | import org.springframework.ai.document.MetadataMode; 6 | import org.springframework.ai.transformers.TransformersEmbeddingClient; 7 | import org.springframework.ai.vectorstore.RedisVectorStore; 8 | import org.springframework.ai.vectorstore.RedisVectorStore.RedisVectorStoreConfig; 9 | import org.springframework.ai.vectorstore.VectorStore; 10 | import org.springframework.context.annotation.Bean; 11 | import org.springframework.context.annotation.Configuration; 12 | 13 | @Configuration 14 | public class RagConfiguration { 15 | 16 | @Bean 17 | TransformersEmbeddingClient transformersEmbeddingClient() { 18 | return new TransformersEmbeddingClient(MetadataMode.EMBED); 19 | } 20 | 21 | @Bean 22 | VectorStore vectorStore(TransformersEmbeddingClient embeddingClient, RedisVectorStoreProperties properties) { 23 | var config = RedisVectorStoreConfig.builder().withURI(properties.getUri()).withIndexName(properties.getIndex()) 24 | .withPrefix(properties.getPrefix()).build(); 25 | RedisVectorStore vectorStore = new RedisVectorStore(config, embeddingClient); 26 | vectorStore.afterPropertiesSet(); 27 | return vectorStore; 28 | } 29 | 30 | @Bean 31 | RagService ragService(ChatClient chatClient, VectorStore vectorStore) { 32 | return new RagService(chatClient, vectorStore); 33 | } 34 | 35 | } 36 | -------------------------------------------------------------------------------- /src/main/java/com/redis/demo/spring/ai/RagController.java: -------------------------------------------------------------------------------- 1 | package com.redis.demo.spring.ai; 2 | 3 | import java.util.UUID; 4 | 5 | import org.springframework.ai.chat.Generation; 6 | import org.springframework.stereotype.Controller; 7 | import org.springframework.web.bind.annotation.PathVariable; 8 | import org.springframework.web.bind.annotation.PostMapping; 9 | import org.springframework.web.bind.annotation.RequestBody; 10 | import org.springframework.web.bind.annotation.ResponseBody; 11 | 12 | @Controller 13 | public class RagController { 14 | 15 | private final RagService ragService; 16 | 17 | public RagController(RagService ragService) { 18 | this.ragService = ragService; 19 | } 20 | 21 | @PostMapping("/chat/startChat") 22 | @ResponseBody 23 | public Message startChat() { 24 | return Message.of(UUID.randomUUID().toString()); 25 | } 26 | 27 | //tag::chatMessage[] 28 | @PostMapping("/chat/{chatId}") 29 | @ResponseBody 30 | public Message chatMessage(@PathVariable("chatId") String chatId, @RequestBody Prompt prompt) { 31 | // Extract user prompt from the body and pass it to the RagService 32 | Generation generation = ragService.retrieve(prompt.getPrompt()); 33 | // Reply with the generated message 34 | return Message.of(generation.getOutput().getContent()); 35 | } 36 | //end::chatMessage[] 37 | 38 | @PostMapping("/documents/upload") 39 | @ResponseBody 40 | public String uploadDocument(String doc) { 41 | return "Document upload not supported"; 42 | } 43 | 44 | public static class Message { 45 | 46 | private String message; 47 | 48 | public String getMessage() { 49 | return message; 50 | } 51 | 52 | public void setMessage(String message) { 53 | this.message = message; 54 | } 55 | 56 | public static Message of(String message) { 57 | Message response = new Message(); 58 | response.setMessage(message); 59 | return response; 60 | } 61 | 62 | } 63 | 64 | public static class Prompt { 65 | 66 | private String prompt; 67 | 68 | public String getPrompt() { 69 | return prompt; 70 | } 71 | 72 | public void setPrompt(String prompt) { 73 | this.prompt = prompt; 74 | } 75 | 76 | } 77 | 78 | } 79 | -------------------------------------------------------------------------------- /src/main/java/com/redis/demo/spring/ai/RagDataLoader.java: -------------------------------------------------------------------------------- 1 | package com.redis.demo.spring.ai; 2 | 3 | import java.util.Map; 4 | import java.util.zip.GZIPInputStream; 5 | 6 | import org.slf4j.Logger; 7 | import org.slf4j.LoggerFactory; 8 | import org.springframework.ai.autoconfigure.vectorstore.redis.RedisVectorStoreProperties; 9 | import org.springframework.ai.reader.JsonReader; 10 | import org.springframework.ai.vectorstore.RedisVectorStore; 11 | import org.springframework.beans.factory.annotation.Value; 12 | import org.springframework.boot.ApplicationArguments; 13 | import org.springframework.boot.ApplicationRunner; 14 | import org.springframework.core.io.InputStreamResource; 15 | import org.springframework.core.io.Resource; 16 | import org.springframework.stereotype.Component; 17 | 18 | @Component 19 | public class RagDataLoader implements ApplicationRunner { 20 | 21 | private static final Logger logger = LoggerFactory.getLogger(RagDataLoader.class); 22 | 23 | private static final String[] KEYS = { "name", "abv", "ibu", "description" }; 24 | 25 | @Value("classpath:/data/beers.json.gz") 26 | private Resource data; 27 | 28 | private final RedisVectorStore vectorStore; 29 | 30 | private final RedisVectorStoreProperties properties; 31 | 32 | public RagDataLoader(RedisVectorStore vectorStore, RedisVectorStoreProperties properties) { 33 | this.vectorStore = vectorStore; 34 | this.properties = properties; 35 | } 36 | 37 | @Override 38 | public void run(ApplicationArguments args) throws Exception { 39 | Map indexInfo = vectorStore.getJedis().ftInfo(properties.getIndex()); 40 | int numDocs = Integer.parseInt((String) indexInfo.getOrDefault("num_docs", "0")); 41 | if (numDocs > 20000) { 42 | logger.info("Embeddings already loaded. Skipping"); 43 | return; 44 | } 45 | Resource file = data; 46 | if (data.getFilename().endsWith(".gz")) { 47 | GZIPInputStream inputStream = new GZIPInputStream(data.getInputStream()); 48 | file = new InputStreamResource(inputStream, "beers.json.gz"); 49 | } 50 | logger.info("Creating Embeddings..."); 51 | // tag::loader[] 52 | // Create a JSON reader with fields relevant to our use case 53 | JsonReader loader = new JsonReader(file, KEYS); 54 | // Use the autowired VectorStore to insert the documents into Redis 55 | vectorStore.add(loader.get()); 56 | // end::loader[] 57 | logger.info("Embeddings created."); 58 | } 59 | 60 | } 61 | -------------------------------------------------------------------------------- /src/main/java/com/redis/demo/spring/ai/RagService.java: -------------------------------------------------------------------------------- 1 | package com.redis.demo.spring.ai; 2 | 3 | import java.util.List; 4 | import java.util.Map; 5 | import java.util.stream.Collectors; 6 | 7 | import org.springframework.ai.chat.ChatClient; 8 | import org.springframework.ai.chat.ChatResponse; 9 | import org.springframework.ai.chat.Generation; 10 | import org.springframework.ai.chat.messages.Message; 11 | import org.springframework.ai.chat.messages.UserMessage; 12 | import org.springframework.ai.chat.prompt.Prompt; 13 | import org.springframework.ai.chat.prompt.SystemPromptTemplate; 14 | import org.springframework.ai.document.Document; 15 | import org.springframework.ai.vectorstore.SearchRequest; 16 | import org.springframework.ai.vectorstore.VectorStore; 17 | import org.springframework.beans.factory.annotation.Value; 18 | import org.springframework.core.io.Resource; 19 | 20 | public class RagService { 21 | 22 | @Value("classpath:/prompts/system-qa.st") 23 | private Resource systemBeerPrompt; 24 | 25 | @Value("${topk:10}") 26 | private int topK; 27 | 28 | private final ChatClient client; 29 | 30 | private final VectorStore store; 31 | 32 | public RagService(ChatClient client, VectorStore store) { 33 | this.client = client; 34 | this.store = store; 35 | } 36 | 37 | // tag::retrieve[] 38 | public Generation retrieve(String message) { 39 | SearchRequest request = SearchRequest.query(message).withTopK(topK); 40 | // Query Redis for the top K documents most relevant to the input message 41 | List docs = store.similaritySearch(request); 42 | Message systemMessage = getSystemMessage(docs); 43 | UserMessage userMessage = new UserMessage(message); 44 | // Assemble the complete prompt using a template 45 | Prompt prompt = new Prompt(List.of(systemMessage, userMessage)); 46 | // Call the autowired chat client with the prompt 47 | ChatResponse response = client.call(prompt); 48 | return response.getResult(); 49 | } 50 | // end::retrieve[] 51 | 52 | private Message getSystemMessage(List similarDocuments) { 53 | String documents = similarDocuments.stream().map(Document::getContent).collect(Collectors.joining("\n")); 54 | SystemPromptTemplate systemPromptTemplate = new SystemPromptTemplate(systemBeerPrompt); 55 | return systemPromptTemplate.createMessage(Map.of("documents", documents)); 56 | } 57 | 58 | } 59 | -------------------------------------------------------------------------------- /src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | #spring.ai.azure.openai.temperature=0.7 2 | spring.ai.vectorstore.redis.index=beers 3 | spring.ai.vectorstore.redis.prefix=beer: -------------------------------------------------------------------------------- /src/main/resources/data/beers.json.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/redis-developer/spring-ai-redis-demo/69f38a121461cb064fa72d40c8886216fdf56c08/src/main/resources/data/beers.json.gz -------------------------------------------------------------------------------- /src/main/resources/prompts/system-qa.st: -------------------------------------------------------------------------------- 1 | You're assisting with questions about products in a beer catalog. 2 | Use the information from the DOCUMENTS section to provide accurate answers. 3 | The answer involves referring to the ABV or IBU of the beer, include the beer name in the response. 4 | If unsure, simply state that you don't know. 5 | 6 | DOCUMENTS: 7 | {documents} --------------------------------------------------------------------------------