trustgraph/README.md

271 lines
8.6 KiB
Markdown
Raw Normal View History

2024-10-26 10:35:08 -07:00
<div align="center">
2025-07-24 20:35:48 -07:00
2025-10-05 18:51:13 -07:00
[![PyPI version](https://img.shields.io/pypi/v/trustgraph.svg)](https://pypi.org/project/trustgraph/) ![E2E Tests](https://github.com/trustgraph-ai/trustgraph/actions/workflows/release.yaml/badge.svg)
[![Discord](https://img.shields.io/discord/1251652173201149994
2025-08-31 12:24:42 -07:00
)](https://discord.gg/sQMwkRz5GX) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/trustgraph-ai/trustgraph)
2024-10-10 18:37:40 -07:00
2025-07-10 18:28:09 -07:00
[**Docs**](https://docs.trustgraph.ai) | [**YouTube**](https://www.youtube.com/@TrustGraphAI?sub_confirmation=1) | [**Configuration Builder**](https://config-ui.demo.trustgraph.ai/) | [**Discord**](https://discord.gg/sQMwkRz5GX) | [**Blog**](https://blog.trustgraph.ai/subscribe)
2024-10-10 18:37:40 -07:00
2025-11-06 18:43:22 -08:00
<img src="TG-fullname-logo.svg" width=100% />
2024-10-10 18:37:40 -07:00
</div>
# AI-Ready Data Infrastructure
TrustGraph provides an event-driven data-to-AI platform that transforms data into AI-ready datasets through automated structuring, knowledge graph construction, and vector embeddings mapping — all deployable privately, on-prem, or in cloud. Deploy and manage open LLMs within the same platform, ensuring complete data sovereignty while enabling agents that generate real, actionable insights.
2025-04-07 13:46:20 -07:00
2025-04-20 15:49:04 -07:00
<details>
<summary>Table of Contents</summary>
<br>
2025-10-05 12:22:10 -07:00
- [**Key Features**](#key-features)<br>
2025-06-13 11:23:20 -07:00
- [**Why TrustGraph?**](#why-trustgraph)<br>
2025-08-22 12:13:47 -07:00
- [**Agentic MCP Demo**](#agentic-mcp-demo)<br>
2025-06-13 11:23:20 -07:00
- [**Getting Started**](#getting-started)<br>
- [**Configuration Builder**](#configuration-builder)<br>
2025-08-08 10:21:26 -07:00
- [**Knowledge Cores**](#knowledge-cores)<br>
2025-06-13 11:23:20 -07:00
- [**Integrations**](#integrations)<br>
- [**Observability & Telemetry**](#observability--telemetry)<br>
- [**Contributing**](#contributing)<br>
- [**License**](#license)<br>
- [**Support & Community**](#support--community)<br>
2025-04-20 15:49:04 -07:00
</details>
2025-04-07 13:46:20 -07:00
2025-10-05 12:22:10 -07:00
## Key Features
TrustGraph is not just another AI framework but a complete, production-ready platform that bridges the gap between raw data and intelligent, adaptable agent deployments.
- **Data Ingestion**
*PDF parsing, OCR, configurable chunking, custom metadata, and bring your own schemas for large scale data ingestion*.
- **Data Transformation**
*Transform unstructured data into flat knowledge graphs or bring your own ontology for rich graphs*.
- **Context Retrieval**
*Deterministic knowledge graph queries, no LLMs in retrieval path*.
- **Event-Driven**
*All services communicate through Apache Pulsar topics rather than direct RPC.*
- **Multi-Backend Storage**
*Data storage with Apache Cassandra, Neo4j, Qdrant, Milvus, Memgraph, FalkorDB, and Pinecone*.
- **Data Sovereignty**
*Deploy the entire stack—data pipelines, knowledge graphs, vector stores, and LLMs—on-premises, in your VPC, or across hybrid environments*.
- **Private LLM Inferencing**
*Support for all major LLM APIs or deploy and manage open models directly integrated with the platform*.
- **Three-Dimensional Multi-Tenancy**
*3 layers of isolation with flows for processing logic, collections for data access, and tool groups for multi-agent.*
- **Container-First**
*Containerized deployments with Docker or Kubernetes. Built for enterprise scale with monitoring, observability, and management*.
- **MCP Integration**
*Native support for MCP enables standardized agent communication with third-party tools and services while maintaining data sovereignty*.
- **Observable by Design**
*3D visualization of knowledge graphs. Prometheus metrics and Grafana dashboards track latency, throughput, costs, and errors*.
2025-06-13 11:21:23 -07:00
## Why TrustGraph?
2025-03-06 12:19:22 -08:00
2025-08-05 15:54:14 -07:00
[![Why TrustGraph?](https://img.youtube.com/vi/Norboj8YP2M/maxresdefault.jpg)](https://www.youtube.com/watch?v=Norboj8YP2M)
2025-03-06 12:19:22 -08:00
2025-08-22 12:13:47 -07:00
## Agentic MCP Demo
[![Agentic MCP Demo](https://img.youtube.com/vi/mUCL1b1lmbA/maxresdefault.jpg)](https://www.youtube.com/watch?v=mUCL1b1lmbA)
2025-06-13 11:21:23 -07:00
## Getting Started
- [**Quickstart Guide**](https://docs.trustgraph.ai/getting-started/)
2025-07-10 18:27:07 -07:00
- [**Configuration Builder**](#configuration-builder)
- [**Workbench**](#workbench)
- [**Developer APIs and CLI**](https://docs.trustgraph.ai/reference/)
- [**Deployment Guide**](https://docs.trustgraph.ai/deployment/)
2025-07-09 20:35:42 -07:00
### Watch TrustGraph 101
2025-07-09 20:30:21 -07:00
2025-07-09 20:35:42 -07:00
[![TrustGraph 101](https://img.youtube.com/vi/rWYl_yhKCng/maxresdefault.jpg)](https://www.youtube.com/watch?v=rWYl_yhKCng)
2025-07-09 20:30:21 -07:00
2025-06-13 11:23:20 -07:00
## Configuration Builder
2025-07-02 19:22:18 -07:00
The [**Configuration Builder**](https://config-ui.demo.trustgraph.ai/) assembles all of the selected components and builds them into a deployable package. It has 4 sections:
2025-07-02 19:22:18 -07:00
- **Version**: Select the version of TrustGraph you'd like to deploy
2025-06-13 11:21:23 -07:00
- **Component Selection**: Choose from the available deployment platforms, LLMs, graph store, VectorDB, chunking algorithm, chunking parameters, and LLM parameters
- **Customization**: Enable OCR pipelines and custom embeddings models
2025-06-13 11:21:23 -07:00
- **Finish Deployment**: Download the launch `YAML` files with deployment instructions
2025-07-08 17:04:05 -07:00
## Workbench
2024-12-30 10:28:50 -08:00
2025-07-08 17:04:05 -07:00
The **Workbench** is a UI that provides tools for interacting with all major features of the platform. The **Workbench** is enabled by default in the **Configuration Builder** and is available at port `8888` on deployment. The **Workbench** has the following capabilities:
2024-12-30 10:28:50 -08:00
2025-08-22 12:10:35 -07:00
- **Agentic, GraphRAG and LLM Chat**: Chat interface for agentic flows, GraphRAG queries, or directly interfacing with a LLM
2025-07-08 17:04:05 -07:00
- **Semantic Discovery**: Analyze semantic relationships with vector search, knowledge graph relationships, and 3D graph visualization
- **Data Management**: Load data into the **Librarian** for processing, create and upload **Knowledge Packages**
- **Flow Management**: Create and delete processing flow patterns
- **Prompt Management**: Edit all LLM prompts used in the platform during runtime
2025-08-22 12:10:35 -07:00
- **Agent Tools**: Define tools used by the Agent Flow including MCP tools
- **MCP Tools**: Connect to MCP servers
2024-12-30 10:28:50 -08:00
2025-08-08 10:24:50 -07:00
## Knowledge Cores
2025-04-07 17:21:05 -07:00
A challenge facing RAG architectures is the ability to quickly reuse and remove datasets from pipelines. **TrustGraph** stores the results of the data ingestion process in reusable Knowledge Cores. Knowledge cores can be loaded and removed during runtime. Some sample knowledge cores are [here](https://github.com/trustgraph-ai/catalog/tree/master/v3).
2025-04-07 17:21:05 -07:00
2025-08-08 10:21:26 -07:00
A Knowledge Core has two components:
2025-04-07 17:21:05 -07:00
- Knowledge graph triples
- Vector embeddings mapped to the knowledge graph
2025-04-07 17:21:05 -07:00
2025-06-13 11:21:23 -07:00
## Integrations
TrustGraph provides maximum flexibility to avoid vendor lock-in.
2025-04-07 14:28:45 -07:00
<details>
<summary>LLM APIs</summary>
<br>
- Anthropic<br>
- AWS Bedrock<br>
- AzureAI<br>
- AzureOpenAI<br>
- Cohere<br>
- Google AI Studio<br>
- Google VertexAI<br>
- Mistral<br>
- OpenAI<br>
</details>
<details>
<summary>LLM Orchestration</summary>
<br>
2025-04-07 17:21:05 -07:00
- LM Studio<br>
- Llamafiles<br>
- Ollama<br>
- TGI<br>
- vLLM<br>
2025-04-07 14:02:23 -07:00
</details>
<details>
<summary>VectorDBs</summary>
<br>
2025-04-07 14:02:23 -07:00
- Qdrant (default)<br>
- Pinecone<br>
- Milvus<br>
2025-04-07 14:02:23 -07:00
</details>
<details>
<summary>Graph Storage</summary>
<br>
- Apache Cassandra (default)<br>
- Neo4j<br>
- Memgraph<br>
- FalkorDB<br>
</details>
<details>
<summary>Observability</summary>
<br>
2025-04-07 14:28:45 -07:00
- Prometheus<br>
- Grafana<br>
</details>
<details>
<summary>Control Plane</summary>
<br>
- Apache Pulsar<br>
</details>
<details>
<summary>Clouds</summary>
<br>
- AWS<br>
- Azure<br>
- Google Cloud<br>
2025-08-22 11:59:51 -07:00
- OVHcloud<br>
- Scaleway<br>
</details>
2025-04-07 14:28:45 -07:00
2025-06-13 11:21:23 -07:00
## Observability & Telemetry
2025-04-07 15:24:58 -07:00
Once the platform is running, access the Grafana dashboard at:
```
http://localhost:3000
```
Default credentials are:
```
user: admin
password: admin
```
The default Grafana dashboard tracks the following:
<details>
<summary>Telemetry</summary>
<br>
- LLM Latency<br>
- Error Rate<br>
- Service Request Rates<br>
- Queue Backlogs<br>
- Chunking Histogram<br>
- Error Source by Service<br>
- Rate Limit Events<br>
- CPU usage by Service<br>
- Memory usage by Service<br>
- Models Deployed<br>
- Token Throughput (Tokens/second)<br>
- Cost Throughput (Cost/second)<br>
</details>
2025-04-07 15:24:58 -07:00
2025-06-13 11:21:23 -07:00
## Contributing
2024-12-28 16:59:11 +00:00
2025-07-10 18:08:02 -07:00
[Developer's Guide](https://docs.trustgraph.ai/community/developer.html)
2024-07-16 17:06:07 +01:00
2025-06-13 11:21:23 -07:00
## License
2025-05-08 18:59:58 +01:00
**TrustGraph** is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).
Copyright 2024-2025 TrustGraph
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
2024-07-16 17:06:07 +01:00
2025-06-13 11:23:20 -07:00
## Support & Community
2025-04-07 15:18:35 -07:00
- Bug Reports & Feature Requests: [Discord](https://discord.gg/sQMwkRz5GX)
- Discussions & Questions: [Discord](https://discord.gg/sQMwkRz5GX)
2025-07-10 13:34:51 -07:00
- Documentation: [Docs](https://docs.trustgraph.ai/)