Back to Weknora

README CN

README_CN.md

0.6.016.5 KB
Original Source
<p align="center"> <picture> </picture> </p> <p align="center"> <picture> <a href="https://trendshift.io/repositories/15289" target="_blank">
</a>
</picture> </p> <p align="center"> <a href="https://weknora.weixin.qq.com" target="_blank">
</a>
<a href="https://chatbot.weixin.qq.com" target="_blank">
    
</a>
<a href="https://chromewebstore.google.com/detail/jpemjbopikggjlmikmclgbmkhhopjdgd" target="_blank">
    
</a>
<a href="https://clawhub.ai/lyingbug/weknora" target="_blank">
    
</a>
<a href="https://github.com/Tencent/WeKnora/blob/main/LICENSE">
    
</a>
<a href="./CHANGELOG.md">
    
</a>
</p> <p align="center"> | <a href="./README.md"><b>English</b></a> | <b>简体中文</b> | <a href="./README_JA.md"><b>日本語</b></a> | <a href="./README_KO.md"><b>한국어</b></a> | </p> <p align="center"> <h4 align="center">

项目介绍架构设计核心特性快速开始文档开发指南

</h4> </p>

💡 WeKnora — 让文档活起来:RAG、Agent 推理与自动 Wiki 一体化的知识框架

📌 项目介绍

WeKnora(维娜拉) 是一款开源的、基于大语言模型(LLM)的知识管理框架,专为企业级文档理解、语义检索与智能推理场景打造。

框架围绕三大核心能力构建:RAG 快速问答适合日常知识查询,ReAct Agent 智能推理自主编排知识检索、MCP 工具与网络搜索完成复杂多步任务,全新的 Wiki 模式则让 Agent 从原始文档中自治生成相互链接的 Markdown 知识库与可视化知识图谱。结合多源数据接入(飞书 / Notion / 语雀,更多持续接入中)、二十余家主流模型厂商集成、Langfuse 全链路可观测性、企业级多租户 RBAC(四级角色矩阵 + 资源归属 + 租户审计日志),以及完全可私有化部署的模块化架构,WeKnora 帮助团队把分散文档沉淀为可查询、可推理、可持续演进的专属知识资产。

框架支持从飞书、Notion 及语雀等外部平台自动同步知识(更多数据源持续接入中),覆盖 PDF、Word、图片、Excel 等十余种文档格式,并可通过企业微信、飞书、Slack、Telegram 等 IM 频道直接提供问答服务。模型层面兼容 OpenAI、DeepSeek、Qwen(阿里云)、智谱、混元、Gemini、MiniMax、NVIDIA、Ollama 等主流厂商。全流程模块化设计,大模型、向量数据库、存储等组件均可灵活替换,支持本地与私有云部署,数据完全自主可控。WeKnora 还无缝集成了 Langfuse,为 Agent 运行、Token 使用及任务流水线提供了全面的可观测性追踪。

✨ 最新更新

  • v0.6.0 —— 租户 RBAC(四级角色矩阵 Owner / Admin / Contributor / Viewer + 按 KB 归属 + 每租户审计日志)、租户成员管理与多工作区 UX、自助创建工作区;weknora CLI v0.4 正式版 + mcp serve;KB 检索跨向量库扇出;MCP / 数据源凭据 AES-256-GCM 加密 + docreader gRPC TLS + Token;新增智谱 Embedding 与华为云 OBS;服务端用户偏好;Go 1.26.0。详见 docs/RBAC说明.mdCHANGELOG.md
  • v0.5.2 —— Wiki 入库支撑万级文档知识库(任务队列 + 死信队列);MCP 工具人机审批;Anthropic / Apache Doris / 腾讯云 VectorDB / 金山云 KS3 / SearXNG 后端;自适应三层分块 + 实时调试面板;全局 ⌘K 命令面板;语雀连接器 + 微信小程序;weknora CLI 早期版本。
  • v0.5.1 —— 知识库批量管理;租户级 IM 频道总览;会话搜索 + 用户级置顶;模型 / 网页搜索 / MCP 统一卡片化设置;按 Agent LLM 调用超时;桌面端租户切换。
  • v0.5.0 —— Wiki 模式正式版 —— Agent 从原始文档自治生成结构化、相互链接的 Markdown Wiki 页面及知识图谱;Wiki 浏览器 + 可视化图谱。
  • v0.4.0 —— WeKnora Cloud(托管模型 + 解析);Chrome 插件;ClawHub Skill;微信 IM;附件处理;Azure OpenAI / 阿里云 OSS;Notion 连接器;百度 + Ollama 网页搜索;VectorStore 管理。
  • v0.3.6 —— ASR 语音;飞书数据源自动同步;OIDC;IM 引用回复 + 线程会话;文档自动摘要;Tavily 搜索;并行工具调用;Agent @提及范围限制。
  • v0.3.5 —— Telegram / 钉钉 / Mattermost IM;IM 斜杠命令 + QA 队列;推荐问题;VLM 自动描述 MCP 返回图片;Novita AI;来源频道标记。
  • v0.3.4 —— 企业微信 / 飞书 / Slack IM;多模态图片;NVIDIA 模型 API;Weaviate;AWS S3;AES-256-GCM API Key 加密;内置 MCP 服务;混合检索优化;final_answer 工具。
  • v0.3.3 —— 父子分块;知识库置顶;兜底回复;Rerank 段落清洗;存储桶自动创建;Milvus。
  • v0.3.2 —— 知识搜索入口;按来源配置解析与存储引擎;本地存储图片渲染;文档预览;火山引擎 TOS;Mermaid 渲染;对话批量管理;记忆图谱预览。
  • v0.3.0 —— 共享空间;Agent Skills + 沙盒执行;自定义 Agent;数据分析 Agent;思考模式;Bing / Google 搜索;API Key 认证;Helm Chart;韩语 i18n;Qdrant。
  • v0.2.0 —— Agent 模式(ReACT);多类型知识库(FAQ + 文档);对话策略配置;DuckDuckGo 网页搜索;MCP 工具集成;全新 UI + Agent 模式切换;MQ 异步任务管理。

