NexQuery AI

智能数据协作平台 (Intelligent Data Collaboration Platform)

面向运营与非技术人员，通过 AI 驱动的自然语言交互，实现安全、自主的数据消费与分析。

📖 简介 (Introduction)

NexQuery AI 是一个现代化的 Text-to-SQL 数据协作平台。它致力于解决“业务提数难、研发排期长”的痛点，通过 Agentic workflow 让运营人员能够用自然语言直接查询数据库，同时保障企业级的数据安全与权限管控。

核心价值

1. 自助提数 (Self-Service): 运营人员无需懂 SQL，直接提问即可获取数据报表。
2. 安全可控 (Enterprise Safe): 细粒度的 RBAC 权限、PII 敏感数据自动脱敏、SQL 注入防御与审计日志。
3. 闭环进化 (Self-Evolving): 支持用户反馈 (Feedback) 与知识库 (Knowledge Base) 联动，AI 越用越聪明。
4. 团队协作 (Team Collaboration): 支持查询任务的私有化与公开分享，打破数据孤岛。

---

🚀 核心功能 (Features)

🤖 AI 智能引擎 (Agentic Engine)

• 4-Agent Pipeline (LangGraph):
  • Supervisor: 智能调度中心，作为入口节点分析用户意图，并将任务精准路由给正确的执行智能体。
  • Discovery Agent: 自动探索 Schema 及多表关联关系，获取生成查询所需的上下文元数据。
  • Generator Agent: 根据前置元数据生成准确的 Text-to-SQL 查询。该节点具备错误自修复能力。
  • Security Agent: 独立的安全审计节点。一旦识别到 DROP, TRUNCATE 等高风险动作立刻阻断，并对 PII（敏感个人信息）执行自动脱敏。
• Agentic Chat:
  • SQL Agent: 深度结合关系型数据库 Schema，支持 Text-to-SQL、歧义主动询问 (Disambiguation) 与思维链展示。
• Voice Input: 基于微信 JSSDK 与后端 API 的双模语音识别 (Transcription)，支持直接长按录音发送自然语言指令（针对移动端与桌面端分别适配优化）。
• Mind Chain & Graph Visualizer: 透明展示 AI 的推理过程 (Reasoning)、工具调用 (如 ListTables, ValidateSql) 与自我纠错逻辑。左侧悬浮窗支持实时可视化节点流转路径。
• Knowledge RAG: 将用户认可的优质 SQL 沉淀为知识库，增强 AI 在特定业务场景下的准确率。
• Hybrid AI Engine: 支持多模型并行接入 (如 OpenAI 兼容模型，DeepSeek，智谱 GLM-4)。支持将聊天模型 (Chat Model) 与 向量模型 (Embedding Model) 分离配置，以实现最佳性价比与检索效果。

🔌 多源数据接入

• Supported Sources: PostgreSQL, MySQL, HTTP API (cURL 适配)。
• Auto-Discovery & Schema Sync: 自动扫描数据库元数据并同步至向量数据库。利用 AI 自动识别（如手机号、邮箱）并配置 PII 数据脱敏规则。

🛡 安全与治理

• End-to-End Encryption: 基于 CryptoService 实现敏感 API 负载的全链路加密，确保 API 密钥与敏感数据不在网络嗅探中泄露。
• Precision RBAC: 基于角色的权限控制，严格实施最小权限呈现原则。Dashboard 支持系统级全量视图与个人专属版面的动态隔离。
• Enterprise-Grade Protection:
  • OOM Defense: 强制行数熔断 (兜底 LIMIT 1000)，阻止巨量数据压垮服务器内存。
  • RCE Prevention: 核心沙箱阻隔 Shell 元字符注入，杜绝命令执行逃逸。

⚙️ 自动化与持续集成

• Parameterized Scheduler: 具备极高韧性的数据库驱动调度器。支持配置动态占位符参数，实现千人千面的自动化报表触达。
• Multi-Channel Push:
  • Email: 自动发送带有数据的 CSV 附件。
  • IM Webhook: 支持企业微信、钉钉、飞书群机器人实时推送数据摘要。
• CI/CD & Docker Native: 原生拥抱 Docker 部署，在 GitHub Actions 流水线中深度集成了针对后端数据库测试的专用 docker-compose.test.yml 验证机制，确保发布稳定性。

---

🛠 技术栈 (Tech Stack)

本项目采用 Monorepo 架构，统一管理前后端与共享库。

Component	Status	Description
Multi-Agent Graph	✅ Implemented	LangGraph-based 4-Agent workflow (Supervisor, Discovery, Generator, Security).
Voice Input	✅ Implemented	Cross-platform audio transcription via WeChat JSSDK & HTML5 MediaRecorder.
Mini Program	✅ Implemented	WeChat client for mobile Task Dashboard, Execution, and WeChat Login.
Payload Encryption	✅ Implemented	AES-256 encryption for sensitive data exchange using shared key.
AI SQL Generation	✅ Implemented	Robust backend agent using LangChain, schema retrieval, and self-correction.
Reasoning Display	✅ Implemented	Users can see "thoughts", "tool calls" (e.g., schema lookup), and node execution.
Code Editor	✅ Implemented	Integrated CodeMirror 6 with SQL syntax highlighting and auto-completion.
Hybrid AI Engine	✅ Implemented	Split Chat/Embedding models via custom config (OpenAI/GLM/DeepSeek).

---

📚 文档导航 (Documentation)

• 👨‍💻 开发者指南 (Developer Guide): 包含环境搭建、架构设计、Docker 部署与模块说明。
• 📖 用户手册 (User Manual): 详细的产品功能使用说明书，适合最终用户与管理员。

---

⚡️ 快速开始 (Quick Start)

前置要求

• Docker & Docker Compose
• Node.js v20+ & pnpm
• FFmpeg (用于语音输入转码)

开发环境启动

1. 克隆仓库:

   git clone https://github.com/OSpoon/nexquery-ai.git
   cd nexquery-ai

2. 环境配置:

   cp .env.example .env
   # 编辑 .env 填入必要的 API Key (OpenAI/GLM) 和数据库密码

3. 初始化与启动:

   # 1. 安装依赖
   pnpm install
   
   # 2. 启动基础设施 (PostgreSQL, Redis)
   docker compose up -d
   
   # 3. 初始化数据库 (首次运行必需)
   pnpm backend:migrate
   pnpm backend:seed  # 填充默认管理员与菜单数据
   
   # 4. 启动应用
   pnpm dev

4. 访问:

   • Web: http://localhost:3000
   • Default Admin: admin@nexquery.ai / password

---

Copyright © 2025-2026 NexQuery AI Team. Apache 2.0 Licensed.