| 英语 | 简体中文 | 日语 | 韩语 |

[概览](#-overview) • [架构](#-architecture) • [关键特性](#-key-features) • [快速入门](#-getting-started) • [API 参考](#-api-reference) • [开发者指南](#-developer-guide)

💡 WeKnora — 利用RAG、代理和自动维基将文档转化为活知识

📌 概述

WeKnora 是一个开源的、由大语言模型驱动的知识框架，旨在实现企业级文档理解、语义检索和自主推理。

https://github.com/user-attachments/assets/19b28ce2-a62f-4f54-b289-c983576259bc

2:25 ·1080p ·英文旁白及说明。

它围绕三大核心功能组织：基于RAG的快速问答功能，用于日常查找;ReAct代理，自主协调检索，MCP工具;租户技能目录，会话持久化的Docker / E2B / Cube沙箱和网页搜索，处理复杂的多步骤任务;以及全新的维基模式，代理将原始文档提炼成自我维护的互联markdown知识库，配备交互式知识图谱，包含手动编辑、修订历史和一键回滚。跨会话长期记忆记住你是谁以及你不断询问的内容。知识策划同样注重实践：树状结构文件夹视图保留上传目录布局，带修订历史的块编辑允许检索区块像文档一样编辑、差异化和还原。结合多源摄取（Feishu wiki / Feishu Drive / GitLab / Tencent IMA / Notion / Yuque / DingTalk Docs / RSS，且还在增长），网站嵌入小组件用于向外部站点发布代理，带主体模型的 API 密钥用于程序化集成， 每个工作区多实例存储后端以实现灵活数据放置，20 个 LLM 提供商集成（包括 LiteLLM），完整的 Langfuse 可观察性以及带工作池治理的运行时任务队列仪表盘，企业级多工作空间 RBAC**（四层角色矩阵、每资源所有权、每个工作空间的审计日志）以及完全自托管的模块化架构，WeKnora 将分散的文档变成可查询、具备推理能力且持续发展的知识资产。

该框架支持来自飞树、GitLab、腾讯IMA、Notion和Yuque（更多数据源即将推出）的自动同步知识，支持包括PDF、Word、图片、Excel和XMind在内的10种文档格式，并可通过WeCom、Feishu、Slack和Telegram等即时通讯渠道直接提供问答。它兼容主要大型语言模型提供商，包括OpenAI、DeepSeek、Qwen（阿里云）、知普、魂源、Gemini、MiniMax、NVIDIA、LiteLLM和Ollama。Office文件可在过程中用anydoc进行解析。其全模块化设计支持交换LLM、矢量数据库和存储后端，支持本地和私有云部署，确保完全的数据主权。WeKnora还与Langfuse集成，实现对代理推理、令牌使用和流水线追踪的全面可观察性。

✨ 最新更新

• v0.8.0 — 技能沙箱运行时（会话持久化 Docker / E2B / Cube 后端，支持每租户网络策略；移除本地主机进程后端；Docker 可选）；租户技能目录（可从 ClawHub / SkillHub / git / zip 安装，支持每沙箱快照、实时进度、文件浏览/编辑、个人与工作区环境变量）；跨会话长期记忆（档案 / 喜好 / 事实 / 任务 / 兴趣，自动提取并确认，search_memory）；进程内 anydoc 办公文档解析器；官方 DeepSeek Harness 插件 @wxg-prc-cpg/dsh-weknora；GitLab 和腾讯 IMA 数据源；LiteLLM；Exa 和 Metaso 网络搜索；XMind 解析；聊天产物、问题大纲和时间戳；上下文压缩及提供者提示缓存标记。此外支持 OIDC JWKS 验证、可选复杂密码、文档自动标记及广泛的沙箱/安全加固。详情见 CHANGELOG.md。
• v0.7.2 — 发布了官方产品文档网站（VitePress；六个部分，约50页，涵盖约360个API端点和约150个环境变量，支持独立Docker/Nginx部署，提供快速入门示例数据和本地MCP演示）；知识库文件夹树（上传路径作为一等数据存储，可像文件管理器一样浏览/重命名/重新归档文档）；块级编辑与修订历史（在UI中编辑检索块，支持版本差异对比与回滚，自动重新索引，并可自定义文档元数据）；Wiki页面修订历史（快照、行级差异、一键回滚、浏览器内手动编辑）；可直接加载的文件URL，通过 resource_urls=public / RESOURCE_URL_MODE（第三方应用可渲染图片和文件，无需二次认证代理调用）；飞书云盘数据源及通过块API的docx同步；批量文档标签；MCP Server 1.1.x（迁移到MCP 2.x高层API，官方PyPI包 tencent-weknora-mcp，新增 create_knowledge_from_text 和 list_shared_knowledge_bases，总计支持29个工具）；AWS S3默认凭证链（IAM Role / IRSA）；本地HTML上传解析；QQBot Markdown回复；新增应用/前端/docreader/mcp-server的PR CI检查。此外，大规模路由和 modelcontext 重构，重排和块质量优化，以及广泛的稳定性修复。详见 CHANGELOG.md。
• v0.7.1 — 新增 云之家（Yunzhijia）IM 集成（WebSocket、图片消息、Markdown 回复）；新增 Volcengine 重新排序 提供器（支持请求批处理）和 智谱 AI 网页搜索 提供器；新增 平台范围的 API 密钥 用于控制平面自动化（租户管理、系统设置、运行队列、审计日志）；新增 按 KB 的活动审计追踪；FAQ 管理增强（筛选、标签、导出、导入追踪）；迁移 Langfuse OTLP/OTel 追踪 并支持 W3C traceparent 传播；聊天标题操作新增一键 Markdown 导出，参考抽屉中展示 wiki 工具结果；提示缓存可观测性；会话通道治理（管理员范围的 IM/嵌入/API 会话）；Feishu 大型 Wiki 同步的高可用性；以及移除旧版 Neo4j 会话记忆依赖。此外，还进行了广泛的 slug 完整性、SSRF 传输和状态同步加固。详见 CHANGELOG.md。
• v0.7.0 — 细粒度 Scoped API 密钥与主体模型（按能力级别授权 每 KB 限制 API 集成操场）；运行时任务队列可观测仪表板与工作池管理（按阶段池 按模型并发管理器 失败任务检查/重试）；多实例存储后端（每工作区多个存储实例，按 KB 绑定，默认实例）；会话范围临时附件（异步图片/文档解析 组合限制）；问题与后续建议；稳定的资源注册表与 LLM 上下文别名压缩；@Skill / @MCP 提及支持范围化代理运行时；会话中 MCP OAuth；QQBot 与 Lark（飞书国际版）IM 集成；Redis TLS；Requesty 模型提供者 Keenable 网络搜索；无租户预配与受控自助工作区；管理员密码重置；知识库重复流程；weknora CLI v0.10。同时进行广泛安全加固（SSRF、密钥脱敏、SQL 验证、IDOR）。详见 CHANGELOG.md。
• v0.6.3 — 网站嵌入小部件 & 集成中心（安全模式令牌交换、速率限制）；聊天体验全面优化（引用弹出框、RAG 流程进度、流式 Markdown）；文档多标签 & 批量重解析；Wiki 文件夹 & 层级导航；RSS 数据源；MCP OAuth2；EPUB / MHTML 解析；代理模型就绪性检查；模型测试调试器；会话来源过滤；工作区删除界面。详见 CHANGELOG.md。
• v0.6.2 — 每次上传的处理配置，带上传确认对话框；使用 process_config 重新解析文档；weknora CLI v0.9（内置代理技能，session stop，身份验证/配置统一）；知识库跑马灯多选；1024 维 pgvector 嵌入的 HNSW 索引；聊天资源存储重构；仅 Langfuse 追踪（移除 Jaeger）。详见 CHANGELOG.md。
• v0.6.1 — 文档解析跟踪时间线（Langfuse 风格的跨度树，带阶段式进度停止解析）；OpenSearch 向量存储驱动；通过 YAML 声明式内置模型；系统管理员与集中化平台设置审计日志；新用户入门指南；设置界面重新设计；weknora CLI v0.7 / v0.8（以代理为先的接口合同，NDJSON，--dry-run）；OpenDataLoader PaddleOCR-VL 解析器；MCP 服务器多传输（stdio / SSE / HTTP）；每模型思维模式配置；腾讯 LKEAP 重新排序原生 Gemini 嵌入 MiniMax-M3。详见 CHANGELOG.md
• v0.6.0 — 工作区 RBAC（4 层角色矩阵 Owner / Admin / Contributor / Viewer，每个知识库所有权，每个工作区审计日志）、工作区成员管理与多工作区用户体验、自助工作区；weknora CLI v0.4 GA 支持 mcp serve；跨向量存储的知识库检索分发；AES-256-GCM 凭证加密、docreader gRPC TLS、Token；智谱嵌入器、华为 OBS；服务端用户偏好设置；Go 1.26.0。参见 docs/RBAC说明.md 和 CHANGELOG.md。
• v0.5.2 — Wiki 导入扩展到 40k 文档知识库（任务队列 DLQ）；MCP 人工介入工具审批；Anthropic / Apache Doris / 腾讯 VectorDB / KS3 / SearXNG 后端；自适应三层分块并实时预览；全局 ⌘K 命令面板；语雀连接器和微信小程序；weknora CLI 预览。
• v0.5.1 — 知识库批处理管理;工作区范围的即时通讯通道概述;会话搜索用户范围固定;统一模型/网页搜索/MCP设置卡;每个代理的LLM超时;桌面工作区切换。
• v0.5.0 — 维基模式GA — 代理自动生成结构化、互联的Markdown维基页面，并带有知识图谱;UI中的维基浏览器可视化图表。
• v0.4.0 — WeKnora Cloud（托管LLM解析）;Chrome扩展;ClawHub技能;微信即时通讯;附件处理;Azure OpenAI / 阿里巴巴OSS;Notion连接器;百度Ollama网页搜索;VectorStore管理。
• v0.3.6 — ASR（音频）;Feishu数据源自动同步;OIDC;即时通讯引用-回复上下文线程会话;文档摘要;Tavily搜索;并行工具调用;代理@mention范围限制。
• v0.3.5 — Telegram / DingTalk / Mattermost IM;IM 斜接命令 QA 队列;建议问题;VLM 自动描述 MCP 工具镜像;Novita AI;通道跟踪。
• v0.3.4 — 企业微信 / 飞书 / Slack 即时消息；多模态图片支持；NVIDIA 模型 API；Weaviate；AWS S3；AES-256-GCM API 密钥加密；内置 MCP 服务；混合搜索优化；final_answer 工具。
• v0.3.3 — 父子分块;键键固定;备份响应;重排序通道清理;存储自动创建;Milvus。
• v0.3.2 — 知识搜索入口；每来源解析器和存储引擎配置；本地存储的图像渲染；文档预览；Volcengine 服务条款；Mermaid 渲染；批量会话管理；内存图预览。
• v0.3.0 — 共享空间；代理技能沙箱执行；自定义代理；数据分析代理；思考模式；Bing / Google 网络搜索；API 密钥认证；Helm 图；韩语本地化；Qdrant。
• v0.2.0 — 代理模式（ReACT）；多类型知识库（FAQ 和文档）；会话策略配置；DuckDuckGo 网络搜索；MCP 工具集成；带代理模式切换的新界面；MQ 异步任务管理。

📱 界面展示

🏗️ 架构

从文档解析、向量化和检索到大语言模型推理的全模块化流程——每个组件都是可替换和可扩展的。支持本地/私有云部署，实现完全的数据主权，并提供零门槛的网页用户界面以快速上手。

🧩 功能概览

智能对话

知识管理

集成与扩展

平台

🧩 Chrome 扩展

WeKnora Chrome 扩展 让你可以将网页内容直接捕捉到你的 WeKnora 知识库中。在浏览器中选择文本、图片或整页内容，一键保存为知识条目——无需复制粘贴或上传文件。

📱 微信小程序

WeKnora 小程序 提供了一个轻量级的移动客户端，用于配置 WeKnora API 访问、选择知识库、导入 URL，以及通过微信进行知识聊天。

🦞 爪中心技能

WeKnora ClawHub 技能 是在 ClawHub 平台上发布的 WeKnora 技能。安装后，它可以通过 WeKnora REST API 实现文档导入（文件 / URL / Markdown）、跨知识库的混合搜索（向量 + 关键词）以及知识条目管理。

• 文档导入 — 上传文件、导入网页或通过代理写入Markdown知识
• 混合搜索——利用向量关键词检索在知识库内或跨知识库进行搜索
• 知识管理 — 以编程方式列出、浏览、编辑和删除知识条目

🐋 DeepSeek Harness 插件

@wxg-prc-cpg/dsh-weknora 是官方 DeepSeek Harness (dsh) 插件 (文档)。该 harness 本身不提供检索、嵌入或知识库功能，因此该插件将你的文档提供给编程代理：dsh plugin --profile web add @wxg-prc-cpg/dsh-weknora，指向一个部署，代理工具集中会出现四个只读工具。

• weknora_search — 混合检索，逐字返回来源段落，每段都有可重用的 knowledge_id
• weknora_read_document — 将单个文档的段落按顺序重新组合，可分页
• weknora_ask — WeKnora 自身生成的答案，附带引用，可通过 RAG 或 ReAct 流程
• weknora_list_knowledge_bases — 知识库名称和 ID，使代理可以限定自己的搜索范围

⌨️ 命令行界面

weknora 是官方 CLI，用于从终端或 AI 代理驱动 API。它是 以代理为先 的：每个命令默认输出稳定的 JSON 封装（带类型化错误代码，对应退出码），并且 --format text 可为人类渲染。它还提供精心策划的 MCP 工具界面（weknora mcp serve）并带有内置代理技能。

weknora profile add prod --host https://kb.example.com --use
weknora auth login
weknora kb list
weknora link --kb my-knowledge-base    # bind the current directory
weknora doc upload notes.md
weknora chat "summarise the design doc"

对于无头/CI 使用，设置 WEKNORA_API_KEY 和 WEKNORA_HOST 并完全跳过 auth login —— 不会将任何凭据写入磁盘。

请参阅 cli/README.md 获取安装和 5 分钟快速入门指南，以及 cli/AGENTS.md 了解操作合约 AI 代理依赖的内容。

🚀 快速入门

🛠 先决条件

• Docker 和 Docker Compose
• Git

📦 安装与启动

git clone https://github.com/Tencent/WeKnora.git
cd WeKnora
cp .env.example .env   # Edit .env as needed, see comments in the file
docker compose pull     # Pull the latest images
docker compose up -d    # Start core services

启动后，访问 http://localhost 开始使用。

要使用本地 Ollama 模型，请先运行 ollama serve > /dev/null 2>&1 &。

🔄 升级中

如果您已经运行 WeKnora 并下载了更新版本：

# Set WEKNORA_VERSION in .env to the target release (e.g. 0.7.0), or keep latest
docker compose pull     # Pull images matching WEKNORA_VERSION
docker compose up -d    # Recreate containers with new images

仅使用 docker compose up -d 会重用本地缓存的镜像，并可能导致 UI 版本与您下载的版本不同步。

🔧 可选服务（Docker Compose 配置文件）

添加 --profile 标志以启用附加组件。多个配置文件可以组合使用：

组合配置文件: docker compose --profile neo4j --profile minio pull && docker compose --profile neo4j --profile minio up -d

停止服务: docker compose down

🌐 服务 URL

MCP 服务器

请参考 MCP 配置指南 进行必要的设置。

🔌 使用微信对话开放平台

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

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

📘 API 参考

官方产品文档：website-docs/ — 完整文档集按“入门 → 架构 → 功能 → API → 客户端 → 开发”组织，涵盖约 360 个 API 端点、约 150 个环境变量及 9 个扩展点。该目录也是 VitePress 站点：执行 cd website-docs && npm install && npm run dev 可本地预览，或使用内部 Dockerfile 独立部署。

故障排查常见问题： 故障排查 FAQ

详细的 API 文档见： API 文档

产品计划及即将推出的功能： 路线图

README 内容已截断, 请前往 GitHub 查看完整内容。