跳转至

CG_RAG 文档

在线版本:https://cg-rag-docs.yjx.me/

CG_RAG 是施工法规问答服务。输入问题或工地照片,服务返回与原文对应的条文。检索、排序及条文筛选均在服务端完成。模型 key 与索引路径对调用方不可见。

curl -sS -X POST http://127.0.0.1:8864/cg-rag/rag \
  -H 'Content-Type: application/json' \
  -d '{"query":"脚手架搭设完毕后,验收应当由谁组织?","scope":"usual","topk":5}'

接口选择参考

使用场景 接口 是否调用大模型
检索条文,由调用方自行处理 POST /cg-rag/retrieve-rerank 否
直接获取答案 POST /cg-rag/rag 是
流式返回,逐步显示 POST /cg-rag/rag/stream 是,SSE
已有候选条文,仅需模型筛选 POST /cg-rag/constrained-generate 是
识别照片中的安全隐患 POST /cg-rag/vision/answer 是,不检索
识别照片隐患并提供法规依据 POST /cg-rag/vision/agentic 是,模型自行检索
保留千问描述,再检索法规 POST /cg-rag/vision/hybrid 是,DeepSeek 检索
作为 Agent 工具调用 MCP 取决于调用的工具

如无特定需求,可优先使用 /cg-rag/rag。

调用方参阅 使用,部署参阅 部署,代码修改参阅 实现。

快速开始 涵盖从健康检查到首次问答、首次图片识别的完整流程。调用示例 提供 curl、Python 与 JavaScript 示例。错误处理参阅 故障排查。

核心概念

scope:指定检索所用的规范库。usual 为常用规范,响应较快;full 为全量规范库;usual_plus_law 在常用规范基础上附加常用法律。不确定时建议使用 full。

受约束生成:模型不自由生成内容,仅从检索结果中选取条文序号,服务再按序号组装答案。此机制可避免模型生成不存在的条款。

fingerprint:语料、索引及模型配置的指纹,写入缓存键。索引或配置变更后,旧缓存不会错误命中。

默认地址

HTTP: http://127.0.0.1:8864/cg-rag
MCP:  http://127.0.0.1:8864/cg-rag/mcp/

端口为仓库启动脚本的默认值。生产环境应通过内网或反向代理访问,不得将 CG_RAG 直接暴露至公网,亦不得使调用方直连模型 provider。