Major changes: - Streaming: LLM统一 _BaseLLM 接口 (invoke + stream), generate/modify/correct 节点使用 get_stream_writer() 实现逐字输出, UI 节点平铺展开自动折叠 - Prompt外部化: 7个prompt拆分到 prompts/*.md, loader.py 支持热重载 - 错误自增长: backend/error_kb.py — 指纹去重 + ChromaDB持久化, correct_jrxml→validate 通过时自动入库, retrieve同时搜索错误KB - 文件上传: backend/file_parser.py — PDF/DOCX/图片/文本解析, 侧边栏多文件上传, 文本自动注入下一条消息 - A4模板识别: backend/layout_analyzer.py — 三种模式(完整A4/行片段修改/行片段新建), PaddleOCR元素提取 + 行分组 + JRXML section匹配 - 会话历史下载: jrxml_versions版本追踪 + 侧边栏历史版本下载按钮 - 预览修复: route_after_save跳过预览/导出意图的验证循环 - Ctrl+C修复: JS注入拦截Streamlit裸c键清缓存 Docs: CLAUDE.md (完整项目文档), ROADMAP.md (改进路线图) Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
8.3 KiB
CLAUDE.md — JRXML 生成代理
项目概述
一个本地桌面应用,通过自然语言多轮对话帮助非技术用户创建 JasperReports 模板(JRXML 文件)。核心技术栈:Streamlit UI + LangGraph 状态机 + LLM 生成/修改 + 自动验证修正循环。
一句话:用户用中文描述报表需求 → LLM 生成 JRXML → 自动验证 → 失败则自动修正(最多3次) → 返回可编译的 JRXML 文件。
启动命令
# 终端 1 — 验证服务(必须先启动)
python -m uvicorn validation_service.main:app --port 8001 --host 0.0.0.0
# 终端 2 — Streamlit UI
STREAMLIT_SERVER_HEADLESS=true streamlit run app.py --server.port 8501
浏览器打开 http://localhost:8501。
当前配置(.env)
- LLM:
cloud/anthropic→ MiniMax Anthropic 兼容 API (MiniMax-M2.7)- Base URL:
https://api.minimaxi.com/anthropic - 认证: 通过
OPENAI_API_KEY传入 Anthropic SDK(注意不是ANTHROPIC_API_KEY) - 绕过代理: 代码中设
NO_PROXY=*
- Base URL:
- 嵌入模型:
local/sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2 - 向量库: ChromaDB 持久化在
./db/chroma - 验证服务: FastAPI
localhost:8001
架构
app.py (Streamlit UI)
│ run_agent(user_input)
│ 功能: 流式输出/节点平铺/文件上传/历史下载/预览/Ctrl+C修复
▼
agent/graph.py (LangGraph 状态机)
│ 节点流程:
│ load_session → process_input → manage_context → save_state_snapshot
│ → classify_intent (8种意图路由)
│ ├─ retrieve → generate → save_session → validate → ... → finalize
│ ├─ modify_jrxml → save_session → validate → ... → finalize
│ ├─ handle_consult / handle_undo / handle_reset → finalize
│ └─ preview/export → save_session → finalize (跳过验证)
│
│ 验证修正循环: validate ─fail─► explain_error ─► correct_jrxml ─► validate
│ ▲ │
│ └──────── (retry < MAX_RETRY=3) ───────────────────┘
│
├──► prompts/loader.py Prompt 外部化:7 个 .md 文件热重载
├──► backend/llm.py LLM 工厂: Anthropic SDK / OpenAI / Ollama (统一 stream/invoke)
├──► backend/rag_adapter.py 语义搜索: ChromaDB + SentenceTransformer
├──► backend/error_kb.py 错误知识库: 指纹去重 + ChromaDB 持久化
├──► backend/file_parser.py 文件解析: PDF/DOCX/图片/文本
├──► backend/layout_analyzer.py A4布局分析: OCR + 行分组 + JRXML行匹配
├──► backend/validation.py HTTP 客户端: POST /validate
├──► backend/session.py 会话持久化: JSON 文件 CRUD
└──► validation_service/ 独立 FastAPI: 结构检查 + XSD 校验
关键文件映射
| 文件 | 职责 | 修改频率 |
|---|---|---|
app.py |
Streamlit UI 入口,聊天界面 + 侧边栏 + 下载 + 文件上传 | 高 |
agent/state.py |
AgentState 类型定义(~23 字段,含 jrxml_versions/last_error_case) | 低 |
agent/nodes.py |
14 个工作流节点 + 流式生成 + 错误记录 | 高 |
agent/graph.py |
状态图编译 + 路由函数(预览跳过验证) | 中 |
prompts/loader.py |
Prompt 加载器(从 .md 文件热重载) | 低 |
prompts/*.md |
7 个独立 Prompt 模板 | 高 |
backend/llm.py |
LLM 工厂,统一 _BaseLLM 接口(invoke + stream) |
中 |
backend/rag_adapter.py |
RAGSearcher 单例,语义搜索接口 | 中 |
backend/error_kb.py |
ErrorKB — 错误指纹去重 + ChromaDB 持久化 + 语义检索 | 中 |
backend/file_parser.py |
文件解析: PDF(pdfplumber)/DOCX(python-docx)/图片(PIL+PaddleOCR可选)/文本 | 中 |
backend/layout_analyzer.py |
A4模板分析: 比例检测/PaddleOCR元素提取/行分组/JRXML行匹配 | 中 |
backend/embeddings.py |
嵌入模型工厂 (HuggingFace/OpenAI) | 低 |
backend/validation.py |
验证服务 HTTP 客户端 | 低 |
backend/session.py |
会话 JSON 文件 CRUD | 低 |
validation_service/main.py |
FastAPI 验证服务 | 低 |
scripts/init_kb.py |
知识库初始化/模型下载 | 低 |
关键约定
-
LLM 调用接口: 所有节点通过
get_llm().invoke(prompt)同步调用,或用get_llm().stream(prompt)流式调用。三个后端(Anthropic/OpenAI/Ollama)通过_BaseLLM统一接口。 -
流式生成: generate/modify_jrxml/correct_jrxml 使用
get_stream_writer()发射自定义事件,UI 通过stream_mode=["updates", "custom"]捕获逐字输出。 -
JRXML 提取:
_extract_jrxml()处理 LLM 响应 —— 去掉 markdown 代码块标记,提取 XML 内容。 -
状态持久化: 每个会话存为
sessions/{session_id}.json,LangGraph 节点间通过 AgentState dict 传递。 -
Token 计数: 使用
tiktoken(gpt-4o encoder) 估算,不管实际模型是什么。 -
RAG 子模块:
rag/是一个独立的 git submodule,其内部的生成产物 (models/,embeddings/,chroma_db/,jrxml_source_chunks/) 不在 git 中。
Prompt 模板位置
所有 Prompt 在 prompts/ 目录,.md 文件可直接编辑,无需重启应用:
| 文件 | 用途 |
|---|---|
prompts/intent_classify.md |
8 分类意图识别 |
prompts/initial_generation.md |
首次生成 JRXML |
prompts/modification.md |
修改现有 JRXML |
prompts/correction.md |
自动修正错误 |
prompts/explain_error.md |
错误转人话 |
prompts/compression.md |
对话压缩摘要 |
prompts/consult.md |
咨询解答 |
新增功能 (v2)
流式输出 + 节点平铺
- LLM 生成时逐字展示 XML(不再是空白等待)
- 节点以"处理过程"折叠区展开,不相互覆盖
- 完成后自动折叠,展示总结卡片
错误自增长知识库
backend/error_kb.py— ChromaDB 集合jrxml_error_cases- 错误指纹去重(标准化 + MD5):相同结构错误不重复录入
- 记录内容:错误信息 + 修正前后 JRXML + 修正 prompt + 工具链
retrieve节点自动注入历史修正案例- 流程:correct_jrxml 保存 last_error_case → validate 通过时自动入库
文件上传
- 侧边栏多文件上传(可逐文件移除)
- 支持: PDF(pdfplumber+PIL) / DOCX(python-docx) / 图片(PIL+PaddleOCR可选) / 纯文本
- 上传文本自动注入下一条消息前缀
- 根据
can_use_vision()判断是否走原生多模态(当前 MiniMax 不支持)
A4 模板识别
backend/layout_analyzer.py— 三种处理路径:- 完整 A4: 比例匹配 + OCR 元素 → 全量布局描述
- 行片段 + 有现有报表: 行匹配到 JRXML section → 定位修改
- 行片段 + 无现有报表: 按 A4 模板生成完整报表
- PaddleOCR(可选安装)提供精确元素位置/字号
- 行分组:Y 轴容差自动聚类;行匹配:文本相似度搜索 JRXML band
会话历史下载
AgentState.jrxml_versions追踪每次生成/修改的版本- 侧边栏"历史版本"折叠区,每版本独立下载按钮
预览修复
route_after_save新增意图判断:预览/导出跳过验证直通 finalize
Ctrl+C 修复
- JS 注入拦截 Streamlit 裸
c键清缓存,保留 Ctrl+C 复制
已知注意点
- Anthropic SDK: 使用原始
anthropic包(非langchain-anthropic),因为需要直连 MiniMax 兼容端点。backend/llm.py:31创建的Anthropic()必须传入api_key,SDK 不会自动读OPENAI_API_KEY。 - Windows 环境: NO_PROXY 设为
*避免代理干扰 MiniMax API。 - Streamlit headless: Windows 下必须设
STREAMLIT_SERVER_HEADLESS=true跳过邮箱采集提示。 - 验证服务结构检查: 字段引用一致性 (
$F{field}vs<field>声明)、SQL SELECT 存在性、pageWidth/pageHeight/name 属性。 - XSD 校验可选: 需要
validation_service/schemas/jasperreport_7_0_6.xsd存在。 - rag 子模块: 内部有独立的管线脚本(
batch_chunker.py→embed_chunks.py→import_to_chroma.py),通常不需要在主项目中运行。 - PaddleOCR 可选: A4 模板精确识别需要
pip install paddleocr,未安装时仅返回图片元信息。