docs: 更新多语言文档，新增知识图谱与MCP配置指南及目录结构

2025-11-24 19:12:51 +08:00 · 2025-11-19 16:47:58 +08:00
parent a910bae6cd
commit 3a2c86df5b
6 changed files with 92 additions and 82 deletions
--- a/README.md
+++ b/README.md
@@ -256,9 +256,7 @@ make clean-db

 http://localhost

-On first access, it will automatically redirect to the initialization configuration page. After configuration is complete, it will automatically redirect to the knowledge base page. Please follow the page instructions to complete model configuration.
-
-![Configuration Page](./docs/images/config.png)
+On your first visit, you will be automatically redirected to the registration/login page. After completing registration, please create a new knowledge base and finish the relevant settings on its configuration page.

 ## 📱 Interface Showcase

@@ -278,17 +276,13 @@ On first access, it will automatically redirect to the initialization configurat

 ### Document Knowledge Graph

-<table>
-  <tr>
-    <td><img src="./docs/images/graph2.png" alt="Knowledge Graph View 1"></td>
-    <td><img src="./docs/images/graph1.png" alt="Knowledge Graph View 2"></td>
-  </tr>
-</table>
-
 WeKnora supports transforming documents into knowledge graphs, displaying the relationships between different sections of the documents. Once the knowledge graph feature is enabled, the system analyzes and constructs an internal semantic association network that not only helps users understand document content but also provides structured support for indexing and retrieval, enhancing the relevance and breadth of search results.

-### MCP Server Integration Effects
-<img width="950" height="2063" alt="MCP Server Integration Demo" src="https://github.com/user-attachments/assets/09111ec8-0489-415c-969d-aa3835778e14" />
+For detailed configuration, please refer to the [Knowledge Graph Configuration Guide](./docs/KnowledgeGraph.md).
+
+### MCP Server
+
+Please refer to the [MCP Configuration Guide](./mcp-server/MCP_CONFIG.md) for the necessary setup.

 ## 📘 API Reference

@@ -302,21 +296,17 @@ Detailed API documentation is available at: [API Docs](./docs/API.md)

 ```
 WeKnora/
+├── client/      # go client
 ├── cmd/         # Main entry point
-├── internal/    # Core business logic
 ├── config/      # Configuration files
-├── migrations/  # DB migration scripts
-├── scripts/     # Shell scripts
-├── services/    # Microservice logic
+├── docker/      # docker images files
+├── docreader/   # Document parsing app
+├── docs/        # Project documentation
 ├── frontend/    # Frontend app
-└── docs/        # Project documentation
-```
-
-### 🔧 Common Commands
-
-```bash
-# Wipe all data from DB (use with caution)
-make clean-db
+├── internal/    # Core business logic
+├── mcp-server/  # MCP server
+├── migrations/  # DB migration scripts
+└── scripts/     # Shell scripts
 ```

 ## 🤝 Contributing
--- a/README_CN.md
+++ b/README_CN.md
@@ -194,12 +194,17 @@ WeKnora 作为[微信对话开放平台](https://chatbot.weixin.qq.com)的核心
 - **零代码部署**：只需上传知识，即可在微信生态中快速部署智能问答服务，实现"即问即答"的体验
 - **高效问题管理**：支持高频问题的独立分类管理，提供丰富的数据工具，确保回答精准可靠且易于维护
 - **微信生态覆盖**：通过微信对话开放平台，WeKnora 的智能问答能力可无缝集成到公众号、小程序等微信场景中，提升用户交互体验
-### 🔗MCP服务器访问已经部署好的WEKnora
+
+### 🔗 MCP 服务器访问已经部署好的 WeKnora
+
 #### 1️⃣克隆储存库
+
 ```
 git clone https://github.com/Tencent/WeKnora
 ```
+
 #### 2️⃣配置MCP服务器
+
 > 推荐直接参考 [MCP配置说明](./mcp-server/MCP_CONFIG.md) 进行配置。

 mcp客户端配置服务器
@@ -219,6 +224,7 @@ mcp客户端配置服务器
  }
 }
 ```
+
 使用stdio命令直接运行
 ```
 pip install weknora-mcp-server
@@ -252,10 +258,7 @@ make clean-db

 http://localhost

-首次访问会自动跳转到初始化配置页面，配置完成后会自动跳转到知识库页面。请按照页面提示信息完成模型的配置。
-
-![配置页面](./docs/images/config.png)
-
+首次访问会自动跳转到注册登录页面，完成注册后，请创建一个新的知识库，并在该知识库的设置页面完成相关设置。

 ## 📱 功能展示

