はじめに
Knowledge Graph Studio (KGS)は、RAGネイティブなナレッジグラフの作成・管理プロセスを簡素化するために設計されたオープンソースプラットフォームです。このプラットフォームは、ルールベースのエンティティ解析、モジュール式のグラフ構築、柔軟なデータ取り込み、APIファーストの設計を提供し、SDKを介して開発者をサポートします。構造化データ、非構造化データを問わず、Knowledge Graph Studioは実験的アプリケーションや大規模アプリケーション向けにスケーラブルで柔軟なソリューションを提供します。NoSQLデータベース上に構築されたこのプラットフォームは、高速なデータ検索と複雑な関係の容易なトラバースをサポートし、データベースに依存しないソリューションとなることを目指しています。
機能一覧
- ルールベースの実体解決
- モジュラー・マッピング
- 柔軟なデータ取り込み
- SDKをサポートするAPIファースト設計
- 構造化データおよび非構造化データのサポート
- スケーラブルで柔軟なソリューション
- 高速データ検索と複雑なリレーショナル・トラバーサル
- 複数のデータベースをサポート
ヘルプの使用
設置プロセス
- クローン倉庫
git clone git@github.com:whyhow-ai/knowledge-graph-studio.git
cd knowledge-graph-studio
- 依存関係をインストールします:
pip install .
- デベロッパーのインストール:
pip install -e .[dev,docs]
クイックスタート
- 準備だ:
- OpenAI APIキー
- MongoDBアカウント
- MongoDBアトラスでプロジェクトとクラスタを作成する
- 環境変数を設定する:
cp .env.sample .env
更新.env
ファイル内の値:
WHYHOW__EMBEDDING__OPENAI__API_KEY=<你的OpenAI API密钥>
WHYHOW__GENERATIVE__OPENAI__API_KEY=<你的OpenAI API密钥>
WHYHOW__MONGODB__USERNAME=<你的MongoDB用户名>
WHYHOW__MONGODB__PASSWORD=<你的MongoDB密码>
WHYHOW__MONGODB__DATABASE_NAME=main
WHYHOW__MONGODB__HOST=<你的MongoDB主机>
- データベースとコレクションの作成
cd src/whyhow_api/cli/
python admin.py setup-collections --config-file collection_index_config.json
- ユーザーとAPIキーを作成します:
python admin.py create-user --email <你的邮箱地址> --openai-key <你的OpenAI API密钥>
- APIサーバーを起動する:
uvicorn src.whyhow_api.main:app
SDKの使用
- Python SDKをインストールします:
pip install whyhow
- WhyHowクライアントを設定します:
from whyhow import WhyHow
client = WhyHow(api_key='<你的WhyHow API密钥>', base_url="http://localhost:8000")
- ワークスペースとマップの作成
workspace = client.workspaces.create(name="Demo Workspace")
chunk = client.chunks.create(workspace_id=workspace.workspace_id, chunks=[Chunk(content="示例内容")])
triples = [Triple(head=Node(name="示例节点", label="示例标签"), relation=Relation(name="示例关系"), tail=Node(name="示例尾节点", label="示例尾标签"), chunk_ids=[c.chunk_id for c in chunk])]
graph = client.graphs.create_graph_from_triples(name="Demo Graph", workspace_id=workspace.workspace_id, triples=triples)
- クエリ・マッピング:
query = client.graphs.query_unstructured(graph_id=graph.graph_id, query="示例查询")
Dockerの使用
- 鏡像を作る:
docker build --platform=linux/amd64 -t kg_engine:v1 .
- イメージを実行する:
docker run -it --rm -p 1234:8000 kg_engine:v1