📱 功能展示

<table> <tr> <td colspan="2" align="center"><b>💬 智能问答对话</b> </td> </tr> <tr> <td width="50%" align="center"><b>📖 Wiki 浏览器</b> </td> <td width="50%" align="center"><b>🕸️ Wiki 知识图谱</b> </td> </tr> <tr> <td width="50%" align="center"><b>🤖 Agent 模式 · 工具调用过程</b> </td> <td width="50%" align="center"><b>⚙️ 对话设置</b> </td> </tr> <tr> <td colspan="2" align="center"><b>🔭 监控可观测性 · Langfuse Tracing</b> </td> </tr> </table>

🏗️ 架构设计

从文档解析、向量化、检索到大模型推理,全流程模块化解耦,组件可灵活替换与扩展。支持本地 / 私有云部署,数据完全自主可控,零门槛 Web UI 快速上手。

🧩 功能概览

智能对话

能力详情
智能推理ReACT 渐进式多步推理,自主编排知识检索、MCP 工具与网络搜索,支持自定义智能体
快速问答基于知识库的 RAG 问答,快速准确地回答问题
Wiki 模式Agent 驱动从原始文档中自动生成并维护结构化、相互链接的 Markdown Wiki 知识页面
工具调用内置工具、MCP 工具、网络搜索
对话策略在线 Prompt 编辑、检索阈值调节、多轮上下文感知
推荐问题基于知识库内容自动生成推荐问题

知识管理

能力详情
知识库类型FAQ / 文档 / Wiki,支持文件夹导入、URL 导入、标签管理、在线录入
数据源导入飞书 / Notion / 语雀 知识库自动同步(更多数据源开发中),支持增量与全量同步
文档格式PDF / Word / Txt / Markdown / HTML / 图片 / CSV / Excel / PPT / JSON
检索策略BM25 稀疏召回 / Dense 稠密召回 / GraphRAG 图谱增强 / 父子分块 / 多维度索引
端到端测试检索+生成全链路可视化,评估召回命中率、BLEU / ROUGE 等指标

集成与扩展

能力详情
模型厂商OpenAI / Azure OpenAI / Anthropic(Claude)/ DeepSeek / Qwen(阿里云)/ 智谱 / 混元 / 豆包(火山引擎)/ Gemini / MiniMax / NVIDIA / Novita AI / SiliconFlow / OpenRouter / Ollama
向量数据库PostgreSQL (pgvector) / Elasticsearch / Milvus / Weaviate / Qdrant / Apache Doris / 腾讯云 VectorDB
EmbeddingOllama / BGE / GTE / 智谱 / OpenAI 兼容接口
对象存储本地 / 腾讯云COS / 火山引擎 TOS / MinIO / AWS S3 / 阿里云 OSS / 金山云 KS3 / 华为云 OBS
IM 集成企业微信 / 飞书 / Slack / Telegram / 钉钉 / Mattermost / 微信
网络搜索DuckDuckGo / Bing / Google / Tavily / Baidu / Ollama / SearXNG

平台能力

能力详情
部署本地 / Docker / Kubernetes (Helm),支持私有化离线部署
界面Web UI / RESTful API / 命令行(weknora)/ Chrome Extension / 微信小程序
权限控制租户 RBAC 四级角色矩阵(Owner / Admin / Contributor / Viewer),按知识库的资源归属,每租户审计日志,invite-only 准入,自助创建工作区,跨租户超级管理员
安全API Key 与 MCP / 数据源凭据 AES-256-GCM 静态加密、支持平滑密钥轮换;app ↔ docreader gRPC TLS + Token;防 SSRF HTTP 客户端;Agent 技能沙箱隔离
可观测性集成 Langfuse 以追踪 ReAct 循环、Token 消耗、工具调用和任务流水线
任务管理MQ 异步任务,版本升级自动数据库迁移
模型管理集中配置,知识库级别模型选择,多租户共享内置模型,WeKnora Cloud 托管模型与文档解析

