From e6d53c74219ee729dbcb4c7c07ad7ee4ce62f947 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E6=B7=8B=E6=B6=9B?= Date: Mon, 16 Nov 2026 15:21:19 +0800 Subject: [PATCH] =?UTF-8?q?feat(chat):=20=E9=97=AE=E6=95=B0=E5=AE=8C?= =?UTF-8?q?=E6=88=90=E5=90=8E=E8=87=AA=E5=8A=A8=E7=94=9F=E6=88=90=E6=95=B0?= =?UTF-8?q?=E6=8D=AE=E5=88=86=E6=9E=90?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 问数成功后自动生成分析结论,不再需要手动点击“数据分析”按钮;分析中的派生数值先由补充 SQL 计算,避免模型自行估算 - 新增配置 CHAT_AUTO_ANALYSIS_ENABLED、ANALYSIS_SUPPLEMENTARY_QUERY_MAX、ANALYSIS_PLAN_DATA_ROWS、ANALYSIS_SUPPLEMENTARY_TIMEOUT - 调整分析提示词模板与前端问数页、执行详情展示 - docker-compose 改为从源码构建,补充 .env.example 与 .dockerignore,README 说明二次开发内容 - 新增 test_chat_auto_analysis.py AI-Coding: true AI-Tool: TophantAI --- .dockerignore | 14 +- .env.example | 12 + README.md | 138 ++++---- backend/apps/chat/models/chat_model.py | 21 +- backend/apps/chat/task/llm.py | 207 ++++++++++- .../template/generate_analysis/generator.py | 5 + backend/common/core/config.py | 7 + backend/locales/en.json | 3 +- backend/locales/ko-KR.json | 3 +- backend/locales/th-TH.json | 3 +- backend/locales/zh-CN.json | 3 +- backend/locales/zh-TW.json | 3 +- backend/templates/template.yaml | 96 ++++- backend/tests/test_chat_auto_analysis.py | 328 ++++++++++++++++++ docker-compose.yaml | 13 +- frontend/src/i18n/en.json | 4 +- frontend/src/i18n/ko-KR.json | 4 +- frontend/src/i18n/th-TH.json | 4 +- frontend/src/i18n/zh-CN.json | 4 +- frontend/src/i18n/zh-TW.json | 4 +- frontend/src/views/chat/ExecutionDetails.vue | 6 +- .../src/views/chat/answer/ChartAnswer.vue | 23 +- .../src/views/chat/chat-block/ChartBlock.vue | 15 +- .../chat/execution-component/LogDataQuery.vue | 9 + frontend/src/views/chat/index.vue | 144 ++++---- 25 files changed, 919 insertions(+), 154 deletions(-) create mode 100644 .env.example create mode 100644 backend/tests/test_chat_auto_analysis.py diff --git a/.dockerignore b/.dockerignore index 6b78531c6..4b795ad78 100644 --- a/.dockerignore +++ b/.dockerignore @@ -9,4 +9,16 @@ backend/.venv backend/.gitignore backend/README.md backend/scripts -backend/.DS_Store \ No newline at end of file +backend/.DS_Store +backend/logs +backend/.pytest_cache +backend/.ruff_cache + +# Frontend +frontend/node_modules +frontend/dist + +# Local runtime data and secrets +.env +data +.git \ No newline at end of file diff --git a/.env.example b/.env.example new file mode 100644 index 000000000..a7d40ef87 --- /dev/null +++ b/.env.example @@ -0,0 +1,12 @@ +# 复制为 .env 后再启动:cp .env.example .env +# 必填:JWT 签名密钥,请替换为随机值,例如 `openssl rand -hex 32` 的输出 +SECRET_KEY=please-change-me + +# 可选:MCP 返回图表图片时使用的地址,改成部署机器的 IP +# SERVER_IMAGE_HOST=http://<服务器IP>:8001/images/ + +# 可选:自动分析相关配置(以下为默认值) +# CHAT_AUTO_ANALYSIS_ENABLED=true +# ANALYSIS_SUPPLEMENTARY_QUERY_MAX=3 +# ANALYSIS_PLAN_DATA_ROWS=50 +# ANALYSIS_SUPPLEMENTARY_TIMEOUT=120 diff --git a/README.md b/README.md index bb8604e9c..b648dcb6c 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,105 @@

SQLBot

-

基于大模型和 RAG 的智能问数系统

- -

- dataease%2FSQLBot | Trendshift -

- -

- Latest release - Stars - Download
-

- -

- 中文(简体) - English -

+

基于大模型和 RAG 的智能问数系统(二次开发版)


