ホーム Architecture Guide (EN) GitHub

AI Knowledge Base Platform - README (JA)

日本企業向けナレッジベース基盤の OSS 実装です。このページは README_ja.md の内容を静的サイト向けに整形した利用ガイドです。

1. できること

ドキュメントを分割アップロードして非同期解析
画像/図表を含む文書を構造化して検索可能にする
ハイブリッド検索（ベクトル + 全文）でQ&A
組織タグベースのアクセス制御（owner/public/org/default）
評価データを蓄積し、品質改善に活用

2. 想定ユースケース

設計・運用文書検索
設計書・運用手順書・画面遷移図の横断検索。

組織別ナレッジ共有
公開範囲を制御した社内ナレッジ運用。

品質改善サイクル
再現率/適合率/忠実性/完全性を継続改善。

根拠付き回答
回答に証跡リンク・画像を付与して検証可能。

3. クイックスタート（Docker）

設定ファイル作成

cp .env.example .env

.env を編集（最低限 OPENAI_API_KEY と各種パスワード）
起動

cd app
./start_docker.sh pg up

動作確認

docker ps --format "table {{.Names}}\t{{.Status}}"
curl http://localhost:8000/health

停止

cd app
./start_docker.sh pg down

4. 最小操作フロー

アカウント登録（所属組織/主組織を設定）
ドキュメントアップロード（公開範囲・組織タグ指定）
ナレッジQ&Aで質問
根拠リンク/画像付き回答を確認

5. システム概要（簡略）

詳細図は Architecture ページを参照。

API層
FastAPI + WebSocket

処理層
Kafka + Document Processor

データ層
PostgreSQL / Redis / MinIO / Elasticsearch

AI層
OpenAI Embedding / Chat / Vision

6. 主要フロー

6.1 アップロード -> 解析 -> 入庫

/upload/chunk で分割受信、MinIO一時領域へ保存
/upload/merge で統合し、Kafkaへ document_parse を発行
Processor が解析・分割・埋め込み・索引化を実行
DB/ESへ保存し、ファイル状態を DONE に更新

6.2 質問 -> 召回 -> 回答

WebSocketチャットで質問受信
意図ルーティング + クエリ理解
権限フィルタ付きハイブリッド検索
証拠コンテキストを使ってLLM回答生成
会話・利用ログを保存

7. 代表API

Method	Path	Purpose
POST	`/api/v1/auth/register`	ユーザー登録
POST	`/api/v1/auth/login`	ログイン
POST	`/api/v1/upload/chunk`	分割アップロード
POST	`/api/v1/upload/merge`	アップロード統合
GET	`/api/v1/search/hybrid`	ハイブリッド検索
WS	`/api/v1/chat?token=...`	Q&Aチャット

8. 設定と運用上の注意

本番では .env の秘密情報（JWT/DB/SMTP/OpenAI）を必ず差し替える
初期設定は単一ノード想定（HAは別途設計）
ES/Kafka/OpenAI パラメータは実データに合わせて調整
初回は .env.example を .env にコピーして利用

9. 既知の制約（v0.1.0-draft）

単一ノード構成を前提（高可用構成は未提供）
大規模負荷向け自動スケールは未実装
一部機能は運用チューニング（ES/Kafka/OpenAI）前提

10. 追加ドキュメント

英語版ユーザーガイド: readme-en.html
設計思想・アーキテクチャ詳細: architecture.html
セキュリティポリシー: security.html
コントリビュート: contributing.html
リリースノート: release-notes.html

11. セキュリティと報告窓口

脆弱性報告手順は security.html を参照してください。

12. コントリビュート

開発手順・PRルールは contributing.html を参照してください。

13. リリースノート

初期版ノートは release-notes.html を参照してください。

14. ライセンス

ライセンスは LICENSE を参照してください。