Allgemeine Einführung
Knowledge Graph Studio (KGS) ist eine Open-Source-Plattform, die den Prozess der Erstellung und Verwaltung von RAG-nativen Wissensgraphen vereinfachen soll. Die Plattform bietet regelbasiertes Entity-Parsing, modulare Graphenkonstruktion, flexible Datenaufnahme und API-first Design zur Unterstützung von Entwicklern über ein SDK. Unabhängig davon, ob es sich um strukturierte oder unstrukturierte Daten handelt, bietet Knowledge Graph Studio den Anwendern skalierbare und flexible Lösungen für experimentelle und groß angelegte Anwendungen. Die auf einer NoSQL-Datenbank basierende Plattform unterstützt den schnellen Datenabruf und die einfache Durchquerung komplexer Beziehungen und ist bestrebt, eine datenbankunabhängige Lösung zu werden.
Funktionsliste
- Regelbasierte Auflösung von Entitäten
- Modularer Aufbau der Kartierung
- Flexible Dateneingabe
- API-zentriertes Design mit SDK-Unterstützung
- Unterstützung für strukturierte und unstrukturierte Daten
- Skalierbare und flexible Lösungen
- Schneller Datenabruf und komplexes relationales Traversal
- Unterstützung für mehrere Datenbanken
Hilfe verwenden
Einbauverfahren
- Klon-Lagerhaus:
git clone git@github.com:whyhow-ai/knowledge-graph-studio.git
cd knowledge-graph-studio
- Installieren Sie die Abhängigkeit:
pip install .
- Entwickler-Installation:
pip install -e .[dev,docs]
Schnellstart
- Vorbereitung:
- OpenAI API-Schlüssel
- MongoDB-Konto
- Erstellen von Projekten und Clustern in MongoDB Atlas
- Konfigurieren Sie die Umgebungsvariablen:
cp .env.sample .env
Update.env
Werte in der Datei:
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主机>
- Erstellen Sie Datenbanken und Sammlungen:
cd src/whyhow_api/cli/
python admin.py setup-collections --config-file collection_index_config.json
- Erstellen Sie Benutzer und API-Schlüssel:
python admin.py create-user --email <你的邮箱地址> --openai-key <你的OpenAI API密钥>
- Starten Sie den API-Server:
uvicorn src.whyhow_api.main:app
Verwendung des SDK
- Installieren Sie das Python-SDK:
pip install whyhow
- Konfigurieren Sie den WhyHow-Client:
from whyhow import WhyHow
client = WhyHow(api_key='<你的WhyHow API密钥>', base_url="http://localhost:8000")
- Erstellen Sie Arbeitsbereiche und Karten:
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)
- Abfrage-Zuordnung:
query = client.graphs.query_unstructured(graph_id=graph.graph_id, query="示例查询")
Docker verwenden
- Bauen Sie das Spiegelbild:
docker build --platform=linux/amd64 -t kg_engine:v1 .
- Führen Sie das Bild aus:
docker run -it --rm -p 1234:8000 kg_engine:v1