WeKnora/README_JA.md at main · Tencent/WeKnora

プロジェクト紹介 · クイックスタート · 最新アップデート · 機能概要 · クライアント · ドキュメント · 開発ガイド

プロジェクト紹介

WeKnora（ウィーノラ） は、大規模言語モデル（LLM）をベースとしたオープンソースのナレッジフレームワークで、エンタープライズ向けの文書理解、セマンティック検索、推論に対応します。チームに散在する文書を集約し、検索・推論に使えるようにし、資料の更新に合わせて維持します。

weknora-intro.mp4

_{1 分 52 秒 · 1080p · ナレーションなし・英語の画面テキスト}

資料の検索には RAG、マルチステップのタスクには Agent、ナレッジの整理には Wiki。3 つの機能は同じナレッジベースを共有します。

01 RAG：根拠のある回答。ハイブリッド検索、マルチモーダル解析、原文引用。02 Agent：知識とツールでタスクを完了。マルチステップ推論、サンドボックス、ローカルブラウザ、MCP ツール、長期メモリ。03 Wiki：ドキュメントを Wiki に整理。自動整理、ナレッジグラフ、ロールバック。

Agent のツールボックス。 ClawHub / SkillHub / Git / ZIP からインストールしたスキルは、セッション単位で永続する Docker / E2B / Cube サンドボックスで動作し、チャットの横でインタラクティブターミナルとグラフィカルデスクトップを開けます。BrowserSkill 拡張機能を通じて Agent はユーザー自身の Chrome / Edge を操作でき、外部 MCP サービス（OAuth 対応）を接続してツールごとに有効化できます。

そのほか：

メモリとナレッジ整理：クロスセッション長期メモリが、ユーザーが確認したプロフィール・好み・事実を保持します。フォルダーアップロードは元のディレクトリ構造を保ち、検索チャンクは編集・差分比較・ロールバックできます。
データソースとフォーマット：Feishu ナレッジベース / Feishu クラウドドライブ / Confluence / GitLab / Tencent IMA / Notion / Yuque / DingTalk Docs / Seafile / RSS の自動同期（順次拡充中）。PDF、Word、画像、Excel、XMind など 10 以上のフォーマットに対応し、Office 文書は anydoc でプロセス内解析します。
チャネルと連携：WeChat Work、Feishu、Slack、Telegram などの IM で直接 Q&A、ウェブサイト埋め込み Widget で外部サイトにエージェントを公開、組み込み MCP Server で Cursor や Claude などの AI ツールと接続、スコープ付き API キーと Principal モデルでプログラム連携。
モデル：29 の組み込みベンダーと自動生成のモデルカタログ。OpenAI、DeepSeek、Qwen（Alibaba Cloud）、Zhipu、Hunyuan、Gemini、MiniMax、NVIDIA、LiteLLM、Ollama などに対応。
権限と運用：マルチワークスペース RBAC（4 階層ロール、リソース所有権、ワークスペース監査ログ）、ワークスペースごとの複数ストレージインスタンス、ランタイムタスクキューダッシュボードと Worker プール統治、Langfuse による Agent ステップ・トークン消費・パイプラインのトレーシング。
デプロイ：LLM、ベクトルデータベース、ストレージバックエンドはすべて差し替え可能。ローカルまたはプライベートクラウドにデプロイし、データを自社環境に置けます。

クイックスタート

_{オンライン}
WeChat 対話オープンプラットフォーム
ナレッジベースをオンラインで管理し、Q&A を公式アカウントやミニプログラムなどの WeChat シナリオに接続します。

プラットフォームを開く →

_クラウド
Tencent Cloud Lighthouse
アプリケーションテンプレートから WeKnora をデプロイし、自分のクラウドサーバーで運用します。

Tencent Cloud でデプロイ →

_{セルフホスト}
自分の環境にデプロイ
Docker または Kubernetes でデプロイし、モデル・ストレージ・ネットワークを自分で設定します。

Docker Compose でデプロイ ↓

Docker Compose でデプロイ

Docker、Docker Compose、Git が必要です。

