diff --git a/.github/workflows/embeddingstore-neo4j-springai.yml b/.github/workflows/embeddingstore-neo4j-springai.yml new file mode 100644 index 0000000..ff5682b --- /dev/null +++ b/.github/workflows/embeddingstore-neo4j-springai.yml @@ -0,0 +1,39 @@ +name: neo4j-springai CI Build + +on: + push: + paths: + - "embeddingstores/neo4j-springai/**" + branches: [main] + pull_request: + paths: + - "embeddingstores/neo4j-springai/**" + types: + - opened + - synchronize + - reopened + +jobs: + build: + name: Run Unit & Integration Tests + runs-on: ubuntu-latest + defaults: + run: + working-directory: embeddingstores/neo4j-springai + strategy: + matrix: + distribution: [ 'temurin' ] + java: [ '21' ] + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis + + - name: Set up JDK ${{ matrix.java }} + uses: actions/setup-java@v4.2.1 + with: + java-version: ${{ matrix.java }} + distribution: ${{ matrix.distribution }} + cache: 'maven' + - name: Build and analyze + run: ./mvnw clean verify \ No newline at end of file diff --git a/README.md b/README.md index 16e281a..1913235 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,17 @@ AI implementations using java, stores and either of Langchain4j or springai framework -| **_Module Name_** | **_Description_** | -|----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------| -| [opensearch langchain4j](./ai-opensearch-langchain4j) | Embeddings implementation using langchain4j and opensearch store | -| [chatmodel springai](./chatmodel-springai) | AI chat playground using springai | -| [pgvector lanchain4j](./pgvector-langchain4j) | Embeddings implementation using langchain4j and pgvector | -| [pgvector springai](./pgvector-springai) | Embeddings implementation using springai and pgvector | -| [playground](./playground) | AI playground using Langchain4j | -| [rag langchain4j AllMiniLmL6V2](./rag-langchain4j-AllMiniLmL6V2-llm) | RAG Implementation using Langchain4j, PGVector store and openai LLM | -| [rag springai ollama llm](./rag-springai-ollama-llm) | RAG Implementation using springai, Redis store, PDF document reader and ollama LLM with llama2 model | -| [rag springai openai llm](./rag-springai-openai-llm) | RAG Implementation using springai, PGVector store, Tika document reader and openai LLM | +| **_Module Name_** | **_Description_** | +|---------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------| +| [playground](./playground) | AI playground using Langchain4j | +| [chatmodel springai](./chatmodel-springai) | AI chat playground using springai | +| [pgvector lanchain4j](./pgvector-langchain4j) | Embeddings implementation using langchain4j and pgvector | +| [pgvector springai](./pgvector-springai) | Embeddings implementation using springai and pgvector | +| [neo4j embedding Store using spring ai](./embeddingstores/neo4j-springai) | Embedding store implementation using springai and neo4j | +| [opensearch langchain4j](./ai-opensearch-langchain4j) | Embeddings implementation using langchain4j and opensearch store | +| [rag langchain4j AllMiniLmL6V2](./rag-langchain4j-AllMiniLmL6V2-llm) | RAG Implementation using Langchain4j, PGVector store and openai LLM | +| [rag springai ollama llm](./rag-springai-ollama-llm) | RAG Implementation using springai, Redis store, PDF document reader and ollama LLM with llama2 model | +| [rag springai openai llm](./rag-springai-openai-llm) | RAG Implementation using springai, PGVector store, Tika document reader and openai LLM | +### Credits +Thanks to langchain4j for providing an openAI compatible API for learning and demo purposes. \ No newline at end of file diff --git a/embeddingstores/neo4j-springai/.mvn/wrapper/maven-wrapper.jar b/embeddingstores/neo4j-springai/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 0000000..cb28b0e Binary files /dev/null and b/embeddingstores/neo4j-springai/.mvn/wrapper/maven-wrapper.jar differ diff --git a/embeddingstores/neo4j-springai/.mvn/wrapper/maven-wrapper.properties b/embeddingstores/neo4j-springai/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..346d645 --- /dev/null +++ b/embeddingstores/neo4j-springai/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,18 @@ +# 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. +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.6/apache-maven-3.9.6-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar diff --git a/embeddingstores/neo4j-springai/ReadMe.md b/embeddingstores/neo4j-springai/ReadMe.md new file mode 100644 index 0000000..0f75ead --- /dev/null +++ b/embeddingstores/neo4j-springai/ReadMe.md @@ -0,0 +1,25 @@ +# neo4j-springai + +### Run tests + +```shell +./mvnw clean verify +``` + +### Run locally + +```shell +docker-compose -f docker/docker-compose.yml up -d +./mvnw spring-boot:run -Dspring-boot.run.profiles=local +``` +### Using Testcontainers at Development Time +You can run `TestApplication.java` from your IDE directly. +You can also run the application using Maven as follows: + +```shell +./mvnw spotless:apply spring-boot:test-run +``` + +### Useful Links +* Swagger UI: http://localhost:8080/swagger-ui.html +* Actuator Endpoint: http://localhost:8080/actuator \ No newline at end of file diff --git a/embeddingstores/neo4j-springai/docker/docker-compose.yml b/embeddingstores/neo4j-springai/docker/docker-compose.yml new file mode 100644 index 0000000..6cef0a7 --- /dev/null +++ b/embeddingstores/neo4j-springai/docker/docker-compose.yml @@ -0,0 +1,7 @@ +services: + neo4j: + container_name: neo4j + image: neo4j:latest + ports: + - 7474:7474 + - 7687:7687 \ No newline at end of file diff --git a/embeddingstores/neo4j-springai/mvnw b/embeddingstores/neo4j-springai/mvnw new file mode 100755 index 0000000..8d937f4 --- /dev/null +++ b/embeddingstores/neo4j-springai/mvnw @@ -0,0 +1,308 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# 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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.2.0 +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "$(uname)" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home"; export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=$(java-config --jre-home) + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --unix "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --unix "$CLASSPATH") +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && + JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="$(which javac)" + if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=$(which readlink) + if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then + if $darwin ; then + javaHome="$(dirname "\"$javaExecutable\"")" + javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" + else + javaExecutable="$(readlink -f "\"$javaExecutable\"")" + fi + javaHome="$(dirname "\"$javaExecutable\"")" + javaHome=$(expr "$javaHome" : '\(.*\)/bin') + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=$(cd "$wdir/.." || exit 1; pwd) + fi + # end of workaround + done + printf '%s' "$(cd "$basedir" || exit 1; pwd)" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + # Remove \r in case we run on Windows within Git Bash + # and check out the repository with auto CRLF management + # enabled. Otherwise, we may read lines that are delimited with + # \r\n and produce $'-Xarg\r' rather than -Xarg due to word + # splitting rules. + tr -s '\r\n' ' ' < "$1" + fi +} + +log() { + if [ "$MVNW_VERBOSE" = true ]; then + printf '%s\n' "$1" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname "$0")") +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR +log "$MAVEN_PROJECTBASEDIR" + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" +if [ -r "$wrapperJarPath" ]; then + log "Found $wrapperJarPath" +else + log "Couldn't find $wrapperJarPath, downloading it ..." + + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + fi + while IFS="=" read -r key value; do + # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) + safeValue=$(echo "$value" | tr -d '\r') + case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; + esac + done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" + log "Downloading from: $wrapperUrl" + + if $cygwin; then + wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") + fi + + if command -v wget > /dev/null; then + log "Found wget ... using wget" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + log "Found curl ... using curl" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + fi + else + log "Falling back to using Java to download" + javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=$(cygpath --path --windows "$javaSource") + javaClass=$(cygpath --path --windows "$javaClass") + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + log " - Compiling MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + log " - Running MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +# If specified, validate the SHA-256 sum of the Maven wrapper jar file +wrapperSha256Sum="" +while IFS="=" read -r key value; do + case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; + esac +done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" +if [ -n "$wrapperSha256Sum" ]; then + wrapperSha256Result=false + if command -v sha256sum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + elif command -v shasum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + exit 1 + fi + if [ $wrapperSha256Result = false ]; then + echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 + echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 + echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + exit 1 + fi +fi + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --windows "$CLASSPATH") + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# shellcheck disable=SC2086 # safe args +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/embeddingstores/neo4j-springai/mvnw.cmd b/embeddingstores/neo4j-springai/mvnw.cmd new file mode 100644 index 0000000..f80fbad --- /dev/null +++ b/embeddingstores/neo4j-springai/mvnw.cmd @@ -0,0 +1,205 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.2.0 +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file +SET WRAPPER_SHA_256_SUM="" +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +) +IF NOT %WRAPPER_SHA_256_SUM%=="" ( + powershell -Command "&{"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ + " exit 1;"^ + "}"^ + "}" + if ERRORLEVEL 1 goto error +) + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/embeddingstores/neo4j-springai/pom.xml b/embeddingstores/neo4j-springai/pom.xml new file mode 100644 index 0000000..ac1022a --- /dev/null +++ b/embeddingstores/neo4j-springai/pom.xml @@ -0,0 +1,131 @@ + + + 4.0.0 + + + org.springframework.boot + spring-boot-starter-parent + 3.2.4 + + + + org.example.ai + neo4j-springai + 1.0.0-SNAPSHOT + + + UTF-8 + 17 + 0.8.1 + 2.43.0 + + + + + org.springframework.boot + spring-boot-starter-actuator + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.ai + spring-ai-openai-spring-boot-starter + + + org.springframework.ai + spring-ai-neo4j-store-spring-boot-starter + + + + org.springdoc + springdoc-openapi-starter-webmvc-ui + 2.4.0 + + + + org.springframework.boot + spring-boot-starter-test + test + + + io.rest-assured + rest-assured + test + + + org.springframework.boot + spring-boot-testcontainers + test + + + org.testcontainers + junit-jupiter + test + + + org.testcontainers + neo4j + test + + + + + + + org.springframework.ai + spring-ai-bom + ${spring-ai.version} + pom + import + + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + com.diffplug.spotless + spotless-maven-plugin + ${spotless.version} + + + + 2.40.0 + + + + + + + + + compile + + check + + + + + + + + + + spring-milestones + Spring Milestones + https://repo.spring.io/milestone + + false + + + + + \ No newline at end of file diff --git a/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/Neo4jVectorEmbeddingStoreExample.java b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/Neo4jVectorEmbeddingStoreExample.java new file mode 100644 index 0000000..8a90ccc --- /dev/null +++ b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/Neo4jVectorEmbeddingStoreExample.java @@ -0,0 +1,12 @@ +package com.learning.ai; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class Neo4jVectorEmbeddingStoreExample { + + public static void main(String[] args) { + SpringApplication.run(Neo4jVectorEmbeddingStoreExample.class, args); + } +} diff --git a/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/config/Initializer.java b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/config/Initializer.java new file mode 100644 index 0000000..893a82b --- /dev/null +++ b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/config/Initializer.java @@ -0,0 +1,20 @@ +package com.learning.ai.config; + +import com.learning.ai.service.Neo4jVectorStoreService; +import org.springframework.boot.CommandLineRunner; +import org.springframework.stereotype.Component; + +@Component +public class Initializer implements CommandLineRunner { + + private final Neo4jVectorStoreService neo4jVectorStoreService; + + public Initializer(Neo4jVectorStoreService neo4jVectorStoreService) { + this.neo4jVectorStoreService = neo4jVectorStoreService; + } + + @Override + public void run(String... args) { + neo4jVectorStoreService.storeEmbeddings(); + } +} diff --git a/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/config/ResponseHeadersModification.java b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/config/ResponseHeadersModification.java new file mode 100644 index 0000000..ce86d3c --- /dev/null +++ b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/config/ResponseHeadersModification.java @@ -0,0 +1,64 @@ +package com.learning.ai.config; + +import java.io.IOException; +import java.io.InputStream; +import java.util.Collections; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpStatusCode; +import org.springframework.http.MediaType; +import org.springframework.http.client.ClientHttpResponse; +import org.springframework.util.LinkedMultiValueMap; +import org.springframework.util.MultiValueMap; +import org.springframework.web.client.RestClient; + +@Configuration(proxyBeanMethods = false) +@ConditionalOnProperty(value = "spring.ai.openai.api-key", havingValue = "demo") +public class ResponseHeadersModification { + + @Bean + RestClient.Builder restClientBuilder() { + return RestClient.builder().requestInterceptor((request, body, execution) -> { + ClientHttpResponse response = execution.execute(request, body); + return new CustomClientHttpResponse(response); + }); + } + + private static class CustomClientHttpResponse implements ClientHttpResponse { + + private final ClientHttpResponse originalResponse; + private final HttpHeaders headers; + + public CustomClientHttpResponse(ClientHttpResponse originalResponse) { + this.originalResponse = originalResponse; + MultiValueMap modifiedHeaders = new LinkedMultiValueMap<>(originalResponse.getHeaders()); + modifiedHeaders.put(HttpHeaders.CONTENT_TYPE, Collections.singletonList(MediaType.APPLICATION_JSON_VALUE)); + this.headers = new HttpHeaders(modifiedHeaders); + } + + @Override + public HttpStatusCode getStatusCode() throws IOException { + return originalResponse.getStatusCode(); + } + + @Override + public String getStatusText() throws IOException { + return originalResponse.getStatusText(); + } + + @Override + public void close() {} + + @Override + public InputStream getBody() throws IOException { + return originalResponse.getBody(); + } + + @Override + public HttpHeaders getHeaders() { + return headers; + } + } +} diff --git a/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/config/SwaggerConfig.java b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/config/SwaggerConfig.java new file mode 100644 index 0000000..c543547 --- /dev/null +++ b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/config/SwaggerConfig.java @@ -0,0 +1,10 @@ +package com.learning.ai.config; + +import io.swagger.v3.oas.annotations.OpenAPIDefinition; +import io.swagger.v3.oas.annotations.info.Info; +import io.swagger.v3.oas.annotations.servers.Server; +import org.springframework.context.annotation.Configuration; + +@Configuration(proxyBeanMethods = false) +@OpenAPIDefinition(info = @Info(title = "pgvector-springai", version = "v1.0.0"), servers = @Server(url = "/")) +public class SwaggerConfig {} diff --git a/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/controller/QueryController.java b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/controller/QueryController.java new file mode 100644 index 0000000..371ab29 --- /dev/null +++ b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/controller/QueryController.java @@ -0,0 +1,25 @@ +package com.learning.ai.controller; + +import com.learning.ai.model.request.AIChatRequest; +import com.learning.ai.model.response.AIChatResponse; +import com.learning.ai.service.Neo4jVectorStoreService; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +@RestController +@RequestMapping("/api/ai") +public class QueryController { + + private final Neo4jVectorStoreService neo4jVectorStoreService; + + public QueryController(Neo4jVectorStoreService neo4jVectorStoreService) { + this.neo4jVectorStoreService = neo4jVectorStoreService; + } + + @PostMapping("/query") + AIChatResponse queryEmbeddedStore(@RequestBody AIChatRequest aiChatRequest) { + return neo4jVectorStoreService.queryEmbeddingStore(aiChatRequest.query()); + } +} diff --git a/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/model/request/AIChatRequest.java b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/model/request/AIChatRequest.java new file mode 100644 index 0000000..440d9bc --- /dev/null +++ b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/model/request/AIChatRequest.java @@ -0,0 +1,3 @@ +package com.learning.ai.model.request; + +public record AIChatRequest(String query) {} diff --git a/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/model/response/AIChatResponse.java b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/model/response/AIChatResponse.java new file mode 100644 index 0000000..83068fc --- /dev/null +++ b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/model/response/AIChatResponse.java @@ -0,0 +1,3 @@ +package com.learning.ai.model.response; + +public record AIChatResponse(String answer) {} diff --git a/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/service/Neo4jVectorStoreService.java b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/service/Neo4jVectorStoreService.java new file mode 100644 index 0000000..991015b --- /dev/null +++ b/embeddingstores/neo4j-springai/src/main/java/com/learning/ai/service/Neo4jVectorStoreService.java @@ -0,0 +1,55 @@ +package com.learning.ai.service; + +import com.learning.ai.model.response.AIChatResponse; +import java.util.List; +import java.util.stream.Collectors; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.ai.document.Document; +import org.springframework.ai.vectorstore.SearchRequest; +import org.springframework.ai.vectorstore.VectorStore; +import org.springframework.stereotype.Service; + +@Service +public class Neo4jVectorStoreService { + + private static final Logger LOGGER = LoggerFactory.getLogger(Neo4jVectorStoreService.class); + + private final VectorStore vectorStore; + + public Neo4jVectorStoreService(VectorStore vectorStore) { + this.vectorStore = vectorStore; + } + + public void storeEmbeddings() { + // Store embeddings + List documents = + List.of(new Document("I like football."), new Document("The weather is good today.")); + vectorStore.add(documents); + } + + public AIChatResponse queryEmbeddingStore(String question) { + try { + // Retrieve embeddings + SearchRequest query = SearchRequest.query(question).withTopK(1); + List similarDocuments = vectorStore.similaritySearch(query); + + if (similarDocuments.isEmpty()) { + // Handle case where no similar documents are found + LOGGER.info("No similar documents found for the question: {}", question); + return new AIChatResponse("No similar documents found."); + } + + String relevantData = similarDocuments.stream() + .map(Document::getContent) + .collect(Collectors.joining(System.lineSeparator())); + + LOGGER.info("Response from vectorStore: {}", relevantData); + return new AIChatResponse(relevantData); + } catch (Exception e) { + // Handle potential exceptions from the similarity search + LOGGER.error("An error occurred during the similarity search: ", e); + return new AIChatResponse("An error occurred while processing your request. Please try again later."); + } + } +} diff --git a/embeddingstores/neo4j-springai/src/main/resources/application.properties b/embeddingstores/neo4j-springai/src/main/resources/application.properties new file mode 100644 index 0000000..e4900ff --- /dev/null +++ b/embeddingstores/neo4j-springai/src/main/resources/application.properties @@ -0,0 +1,12 @@ +spring.ai.openai.api-key=demo +spring.ai.openai.base-url=http://langchain4j.dev/demo/openai +spring.ai.openai.image.enabled=false +spring.ai.openai.chat.options.temperature=0.2 +spring.ai.openai.chat.options.model=gpt-3.5-turbo +spring.ai.openai.chat.options.responseFormat=json_object + +spring.threads.virtual.enabled=true + + +#Neo4jVector +#spring.ai.vectorstore.neo4j.databaseName=neo4j_vector_store \ No newline at end of file diff --git a/embeddingstores/neo4j-springai/src/test/java/com/learning/ai/TestNeo4jVectorEmbeddingStoreExample.java b/embeddingstores/neo4j-springai/src/test/java/com/learning/ai/TestNeo4jVectorEmbeddingStoreExample.java new file mode 100644 index 0000000..b9c9382 --- /dev/null +++ b/embeddingstores/neo4j-springai/src/test/java/com/learning/ai/TestNeo4jVectorEmbeddingStoreExample.java @@ -0,0 +1,26 @@ +package com.learning.ai; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.test.context.TestConfiguration; +import org.springframework.boot.testcontainers.service.connection.ServiceConnection; +import org.springframework.context.annotation.Bean; +import org.testcontainers.containers.Neo4jContainer; +import org.testcontainers.utility.DockerImageName; + +@TestConfiguration(proxyBeanMethods = false) +public class TestNeo4jVectorEmbeddingStoreExample { + + @Bean + @ServiceConnection + Neo4jContainer neo4jContainer() { + return new Neo4jContainer<>(DockerImageName.parse("neo4j:5")) + .withoutAuthentication() + .withLabsPlugins("apoc"); + } + + public static void main(String[] args) { + SpringApplication.from(Neo4jVectorEmbeddingStoreExample::main) + .with(TestNeo4jVectorEmbeddingStoreExample.class) + .run(args); + } +} diff --git a/embeddingstores/neo4j-springai/src/test/java/com/learning/ai/controller/QueryControllerTest.java b/embeddingstores/neo4j-springai/src/test/java/com/learning/ai/controller/QueryControllerTest.java new file mode 100644 index 0000000..e0ada98 --- /dev/null +++ b/embeddingstores/neo4j-springai/src/test/java/com/learning/ai/controller/QueryControllerTest.java @@ -0,0 +1,40 @@ +package com.learning.ai.controller; + +import static io.restassured.RestAssured.given; +import static org.hamcrest.Matchers.equalTo; + +import com.learning.ai.TestNeo4jVectorEmbeddingStoreExample; +import com.learning.ai.model.request.AIChatRequest; +import io.restassured.RestAssured; +import io.restassured.http.ContentType; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.TestInstance; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.web.server.LocalServerPort; + +@SpringBootTest( + webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, + classes = TestNeo4jVectorEmbeddingStoreExample.class) +@TestInstance(TestInstance.Lifecycle.PER_CLASS) +class QueryControllerTest { + + @LocalServerPort + private int localServerPort; + + @BeforeAll + void setUp() { + RestAssured.port = localServerPort; + } + + @Test + void queryEmbeddedStore() { + given().contentType(ContentType.JSON) + .body(new AIChatRequest("What is your favourite sport?")) + .when() + .post("/api/ai/query") + .then() + .statusCode(200) + .body("answer", equalTo("I like football.")); + } +}