Files
ssw-ontology/README.md
T
admin 1e30d4c355 docs+code: 通用化平台叙事,去掉尚数网业务绑定
## 文档重构(5 个 md + 1 个 html)
- README.md: '尚数网本体管理平台' → '本体元数据平台 · Ontology Platform'
- docs/README.md: 通用化定位,补全 P0/P1/P2 (Palantir Ontology 对标) + Materialization/BackingSource/Suggestions 全清单
- docs/PLAN.md: 通用化设计目标,改为 'Palantir Ontology 对标' 路线图
- docs/USAGE.md: 用通用占位符(项目/空间/组织)替换尚数网具体业务举例
- docs/IMPORT.md: 把 shangshu 当成 '一个采用方示例' 展示通用模式
- docs/product-intro.html: title/brand/hero/场景/footer 全改通用,沙数只作典型场景之一

## 代码字符串同步去 shangshu
- server/main.go: '[boot] 尚数网本体管理平台监听' → '[boot] 本体平台监听'
- server/handlers_connector.go: manifest 'server' 字段 → 'ontology-platform'
- server/handlers_mcp.go: tool description + serverInfo → 通用
- server/handlers_functions.go: builtin interface description → 通用
- server/handlers_backing_source.go: 注释去 shangshuwang.cn 具体网址
- server/config.go + server/db.go: 注释/seed 数据改占位 (demo_self / demo_partner_a/b)
- server/ai/anthropic.go: fallback systemPrompt → '通用本体平台工程师'
- server/ai/heuristic.go: 未识别 summary → '本体概念'
- server/ai/prompt.go: 静态 systemPrompt 头部 + JSON 示例去 shangshu

## 前端文案同步
- web/src/App.vue: title 改 '本体元数据平台'
- web/src/views/LoginView.vue: 登录页 h1 改通用
- web/src/views/OntologyView.vue: backing source placeholder 改 example.com
- web/src/components/ReviewWorkbench.vue + useReviewWorkbench.js: '尚数网' → '本体平台'

## 验证
- go build ./server OK
- 剩余 '尚数网' / 'shangshu-ontology' 引用:
  - 文档 README/README/USAGE/PLAN/IMPORT 仅在 '采用方示例' 上下文出现
  - 代码注释 sswOntologySystemPrompt 等 identifier 保持不变(避免改动 API 表面)
  - skill 名 'ssw-ontology-reviewer' 保持不变(已发布技能)

Refs: docs/README.md (1.1 元数据组件表)、docs/PLAN.md (4 当前已完成能力)
2026-08-24 14:04:59 +08:00

5.8 KiB
Raw Blame History

通用本体元数据平台 · Ontology Platform

把业务实体、属性、关系、动作、函数、接口与访问控制统一纳入一套可查询、可治理、可审计的本体元数据平台。 既适合企业沉淀内部业务(数据要素、可信数据空间、CRM、组织架构、产品目录…),也适合个人/小团队管理自己的知识网络。

设计对标 Palantir Ontology 的 6 元原语(Object / Property / Link / Interface / Action / Function)+ Dynamic Security 治理 + AI 摄取 + 只读 REST/MCP 连接器。 详细架构、API、能力清单与 Palantir 对标表见 docs/README.md。

文档导航

文档 用途
docs/README.md 架构总览、6 元原语、API 全清单、Palantir 对标
docs/PLAN.md 设计目标、能力边界、演进计划(P1/P2/P3)
docs/USAGE.md 启动 + 连接器查询 + AI 摄取 实战
docs/IMPORT.md 把外部数据源(API/文件/数据库)导入本体
docs/update/2026-08-24.md 升级说明:P0/P1/P2 全落地 + 迁移步骤 + 回滚
docs/product-intro.html 营销/介绍页

核心能力

  • 6 元原语 + 物化层:Object / Property / Link / Interface / Action / Function + Materialization / Backing Source,完整覆盖"数据 + 计算 + 接口"三面
  • Dynamic Security:Principal + Marking + Grant + FieldPolicy + 审计日志,与对象/链接/动作平级的治理元能力
  • AI 摄取:粘贴文本、批量文件、数据连接资源三种入口,自动抽 schema 并写入本体,可精确指定抽取范围(directive)
  • 只读 REST/MCP:连接器对外暴露本体子集,所有读路径过同一套授权 + 字段脱敏;MCP 一行注册到 WorkBuddy / Claude Code
  • 提示调度:/api/v1/ontology/suggestions 按上下文(context/type/stage)推 Function/Action;UI 用统一的 💡 SuggestionHints 组件
  • 物化 + 同步源:Materialization 把多表 join 物化成快读行,Backing Source 描述外部数据源的字段映射