git clone https://github.com/Tencent/WeKnora.git
cd WeKnora
cp .env.example .env    # 必要に応じて .env を編集（詳細はファイル内のコメント参照）
docker compose pull     # 最新イメージを取得
docker compose up -d    # コアサービスを起動

起動後、http://localhost にアクセスし、オンボーディングガイドに沿って設定してください。サンプルデータ付きの手順はクイックスタート（中国語）を参照してください。

Tip

ローカル Ollama モデルを使用する場合は、先に ollama serve > /dev/null 2>&1 & を実行してください。Ollama の埋め込みモデル名、OLLAMA_BASE_URL、メモリの注意は設定ドキュメントを参照してください。

サービス	URL
Web UI	`http://localhost`
バックエンド API	`http://localhost:8080`
Langfuse トレーシング	`http://localhost:3000`

オプションサービス

--profile フラグで追加コンポーネントを有効化します。複数の profile を組み合わせ可能です。

Profile	説明
(デフォルト)	コアサービス
`full`	全機能
`neo4j`	ナレッジグラフ (Neo4j)
`minio`	オブジェクトストレージ (MinIO)
`langfuse`	トレーシング (Langfuse)

docker compose --profile neo4j --profile minio pull
docker compose --profile neo4j --profile minio up -d
docker compose down     # サービスを停止

アップグレード

既存のデプロイがあり、新しい release をダウンロードした場合：

# .env の WEKNORA_VERSION を対象バージョン（例: 0.8.2）に設定、または latest のまま
docker compose pull     # WEKNORA_VERSION に一致するイメージを取得
docker compose up -d    # 新しいイメージでコンテナを再作成

Note

docker compose up -d のみではローカルキャッシュのイメージが再利用され、Web UI の表示バージョンがダウンロードした release と一致しない場合があります。v0.8.0 からアップグレードする前にアップグレードの注意事項を確認してください。

その他のデプロイ方法

方法	用途
Docker Compose	上記の標準デプロイ。全機能、複数サービス構成
Kubernetes (Helm)	本番クラスター。Chart は `helm/` にあります
Lite シングルバイナリ	ローカルや低リソース環境向け、外部依存なし（SQLite + インメモリキュー）。標準版との違いは Lite と標準版の違い（中国語）
デスクトップアプリ	GUI 付きの Lite ランタイム。ログイン不要で起動し、macOS ではホストサンドボックスを提供。インストーラーは未公開のため、ソースからビルドしてください

すべてのデプロイ形態、ハードウェア要件、構成例はインストールガイドを参照してください。

Warning

WeKnora にはログイン認証がありますが、本番環境でのデプロイでは以下を強く推奨します：

WeKnora サービスはパブリックインターネットではなく、内部 / プライベートネットワーク環境にデプロイする
情報漏洩を防ぐため、サービスを直接パブリックネットワークに公開しない
デプロイ環境に適切なファイアウォールルールとアクセス制御を設定する
セキュリティパッチと改善のため、定期的に最新バージョンに更新する

機能デモ

クイック Q&A とスマート推論

2 つの質問方法。 クイック Q&A はナレッジベースを RAG で検索して回答し、参照した出典を示します。スマート推論ではエージェントがマルチステップの作業を計画し、検索、文書の読み込み、ツールやスキルの呼び出しを行い、各ステップを会話内に表示します。ドキュメント →

ローカルブラウザ

コンピューターのブラウザを操作。 Tencent がオープンソースで公開する BrowserSkill 拡張機能を通じて、エージェントがあなたの Chrome や Edge でページを開き、フォームに入力します。ログインや CAPTCHA ではあなたに引き継ぎます。ドキュメント →

スキルとサンドボックス

スキルを実行し、ファイルを生成。 Docker、E2B、Cube に対応。同じセッションの複数ターンは 1 つのワークスペースを共有し、生成ファイルはプレビューとダウンロードができます。会話の横でグラフィカルデスクトップやインタラクティブターミナルを開き、エージェントの各ステップを確認し、必要に応じて操作を引き継げます。ドキュメント →