🧩 Chrome 插件

WeKnora Chrome 插件支持在浏览器中直接将网页内容采集到 WeKnora 知识库。选中文本、图片或整个页面,一键保存为知识条目,无需复制粘贴或手动上传文件。

📱 微信小程序

WeKnora 微信小程序 提供轻量移动端客户端,支持配置 WeKnora API、选择知识库、导入 URL,并在微信内向知识库提问。

🦞 ClawHub Skill

WeKnora ClawHub Skill 是 WeKnora 发布在 ClawHub 平台上的技能。安装后,可通过 WeKnora REST API 上传文档(文件 / URL / Markdown)、执行混合检索(向量 + 关键词)以及管理知识条目。

  • 文档导入 — 通过 Agent 上传文件、导入网页或写入 Markdown 知识
  • 混合检索 — 在单个或多个知识库中进行向量 + 关键词混合搜索
  • 知识管理 — 以编程方式浏览、编辑和删除知识条目

🚀 快速开始

🛠 环境要求

📦 安装与启动

bash
git clone https://github.com/Tencent/WeKnora.git
cd WeKnora
cp .env.example .env   # 按需编辑 .env,详见文件内注释
docker compose up -d   # 启动核心服务

启动成功后访问 http://localhost 即可使用。

如需使用本地 Ollama 模型,请先运行 ollama serve > /dev/null 2>&1 &

🔧 可选服务(Docker Compose Profile)

按需添加 --profile 启动额外组件,多个 profile 可叠加使用:

Profile说明启动命令
(默认)核心服务docker compose up -d
full全部功能docker compose --profile full up -d
neo4j知识图谱 (Neo4j)docker compose --profile neo4j up -d
minio对象存储 (MinIO)docker compose --profile minio up -d
langfuse链路追踪 (Langfuse)docker compose --profile langfuse up -d

组合示例:docker compose --profile neo4j --profile minio up -d

停止服务:docker compose down

🌐 服务地址

服务地址
Web UIhttp://localhost
后端 APIhttp://localhost:8080
链路追踪 (Langfuse)http://localhost:3000

文档知识图谱

WeKnora 支持将文档转化为知识图谱,展示文档中不同段落之间的关联关系。开启知识图谱功能后,系统会分析并构建文档内部的语义关联网络,不仅帮助用户理解文档内容,还为索引和检索提供结构化支撑,提升检索结果的相关性和广度。

具体配置请参考 知识图谱配置说明 进行相关配置。

配套MCP服务器

请参考 MCP配置说明 进行相关配置。

🔌 使用微信对话开放平台

WeKnora 作为微信对话开放平台的核心技术框架,提供更简便的使用方式:

  • 零代码部署:只需上传知识,即可在微信生态中快速部署智能问答服务,实现"即问即答"的体验
  • 高效问题管理:支持高频问题的独立分类管理,提供丰富的数据工具,确保回答精准可靠且易于维护
  • 微信生态覆盖:通过微信对话开放平台,WeKnora 的智能问答能力可无缝集成到公众号、小程序等微信场景中,提升用户交互体验

📘 文档

常见问题排查:常见问题排查

详细接口说明请参考:API 文档

产品规划与计划:路线图 (Roadmap)

🧭 开发指南

⚡ 快速开发模式(推荐)

如果你需要频繁修改代码,不需要每次重新构建 Docker 镜像!使用快速开发模式:

bash
# 启动基础设施
make dev-start

# 启动后端(新终端)
make dev-app

# 启动前端(新终端)
make dev-frontend

开发优势:

  • ✅ 前端修改自动热重载(无需重启)
  • ✅ 后端修改快速重启(5-10秒,支持 Air 热重载)
  • ✅ 无需重新构建 Docker 镜像
  • ✅ 支持 IDE 断点调试

详细文档: 开发环境快速入门

🤝 贡献指南

欢迎通过 Issue 反馈问题或提交 Pull Request。

流程: Fork → 新建分支 → 提交更改 → 创建 PR

规范: 使用 gofmt 格式化代码,遵循 Conventional Commits 提交(feat: / fix: / docs: / test: / refactor:

🔒 安全声明

重要提示: 从 v0.1.3 版本开始,WeKnora 提供了登录鉴权功能,以增强系统安全性。在生产环境部署时,我们强烈建议:

  • 将 WeKnora 服务部署在内网/私有网络环境中,而非公网环境
  • 避免将服务直接暴露在公网上,以防止重要信息泄露风险
  • 为部署环境配置适当的防火墙规则和访问控制
  • 定期更新到最新版本以获取安全补丁和改进

👥 贡献者

感谢以下优秀的贡献者们:

📄 许可证

本项目基于 MIT 协议发布。 你可以自由使用、修改和分发本项目代码,但需保留原始版权声明。

📈 项目统计

<a href="https://www.star-history.com/#Tencent/WeKnora&type=date&legend=top-left"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Tencent/WeKnora&type=date&theme=dark&legend=top-left" /> <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Tencent/WeKnora&type=date&legend=top-left" /> </picture> </a>