WeKnora 文档

WeKnora（维娜拉）是腾讯开源的企业级知识库与 RAG（Retrieval-Augmented Generation）系统：Go 单体后端 + Vue 3 前端 + Python 文档解析微服务（docreader），支持多租户、多知识库、混合检索、Agent 智能体、知识图谱、Wiki 生成、MCP 集成、多平台 IM 接入与网页嵌入等能力。

本目录是 WeKnora 的官方文档，按「入门 → 架构 → 功能 → API → 客户端 → 开发」六个部分组织。

文档站点

本目录同时是一个 VitePress 站点，Markdown 即页面，新增文件会自动进入侧边栏（标题取正文一级标题，目录顺序按文件名数字前缀）。

npm install
npm run dev      # 本地预览
npm run build    # 产物输出到 .vitepress/dist
npm run preview  # 预览构建产物

主题位于 .vitepress/theme/：style.css 是排版与配色的单一来源，Landing.vue 是首页。

写作约定

• 先讲怎么用，再讲怎么实现。 每篇功能文档开头回答「这东西解决什么问题、在界面上怎么用」，之后才展开数据模型、流程与源码细节；源码索引统一放在文末的「实现参考」小节。
• 面向用户的章节（01 快速开始、03 功能模块、05 客户端）以任务为主线；面向开发者的章节（02 架构、04 API、06 开发指南）以结构为主线，可以直接深入细节。
• 涉及界面操作的地方配截图，用 <Screenshot> 组件引用（见下节）。

截图

截图用全局组件 <Screenshot> 引用，图片放在 public/screenshots/ 下：

<Screenshot
  src="/screenshots/kb-document-list.png"
  caption="知识库文档列表：解析状态、标签与批量操作"
  hint="展示文档列表页，包含解析状态列、标签列、顶部筛选栏与勾选后出现的批量操作栏。" />

图片文件不存在时，组件会渲染成一个带说明的虚线占位框，标出期望的文件路径与该图应当展示的内容；把同名图片放进 website-docs/public/screenshots/ 即可自动生效，不需要改 Markdown。

当前待补充的截图共 31 张：

仓库 docs/images/ 下已有一批现成的产品截图（qa.png、knowledgebases.png、wiki-browser.png、wiki-graph.png、settings.png、agent-qa.png、graph1-3.png、langfuse.png、rbac-*.png 等），补图时可以先看看能否直接复用。

阅读路径建议

• 初次使用：01 快速开始 四篇按顺序读完即可完成部署与首次问答。
• 评估选型 / 了解原理：02 架构 五篇给出系统全貌与两条核心流水线（文档入库、检索问答）。
• 使用某项具体功能：直接查 03 功能模块 对应章节。
• 对接 API / 写集成：04 API 参考 + 05 客户端（CLI / Go SDK）。
• 二次开发 / 贡献代码：06 开发指南，尤其是扩展点指南。

目录

01 快速开始

02 架构

03 功能模块

04 API 参考

覆盖约 360 个端点，每个端点含权限要求、参数表与 curl 示例。

05 客户端

06 开发指南

系统组件速览

flowchart LR
    subgraph Clients["客户端"]
        FE["Web 前端 Vue 3"]
        CLI["CLI weknora"]
        SDK["Go SDK"]
        MINI["微信小程序"]
        EMBED["网页嵌入挂件"]
        IM["IM 平台 x10"]
    end
    subgraph Core["核心服务"]
        APP["app 主服务 Go/Gin :8080"]
        DR["docreader 解析服务 Python gRPC :50051"]
    end
    subgraph Infra["基础设施"]
        PG[("PostgreSQL / ParadeDB")]
        RD[("Redis + asynq")]
        VS[("向量/检索引擎 可选多种")]
        OBJ[("对象存储 local/minio/cos/oss/s3 等")]
        NEO[("Neo4j 知识图谱 可选")]
    end
    LLM["LLM / Embedding / Rerank / VLM 多厂商"]
    FE --> APP
    CLI --> APP
    SDK --> APP
    MINI --> APP
    EMBED --> APP
    IM --> APP
    APP --> DR
    APP --> PG
    APP --> RD
    APP --> VS
    APP --> OBJ
    APP --> NEO
    APP --> LLM

文档约定

• 文中源码路径均相对仓库根目录，如 internal/agent/engine.go。
• API 路径默认带 /api/v1 前缀；认证方式见 API 总览。
• 配置示例中的密钥均为占位符，生产环境务必替换（尤其 JWT_SECRET、SYSTEM_AES_KEY、数据库口令）。
• 文档基于仓库根目录 VERSION 文件对应版本源码整理（VitePress 构建时自动读取），随代码变更同步维护。