ツールボックス：MCP サービスとスキル

エージェントが使えるツール。 外部の MCP サービスを接続し、有効にするツールと承認が必要な呼び出しをツールごとに選べます。スキルは ClawHub、SkillHub、Git、ZIP からインストールしてワークスペースで管理し、各サンドボックスで再利用できます。ドキュメント →

自動 Wiki

ドキュメントを閲覧できる Wiki に。 Wiki を有効にすると、ナレッジベースの文書から人物・製品・概念を抽出し、出典付きのページを生成してディレクトリ別に閲覧できます。ナレッジグラフでページ間の関係を確認でき、ページは直接編集でき、変更はさかのぼれます。ドキュメント →

可観測性

トレーシングとランタイム監視。 Langfuse がエージェントの各ステップの推論、ツール呼び出し、トークン使用量を追跡します。文書解析タイムラインはステージごとの進捗を表示し、タスクキューダッシュボードは待機中と失敗したタスクを一覧します。ドキュメント →

アーキテクチャ設計

WeKnora アーキテクチャ：クライアントとチャネルが WeKnora アプリに接続し、RAG Q&A・Agent 推論・自動 Wiki が同じナレッジ処理パイプラインを共有。アプリはランタイムサービスを呼び出し、PostgreSQL・Redis と任意のストレージにデータを保存

文書解析・ベクトル化・検索から大規模モデル推論まで、各工程をモジュール化し、コンポーネントは差し替え・拡張できます。ローカルとプライベートクラウドへのデプロイに対応し、Web UI はすぐに使い始められます。詳しくは：アーキテクチャ概要 · RAG パイプライン · 拡張ポイント（中国語）。

機能概要

領域	主な機能
Q&A と Agent	クイック Q&A はナレッジベースから出典付きで回答し、スマート推論では ReAct エージェントがナレッジベース、Web 検索、MCP ツール、スキル、ローカルブラウザを組み合わせます。実行中の会話への要件追加・分岐・巻き戻しと、セッションをまたぐ長期メモリに対応
Wiki	エージェントが相互リンクされた Wiki ページとナレッジグラフを生成。ブラウザ内編集、バージョン差分とロールバック
スキルとサンドボックス	ClawHub / SkillHub / Git / ZIP からインストールするスキルカタログ。セッション単位で永続する Docker / E2B / Cube サンドボックスと設定単位のネットワークポリシー。チャットの横にインタラクティブターミナルとグラフィカルデスクトップ
ナレッジベース	FAQ・ドキュメント・Wiki の 3 種類。フォルダーツリー、チャンク編集とバージョン履歴、アップロード単位の解析・チャンキング・マルチモーダル設定、自動タグ付け
検索	キーワード + ベクトルのハイブリッド検索、リランク、親子チャンキング、GraphRAG（Neo4j）。リコール的中率と BLEU / ROUGE によるエンドツーエンド評価
権限とセキュリティ	4 階層ロールと監査ログを備えたワークスペース RBAC、スコープ付き API キー、OIDC、AES-256-GCM による資格情報の暗号化、SSRF 対策済みの外部通信とホワイトリスト限定モード
運用	Langfuse による Agent ステップ・トークン消費・パイプラインのトレーシング、ドキュメント解析タイムライン、Worker プール付きのタスクキューダッシュボード、バージョンアップ時の自動 DB マイグレーション

対応バックエンド

