AIGC Agent

项目简介

AIGC Agent 是一个可私有化部署的 AI 数据协作平台。业务人员可以用自然语言查询数据，也可以上传 CSV / Excel 提交数据变更需求；开发人员可以像审 PR 一样审阅 SQL、执行 dry-run、批准、拒绝、执行和追踪审计日志。

业务人员提出查询或变更需求
  -> AI 生成查询结果或变更方案
  -> 系统做 SQL 安全校验和 dry-run
  -> 形成 Change Request
  -> developer/admin 审阅并受控执行
  -> 审计日志记录全过程

功能说明

• 自然语言问数：基于 LangChain Agent 将业务问题转为 SQL 查询，并返回结论、SQL 和结果表格。
• 只读 SQL 安全执行：单条 SELECT / WITH / SHOW / DESC / DESCRIBE / EXPLAIN 可直接执行，DML / DDL 会被拦截。
• Change Request：自然语言或文件生成数据库变更申请，所有 DML 必须经过审批。
• CSV / Excel 到 CR：解析文件、推荐目标表和字段映射、执行 dry-run，确认后创建 CR。
• 多数据源：支持 MySQL、PostgreSQL、SQLite、ClickHouse、Oracle、SQL Server、OceanBase、MongoDB、Redis、Elasticsearch。
• 数据源连接方式：支持服务端直连、服务端 SSH 隧道和连接器虚拟 IP。
• 权限体系：developer/admin 管理数据源、模型、系统配置、CR 和审计；viewer 只能访问授权查询类能力。
• 审计追踪：记录 CR 创建、审批、执行、失败、回滚标记和关键操作。
• 数据看板：支持 Dashboard、Widget、图表渲染、结构化筛选器、公开看板、私有看板和告警。
• 私有化部署：FastAPI 后端、Vue 3 前端、PostgreSQL 系统库、Docker Compose 一键启动。

使用的模型与算力环境

项目通过 OpenAI-compatible API 接入大模型，可在 .env 或“模型管理”页面配置模型提供方、模型名、API Base 和 API Key。应用服务本身可运行在普通 CPU 环境；如果使用外部模型 API，不要求本地 GPU。私有化部署大模型时，GPU 和显存要求取决于实际接入的模型服务。

详细配置见 技术说明文档.md。

快速入口

• 技术说明文档：docs/技术说明文档.md
• 开发过程记录：docs/开发过程记录.md
• 项目介绍：项目介绍.md
• API 接口文档：API接口文档.md
• 分工文档：分工文档.md
• 示例输入输出：docs/示例输入输出.md

运行摘要

⚠️ 启动前必须完成 .env 配置：复制 .env.example 为 .env 并填写真实值， 至少包括 JWT_SECRET、DATASOURCE_SECRET_KEY、LLM_API_KEY、DATABASE_URL、 POSTGRES_PASSWORD。生产模式下 JWT_SECRET / DATASOURCE_SECRET_KEY 使用 占位符会导致启动直接失败（安全保护，属预期行为）。

推荐使用 Docker Compose 启动：

docker compose up -d --build

初始化 developer 账号：

docker compose exec backend python scripts/init_admin.py --username admin --password "change-me"

更多环境变量、本地开发、测试和常见问题见 技术说明文档.md。

示例输入输出

项目的自然语言问数、SQL 工作区、CSV / Excel 多表导入和 Change Request 审批示例见 docs/示例输入输出.md。

参考来源说明

本仓库文档整理自项目源码、测试、配置模板、API 文档、设计文档和 Git 提交记录。外部技术参考包括 FastAPI、SQLAlchemy Async、Pydantic、LangChain、Vue 3、Vite、Pinia、Chart.js、Docker Compose 以及 OpenAI-compatible API 协议；具体接口契约以 API接口文档.md 和代码实现为准。

License

本项目使用 Apache License 2.0。