Initial commit with SpringAI SQL Assistant project

Author: BurshteynAnton

.gitattributes

@@ -0,0 +1,2 @@
+/mvnw text eol=lf
+*.cmd text eol=crlf

.gitignore

@@ -0,0 +1,17 @@
+target/
+
+.idea/
+*.iml
+.classpath
+.project
+.settings/
+
+.DS_Store
+Thumbs.db
+*.log
+*.swp
+
+application.yaml
+.env
+
+HELP.md

.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+wrapperVersion=3.3.2
+distributionType=only-script
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip

Dockerfile

@@ -0,0 +1,9 @@
+FROM eclipse-temurin:21-jdk-alpine
+
+WORKDIR /app
+
+COPY target/SpringAI-0.0.1-SNAPSHOT.jar app.jar
+
+EXPOSE 8080
+
+ENTRYPOINT ["java", "-jar", "app.jar"]

README.md

@@ -0,0 +1,68 @@
+# Spring AI SQL Assistant
+![System Architecture](media_examples/architecture_schema.png)  
+Ask a question in natural language, and AI will generate and execute a SQL query. The application is connected to PostgreSQL, where the `ai_service` table containing the parameters of 18 AI models (prices, SQL support, providers, etc.) is stored.
+
+## 💡 Tech Stack
+
+- Java 
+- Spring Boot 3.4.5
+- Spring AI 1.0.0-M8
+- PostgreSQL
+- OpenAI GPT (gpt-3.5-turbo)
+- 🐳 Docker + Docker Compose
+
+## Project Showcase
+
+![UI Example](media_examples/Screenshot_1.png)
+- [UI walkthrough video](./media_examples/app_video.mp4) _(short demo, downloadable if not previewable)_
+- 📂 Example screenshots and results are located in the `media_example/` folder
+
+## ⚙️ Key Engineering Challenges
+
+- **Natural language to SQL translation using LLMs**  
+  Integrated Spring AI with OpenAI (GPT-3.5) to translate user questions into SQL queries based on the structure of the `ai_services` table.
+
+- **Safe dynamic SQL execution**  
+  Designed a secure way to execute dynamically generated SQL without injection risks, using validation and controlled execution via `JdbcTemplate`.
+
+- **Database bootstrapping with production-ready data**  
+  On first startup, the PostgreSQL container automatically initializes the `ai_services` table with 18 real AI model entries via `spring_ai_init.sql`.
+
+- **Dockerized multi-container setup with persistent storage**  
+  Used Docker Compose to orchestrate the Spring Boot app and PostgreSQL with named volumes and health checks to ensure reliable startup and data persistence.
+
+- **Flexible, language-agnostic prompting pipeline**  
+  The LLM prompting system is designed to handle both SQL and natural questions with domain-specific context, and can be extended to other database schemas.
+
+
+## ✅ Testing
+
+The Java backend is covered with both unit and integration-style tests for core logic components:
+
+- Text-to-SQL conversion logic: Validates that natural language questions are correctly translated into SQL using mocked ChatClient (LLM).
+- SQL execution layer: Verifies safety of query execution, correct result formatting, null-handling, column ordering, and exception handling using JdbcTemplate.
+- Safety filters: Prevent unsafe queries (DELETE, DROP, etc.) from being executed — covered by negative test cases.
+
+## 🐳 How to Run
+
+1. Open docker-compose.yml and update these environment variables:
+- POSTGRES_PASSWORD=your_password
+- SPRING_AI_OPENAI_API-KEY=your_openai_api_key
+- 
+2. Run everything with Docker Compose:
+
+```bash
+docker-compose up --build
+```
+
+3. Access service:
+    - `http://localhost:8080/ask`
+
+## ⚠️ Tech Notes
+
+- This project uses the OpenAI API, but the architecture allows for easy integration with other LLM providers (e.g. Anthropic, Google, Cohere, Mistral) depending on business needs and cost model.
+
+## 🤝 Thanks for your interest!
+
+- I'm always open to feedback, collaboration, or professional connections.
+- Feel free to reach out!

docker-compose.yml

@@ -0,0 +1,49 @@
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: spring-ai-app
+    ports:
+      - "8080:8080"
+    environment:
+      - SPRING_DATASOURCE_URL=jdbc:postgresql://db:5432/your_database
+      - SPRING_DATASOURCE_USERNAME=username
+      - SPRING_DATASOURCE_PASSWORD=password
+      - SPRING_AI_OPENAI_API-KEY=sk...
+      - SPRING_AI_OPENAI_CHAT_OPTIONS_MODEL=gpt-3.5-turbo
+    restart: unless-stopped
+    depends_on:
+      db:
+        condition: service_healthy
+    networks:
+      - app-network
+
+  db:
+    image: postgres:14
+    container_name: spring-ai-db
+    ports:
+      - "5432:5432"
+    environment:
+      - POSTGRES_DB=your_database
+      - POSTGRES_USER=username
+      - POSTGRES_PASSWORD=password
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+      - ./spring_ai_init.sql:/docker-entrypoint-initdb.d/init.sql
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+    restart: unless-stopped
+    networks:
+      - app-network
+
+networks:
+  app-network:
+    driver: bridge
+
+volumes:
+  postgres_data:
+