コンポーネント	選択肢
大規模モデル	29 の組み込みベンダー。OpenAI / Azure OpenAI / Anthropic / DeepSeek / Qwen（Alibaba Cloud）/ Zhipu / Hunyuan / Doubao（Volcengine）/ Gemini / MiniMax / NVIDIA / SiliconFlow / OpenRouter / LiteLLM / Ollama など
Embedding	Ollama / BGE / GTE / Zhipu / OpenAI 互換 API
ベクトル DB	PostgreSQL (pgvector) / Elasticsearch / OpenSearch / Milvus / Weaviate / Qdrant / Apache Doris / Tencent VectorDB
オブジェクトストレージ	ローカル / Tencent Cloud COS / MinIO / AWS S3 / 火山引擎 TOS / Alibaba Cloud OSS / 金山雲 KS3 / 華為雲 OBS
文書フォーマット	PDF / Word / PPT / Excel / CSV / TXT / Markdown / HTML / EPUB / MHTML / JSON / XMind / 画像
データソース	Feishu ナレッジベース / Feishu クラウドドライブ / Lark / Confluence / GitLab / Tencent IMA / Notion / Yuque / DingTalk Docs / Seafile / RSS
IM 統合	WeChat Work / Feishu / Lark / QQBot / Slack / Telegram / DingTalk / Mattermost / WeChat / Yunzhijia
Web 検索	DuckDuckGo / Bing / Google / Tavily / Baidu / Ollama / SearXNG / Keenable / Zhipu AI / Exa / Metaso / Bocha / Serply
デプロイ	Docker Compose / Kubernetes (Helm) / Lite シングルバイナリ / デスクトップアプリ。オフライン・プライベートクラウドに対応。UI は中国語 / 英語 / 日本語 / 韓国語 / ロシア語

クライアントとエコシステム

	クライアント	用途
	CLI `weknora`	Agent ファーストのコマンドライン。API 全体を扱え、厳選した MCP ツールと同梱の Agent Skills を提供
	組み込み MCP Server	Streamable HTTP でナレッジベースを Cursor、Claude などの MCP クライアントに公開。`mcp-server/` の Python サーバーは非推奨
	ローカルブラウザ（BrowserSkill）	エージェントがユーザー自身の Chrome / Edge を操作
	Chrome 拡張機能	テキスト、画像、ページ全体を選択してワンクリックでナレッジエントリとして保存。コピペやファイルアップロードは不要
	WeChat ミニプログラム	軽量なモバイルクライアント。API の設定、ナレッジベースの選択、URL のインポート、WeChat からのナレッジ Q&A
	ClawHub Skill	ClawHub で公開された WeKnora スキル。REST API でドキュメントのインポート、ハイブリッド検索、ナレッジ管理
	DeepSeek Harness プラグイン	`dsh` のコーディングエージェントに 4 つの読み取り専用ツール（検索、ドキュメント読み取り、質問、ナレッジベース一覧）を提供
	ウェブ埋め込み Widget	エージェントを外部サイトに公開
	Go SDK	ナレッジベース・ドキュメント・セッションなどの CRUD と SSE ストリーミング Q&A
	WeChat 対話オープンプラットフォーム	WeKnora をベースにしたホスティング型 Q&A。ナレッジをアップロードするだけで WeChat 内に Q&A サービスを公開

コマンドラインツール

weknora は、ターミナルや AI エージェントから API を操作するための公式 CLI です。Agent ファーストの設計で、すべてのコマンドは既定で安定した JSON エンベロープを出力し（型付きエラーコードは終了コードに対応）、--format text で人間向けに表示します。厳選した MCP ツール（weknora mcp serve）も提供し、Agent Skills を同梱しています。

weknora profile add prod --host https://kb.example.com --use
weknora auth login
weknora kb list
weknora link --kb my-knowledge-base    # 現在のディレクトリを紐づけ
weknora doc upload notes.md
weknora chat "設計ドキュメントを要約して"

ヘッドレス / CI 環境では WEKNORA_API_KEY と WEKNORA_HOST を設定すれば auth login は不要で、資格情報はディスクに書き込まれません。インストールと 5 分間のクイックスタートは cli/README.md、AI エージェントが依存する運用上の約束は cli/AGENTS.md を参照してください。

ドキュメント

製品ドキュメントは weknora.weixin.qq.com/docs（中国語）にあります。「入門 → アーキテクチャ → 機能 → API → クライアント → 開発」の 6 セクションで構成され、約 360 の API エンドポイント、約 150 の環境変数、9 つの拡張ポイントを網羅しています。