-SQLBot 是一款基于大语言模型和 RAG 的智能问数系统,由 DataEase 开源项目组匠心出品。借助 SQLBot,用户可以实现对话式数据分析(ChatBI),快速提炼获取所需的数据信息及可视化图表,并且支持进一步开展智能分析。 +本项目基于开源项目 [dataease/SQLBot](https://github.com/dataease/SQLBot) 二次开发。在原有"自然语言提问 → 生成 SQL → 返回数据和图表"的基础上,增加了问数后自动生成分析结论的能力,分析中用到的派生数值由数据库计算,不由大模型心算。 -## 工作原理 +## 二次开发内容 -image +| 功能 | 说明 | +| --- | --- | +| 问数后自动分析 | 问数完成后自动生成分析结论,不需要再手动点击"数据分析"按钮。可以用 `CHAT_AUTO_ANALYSIS_ENABLED` 关闭。 | +| 补充计算 SQL | 生成分析前,大模型先规划占比、环比、合计这类派生指标的补充查询(最多 `ANALYSIS_SUPPLEMENTARY_QUERY_MAX` 条)。补充查询只能访问本次问数已授权的表,并且只允许只读语句,校验通过后在数据库执行,分析结论引用执行结果,减少数值错误。 | +| 执行过程可见 | "执行详情"里新增"规划分析计算"和"执行分析计算 SQL"两个步骤,分析过程的思考内容也会展示出来。 | +| 切换会话不丢进度 | 回答生成过程中切换到其他会话再切回来,页面会继续轮询并显示后端的执行进度,直到回答完成。 | +| 失败提示 | 分析生成失败时给出明确的错误信息(已覆盖中、英、繁中、韩、泰五种语言)。 | -## 核心优势 +主要改动位置:`backend/apps/chat/task/llm.py`、`backend/templates/template.yaml`、`backend/common/core/config.py`、`frontend/src/views/chat/`。单元测试位于 `backend/tests/test_chat_auto_analysis.py`。 -- **开箱即用**:仅需简单配置大模型与数据源,无需复杂开发,即可快速开启智能问数;依托大模型自然语言理解与 SQL 生成能力,结合 RAG 技术,实现高质量 Text-to-SQL 转换。 -- **安全可控**:提供工作空间级资源隔离机制,构建清晰数据边界,保障数据访问安全;支持细粒度数据权限配置,强化权限管控能力,确保使用过程合规可控。 -- **易于集成**:支持多种集成方式,提供 Web 嵌入、弹窗嵌入、MCP 调用等能力;能够快速嵌入到 n8n、Dify、MaxKB、DataEase 等应用,让各类应用快速拥有智能问数能力。 -- **越问越准**:支持自定义提示词、术语库配置,可维护 SQL 示例校准逻辑,精准匹配业务场景;高效运营,基于用户交互数据持续迭代优化,问数效果随使用逐步提升,越问越准。 +## 部署(Docker,推荐) -## 快速开始 +### 1. 环境要求 -### 安装部署 +- Linux 服务器或 WSL2,4 核 8 GB 内存以上,磁盘可用空间 20 GB 以上 +- Docker 20.10+,并安装 Docker Compose v2(`docker compose version` 能正常输出) +- 构建时要能访问 `registry.cn-qingdao.aliyuncs.com`、`ghcr.io`、npm 源和 PyPI +- 一个可用的大模型 API(OpenAI 兼容接口即可,例如 DeepSeek、通义千问) -准备一台 Linux 服务器,安装好 [Docker](https://docs.docker.com/get-docker/),执行以下一键安装脚本: +### 2. 获取代码并配置 ```bash -docker run -d \ - --name sqlbot \ - --restart unless-stopped \ - -p 8000:8000 \ - -p 8001:8001 \ - -v ./data/sqlbot/excel:/opt/sqlbot/data/excel \ - -v ./data/sqlbot/file:/opt/sqlbot/data/file \ - -v ./data/sqlbot/images:/opt/sqlbot/images \ - -v ./data/sqlbot/logs:/opt/sqlbot/app/logs \ - -v ./data/postgresql:/var/lib/postgresql/data \ - --privileged=true \ - dataease/sqlbot +git clone <本仓库地址> SQLBot +cd SQLBot + +cp .env.example .env +# 把 .env 里的 SECRET_KEY 替换为随机值 +sed -i "s/^SECRET_KEY=.*/SECRET_KEY=$(openssl rand -hex 32)/" .env ``` -你也可以通过 [1Panel 应用商店](https://apps.fit2cloud.com/1panel) 快速部署 SQLBot。 +### 3. 构建并启动 + +```bash +docker compose up -d --build +``` -如果是内网环境,你可以通过 [离线安装包方式](https://community.fit2cloud.com/#/products/sqlbot/downloads) 部署 SQLBot。 +镜像从本仓库源码构建,第一次构建需要 10 到 30 分钟,视网络情况而定。查看启动日志: -### 访问方式 +```bash +docker compose logs -f sqlbot +``` -- 在浏览器中打开: http://<你的服务器IP>:8000/ -- 用户名: admin -- 密码: SQLBot@123456 +日志出现 `Uvicorn running on http://0.0.0.0:8000` 表示启动完成。 -### 联系我们 +### 4. 访问 -如你有更多问题,可以加入我们的技术交流群与我们交流。 +- 地址:`http://<服务器IP>:8000/` +- 用户名:`admin` +- 密码:`SQLBot@123456` -contact_me_qr +### 5. 首次使用 -## UI 展示 +1. 登录后进入"系统管理 → AI 模型配置",添加一个大模型并设为默认模型。 +2. 进入"数据源",添加一个数据库连接(MySQL、PostgreSQL 等),选择要问数的表。 +3. 回到"智能问数",选择该数据源后提问,例如"各地区上月销售额及占比"。回答完成后会自动生成分析结论,点开"执行详情"可以看到补充计算的 SQL。 - - q&a - +### 停止与清理 -## 飞致云旗下的其他明星项目 +```bash +docker compose down # 停止服务,数据保留在 ./data 目录 +rm -rf ./data # 如需清空全部数据(不可恢复) +``` + +## 配置项 + +在 `.env` 中设置,修改后执行 `docker compose up -d` 生效。 + +| 变量 | 默认值 | 说明 | +| --- | --- | --- | +| `SECRET_KEY` | 无,必填 | JWT 签名密钥 | +| `SERVER_IMAGE_HOST` | `http://localhost:8001/images/` | MCP 返回图表图片时使用的地址,外部访问时改成服务器 IP | +| `CHAT_AUTO_ANALYSIS_ENABLED` | `true` | 问数完成后是否自动生成分析 | +| `ANALYSIS_SUPPLEMENTARY_QUERY_MAX` | `3` | 每次分析最多执行的补充查询数,`0` 表示不做补充计算 | +| `ANALYSIS_PLAN_DATA_ROWS` | `50` | 规划补充查询时提供给大模型的结果行数上限 | +| `ANALYSIS_SUPPLEMENTARY_TIMEOUT` | `120` | 等待补充计算的最长秒数,超时则不使用补充结果 | + +## 运行测试 + +```bash +cd backend +uv sync +uv run pytest tests/test_chat_auto_analysis.py +``` -- [DataEase](https://github.com/dataease/dataease/) - 人人可用的开源 BI 工具 -- [1Panel](https://github.com/1panel-dev/1panel/) - 现代化、开源的 Linux 服务器运维管理面板 -- [MaxKB](https://github.com/1panel-dev/MaxKB/) - 强大易用的企业级智能体平台 -- [JumpServer](https://github.com/jumpserver/jumpserver/) - 广受欢迎的开源堡垒机 -- [Cordys CRM](https://github.com/1Panel-dev/CordysCRM) - 新一代的开源 AI CRM 系统 -- [Halo](https://github.com/halo-dev/halo/) - 强大易用的开源建站工具 -- [MeterSphere](https://github.com/metersphere/metersphere/) - 新一代的开源持续测试工具 +## 常见问题 -## License +- **启动报 `Set a unique SECRET_KEY in .env`**:没有创建 `.env` 或其中没有 `SECRET_KEY`,按第 2 步处理。 +- **构建时拉取镜像失败**:检查服务器能否访问 `registry.cn-qingdao.aliyuncs.com` 和 `ghcr.io`,必要时为 Docker 配置代理或镜像加速。 +- **8000 / 8001 端口被占用**:修改 `docker-compose.yaml` 中 `ports` 的左侧端口,例如 `18000:8000`。 +- **提问没有回答**:确认已配置默认大模型,并且服务器能访问该模型的 API 地址。 -本仓库遵循 [FIT2CLOUD Open Source License](LICENSE) 开源协议,该许可证本质上是 GPLv3,但有一些额外的限制。 +## 致谢与 License -你可以基于 SQLBot 的源代码进行二次开发,但是需要遵守以下规定: +本项目基于 [dataease/SQLBot](https://github.com/dataease/SQLBot)(飞致云 DataEase 开源项目组)二次开发,遵循原项目的 [FIT2CLOUD Open Source License](LICENSE)。该协议本质上是 GPLv3,并附加以下限制: - 不能替换和修改 SQLBot 的 Logo 和版权信息; - 二次开发后的衍生作品必须遵守 GPL V3 的开源义务。 diff --git a/backend/apps/chat/models/chat_model.py b/backend/apps/chat/models/chat_model.py index 284e15961..5479c40fc 100644 --- a/backend/apps/chat/models/chat_model.py +++ b/backend/apps/chat/models/chat_model.py @@ -12,7 +12,7 @@ from apps.db.constant import DB from apps.template.filter.generator import get_permissions_template -from apps.template.generate_analysis.generator import get_analysis_template +from apps.template.generate_analysis.generator import get_analysis_template, get_analysis_plan_template from apps.template.generate_chart.generator import get_chart_template from apps.template.generate_dynamic.generator import get_dynamic_template from apps.template.generate_guess_question.generator import get_guess_question_template @@ -49,6 +49,8 @@ class OperationEnum(Enum): GENERATE_PICTURE = '13' EXTRACT_KEYWORDS = '14' COMPLETE_QUESTION = '15' + ANALYSIS_PLAN = '16' + ANALYSIS_QUERY = '17' class ChatFinishStep(Enum): @@ -260,6 +262,9 @@ class AiModelQuestion(BaseModel): regenerate_record_id: Optional[int] = None sample_data: str = "" sqlbot_name: str = "SQLBot" + analysis_schema: str = "" + data_row_count: int = 0 + supplementary_results: str = "" def complete_question_sys_prompt(self) -> str: return get_sql_template()["complete_question"] @@ -338,7 +343,19 @@ def analysis_sys_question(self): custom_prompt=self.custom_prompt, sqlbot_name=self.sqlbot_name) def analysis_user_question(self): - return get_analysis_template()['user'].format(fields=self.fields, data=self.data) + return get_analysis_template()['user'].format(question=self.question, sql=self.sql, fields=self.fields, + data=self.data, + supplementary_results=self.supplementary_results) + + def analysis_plan_sys_question(self, max_queries: int): + return get_analysis_plan_template()['system'].format(lang=self.lang, sqlbot_name=self.sqlbot_name, + engine=self.engine, schema=self.analysis_schema, + terminologies=self.terminologies, + max_queries=max_queries) + + def analysis_plan_user_question(self): + return get_analysis_plan_template()['user'].format(question=self.question, sql=self.sql, fields=self.fields, + data=self.data, row_count=self.data_row_count) def predict_sys_question(self): return get_predict_template()['system'].format(lang=self.lang, custom_prompt=self.custom_prompt, diff --git a/backend/apps/chat/task/llm.py b/backend/apps/chat/task/llm.py index a205b1422..a65ae52af 100644 --- a/backend/apps/chat/task/llm.py +++ b/backend/apps/chat/task/llm.py @@ -95,6 +95,35 @@ def extract_tables_from_sql(sql: str, ds_type: str = None) -> set: return tables +def parse_analysis_plan(text: str, max_queries: int) -> List[Dict[str, str]]: + """解析补充查询规划,丢弃格式不合法的条目;SQL 的安全校验在执行前进行。""" + if max_queries <= 0: + return [] + json_str = extract_nested_json(text) + if json_str is None: + return [] + try: + data = orjson.loads(json_str) + except Exception: + return [] + items = data.get('queries') if isinstance(data, dict) else data + if not isinstance(items, list): + return [] + queries: List[Dict[str, str]] = [] + for item in items: + if not isinstance(item, dict): + continue + sql = item.get('sql') + if not isinstance(sql, str) or not sql.strip(): + continue + purpose = item.get('purpose') + queries.append({'purpose': purpose.strip() if isinstance(purpose, str) else '', + 'sql': sql.strip().rstrip(';').strip()}) + if len(queries) >= max_queries: + break + return queries + + class LLMService: ds: CoreDatasource chat_question: ChatQuestion @@ -688,22 +717,32 @@ def choose_table_schema(self, _session: Session): full_message=self.chat_question.db_schema) return tables - def generate_analysis(self, _session: Session): + def generate_analysis(self, _session: Session, in_main_task: bool = False, + supplementary_results: Optional[List[Dict[str, Any]]] = None): + """生成分析结论。 + + in_main_task 为 True 时在问数主流程中调用:沿用本次已匹配的术语;supplementary_results 是由数据库 + 预先计算的派生数值(见 start_analysis_supplementary_queries)。 + """ fields = self.get_fields_from_chart(_session) self.chat_question.fields = orjson.dumps(fields).decode() data = get_chat_chart_data(_session, self.record.id) - self.chat_question.data = orjson.dumps(data.get('data')).decode() + rows = data.get('data') or [] + self.chat_question.data = orjson.dumps(rows).decode() + self.chat_question.data_row_count = len(rows) + self.chat_question.supplementary_results = orjson.dumps( + supplementary_results).decode() if supplementary_results else '' analysis_msg: List[Union[BaseMessage, dict[str, Any]]] = [] - # 从 record 加载已提取的关键词(SQL 生成阶段已持久化) - if self.record.extracted_keywords: - self.chat_question.extracted_keywords = self.record.extracted_keywords - if self.record.expanded_keywords: - self.chat_question.expanded_keywords = self.record.expanded_keywords - ds_id = self.ds.id if isinstance(self.ds, CoreDatasource) else None - self.filter_terminology_template(_session, self.oid, ds_id) + if not in_main_task: + # 从 record 加载已提取的关键词(SQL 生成阶段已持久化) + if self.record.extracted_keywords: + self.chat_question.extracted_keywords = self.record.extracted_keywords + if self.record.expanded_keywords: + self.chat_question.expanded_keywords = self.record.expanded_keywords + self.filter_terminology_template(_session, self.oid, ds_id) self.filter_custom_prompts(_session, CustomPromptTypeEnum.ANALYSIS, self.oid, ds_id) @@ -749,6 +788,128 @@ def generate_analysis(self, _session: Session): self.record = save_analysis_answer(session=_session, record_id=self.record.id, answer=orjson.dumps({'content': full_analysis_text}).decode()) + def start_analysis_supplementary_queries(self, tables: List[str], fields: List[str], + rows: List[dict]) -> Optional[Future]: + """在独立线程中规划并执行补充查询,与图表生成并行;返回 None 表示本次不补充。""" + if not settings.ANALYSIS_SUPPLEMENTARY_QUERY_MAX > 0 or not tables: + return None + if not isinstance(self.ds, CoreDatasource) or self.out_ds_instance: + return None + # 规划只读取这份快照,主线程生成图表时修改 chat_question 不会互相影响 + plan_question = self.chat_question.model_copy() + plan_question.fields = orjson.dumps(fields).decode() + plan_question.data = orjson.dumps(rows[:max(settings.ANALYSIS_PLAN_DATA_ROWS, 1)]).decode() + plan_question.data_row_count = len(rows) + return executor.submit(self._run_analysis_supplementary_queries_in_session, list(tables), plan_question) + + def _run_analysis_supplementary_queries_in_session(self, tables: List[str], + plan_question: ChatQuestion) -> List[Dict[str, Any]]: + # 后台线程使用自己的数据库会话,不与主流程共享 + with Session(engine) as session: + return self.run_analysis_supplementary_queries(session, tables, plan_question) + + @staticmethod + def collect_analysis_supplementary_results(future: Optional[Future]) -> List[Dict[str, Any]]: + if future is None: + return [] + try: + return future.result(timeout=settings.ANALYSIS_SUPPLEMENTARY_TIMEOUT) + except Exception: + traceback.print_exc() + return [] + + def run_analysis_supplementary_queries(self, _session: Session, tables: List[str], + plan_question: ChatQuestion) -> List[Dict[str, Any]]: + """规划并执行分析所需的补充查询,结论中的派生数值由数据库计算,失败时降级为无补充结果。""" + max_queries = settings.ANALYSIS_SUPPLEMENTARY_QUERY_MAX + if max_queries <= 0 or not isinstance(self.ds, CoreDatasource) or self.out_ds_instance: + return [] + try: + # 行权限由模型改写 SQL 实现,补充查询只在无需行权限时执行,避免绕过权限 + if (not self.current_assistant or self.current_assistant.type == 4) and is_normal_user( + self.current_user): + if get_row_permission_filters(session=_session, current_user=self.current_user, ds=self.ds, + tables=tables): + return [] + + plan_question.analysis_schema, _ = get_table_schema(session=_session, current_user=self.current_user, + ds=self.ds, question=plan_question.question, + embedding=False, table_list=tables) + plan_text = self.generate_analysis_plan(_session, plan_question, max_queries) + except Exception: + traceback.print_exc() + return [] + + results: List[Dict[str, Any]] = [] + for query in parse_analysis_plan(plan_text, max_queries): + results.append(self.execute_analysis_query(_session, query)) + return results + + def generate_analysis_plan(self, _session: Session, plan_question: ChatQuestion, max_queries: int) -> str: + plan_msg: List[Union[BaseMessage, dict[str, Any]]] = [ + SystemPromptMessage(content=plan_question.analysis_plan_sys_question(max_queries)), + HumanMessage(content=plan_question.analysis_plan_user_question())] + # 在后台线程运行,日志用局部变量,不写共享的 current_logs + log = start_log(session=_session, ai_modal_id=plan_question.ai_modal_id, + ai_modal_name=plan_question.ai_modal_name, operate=OperationEnum.ANALYSIS_PLAN, + record_id=self.record.id, + full_message=[{'type': msg.type, + 'sqlbot_system': getattr(msg, 'sqlbot_system', False) is True, + 'content': msg.content} for msg in plan_msg]) + full_thinking_text = '' + full_plan_text = '' + token_usage = {} + try: + for chunk in process_stream(self.llm.stream(plan_msg), token_usage): + if chunk.get('content'): + full_plan_text += chunk.get('content') + if chunk.get('reasoning_content'): + full_thinking_text += chunk.get('reasoning_content') + except Exception: + trigger_log_error(_session, log) + raise + + plan_msg.append(AIMessage(full_plan_text)) + end_log(session=_session, log=log, + full_message=[{'type': msg.type, + 'sqlbot_system': getattr(msg, 'sqlbot_system', False) is True, + 'content': msg.content} for msg in plan_msg], + reasoning_content=full_thinking_text, token_usage=token_usage) + return full_plan_text + + def execute_analysis_query(self, _session: Session, query: Dict[str, str]) -> Dict[str, Any]: + purpose = query.get('purpose', '') + sql = query.get('sql', '') + log = start_log(session=_session, operate=OperationEnum.ANALYSIS_QUERY, record_id=self.record.id, + local_operation=True) + result: Dict[str, Any] = {'purpose': purpose, 'sql': sql} + try: + # 与主流程相同的表白名单校验:用 sqlglot 提取真实表名(排除 CTE 别名) + actual_tables = extract_tables_from_sql(sql, ds_type=self.ds.type) + if not actual_tables: + raise SingleMessageError('SQL parsing failed: unable to extract table names') + unauthorized_tables = actual_tables - set(self.table_name_list) + if unauthorized_tables: + raise SingleMessageError(f"SQL contains unauthorized tables: {', '.join(unauthorized_tables)}") + # exec_sql 内部会再做只读校验 + exec_result = self.execute_sql(sql=sql) + data = DataFormat.convert_large_numbers_in_object_array(exec_result.get('data')) + data = DataFormat.normalize_qualified_sql_column_keys_in_object_array(data) or [] + limit = settings.ANALYSIS_PLAN_DATA_ROWS + result['data'] = prepare_for_orjson(data[:limit]) if data else [] + if data and len(data) > limit: + result['truncated'] = True + end_log(session=_session, log=log, full_message={'purpose': purpose, 'sql': sql, 'count': len(data)}) + except Exception as e: + SQLBotLogUtil.warning(f"analysis supplementary query failed: {e}") + # 错误会传给模型和执行详情,只保留最后一行,不暴露 traceback 和内部路径 + error = (str(e).strip().splitlines() or [type(e).__name__])[-1][:500] + result['error'] = error + end_log(session=_session, log=log, full_message={'purpose': purpose, 'sql': sql, 'count': 0, + 'error': error}) + trigger_log_error(_session, log) + return result + def generate_predict(self, _session: Session): fields = self.get_fields_from_chart(_session) self.chat_question.fields = orjson.dumps(fields).decode() @@ -1482,6 +1643,7 @@ def run_task(self, in_chat: bool = True, stream: bool = True, finish_step: ChatFinishStep = ChatFinishStep.GENERATE_CHART, return_img: bool = True): json_result: Dict[str, Any] = {'success': True} _session = None + analysis_future: Optional[Future] = None try: _session = session_maker() self.complete_question(_session) @@ -1689,6 +1851,11 @@ def run_task(self, in_chat: bool = True, stream: bool = True, yield json_result return + # 分析所需的补充计算只依赖 SQL 结果,与图表生成并行,减少等待 + if in_chat and settings.CHAT_AUTO_ANALYSIS_ENABLED: + analysis_future = self.start_analysis_supplementary_queries( + sorted(actual_tables), result.get('fields') or [], result.get('data') or []) + # generate chart used_tables_schema, used_tables = self.out_ds_instance.get_db_schema( self.ds.id, self.chat_question.question, embedding=False, @@ -1735,6 +1902,25 @@ def run_task(self, in_chat: bool = True, stream: bool = True, markdown_table = df_safe.to_markdown(index=False) yield markdown_table + '\n\n' + if in_chat and settings.CHAT_AUTO_ANALYSIS_ENABLED: + # 自动生成分析结论;失败只影响分析部分,SQL、数据和图表照常展示 + try: + supplementary_results = self.collect_analysis_supplementary_results(analysis_future) + analysis_future = None + for chunk in self.generate_analysis(_session, in_main_task=True, + supplementary_results=supplementary_results): + yield 'data:' + orjson.dumps( + {'content': chunk.get('content'), 'reasoning_content': chunk.get('reasoning_content'), + 'type': 'analysis-result'}).decode() + '\n\n' + yield 'data:' + orjson.dumps({'type': 'info', 'msg': 'analysis generated'}).decode() + '\n\n' + except Exception as e: + traceback.print_exc() + if self.current_logs.get(OperationEnum.ANALYSIS): + trigger_log_error(_session, self.current_logs[OperationEnum.ANALYSIS]) + yield 'data:' + orjson.dumps( + {'content': self.trans('i18n_chat.analysis_failed', msg=str(e)), + 'type': 'analysis-error'}).decode() + '\n\n' + if in_chat: yield 'data:' + orjson.dumps({'type': 'finish'}).decode() + '\n\n' else: @@ -1795,6 +1981,9 @@ def run_task(self, in_chat: bool = True, stream: bool = True, json_result['message'] = error_msg yield json_result finally: + if analysis_future is not None: + # 图表等后续步骤失败时,未取用的补充计算不再需要 + analysis_future.cancel() self.finish(_session) session_maker.remove() diff --git a/backend/apps/template/generate_analysis/generator.py b/backend/apps/template/generate_analysis/generator.py index 4dce6f65c..6e2996fce 100644 --- a/backend/apps/template/generate_analysis/generator.py +++ b/backend/apps/template/generate_analysis/generator.py @@ -4,3 +4,8 @@ def get_analysis_template(): template = get_base_template() return template['template']['analysis'] + + +def get_analysis_plan_template(): + template = get_base_template() + return template['template']['analysis_plan'] diff --git a/backend/common/core/config.py b/backend/common/core/config.py index 7eef381b9..d6dc6662a 100644 --- a/backend/common/core/config.py +++ b/backend/common/core/config.py @@ -113,6 +113,12 @@ def SQLALCHEMY_DATABASE_URI(self) -> PostgresDsn | str: GENERATE_SQL_QUERY_LIMIT_ENABLED: bool = True GENERATE_SQL_QUERY_HISTORY_ROUND_COUNT: int = 3 + # 问数完成后自动生成分析结论;分析中的派生数值先由补充 SQL 计算 + CHAT_AUTO_ANALYSIS_ENABLED: bool = True + ANALYSIS_SUPPLEMENTARY_QUERY_MAX: int = 3 # 每次分析最多执行的补充查询数,0 表示不补充 + ANALYSIS_PLAN_DATA_ROWS: int = 50 # 规划补充查询时提供给模型的结果行数上限 + ANALYSIS_SUPPLEMENTARY_TIMEOUT: float = 120 # 等待补充计算的最长秒数,超时则不使用补充结果 + # 安全配置:是否允许元数据查询(SHOW/DESCRIBE/DESC/EXPLAIN) # 默认关闭,防止通过元数据查询泄露数据库结构 SQLBOT_ALLOW_METADATA_QUERIES: bool = False @@ -147,6 +153,7 @@ def SQLALCHEMY_DATABASE_URI(self) -> PostgresDsn | str: 'TABLE_EMBEDDING_ENABLED', 'TABLE_EMBEDDING_KEYWORD_ENABLED', 'SAMPLE_DATA_ENABLED', + 'CHAT_AUTO_ANALYSIS_ENABLED', mode='before') @classmethod def lowercase_bool(cls, v: Any) -> Any: diff --git a/backend/locales/en.json b/backend/locales/en.json index c57c57b03..d44156bb0 100644 --- a/backend/locales/en.json +++ b/backend/locales/en.json @@ -76,7 +76,8 @@ "timezone_mismatch": "The timezone information in the signature does not match the signing time. Embedding has been blocked." }, "i18n_chat": { - "record_id_in_mcp": "Answer ID: " + "record_id_in_mcp": "Answer ID: ", + "analysis_failed": "Failed to generate analysis: {msg}" }, "i18n_terminology": { "terminology_not_exists": "This terminology does not exist", diff --git a/backend/locales/ko-KR.json b/backend/locales/ko-KR.json index e66ee2e3d..9e8168820 100644 --- a/backend/locales/ko-KR.json +++ b/backend/locales/ko-KR.json @@ -76,7 +76,8 @@ "timezone_mismatch": "서명의 시간대 정보가 서명 시간과 일치하지 않아 임베드를 차단했습니다." }, "i18n_chat": { - "record_id_in_mcp": "응답 ID: " + "record_id_in_mcp": "응답 ID: ", + "analysis_failed": "분석 생성 실패: {msg}" }, "i18n_terminology": { "terminology_not_exists": "이 용어가 존재하지 않습니다", diff --git a/backend/locales/th-TH.json b/backend/locales/th-TH.json index b994f70b7..f3dc16924 100644 --- a/backend/locales/th-TH.json +++ b/backend/locales/th-TH.json @@ -76,7 +76,8 @@ "timezone_mismatch": "ข้อมูลเขตเวลาในลายเซ็นไม่สอดคล้องกับเวลาในลายเซ็น จึงบล็อกการฝัง" }, "i18n_chat": { - "record_id_in_mcp": "รหัสการตอบกลับ: " + "record_id_in_mcp": "รหัสการตอบกลับ: ", + "analysis_failed": "สร้างการวิเคราะห์ไม่สำเร็จ: {msg}" }, "i18n_terminology": { "terminology_not_exists": "ไม่พบคำศัพท์นี้", diff --git a/backend/locales/zh-CN.json b/backend/locales/zh-CN.json index 7d5049de0..9838ae27e 100644 --- a/backend/locales/zh-CN.json +++ b/backend/locales/zh-CN.json @@ -76,7 +76,8 @@ "timezone_mismatch": "签名中的时区信息与签名时间不一致,已阻止嵌入。" }, "i18n_chat": { - "record_id_in_mcp": "响应ID: " + "record_id_in_mcp": "响应ID: ", + "analysis_failed": "分析生成失败:{msg}" }, "i18n_terminology": { "terminology_not_exists": "该术语不存在", diff --git a/backend/locales/zh-TW.json b/backend/locales/zh-TW.json index 83489f281..7b01e1e22 100644 --- a/backend/locales/zh-TW.json +++ b/backend/locales/zh-TW.json @@ -76,7 +76,8 @@ "timezone_mismatch": "簽名中的時區資訊與簽名時間不一致,已阻止嵌入。" }, "i18n_chat": { - "record_id_in_mcp": "響應ID: " + "record_id_in_mcp": "響應ID: ", + "analysis_failed": "分析產生失敗:{msg}" }, "i18n_terminology": { "terminology_not_exists": "該術語不存在", diff --git a/backend/templates/template.yaml b/backend/templates/template.yaml index 97ace680e..affd8ddc7 100644 --- a/backend/templates/template.yaml +++ b/backend/templates/template.yaml @@ -637,35 +637,121 @@ template: system: | 你是智能问数小助手:"{sqlbot_name}"。你可以根据用户提问,专业生成SQL与可视化图表。 - 你当前的任务是根据给定的数据分析数据,并给出你的分析结果。 + 你当前的任务是根据已执行查询的结果回答用户提问,并给出你的分析结论。 我们会在块内提供给你信息,帮助你进行分析: 内有等信息; :提供一组术语,块内每一个就是术语,其中同一个内的多个代表术语的多种叫法,也就是术语与它的同义词,即该术语对应的描述,其中也可能是能够用来参考的计算公式,或者是一些其他的查询条件。 若有块,它会提供一组,可能会是额外添加的背景信息,或者是额外的分析要求,请结合额外信息或要求后生成你的回答。 用户会在提问中提供给你信息: + 块内是用户的原始提问; + 块内是本次执行的SQL,可从中读出查询的时间范围、筛选条件和计算口径,可能为空; 块内是提供给你的数,以JSON格式给出; - 块内提供给你对应的字段或字段别名。 + 块内提供给你对应的字段或字段别名; + 块内是为本次分析补充执行的查询及其结果,以JSON格式给出,可能为空。 - + 你必须遵守以下规则: 请使用语言:{lang} 回答,若有深度思考过程,则思考过程也需要使用 {lang} 输出 + + 结论中出现的每一个数值,都必须原样取自或,不得自行计算、估算或换算,包括求和、差值、比率、占比、增长率、平均值和排名。所需数值在两者中都没有时,不写具体数字,改用定性描述。 + + + 先直接回答用户提问;提问包含多个子问题时逐一回答,不要遗漏。 + + + 说明结论的依据:时间范围、筛选条件和指标口径,以和为准,不得臆造。 + + + 区分数据事实与推断。涉及原因、归因、因果或效果判断时,若数据中没有能直接证明该结论的字段,必须明确说明现有数据无法得出该结论,并指出需要补充哪些数据。 + + + 查询结果为空或不足以回答提问时,直接说明,不要编造。 + + + 发现空值、异常值、重复记录或口径可能不一致等数据问题时,简要指出。 + + + 中带有error的查询表示执行失败或被跳过,不得使用其预期结果。 + + + 使用 Markdown 输出,先给结论再给依据,内容简洁。 + - + {terminologies} {custom_prompt} user: | + + {question} + + + + {sql} + + {fields} - + {data} + + + {supplementary_results} + + analysis_plan: + system: | + + 你是智能问数小助手:"{sqlbot_name}"。系统已根据用户提问生成并执行了SQL,接下来要基于查询结果撰写分析结论。 + 你当前的任务是为撰写结论做准备:判断回答用户提问还需要哪些派生数值,并为这些数值编写补充查询。 + 所有数值计算(求和、差值、比率、占比、增长率、贡献度、平均值、排名等)都必须交给数据库完成,分析结论只能引用查询返回的数值。 + 我们会在块内提供、和: + 是可以使用的表结构; + :提供一组术语,即该术语对应的描述,其中也可能是计算公式或查询条件。 + 用户会在提问中提供、、和,的row-count属性是查询结果的总行数,块内可能只包含前若干行。 + + + 你必须遵守以下规则: + + 先确定回答用户提问、解释查询结果所需要的结论性数值;已在中直接给出的数值不需要再查。 + 只为中没有、需要计算才能得到的数值编写补充查询;不需要时返回空列表。 + 补充查询最多 {max_queries} 条。每条只能是一条 SELECT 语句(可以使用 WITH),只能使用中的表和字段,并遵守的语法。 + 补充查询必须与保持相同的时间范围、筛选条件和指标口径,并遵守中的术语定义。 + 比率、百分比等结果在SQL中保留两位小数,列别名写明含义和单位。 + 现有表中没有的信息不要编写查询,留给结论说明无法得出。 + purpose 使用语言:{lang}。 + 只输出JSON,格式:{{"queries":[{{"purpose":"该查询要得到的数值","sql":"SQL语句"}}]}};不需要补充查询时输出 {{"queries":[]}}。 + + + + {engine} + + {schema} + + {terminologies} + + user: | + + {question} + + + + {sql} + + + + {fields} + + + + {data} + predict: system: | diff --git a/backend/tests/test_chat_auto_analysis.py b/backend/tests/test_chat_auto_analysis.py new file mode 100644 index 000000000..3ccbd2b9d --- /dev/null +++ b/backend/tests/test_chat_auto_analysis.py @@ -0,0 +1,328 @@ +import os +import sys +import threading +from concurrent.futures import Future +from types import SimpleNamespace +from unittest.mock import MagicMock, patch + +import orjson + +# Ensure backend root is in sys.path +backend_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) +if backend_dir not in sys.path: + sys.path.insert(0, backend_dir) + +from apps.chat.models.chat_model import ChatQuestion, OperationEnum # noqa: E402 +from apps.chat.task import llm as llm_module # noqa: E402 +from apps.chat.task.llm import LLMService, parse_analysis_plan # noqa: E402 +from apps.datasource.models.datasource import CoreDatasource # noqa: E402 + +REPO_ROOT = os.path.dirname(backend_dir) + + +def _plan(*queries): + return orjson.dumps({'queries': list(queries)}).decode() + + +# ---------- parse_analysis_plan ---------- + +def test_parse_plan_extracts_queries_and_strips_semicolon(): + text = '说明\n' + _plan({'purpose': ' 占比 ', 'sql': ' SELECT 1; '}) + assert parse_analysis_plan(text, 3) == [{'purpose': '占比', 'sql': 'SELECT 1'}] + + +def test_parse_plan_respects_max_queries(): + text = _plan(*[{'purpose': str(i), 'sql': f'SELECT {i}'} for i in range(5)]) + assert len(parse_analysis_plan(text, 2)) == 2 + assert parse_analysis_plan(text, 0) == [] + + +def test_parse_plan_drops_invalid_items(): + text = _plan({'purpose': 'no sql'}, {'sql': ''}, {'sql': 123}, 'raw', {'sql': 'SELECT 2'}) + assert parse_analysis_plan(text, 5) == [{'purpose': '', 'sql': 'SELECT 2'}] + + +def test_parse_plan_handles_non_json_and_empty(): + assert parse_analysis_plan('不需要补充查询', 3) == [] + assert parse_analysis_plan(_plan(), 3) == [] + assert parse_analysis_plan('{"queries": "SELECT 1"}', 3) == [] + + +# ---------- templates ---------- + +def test_analysis_templates_format_without_errors(): + q = ChatQuestion(chat_id=1, question='4月比3月变化多少?') + q.sql = 'SELECT 1' + q.fields = '["a"]' + q.data = '[{"a": 1}]' + q.data_row_count = 1 + q.analysis_schema = '# Table: orders' + q.engine = 'PostgreSQL' + + system = q.analysis_sys_question() + user = q.analysis_user_question() + plan_system = q.analysis_plan_sys_question(3) + plan_user = q.analysis_plan_user_question() + + assert '不得自行计算' in system + assert '4月比3月变化多少?' in user and 'SELECT 1' in user + assert '最多 3 条' in plan_system and '{"queries":[]}' in plan_system + assert 'row-count="1"' in plan_user + + +# ---------- execute_analysis_query: same guards as main flow ---------- + +def _service(table_names=('orders',)): + service = LLMService.__new__(LLMService) + service.ds = CoreDatasource(id=1, name='ds', type='pg', oid=1) + service.table_name_list = list(table_names) + service.record = SimpleNamespace(id=10) + return service + + +@patch.object(llm_module, 'trigger_log_error') +@patch.object(llm_module, 'end_log') +@patch.object(llm_module, 'start_log', return_value=SimpleNamespace(id=1)) +def test_execute_query_rejects_unauthorized_table(_start, _end, trigger): + service = _service() + service.execute_sql = MagicMock() + + result = service.execute_analysis_query(MagicMock(), {'purpose': 'x', 'sql': 'SELECT * FROM sys_user'}) + + assert 'unauthorized tables' in result['error'] + service.execute_sql.assert_not_called() + trigger.assert_called_once() + + +@patch.object(llm_module, 'trigger_log_error') +@patch.object(llm_module, 'end_log') +@patch.object(llm_module, 'start_log', return_value=SimpleNamespace(id=1)) +def test_execute_query_cte_alias_does_not_bypass_whitelist(_start, _end, _trigger): + service = _service() + service.execute_sql = MagicMock() + sql = 'WITH orders AS (SELECT * FROM sys_user) SELECT * FROM orders' + + result = service.execute_analysis_query(MagicMock(), {'purpose': 'x', 'sql': sql}) + + assert 'sys_user' in result['error'] + service.execute_sql.assert_not_called() + + +@patch.object(llm_module, 'trigger_log_error') +@patch.object(llm_module, 'end_log') +@patch.object(llm_module, 'start_log', return_value=SimpleNamespace(id=1)) +def test_execute_query_returns_rows_for_allowed_table(_start, end, trigger): + service = _service() + service.execute_sql = MagicMock(return_value={'fields': ['n'], 'data': [{'n': 3}]}) + sql = 'WITH t AS (SELECT * FROM orders) SELECT count(*) AS n FROM t' + + result = service.execute_analysis_query(MagicMock(), {'purpose': '订单数', 'sql': sql}) + + assert result == {'purpose': '订单数', 'sql': sql, 'data': [{'n': 3}]} + service.execute_sql.assert_called_once_with(sql=sql) + trigger.assert_not_called() + assert end.call_args.kwargs['full_message']['count'] == 1 + + +@patch.object(llm_module, 'trigger_log_error') +@patch.object(llm_module, 'end_log') +@patch.object(llm_module, 'start_log', return_value=SimpleNamespace(id=1)) +def test_execute_query_reports_read_only_rejection(_start, _end, trigger): + service = _service() + service.execute_sql = MagicMock(side_effect=ValueError('SQL can only contain read operations')) + + result = service.execute_analysis_query(MagicMock(), {'purpose': 'x', 'sql': 'DELETE FROM orders'}) + + assert 'read operations' in result['error'] + trigger.assert_called_once() + + +@patch.object(llm_module, 'trigger_log_error') +@patch.object(llm_module, 'end_log') +@patch.object(llm_module, 'start_log', return_value=SimpleNamespace(id=1)) +def test_execute_query_error_hides_traceback(_start, end, _trigger): + service = _service() + traceback_text = ('Traceback (most recent call last):\n File "/home/u/backend/apps/db/db.py", line 9\n' + 'ValueError: SQL can only contain read operations') + service.execute_sql = MagicMock(side_effect=llm_module.SQLBotDBError(traceback_text)) + + result = service.execute_analysis_query(MagicMock(), {'purpose': 'x', 'sql': 'SELECT 1 FROM orders'}) + + assert result['error'] == 'ValueError: SQL can only contain read operations' + assert '/home/' not in end.call_args.kwargs['full_message']['error'] + + +# ---------- run_analysis_supplementary_queries: skip paths ---------- + +def _supplementary_service(user_id=2, assistant=None, out_ds=None): + service = _service() + service.current_user = SimpleNamespace(id=user_id) + service.current_assistant = assistant + service.out_ds_instance = out_ds + service.chat_question = ChatQuestion(chat_id=1, question='q') + service.generate_analysis_plan = MagicMock(return_value=_plan({'purpose': 'p', 'sql': 'SELECT 1 FROM orders'})) + service.execute_analysis_query = MagicMock(return_value={'purpose': 'p', 'data': []}) + return service + + +def _plan_question(): + return ChatQuestion(chat_id=1, question='q') + + +@patch.object(llm_module, 'get_table_schema', return_value=('schema', ['orders'])) +@patch.object(llm_module, 'get_row_permission_filters', return_value=[{'table': 'orders', 'filter': 'x'}]) +def test_supplementary_skipped_when_row_permission_applies(_filters, _schema): + service = _supplementary_service() + + assert service.run_analysis_supplementary_queries(MagicMock(), ['orders'], _plan_question()) == [] + service.generate_analysis_plan.assert_not_called() + + +@patch.object(llm_module, 'get_table_schema', return_value=('schema', ['orders'])) +@patch.object(llm_module, 'get_row_permission_filters', return_value=[]) +def test_supplementary_skipped_for_dynamic_datasource(_filters, _schema): + service = _supplementary_service(out_ds=object()) + + assert service.run_analysis_supplementary_queries(MagicMock(), ['orders'], _plan_question()) == [] + assert service.start_analysis_supplementary_queries(['orders'], [], []) is None + service.generate_analysis_plan.assert_not_called() + + +@patch.object(llm_module, 'get_table_schema', return_value=('schema', ['orders'])) +@patch.object(llm_module, 'get_row_permission_filters', return_value=[]) +def test_supplementary_runs_planned_queries(_filters, _schema): + service = _supplementary_service() + plan_question = _plan_question() + + results = service.run_analysis_supplementary_queries(MagicMock(), ['orders'], plan_question) + + assert results == [{'purpose': 'p', 'data': []}] + service.execute_analysis_query.assert_called_once() + assert plan_question.analysis_schema == 'schema' + # 规划只写自己的快照,不改共享的 chat_question + assert service.chat_question.analysis_schema == '' + + +@patch.object(llm_module, 'get_table_schema', return_value=('schema', ['orders'])) +@patch.object(llm_module, 'get_row_permission_filters', return_value=[]) +def test_supplementary_plan_failure_degrades_to_empty(_filters, _schema): + service = _supplementary_service() + service.generate_analysis_plan = MagicMock(side_effect=RuntimeError('llm down')) + + assert service.run_analysis_supplementary_queries(MagicMock(), ['orders'], _plan_question()) == [] + service.execute_analysis_query.assert_not_called() + + +@patch.object(llm_module.settings, 'ANALYSIS_SUPPLEMENTARY_QUERY_MAX', 0) +def test_supplementary_disabled_by_setting(): + service = _supplementary_service() + + assert service.run_analysis_supplementary_queries(MagicMock(), ['orders'], _plan_question()) == [] + assert service.start_analysis_supplementary_queries(['orders'], [], []) is None + service.generate_analysis_plan.assert_not_called() + + +# ---------- parallel planning ---------- + +def test_start_supplementary_runs_in_background_with_snapshot(): + service = _supplementary_service() + started = threading.Event() + release = threading.Event() + seen = {} + + def fake_run(tables, plan_question): + started.set() + release.wait(5) + seen['tables'] = tables + seen['data'] = plan_question.data + seen['fields'] = plan_question.fields + seen['row_count'] = plan_question.data_row_count + return [{'purpose': 'p', 'data': [{'n': 1}]}] + + service._run_analysis_supplementary_queries_in_session = fake_run + rows = [{'a': i} for i in range(3)] + + future = service.start_analysis_supplementary_queries(['orders'], ['a'], rows) + assert started.wait(5) + # 后台规划进行时,主线程(图表生成)修改共享的 chat_question 不影响快照 + service.chat_question.data = 'changed by chart' + service.chat_question.fields = 'changed by chart' + assert not future.done() + release.set() + + assert LLMService.collect_analysis_supplementary_results(future) == [{'purpose': 'p', 'data': [{'n': 1}]}] + assert seen['tables'] == ['orders'] + assert orjson.loads(seen['data']) == rows + assert orjson.loads(seen['fields']) == ['a'] + assert seen['row_count'] == 3 + + +@patch.object(llm_module.settings, 'ANALYSIS_PLAN_DATA_ROWS', 2) +def test_start_supplementary_limits_rows_for_planning(): + service = _supplementary_service() + seen = {} + service._run_analysis_supplementary_queries_in_session = lambda tables, q: seen.update( + data=q.data, row_count=q.data_row_count) or [] + + future = service.start_analysis_supplementary_queries(['orders'], [], [{'a': i} for i in range(5)]) + LLMService.collect_analysis_supplementary_results(future) + + assert len(orjson.loads(seen['data'])) == 2 + assert seen['row_count'] == 5 + + +def test_collect_supplementary_degrades_on_failure_and_timeout(): + assert LLMService.collect_analysis_supplementary_results(None) == [] + + failed = Future() + failed.set_exception(RuntimeError('boom')) + assert LLMService.collect_analysis_supplementary_results(failed) == [] + + with patch.object(llm_module.settings, 'ANALYSIS_SUPPLEMENTARY_TIMEOUT', 0.01): + assert LLMService.collect_analysis_supplementary_results(Future()) == [] + + +def test_run_task_starts_planning_before_chart_generation(): + source = _read('backend/apps/chat/task/llm.py') + run_task = source[source.index(' def run_task('):source.index(' def run_recommend_questions_task_async')] + + start = run_task.index('self.start_analysis_supplementary_queries(') + chart = run_task.index('self.generate_chart(') + collect = run_task.index('self.collect_analysis_supplementary_results(') + assert start < chart < collect + assert 'analysis_future.cancel()' in run_task + + +def test_new_operations_have_distinct_values(): + values = [op.value for op in OperationEnum] + assert len(values) == len(set(values)) + # '15' is upstream's COMPLETE_QUESTION; auto analysis uses the next codes. + assert OperationEnum.ANALYSIS_PLAN.value == '16' + assert OperationEnum.ANALYSIS_QUERY.value == '17' + + +# ---------- frontend contract ---------- + +def _read(rel): + with open(os.path.join(REPO_ROOT, rel), encoding='utf-8') as f: + return f.read() + + +def test_frontend_removes_analysis_button_and_renders_inline_analysis(): + index_vue = _read('frontend/src/views/chat/index.vue') + chart_answer = _read('frontend/src/views/chat/answer/ChartAnswer.vue') + + assert 'clickAnalysis(' not in index_vue + assert "t('chat.data_analysis')" not in index_vue + assert "case 'analysis-result':" in chart_answer + assert "case 'analysis-error':" in chart_answer + assert ' - + + reasoningName: + | 'sql_answer' + | 'chart_answer' + | 'analysis_thinking' + | Array<'sql_answer' | 'chart_answer' | 'analysis_thinking'> }>(), { recordId: undefined, @@ -120,6 +125,8 @@ const sendMessage = async () => { let sql_answer = '' let chart_answer = '' + let analysis_answer = '' + let analysis_answer_thinking = '' let tempResult = '' @@ -211,6 +218,15 @@ const sendMessage = async () => { case 'chart': _currentChat.value.records[index.value].chart = data.content break + case 'analysis-result': + analysis_answer += data.content ?? '' + analysis_answer_thinking += data.reasoning_content ?? '' + _currentChat.value.records[index.value].analysis = analysis_answer + _currentChat.value.records[index.value].analysis_thinking = analysis_answer_thinking + break + case 'analysis-error': + _currentChat.value.records[index.value].analysis = data.content + break case 'datasource': if (!_currentChat.value.datasource) { _currentChat.value.datasource = data.id @@ -291,6 +307,11 @@ defineExpose({ sendMessage, index: () => index.value, stop }) :record-id="recordId" :loading-data="loadingData" /> +