SuperSQLAI 驱动的 SQL 生成框架

简介 ​

SuperSQL 是一个基于生成式大模型实现的 NL2SQL Java 框架，专注于将数据库表结构通过检索增强生成（RAG）技术进行训练，实现从自然语言到 SQL 的智能转换。

快速开始 ​

1. 添加依赖 ​

<dependency>
    <groupId>com.aispace.supersql</groupId>
    <artifactId>super-sql-spring-boot-starter</artifactId>
    <version>1.0.0-M1</version>
</dependency>

2. 配置大模型 ​

spring:
  ai:
    azure:
      openai:
        api-key: your-api-key
        endpoint: https://your-resource.openai.azure.com/
        chat:
          options:
            deployment-name: gpt-4o-latest

3. 编写代码 ​

@GetMapping("/query")
public Object query(@RequestParam String question) {
    String sql = sqlEngine.setChatModel(chatModel)
            .generateSql(question);
    return sqlEngine.executeSql(sql);
}

4. 测试 ​

访问：http://localhost:8080/api/query?question=查询所有用户

技术栈 ​

• Java 21 - 使用最新的 Java 特性
• Spring Boot 3.4+ - 基于 Spring Boot 框架
• Spring AI - 集成 Spring AI 生态
• Vector Database - 支持多种向量数据库
• LLM - 支持多种大模型提供商

学习资源 ​

• 📖 快速开始指南 - 5 分钟上手
• 🔧 安装配置 - 详细安装说明
• 💡 基础用法 - 学习核心功能
• 🚀 高级特性 - 探索高级功能
• 📝 API 文档 - 完整 API 参考

社区 ​

• 💬 GitHub
• 🐛 Gitee
• 📧 GitCode

许可证 ​

SuperSQL 基于 Apache 2.0 许可证 开源。