ここから
製品紹介	機能の概要
インストール	Docker Compose、Helm、Lite、デスクトップ
設定	環境変数とモデル設定
トラブルシューティング	よくある問題と解決方法
API ドキュメント	REST API の概要
リリースノート	各バージョンの変更点

開発ガイド

コードを頻繁に変更する場合、Docker イメージを毎回再構築する必要はありません。高速開発モードを使用してください：

make dev-start      # インフラストラクチャを起動
make dev-app        # バックエンドを起動（新しいターミナル）
make dev-frontend   # フロントエンドを起動（新しいターミナル）

フロントエンドの変更は自動ホットリロード（再起動不要）
バックエンドの変更は高速再起動（5-10 秒、Air ホットリロード対応）
Docker イメージの再構築が不要
IDE のブレークポイントデバッグに対応

詳細は開発環境クイックスタート（中国語）を参照してください。

ドキュメントサイトと製品ホームページのソースは website-docs/ にあります。Node.js 24 で cd website-docs && npm run setup && npm run build && npm run preview を実行すると両方をプレビューできます。統合された静的出力は / でホームページ、/docs/ でドキュメントを配信します。Nginx と Docker でのデプロイ方法は同ディレクトリの README を参照してください。

貢献ガイド

Issue や Pull Request の提出を歓迎します。

フロー： Fork → ブランチ作成 → 変更をコミット → PR を作成
規約： gofmt でコードをフォーマットし、Conventional Commits に従う（feat: / fix: / docs: / test: / refactor:）

変更の検証

範囲を絞った PR では、まず変更した範囲を検証してください：

git fetch origin main
git diff --check origin/main...HEAD
golangci-lint run --new-from-rev=origin/main ./...
go test ./path/to/changed/package -count=1

コミット前に、変更した Go ファイルに gofmt を実行してください。フロントエンドの変更では frontend/ で関連するテストを実行し、TypeScript や Vue コンポーネントに影響する場合は npm run type-check も実行してください。

メンテナーが使うリポジトリ全体の検証コマンドは次のとおりです：

make fmt
make lint
make test

make fmt はリポジトリ全体の Go コードをフォーマットするため、ワークツリーがクリーンな状態でのみ実行し、生じた差分を確認してください。一部の全体テストはローカルのインフラやサービス設定を必要とします。無関係なベースラインや環境の理由で全体チェックが失敗した場合は、実行したコマンドとエラーを PR に記載し、変更範囲の対象テストが通ることを示してください。

コントリビューター

すべてのコントリビューターに感謝します：

ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。このプロジェクトのコードを自由に使用、変更、配布できますが、元の著作権表示を保持する必要があります。

Navigation Menu

Repository navigation

プロジェクト紹介

クイックスタート

Docker Compose でデプロイ

オプションサービス

アップグレード

その他のデプロイ方法

最新アップデート

v0.8.2 _{· 2026-09-24 · リリースノート}

v0.8.0 _{· リリースノート}

機能デモ

クイック Q&A とスマート推論

ローカルブラウザ

スキルとサンドボックス

ツールボックス：MCP サービスとスキル

自動 Wiki

可観測性

アーキテクチャ設計

機能概要

対応バックエンド

クライアントとエコシステム

コマンドラインツール

ドキュメント

開発ガイド

貢献ガイド

コントリビューター

ライセンス

FilesExpand file tree

README_JA.md

Latest commit

History

README_JA.md

File metadata and controls

プロジェクト紹介

クイックスタート

Docker Compose でデプロイ

オプションサービス

アップグレード

その他のデプロイ方法

最新アップデート

v0.8.2 · 2026-09-24 · リリースノート

v0.8.0 · リリースノート

機能デモ

クイック Q&A とスマート推論

ローカルブラウザ

スキルとサンドボックス

ツールボックス：MCP サービスとスキル

自動 Wiki

可観測性

アーキテクチャ設計

機能概要

対応バックエンド

クライアントとエコシステム

コマンドラインツール

ドキュメント

開発ガイド

貢献ガイド

コントリビューター

ライセンス

v0.8.2 _{· 2026-09-24 · リリースノート}

v0.8.0 _{· リリースノート}