# AskDB **Repository Path**: DJH0727/ask-db ## Basic Information - **Project Name**: AskDB - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-09-08 - **Last Updated**: 2025-10-11 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # NLQ2SQL 问答系统 这是一个基于自然语言查询 (Natural Language Query) 转 SQL 的问答系统。用户可以通过自然语言向系统提问,系统会将问题自动转换为 SQL 查询,并返回对应的数据,同时支持生成图表、导出报表等功能。 --- ## 功能特性 1. **自然语言查询 SQL** - 支持用户使用中文或英文自然语言查询数据库。 - 系统自动生成 SQL 并执行查询,返回结果。 2. **智能聊天** - 对于非查询类问题,系统可生成智能回答。 3. **结果展示** - 数据表格显示查询结果。 - 支持图表类型:折线图 (Line)、柱状图 (Bar)、饼图 (Pie)、散点图 (Scatter)。 4. **报表导出** - 支持导出查询结果及图表为以下格式: - CSV - Excel (XLSX) - Word (DOCX) - PDF 5. **聊天记录管理** - 保存用户提问及系统回复历史。 - 支持清空历史和获取历史记录。 --- ## 数据库表结构 系统内置数据库包含以下表(示例数据已提供): ### 1. departments 部门表 | 字段 | 类型 | 说明 | |------------|---------|----------------------| | id | INT | 主键 | | name | VARCHAR | 部门名称(示例:研发部、销售部) | | manager_id | INT | 部门经理,对应 employees.id | ### 2. employees 员工表 | 字段 | 类型 | 说明 | |---------------|---------|-------------------| | id | INT | 主键 | | name | VARCHAR | 员工姓名 | | department_id | INT | 对应 departments.id | | hire_date | DATE | 入职时间 | | salary | DECIMAL | 工资 | ### 3. products 产品表 | 字段 | 类型 | 说明 | |----------|---------|----------------| | id | INT | 主键 | | name | VARCHAR | 产品名称 | | category | VARCHAR | 产品类别(示例:手机、电脑) | | price | DECIMAL | 单价 | | stock | INT | 库存数量 | ### 4. clients 客户表 | 字段 | 类型 | 说明 | |----------|---------|---------------| | id | INT | 主键 | | name | VARCHAR | 客户名称 | | industry | VARCHAR | 行业(示例:互联网、金融) | | location | VARCHAR | 地区(示例:北京、上海) | ### 5. orders 订单表 | 字段 | 类型 | 说明 | |--------------|---------|------------------------| | id | INT | 主键 | | client_id | INT | 客户 ID,对应 clients.id | | employee_id | INT | 销售员 ID,对应 employees.id | | order_date | DATE | 下单时间 | | total_amount | DECIMAL | 总金额 | ### 6. order_items 订单明细表 | 字段 | 类型 | 说明 | |------------|---------|----------------| | id | INT | 主键 | | order_id | INT | 对应 orders.id | | product_id | INT | 对应 products.id | | quantity | INT | 数量 | | unit_price | DECIMAL | 下单单价 | --- ## 技术架构 - **前端**: HTML + CSS + JavaScript + JQuery + Chart.js - **后端**: Django + Python - **数据库**: MySQL 8.0.43 - **Python**: Python 3.10.11 - **自然语言处理**: LLM 模型,将自然语言转换为 SQL 核心流程: system_flow_markdown: | ## 系统整体流程 ### 1️. 用户输入阶段 - 用户在前端页面 (`chat.html`) 输入自然语言问题。 - Django 视图 `getReply(request)` 接收用户输入。 ### 2. 自然语言转 SQL - 调用 `generate_sql_from_nl(nl_question, table_schema)`: 1. 构造 LLM prompt (`generate_sql_from_nl_prompt`): - 包含数据库表结构说明、用户问题、当前时间。 - 明确生成 SQL 的规则(必须 SELECT、不返回原始 id、避免 SELECT * 等)。 2. 调用 LLM (`call_llm_json`): - 通过 OpenAI DeepSeek API 生成 JSON 输出: ```json { "intent": "query | chat | reject", "sql": "...", "answer": "..." } ``` - 根据 LLM 返回的 `intent`: - `query` → 执行 SQL - `chat` → 返回自然语言回答 - `reject` → 返回拒绝信息 ### 3️. 执行 SQL 查询 - 如果 `intent=query`: 1. 调用 `run_sql(sql)` 执行 SQL。 2. 检查执行结果: - 成功 → 调用 `generate_chart_and_summary(result['data'], user_input)` 生成图表类型和数据摘要。 - 失败 → 调用 `check_sql_exception(sql, exception_msg, TABLE_SCHEMA)` 审查 SQL 并给出修正建议或拒绝原因。 ### 4️. 数据分析与可视化 - `generate_chart_and_summary(query_result, user_question)`: 1. 构造 LLM prompt (`generate_chart_and_summary_prompt`)。 2. LLM 返回 JSON: ```json { "chart_type": "table | bar | line | pie | scatter", "summary": "简短中文总结", "fields": ["需要可视化的字段"] } ``` - 根据 `chart_type`,前端展示对应图表。 - 使用 Chart.js 库生成图表,有更高的互动性。 ### 5️. 聊天记录管理 - `chat_history.add_message(user_input, response)` 保存问题和回答。 - 提供接口: - `getHistory` → 获取历史记录 - `cleanHistory` → 清空历史 ### 6️. 报表导出 - 用户可下载报表(CSV、XLSX、DOCX、PDF): 1. 调用 `download_file(request, id, format)`。 2. 获取聊天记录及图表数据(前端Chart.js生成base64编码)。 3. 调用工具函数生成对应格式文件: - `generate_csv` - `generate_xlsx` - `generate_word` - `generate_pdf` 4. 返回 HTTP Response 触发下载。 ### 🔹 模块关系示意 ```text 前端用户输入 │ ▼ Django视图 getReply() │ ▼ generate_sql_from_nl() ──> LLM(JSON生成) ──> intent=query? ──┐ │ │ ▼ ▼ intent=chat/reject run_sql() │ │ ▼ ▼ 返回自然语言回答 generate_chart_and_summary() -> 图表/summary │ │ └─────────> 返回 JSON 到前端 <─────────────────────────┘ ``` ### 示例问题 ~~~text 统计每个客户的订单总金额 显示 2025 年每个月的订单总金额趋势 卖的最好的前十个产品销售情况怎么样? 统计2025年分类为外设的销售量变化 不同地区客户订单总金额饼图 员工工资和入职时长有什么关系? 列出 name='张三' 或 1=1 的员工 ~~~ ### 不足 - **LLM 调用缺乏流水线**:当前系统中每次 LLM 调用都是独立的: - 自然语言转 SQL (`generate_sql_from_nl`) - SQL 审查 (`check_sql_exception`) - 查询结果分析与可视化 (`generate_chart_and_summary`) 这些调用没有形成统一的多步骤 LLM 流水线,缺乏可复用和模块化。 - **SQL 生成依赖 LLM**:复杂或模糊问题可能生成不准确的 SQL,会导致查询结果不准确或报错。 - **依赖提示词Prompt**:返回结果的质量依赖提示词,提示词的质量和准确性也会影响结果的质量。 - **不支持多轮对话**:每次问答都是独立的。