From 115bc826c2dda75ee22b371fc2ee250e5166a92d Mon Sep 17 00:00:00 2001 From: wizardchen Date: Thu, 2 Apr 2026 11:54:14 +0800 Subject: [PATCH] docs: update README files to streamline section headings and remove redundant content across multiple languages --- README.md | 23 ++--------------------- README_CN.md | 8 +++----- README_JA.md | 23 +++-------------------- README_KO.md | 13 +++---------- 4 files changed, 11 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 805074b4..64b325a6 100644 --- a/README.md +++ b/README.md @@ -268,8 +268,6 @@ Once started, services will be available at: ## 📱 Interface Showcase -### Web UI Interface - @@ -283,23 +281,12 @@ Once started, services will be available at:
Intelligent Q&A Conversation
Intelligent Q&A Conversation
-**Knowledge Base Management:** Support for creating FAQ and document knowledge base types, with multiple import methods including drag-and-drop, folder import, and URL import. Automatically identifies document structures and extracts core knowledge to establish indexes. Supports tag management and online entry. The system clearly displays processing progress and document status, achieving efficient knowledge base management. -**Agent Mode:** Support for ReACT Agent mode that can use built-in tools to retrieve knowledge bases, call user-configured MCP tools and web search tools to access external services, providing comprehensive summary reports through multiple iterations and reflection. Supports cross-knowledge base retrieval, allowing selection of multiple knowledge bases for simultaneous retrieval. - -**Conversation Strategy:** Support for configuring Agent models, normal mode models, retrieval thresholds, and online Prompt configuration, with precise control over multi-turn conversation behavior and retrieval execution methods. The conversation input box supports Agent mode/normal mode switching, enabling/disabling web search, and selecting conversation models. - -### Document Knowledge Graph - -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. - -For detailed configuration, please refer to the [Knowledge Graph Configuration Guide](./docs/KnowledgeGraph.md). - -### MCP Server +## MCP Server Please refer to the [MCP Configuration Guide](./mcp-server/MCP_CONFIG.md) for the necessary setup. -### 🔌 Using WeChat Dialog Open Platform +## 🔌 Using WeChat Dialog Open Platform WeKnora serves as the core technology framework for the [WeChat Dialog Open Platform](https://chatbot.weixin.qq.com), providing a more convenient usage approach: @@ -307,12 +294,6 @@ WeKnora serves as the core technology framework for the [WeChat Dialog Open Plat - **Efficient Question Management**: Support for categorized management of high-frequency questions, with rich data tools to ensure accurate, reliable, and easily maintainable answers - **WeChat Ecosystem Integration**: Through the WeChat Dialog Open Platform, WeKnora's intelligent Q&A capabilities can be seamlessly integrated into WeChat Official Accounts, Mini Programs, and other WeChat scenarios, enhancing user interaction experiences -### 🔗 Access WeKnora via MCP Server - -#### 1️⃣ Clone the repository -``` -git clone https://github.com/Tencent/WeKnora -``` ## 📘 API Reference diff --git a/README_CN.md b/README_CN.md index a5062acf..96f9341b 100644 --- a/README_CN.md +++ b/README_CN.md @@ -275,8 +275,6 @@ docker compose down ## 📱 功能展示 -### Web UI 界面 - @@ -292,17 +290,17 @@ docker compose down -### 文档知识图谱 +## 文档知识图谱 WeKnora 支持将文档转化为知识图谱，展示文档中不同段落之间的关联关系。开启知识图谱功能后，系统会分析并构建文档内部的语义关联网络，不仅帮助用户理解文档内容，还为索引和检索提供结构化支撑，提升检索结果的相关性和广度。 具体配置请参考 [知识图谱配置说明](./docs/KnowledgeGraph.md) 进行相关配置。 -### 配套MCP服务器 +## 配套MCP服务器 请参考 [MCP配置说明](./mcp-server/MCP_CONFIG.md) 进行相关配置。 -### 🔌 使用微信对话开放平台 +## 🔌 使用微信对话开放平台 WeKnora 作为[微信对话开放平台](https://chatbot.weixin.qq.com)的核心技术框架，提供更简便的使用方式： diff --git a/README_JA.md b/README_JA.md index 73b7c1a7..1aa50e85 100644 --- a/README_JA.md +++ b/README_JA.md @@ -138,15 +138,6 @@ Feishuなどの外部プラットフォームからのナレッジ自動同期 文書解析・ベクトル化・検索から大規模モデル推論まで、全パイプラインをモジュラー分離。各コンポーネントは柔軟に差し替え・拡張可能。ローカル / プライベートクラウドデプロイに対応し、データ完全自己管理、ゼロバリアの Web UI で即座に利用開始。 -## 📊 適用シナリオ - -| 応用シナリオ | 具体的な応用 | コア価値 | -|---------|----------|----------| -| **企業ナレッジ管理** | 内部文書検索、規則Q&A、操作マニュアル照会 | ナレッジ検索効率の向上、トレーニングコストの削減 | -| **科学研究文献分析** | 論文検索、研究レポート分析、学術資料整理 | 文献調査の加速、研究意思決定の支援 | -| **製品技術サポート** | 製品マニュアルQ&A、技術文書検索、トラブルシューティング | カスタマーサービス品質の向上、技術サポート負担の軽減 | -| **法的コンプライアンス審査** | 契約条項検索、法規政策照会、ケース分析 | コンプライアンス効率の向上、法的リスクの削減 | -| **医療知識支援** | 医学文献検索、診療ガイドライン照会、症例分析 | 臨床意思決定の支援、診療品質の向上 | ## 🧩 機能概要 @@ -279,8 +270,6 @@ docker compose down ## 📱 機能デモ -### Web UIインターフェース -
智能问答对话
智能问答对话
@@ -294,24 +283,18 @@ docker compose down
インテリジェントQ&A対話
インテリジェントQ&A対話
-**ナレッジベース管理：** FAQとドキュメントの2種類のナレッジベースの作成をサポート、ドラッグ＆ドロップアップロード、フォルダーインポート、URLインポートなど複数の方法をサポート、文書構造を自動認識してコア知識を抽出し、インデックスを構築します。タグ管理とオンライン入力をサポート、システムは処理の進行状況と文書のステータスを明確に表示し、効率的なナレッジベース管理を実現します。 - -**Agentモード：** ReACT Agentモードの有効化をサポート、組み込みツールでナレッジベースを検索、ユーザーが設定したMCPツールとWeb検索ツールを呼び出して外部サービスにアクセス、複数回の反復とリフレクションを通じて、最終的に包括的なサマリーレポートを提供します。クロスナレッジベース検索をサポート、複数のナレッジベースを同時に検索できます。 - -**対話戦略：** Agentモデル、通常モードに必要なモデル、検索閾値の設定をサポート、オンラインPrompt設定をサポート、マルチターン対話の動作と検索リコールの実行方法を精密に制御します。対話入力ボックスはAgentモード/通常モードの切り替えをサポート、Web検索の有効化/無効化をサポート、対話モデルの選択をサポートします。 - -### 文書ナレッジグラフ +## 文書ナレッジグラフ WeKnoraは文書をナレッジグラフに変換し、文書内の異なる段落間の関連関係を表示することをサポートします。ナレッジグラフ機能を有効にすると、システムは文書内部の意味関連ネットワークを分析・構築し、ユーザーが文書内容を理解するのを助けるだけでなく、インデックスと検索に構造化サポートを提供し、検索結果の関連性と幅を向上させます。 詳細な設定については、[ナレッジグラフ設定ガイド](./docs/KnowledgeGraph.md)をご参照ください。 -### 対応するMCPサーバー +## 対応するMCPサーバー [MCP設定ガイド](./mcp-server/MCP_CONFIG.md) をご参照のうえ、必要な設定を行ってください。 -### 🔌 WeChat対話オープンプラットフォームの使用 +## 🔌 WeChat対話オープンプラットフォームの使用 WeKnoraは[WeChat対話オープンプラットフォーム](https://chatbot.weixin.qq.com)のコア技術フレームワークとして、より簡単な使用方法を提供します： diff --git a/README_KO.md b/README_KO.md index f6732b83..b99024c6 100644 --- a/README_KO.md +++ b/README_KO.md @@ -278,8 +278,6 @@ docker compose down ## 📱 인터페이스 소개 -### Web UI 인터페이스 - @@ -293,23 +291,18 @@ docker compose down
지능형 Q&A 대화
지능형 Q&A 대화
-**지식베이스 관리:** FAQ/문서 지식베이스 타입 생성 지원, 드래그 앤 드롭/폴더/URL 임포트 등 다양한 방식 지원. 문서 구조를 자동 식별하고 핵심 지식을 추출해 인덱스를 구축합니다. 태그 관리와 온라인 입력을 지원하며, 처리 진행 상황과 문서 상태를 명확히 표시해 효율적인 지식베이스 운영을 돕습니다. -**Agent 모드:** ReACT Agent 모드를 지원하며, 내장 도구로 지식베이스 검색, 사용자 설정 MCP 도구 및 웹 검색 도구 호출을 통해 외부 서비스 접근이 가능합니다. 다중 반복과 리플렉션을 통해 종합 요약 리포트를 제공합니다. 교차 지식베이스 검색도 지원하여 여러 지식베이스를 동시에 검색할 수 있습니다. - -**대화 전략:** Agent 모델, 일반 모드 모델, 검색 임계값, 온라인 프롬프트 설정을 지원하여 멀티턴 대화 동작과 검색 실행 방식을 정밀하게 제어할 수 있습니다. 입력창에서 Agent/일반 모드 전환, 웹 검색 활성화/비활성화, 대화 모델 선택을 지원합니다. - -### 문서 지식 그래프 +## 문서 지식 그래프 WeKnora는 문서를 지식 그래프로 변환해 문서 내 서로 다른 섹션 간 관계를 시각화할 수 있습니다. 지식 그래프 기능을 활성화하면 문서 내부의 시맨틱 연관 네트워크를 분석/구성하여 문서 이해를 돕고, 인덱싱과 검색에 구조화된 지원을 제공해 검색 결과의 관련성과 폭을 향상시킵니다. 자세한 설정은 [지식 그래프 설정 가이드](./docs/KnowledgeGraph.md)를 참고하세요. -### MCP 서버 +## MCP 서버 필요한 설정은 [MCP 설정 가이드](./mcp-server/MCP_CONFIG.md)를 참고하세요. -### 🔌 WeChat 대화 오픈 플랫폼 사용 +## 🔌 WeChat 대화 오픈 플랫폼 사용 WeKnora는 [WeChat 대화 오픈 플랫폼](https://chatbot.weixin.qq.com)의 핵심 기술 프레임워크로 사용되며, 보다 간편한 사용 방식을 제공합니다: