Introdução geral
O Knowledge Graph Studio (KGS) é uma plataforma de código aberto projetada para simplificar o processo de criação e gerenciamento de gráficos de conhecimento nativos do RAG. A plataforma oferece análise de entidades com base em regras, construção de gráficos modulares, ingestão flexível de dados e design que prioriza a API para dar suporte aos desenvolvedores por meio de um SDK. Seja lidando com dados estruturados ou não estruturados, o Knowledge Graph Studio oferece aos usuários soluções dimensionáveis e flexíveis para aplicativos experimentais e de grande escala. Criada com base em um banco de dados NoSQL, a plataforma oferece suporte à recuperação rápida de dados e à fácil passagem por relacionamentos complexos, e tem o compromisso de se tornar uma solução independente de banco de dados.
Lista de funções
- Resolução de entidades baseada em regras
- Construção de mapeamento modular
- Ingestão flexível de dados
- Design que prioriza a API com suporte a SDK
- Suporte para dados estruturados e não estruturados
- Soluções escaláveis e flexíveis
- Recuperação rápida de dados e passagem relacional complexa
- Suporte a vários bancos de dados
Usando a Ajuda
Processo de instalação
- Armazém de Clonagem:
git clone git@github.com:whyhow-ai/knowledge-graph-studio.git
cd knowledge-graph-studio
- Instale a dependência:
pip install .
- Instalação do desenvolvedor:
pip install -e . [dev,docs]
Início rápido
- Preparação:
- Chave da API da OpenAI
- Conta MongoDB
- Criação de projetos e clusters no MongoDB Atlas
- Configurar variáveis de ambiente:
cp .env.sample .env
atualização.env
valores no arquivo:
WHYHOW__EMBEDDING__OPENAI__API_KEY=
WHYHOW__GENERATIVE__OPENAI__API_KEY=
WHYHOW__MONGODB__USERNAME=
WHYHOW__MONGODB__PASSWORD=
WHYHOW__MONGODB__DATABASE_NAME=main
WHYHOW__MONGODB__HOST=
- Criar bancos de dados e coleções:
cd src/whyhow_api/cli/
python admin.py setup-collections --config-file collection_index_config.json
- Crie usuários e chaves de API:
python admin.py create-user --email --openai-key
- Inicie o servidor de API:
uvicorn src.whyhow_api.main:app
Usando o SDK
- Instale o Python SDK:
pip install whyhow
- Configurar o cliente WhyHow:
from whyhow import WhyHow
cliente = WhyHow(api_key='', base_url="http://localhost:8000")
- Criar espaços de trabalho e mapas:
workspace = client.workspaces.create(name="Demo Workspace")
chunk = client.chunks.create(workspace_id=workspace.workspace_id, chunks=[Chunk(content="Example Content")])
triples = [Triple(head=Node(name="example node", label="example label"), relation=Relation(name="example relation"), tail=Node(name="example tail node", label="example tail 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)
- Mapeamento de consultas:
query = client.graphs.query_unstructured(graph_id=graph.graph_id, query="example query")
Usando o Docker
- Construa a imagem espelhada:
docker build --platform=linux/amd64 -t kg_engine:v1 .
- Execute a imagem:
docker run -it --rm -p 1234:8000 kg_engine:v1