@@ -275,17 +278,13 @@ http://localhost

 ### 文档知识图谱

-<table>
-  <tr>
-    <td><img src="./docs/images/graph2.png" alt="知识图谱展示1"></td>
-    <td><img src="./docs/images/graph1.png" alt="知识图谱展示2"></td>
-  </tr>
-</table>
-
 WeKnora 支持将文档转化为知识图谱，展示文档中不同段落之间的关联关系。开启知识图谱功能后，系统会分析并构建文档内部的语义关联网络，不仅帮助用户理解文档内容，还为索引和检索提供结构化支撑，提升检索结果的相关性和广度。
-### 配套MCP服务器调用效果
-<img width="950" height="2063" alt="118d078426f42f3d4983c13386085d7f" src="https://github.com/user-attachments/assets/09111ec8-0489-415c-969d-aa3835778e14" />

+具体配置请参考 [知识图谱配置说明](./docs/KnowledgeGraph.md) 进行相关配置。
+
+### 配套MCP服务器
+
+请参考 [MCP配置说明](./mcp-server/MCP_CONFIG.md) 进行相关配置。

 ## 📘 文档

@@ -299,21 +298,17 @@ WeKnora 支持将文档转化为知识图谱，展示文档中不同段落之间

 ```
 WeKnora/
+├── client/      # go客户端
 ├── cmd/         # 应用入口
-├── internal/    # 核心业务逻辑
 ├── config/      # 配置文件
-├── migrations/  # 数据库迁移脚本
-├── scripts/     # 启动与工具脚本
-├── services/    # 各子服务实现
+├── docker/      # docker 镜像文件
+├── docreader/   # 文档解析项目
+├── docs/        # 项目文档
 ├── frontend/    # 前端项目
-└── docs/        # 项目文档
-```
-
-### 🔧 常用命令
-
-```bash
-# 清空数据库（慎用！）
-make clean-db
+├── internal/    # 核心业务逻辑
+├── mcp-server/  # MCP服务器
+├── migrations/  # 数据库迁移脚本
+└── scripts/     # 启动与工具脚本
 ```

 ## 🤝 贡献指南
--- a/README_JA.md
+++ b/README_JA.md
@@ -195,12 +195,15 @@ WeKnoraは[WeChat対話オープンプラットフォーム](https://chatbot.wei
 - **効率的な問題管理**：高頻度の問題の独立した分類管理をサポートし、豊富なデータツールを提供して、正確で信頼性が高く、メンテナンスが容易な回答を保証
 - **WeChatエコシステムカバレッジ**：WeChat対話オープンプラットフォームを通じて、WeKnoraのインテリジェントQ&A能力を公式アカウント、ミニプログラムなどのWeChatシナリオにシームレスに統合し、ユーザーインタラクション体験を向上

-### 🔗MCPサーバーを使用してデプロイ済みのWeKnoraにアクセス
+### 🔗 MCP サーバーを使用してデプロイ済みの WeKnora にアクセス
+
 #### 1️⃣リポジトリのクローン
 ```
 git clone https://github.com/Tencent/WeKnora
 ```
-#### 2️⃣MCPサーバーの設定
+
+#### 2️⃣ MCPサーバーの設定
+
 > 設定には直接 [MCP設定説明](./mcp-server/MCP_CONFIG.md) を参照することをお勧めします。

 MCPクライアントでサーバーを設定
@@ -220,6 +223,7 @@ MCPクライアントでサーバーを設定
  }
 }
 ```
+
 stdioコマンドで直接実行
 ```
 pip install weknora-mcp-server
@@ -253,10 +257,7 @@ make clean-db

 http://localhost

-初回アクセス時は自動的に初期設定ページにリダイレクトされ、設定完了後は自動的にナレッジベースページにリダイレクトされます。ページの指示に従ってモデルの設定を完了してください。
-
-![設定ページ](./docs/images/config.png)
-
+初回アクセス時は自動的に登録・ログインページに遷移します。登録完了後、新規にナレッジベースを作成し、その設定画面で必要な項目を構成してください。

 ## 📱 機能デモ

@@ -276,17 +277,13 @@ http://localhost

 ### 文書ナレッジグラフ