快速开始

平台强依赖 PostgreSQL。表结构由代码在启动时自动创建(server/db.go 的 migrate() + server/access_control.go 的 ensureAccessControlSchema()),并自动灌入极简种子(1 个对象类型「合作企业」+ 3 条示例,部署后可一键清掉),只要有可用的 Postgres 空库,即可直接运行,无需手动建表或导入。

方式 A:Docker 一键镜像(自带 PG,推荐用于部署/分发)

mkdir -p ~/ontology-data/pg ~/ontology-data/archive
docker run -d --name ontology -p 8081:8081 \
  -v ~/ontology-data:/data --restart unless-stopped \
  crpi-yscq976uwza88qap.cn-shenzhen.personal.cr.aliyuncs.com/ssw188/ssw-ontology:1.0.0
  • 自带 PostgreSQL(容器内 5432,本体后端映射到宿主机 8081)
  • 默认账户:数据库 ssw-ontology / 用户 ssw / 密码 ssw
  • 挂 -v /host/x:/data 后,/data/pg 存 PG 数据、/data/archive 存文档;不挂则匿名卷,重启丢
  • 健康检查:wget --spider http://127.0.0.1:8081/api/v1/connector/object-types,docker ps 看 STATUS 是否 (healthy)
  • 详见 Dockerfile 与 docker/entrypoint.sh

方式 B:本机 ./run.sh(开发用)

./build.sh && ./run.sh    # 监听 http://127.0.0.1:8081

需要本机有 PostgreSQL(可以是 Docker 镜像外的任意实例)。DATABASE_URL 与其他配置都在仓库根 .env 里设置(参考 .env.example),不在仓库里出现真实凭据。

快速起本地 PG 示例:

docker compose up -d    # 起 jnpf-postgres,端口 15432 映射

Docker 镜像配置

覆盖 PG 账户:

docker run ... -e POSTGRES_USER=myuser -e POSTGRES_PASSWORD=mypwd -e POSTGRES_DB=mydb ...

启用 AI 智能导入(默认 AI_ENABLED=false 走启发式抽取,只能识别引号实体;开启后大模型会建对象类型/属性/链接类型/动作类型/实例/关系):

docker run -d --name ontology -p 8081:8081 \
  -v ~/ontology-data:/data --restart unless-stopped \
  -e AI_ENABLED=true \
  -e AI_BASE_URL=https://api.minimaxi.com/anthropic \
  -e AI_KEY=<your-key> \
  -e AI_MODEL=MiniMax-M3 \
  crpi-yscq976uwza88qap.cn-shenzhen.personal.cr.aliyuncs.com/ssw188/ssw-ontology:1.0.0
  • URL 含 /anthropic 子串 → Anthropic Messages 协议;其余按 OpenAI Chat Completions 兼容协议(DeepSeek / 通义千问 / Ollama 等均可)
  • 4 个变量必须全设;只设 KEY 但 AI_ENABLED=false 仍走启发式
  • 适用接口:POST /api/v1/ai/ingest(粘贴文本摄取)、POST /api/v1/km/extract(从 archive 文件摄取)

启用管理接口鉴权(默认开放给所有请求,生产环境建议开启):

docker run ... -e MANAGER_API_KEY=<your-key> ...   # 调用管理接口需带 X-API-Key: <key>

本地构建镜像(如需):

docker build -t ontology:1.0.0 .

适用场景(不限于)

场景 典型对象类型 价值
企业数据资产盘点 数据资源/产品/需求/空间 资产可发现、可查询、可授权
CRM / 销售管理 客户/合同/订单/产品 关系驱动,精准展开客户全貌
知识管理 文档/概念/人/项目 AI 摄取 + 关系图谱 + 全文检索
可信数据空间 空间/会员/产品/设备 合规授权 + 审计日志
个人 / 小团队 项目/任务/笔记/人脉 单机部署 + REST/MCP 查询

许可与品牌

  • 平台是通用的:不绑定任何特定业务,可独立部署、改造、商用
  • 采用方示例:尚数网(shangshuwang.cn)是当前采用此平台的项目之一,主要用其做数据要素与可信数据空间的本体管理
  • Docker 镜像、默认端口(8081)、默认账户(ssw/ssw)沿用尚数网最初部署约定,改用其他镜像/账户不影响功能