# ClawKnowledge

**Repository Path**: North_Fan/claw-knowledge

## Basic Information

- **Project Name**: ClawKnowledge
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-08-25
- **Last Updated**: 2026-09-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 知识图谱知识库系统（第一版本 v1）

中大型企业级多模态**知识图谱知识库**系统。前端基座 **RuoYi-Vue3**，若依后端基座 **RuoYi-Vue**（内嵌知识图谱治理模块 `kg`），统一 Python 服务 **kg-unified**（FastAPI + `kg_auth` 认证 SDK），知识构建采用 **Schema 驱动的两段式抽取**（初版 LLM-free 预览 → 用户确认后 LLM 扩容）。

## 目录结构

```
.
├── ruoyi/            # 若依后端基座（Spring Boot 3.5 / JDK 17，内嵌 kg 治理模块）
│   ├── kg/           # 知识图谱独立模块（com.ruoyi.kg：控制器/服务/Mapper/安全/令牌）
│   ├── ruoyi-admin/  # 后台管理启动模块（:8080）
│   ├── ruoyi-common/ framework/ system/ quartz/ generator/
│   └── sql/          # 若依基础库 DDL（ry_*.sql / quartz.sql / kg_init.sql）
├── ruoyi-ui/         # 前端基座（RuoYi-Vue3：Vue3 + Vite + Element Plus + ECharts）
│   └── src/views/kg/ # 文件管理 / 智能问答 / 权限管理 / 抽取规则 / 图谱
├── python/           # 统一 Python 服务（kg-unified）与认证 SDK
│   ├── app.py        # FastAPI 入口（:8001；--worker parse|extract 后台 worker）
│   ├── routes/       # 模块化路由（common / open_api / pipeline / qa）
│   ├── kg_auth/      # 认证 SDK：内部令牌/OBO/Actor/存储/图谱/解析适配器/MQ/抽取
│   └── tests/        # 全部测试（141 项通过）
├── deploy/           # 部署与配置
│   ├── middleware/   # 中间件 DockerCompose（PG/TuGraph/RabbitMQ/Valkey/MySQL/MinIO/OpenSPG/AnyDoc，MinerU 已停用）
│   │   └── initdb/01-init-v1.sql   # v1 权威 schema + 种子数据（pg_dump 导出）
│   ├── docker-compose.yml  # 应用编排（ruoyi-ui / ruoyi / kg-unified）
│   ├── .env.example  # 环境变量模板（复制为 .env 使用）
└── docs/            # 项目文档（v1 重新生成，见 docs/README.md）
```

## 快速开始

```
cd deploy && cp .env.example .env
cd deploy/middleware && docker compose up -d      # 中间件（含 Postgres 自动执行 01-init-v1.sql）
# 本地开发：python（Conda + uvicorn + worker） / ruoyi（Java） / ruoyi-ui（npm run dev）
```

详见 [docs/STARTUP.md](docs/STARTUP.md) 与 [docs/ENV.md](docs/ENV.md)。

## 文档索引

| 文档 | 内容 |
| --- | --- |
| [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) | 系统架构（分层/组件/信任边界/关键链路） |
| [docs/TECH-STACK.md](docs/TECH-STACK.md) | 技术栈与中间件（角色/版本/端口） |
| [docs/STARTUP.md](docs/STARTUP.md) | 启动指南（本地开发 + 容器部署） |
| [docs/DATABASE.md](docs/DATABASE.md) | 数据库设计（22 张表 / init） |
| [docs/KG-DESIGN.md](docs/KG-DESIGN.md) | 知识构建设计（两段式抽取/效果控制/溯源/认证） |
| [docs/API.md](docs/API.md) | HTTP API 参考 |
| [docs/ENV.md](docs/ENV.md) | 环境变量说明（生产必改） |

## 核心设计原则

- **两段式抽取**：初版（base，LLM-free 规则）自动产出第一版三元组 → 用户确认 → 扩容（full，LLM）深度抽取并 supersede 初版；
- **Schema 驱动**：实体/谓词按 Schema 约束，专有名词识别只收专有名词，列表式文档经加粗措施 + 章节层级结构形成骨架图谱；
- **效果可控**：块级暂存/发布（fail-closed），未发布块不参与抽取与检索；
- **可替换 SPI（低侵入）**：解析引擎（ParserAdapter）与知识抽取引擎均通过**中立 SPI**解耦——业务层只依赖 `ExtractionBuilder` 接口与 `build_extraction_builder()` 工厂（`KG_EXTRACT_ENGINE` 选引擎：kag / llm / rule / base），后期替换/卸载 KAG 只需新增实现类并注册，业务代码零改动；KAG SDK 已改为可选依赖（`pip install -r requirements-kag.txt`）；
- **多信任边界**：SaToken（前端）→ X-Internal-Token（内部）→ OBO（外部 Agent），Actor fail-closed。