-<table>
-  <tr>
-    <td><img src="./docs/images/graph2.png" alt="ナレッジグラフ表示1"></td>
-    <td><img src="./docs/images/graph1.png" alt="ナレッジグラフ表示2"></td>
-  </tr>
-</table>
-
 WeKnoraは文書をナレッジグラフに変換し、文書内の異なる段落間の関連関係を表示することをサポートします。ナレッジグラフ機能を有効にすると、システムは文書内部の意味関連ネットワークを分析・構築し、ユーザーが文書内容を理解するのを助けるだけでなく、インデックスと検索に構造化サポートを提供し、検索結果の関連性と幅を向上させます。

-### 対応MCPサーバー呼び出し効果
-<img width="950" height="2063" alt="118d078426f42f3d4983c13386085d7f" src="https://github.com/user-attachments/assets/09111ec8-0489-415c-969d-aa3835778e14" />
+詳細な設定については、[ナレッジグラフ設定ガイド](./docs/KnowledgeGraph.md)をご参照ください。
+
+### 対応するMCPサーバー  
+
+[MCP設定ガイド](./mcp-server/MCP_CONFIG.md) をご参照のうえ、必要な設定を行ってください。


 ## 📘 ドキュメント
@@ -300,22 +297,18 @@ WeKnoraは文書をナレッジグラフに変換し、文書内の異なる段
 ### 📁 プロジェクトディレクトリ構造

 ```
-WeKnora/
-├── cmd/         # アプリケーションエントリー
-├── internal/    # コアビジネスロジック
-├── config/      # 設定ファイル
-├── migrations/  # データベースマイグレーションスクリプト
-├── scripts/     # 起動とツールスクリプト
-├── services/    # 各サブサービスの実装
-├── frontend/    # フロントエンドプロジェクト
-└── docs/        # プロジェクトドキュメント
-```
-
-### 🔧 よく使うコマンド
-
-```bash
-# データベースをクリア（注意して使用！）
-make clean-db
+WeKnora/  
+├── client/      # Goクライアント  
+├── cmd/         # アプリケーションエントリ  
+├── config/      # 設定ファイル  
+├── docker/      # Dockerイメージファイル  
+├── docreader/   # 文書解析プロジェクト  
+├── docs/        # プロジェクトドキュメント  
+├── frontend/    # フロントエンドプロジェクト  
+├── internal/    # コアビジネスロジック  
+├── mcp-server/  # MCPサーバー  
+├── migrations/  # データベースマイグレーションスクリプト  
+└── scripts/     # 起動およびツールスクリプト
 ```

 ## 🤝 貢献ガイド
--- a/docs/KnowledgeGraph.md
+++ b/docs/KnowledgeGraph.md
@@ -0,0 +1,28 @@
+# WeKnora 知识图谱
+
+## 快速开始
+
+- .env 配置相关环境变量
+    - 启用 Neo4j: `NEO4J_ENABLE=true`
+    - Neo4j URI: `NEO4J_URI=bolt://neo4j:7687`
+    - Neo4j 用户名: `NEO4J_USERNAME=neo4j`
+    - Neo4j 密码: `NEO4J_PASSWORD=password`
+
+- 启动 Neo4j
+```bash
+docker-compose --profile neo4j up -d
+```
+
+- 在知识库设置页面启用实体和关系提取，并根据提示配置相关内容
+
+## 生成图谱
+
+上传任意文档后，系统会自动提取实体和关系，并生成对应的知识图谱。
+
+![知识图片示例](./images/graph3.png)
+
+## 查看图谱
+
+登陆 `http://localhost:7474`，执行 `match (n) return (n)` 即可查看生成的知识图谱。
+
+在对话时，系统会自动查询知识图谱，并获取相关知识。
--- a/docs/images/graph3.png
+++ b/docs/images/graph3.png
--- a/mcp-server/README.md
+++ b/mcp-server/README.md
@@ -136,4 +136,8 @@ python test_module.py
 如果遇到导入错误，请确保：
 1. 已安装所有必需的依赖包
 2. Python 版本兼容（推荐 3.10+）
-3. 没有文件名冲突（避免使用 `mcp.py` 作为文件名）
+3. 没有文件名冲突（避免使用 `mcp.py` 作为文件名）
+
+## 调用效果
+
+<img width="950" height="2063" alt="118d078426f42f3d4983c13386085d7f" src="https://github.com/user-attachments/assets/09111ec8-0489-415c-969d-aa3835778e14" />