mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 08:26:21 +02:00
195 lines
9.1 KiB
Markdown
195 lines
9.1 KiB
Markdown
<div align="center">
|
|
|
|
|
|
|
|
## Connect Data Silos with Explainable AI
|
|
|
|
</div>
|
|
|
|
<div align="center">
|
|
|
|
[](https://pypi.org/project/trustgraph/) [](https://discord.gg/sQMwkRz5GX)
|
|
|
|
🚀 [Getting Started](https://trustgraph.ai/docs/getstarted) ⚙️ [API Docs](https://trustgraph.ai/docs/api/apistarted/) 🧑💻 [CLI Docs](https://trustgraph.ai/docs/running/cli) 📺 [YouTube](https://www.youtube.com/@TrustGraph?sub_confirmation=1) 💬 [Discord](https://discord.gg/sQMwkRz5GX) 📖 [Blog](https://blog.trustgraph.ai) 📋 [Use Cases](https://trustgraph.ai/docs/usecases)
|
|
|
|
</div>
|
|
|
|
TrustGraph is a fully agentic AI data engineering platform for complex unstructured data. Extract your documents to knowledge graphs and vector embeddings with customizable data extraction agents. Deploy AI agents that leverage your data to generate explainable AI responses.
|
|
|
|
## Key Features
|
|
|
|
- 📄 **Document Extraction**: Bulk ingest documents such as `.pdf`,`.txt`, and `.md`
|
|
- 🪓 **Adjustable Chunking**: Choose your chunking algorithm and parameters
|
|
- 🔁 **No-code LLM Integration**: Anthropic, AWS Bedrock, AzureAI, AzureOpenAI, Cohere, Google AI Studio, Google VertexAI, Llamafiles, Ollama, and OpenAI
|
|
- 📖 **Entity, Topic, and Relationship Knowledge Graphs**
|
|
- 🔢 **Mapped Vector Embeddings**
|
|
- ❔**No-code GraphRAG Queries**: Automatically perform a semantic similiarity search and subgraph extraction for the context of LLM generative responses
|
|
- 🤖 **Agent Flow**: Define custom tools used by a ReAct style Agent Manager that fully controls the response flow including the ability to perform GraphRAG requests
|
|
- 🎛️ **Production-Grade** reliability, scalability, and accuracy
|
|
- 🔍 **Observability**: get insights into system performance with Prometheus and Grafana
|
|
- 🗄️ **AI Powered Data Warehouse**: Load only the subgraph and vector embeddings you use most often
|
|
- 🪴 **Customizable and Extensible**: Tailor for your data and use cases
|
|
- 🖥️ **Configuration UI**: Build the `YAML` configuration with drop down menus and selectable parameters
|
|
|
|
## Getting Started
|
|
|
|
There are four ways of interacting with TrustGraph:
|
|
|
|
- [**REST API**](https://trustgraph.ai/docs/api/apistarted)
|
|
- [**Python SDK**](https://trustgraph.ai/docs/api/apistarted)
|
|
- [**TrustGraph CLI**](https://trustgraph.ai/docs/running/cli)
|
|
- [**Configuration UI**](https://config-ui.demo.trustgraph.ai/)
|
|
|
|
The `TrustGraph CLI` installs the commands for interacting with TrustGraph while running along with the Python SDK. The `Configuration UI` enables customization of TrustGraph deployments prior to launching. The **REST API** can be accessed through port `8088` of the TrustGraph host machine with JSON request and response bodies.
|
|
|
|
### Install the TrustGraph CLI
|
|
|
|
```
|
|
pip3 install trustgraph-cli==0.17.16
|
|
```
|
|
|
|
> [!NOTE]
|
|
> The `TrustGraph CLI` version must match the desired `TrustGraph` release version.
|
|
|
|
### Configuration UI
|
|
|
|
TrustGraph is endlessly customizable by editing the `YAML` launch files. The `Configuration UI` provides a quick and intuitive tool for building a custom configuration that deploys with Docker, Podman, Minikube, or Google Cloud. There is a `Configuration UI` for the both the lastest and stable `TrustGraph` releases.
|
|
|
|
- [**Stable Configuration UI** (0.17.16) 🚀](https://config-ui.demo.trustgraph.ai/)
|
|
- [**Latest Configuration UI** (0.17.16) 🚀](https://dev.config-ui.demo.trustgraph.ai/)
|
|
|
|
The `Configuration UI` has three sections:
|
|
|
|
- **Component Selection** ✅: Choose from the available deployment platforms, LLMs, graph store, VectorDB, chunking algorithm, chunking parameters, and LLM parameters
|
|
- **Customization** 🧰: Customize the prompts for the LLM System, Data Extraction Agents, and Agent Flow
|
|
- **Finish Deployment** 🚀: Download the launch `YAML` files with deployment instructions
|
|
|
|
The `Configuration UI` will generate the `YAML` files in `deploy.zip`. Once `deploy.zip` has been downloaded and unzipped, launching TrustGraph is as simple as navigating to the `deploy` directory and running:
|
|
|
|
```
|
|
docker compose up -d
|
|
```
|
|
|
|
> [!TIP]
|
|
> Docker is the recommended container orchestration platform for first getting started with TrustGraph.
|
|
|
|
When finished, shutting down TrustGraph is as simple as:
|
|
```
|
|
docker compose down -v
|
|
```
|
|
|
|
### Example TrustGraph Notebooks
|
|
|
|
- [**REST API Notebooks**](https://github.com/trustgraph-ai/example-notebooks/tree/master/api-examples)
|
|
- [**Python SDK Notebooks**](https://github.com/trustgraph-ai/example-notebooks/tree/master/api-library)
|
|
|
|
## TrustGraph Releases
|
|
|
|
TrustGraph releases are available [here](https://github.com/trustgraph-ai/trustgraph/releases). Download `deploy.zip` for the desired release version.
|
|
|
|
| Release Type | Release Version |
|
|
| ------------ | --------------- |
|
|
| Latest | [0.17.16](https://github.com/trustgraph-ai/trustgraph/releases/download/v0.17.16/deploy.zip) |
|
|
| Stable | [0.17.16](https://github.com/trustgraph-ai/trustgraph/releases/download/v0.17.16/deploy.zip) |
|
|
|
|
TrustGraph is fully containerized and is launched with a `YAML` configuration file. Unzipping the `deploy.zip` will add the `deploy` directory with the following subdirectories:
|
|
|
|
- `docker-compose`
|
|
- `minikube-k8s`
|
|
- `gcp-k8s`
|
|
|
|
Each directory contains the pre-built `YAML` configuration files needed to launch TrustGraph:
|
|
|
|
| Model Deployment | Graph Store | Launch File |
|
|
| ---------------- | ------------ | ----------- |
|
|
| AWS Bedrock API | Cassandra | `tg-bedrock-cassandra.yaml` |
|
|
| AWS Bedrock API | Neo4j | `tg-bedrock-neo4j.yaml` |
|
|
| AzureAI API | Cassandra | `tg-azure-cassandra.yaml` |
|
|
| AzureAI API | Neo4j | `tg-azure-neo4j.yaml` |
|
|
| AzureOpenAI API | Cassandra | `tg-azure-openai-cassandra.yaml` |
|
|
| AzureOpenAI API | Neo4j | `tg-azure-openai-neo4j.yaml` |
|
|
| Anthropic API | Cassandra | `tg-claude-cassandra.yaml` |
|
|
| Anthropic API | Neo4j | `tg-claude-neo4j.yaml` |
|
|
| Cohere API | Cassandra | `tg-cohere-cassandra.yaml` |
|
|
| Cohere API | Neo4j | `tg-cohere-neo4j.yaml` |
|
|
| Google AI Studio API | Cassandra | `tg-googleaistudio-cassandra.yaml` |
|
|
| Google AI Studio API | Neo4j | `tg-googleaistudio-neo4j.yaml` |
|
|
| Llamafile API | Cassandra | `tg-llamafile-cassandra.yaml` |
|
|
| Llamafile API | Neo4j | `tg-llamafile-neo4j.yaml` |
|
|
| Ollama API | Cassandra | `tg-ollama-cassandra.yaml` |
|
|
| Ollama API | Neo4j | `tg-ollama-neo4j.yaml` |
|
|
| OpenAI API | Cassandra | `tg-openai-cassandra.yaml` |
|
|
| OpenAI API | Neo4j | `tg-openai-neo4j.yaml` |
|
|
| VertexAI API | Cassandra | `tg-vertexai-cassandra.yaml` |
|
|
| VertexAI API | Neo4j | `tg-vertexai-neo4j.yaml` |
|
|
|
|
Once a configuration `launch file` has been selected, deploy TrustGraph with:
|
|
|
|
**Docker**:
|
|
```
|
|
docker compose -f <launch-file.yaml> up -d
|
|
```
|
|
|
|
**Kubernetes**:
|
|
```
|
|
kubectl apply -f <launch-file.yaml>
|
|
```
|
|
|
|
## Architecture
|
|
|
|
|
|
|
|
TrustGraph is designed to be modular to support as many LLMs and environments as possible. A natural fit for a modular architecture is to decompose functions into a set of modules connected through a pub/sub backbone. [Apache Pulsar](https://github.com/apache/pulsar/) serves as this pub/sub backbone. Pulsar acts as the data broker managing data processing queues connected to procesing modules.
|
|
|
|
### Pulsar Workflows
|
|
|
|
- For processing flows, Pulsar accepts the output of a processing module and queues it for input to the next subscribed module.
|
|
- For services such as LLMs and embeddings, Pulsar provides a client/server model. A Pulsar queue is used as the input to the service. When processed, the output is then delivered to a separate queue where a client subscriber can request that output.
|
|
|
|
## Data Extraction Agents
|
|
|
|
TrustGraph extracts knowledge documents to an ultra-dense knowledge graph using 3 automonous data extraction agents. These agents focus on individual elements needed to build the knowledge graph. The agents are:
|
|
|
|
- Topic Extraction Agent
|
|
- Entity Extraction Agent
|
|
- Relationship Extraction Agent
|
|
|
|
The agent prompts are built through templates, enabling customized data extraction agents for a specific use case. The data extraction agents are launched automatically with the loader commands.
|
|
|
|
PDF file:
|
|
```
|
|
tg-load-pdf <document.pdf>
|
|
```
|
|
|
|
Text or Markdown file:
|
|
```
|
|
tg-load-text <document.txt>
|
|
```
|
|
|
|
## GraphRAG Queries
|
|
|
|
Once the knowledge graph and embeddings have been built or a knowledge core has been loaded, RAG queries are launched with a single line:
|
|
|
|
```
|
|
tg-query-graph-rag -q "Write a blog post about the 5 key takeaways from SB1047 and how they will impact AI development."
|
|
```
|
|
|
|
## Agent Flow
|
|
|
|
Invoking the Agent Flow will use a ReAct style approach the combines GraphRAG and text completion requests to think through a problem solution.
|
|
|
|
```
|
|
tg-invoke-agent -v -q "Write a blog post about the 5 key takeaways from SB1047 and how they will impact AI development."
|
|
```
|
|
|
|
> [!TIP]
|
|
> Adding `-v` to the agent request will return all of the agent manager's thoughts and observations that led to the final response.
|
|
|
|
## Deploy and Manage TrustGraph
|
|
|
|
[🚀 Full Deployment Guide 🚀](https://trustgraph.ai/docs/getstarted)
|
|
|
|
## TrustGraph Developer's Guide
|
|
|
|
[Developing for TrustGraph](docs/README.development.md)
|