trustgraph/README.md

261 lines
11 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
</div>
# AI-Ready Data Infrastructure
TrustGraph provides an event-driven data-to-AI platform that automatically transforms raw data into AI-ready datasets through automated structuring, knowledge graph construction, and vector embeddings—all deployable privately, on-prem, or in your cloud. You can deploy and manage your own LLMs within the same platform, ensuring your data never leaves your infrastructure 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-14 14:25:52 -07:00
- [**Context Engineering**](#context-engineering)<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 comprehensive context stack that bridges the gap between raw data and intelligent, adaptable agent deployments in production environments.
- **Complete Agentic Context Stack**
- Combines all necessary layers: data streaming control plane, knowledge graphs, vector databases, LLM integrations, and data pipelines in a unified platform.
- Enables deployment of intelligent agents grounded in domain-specific knowledge.
- **Post-Training Infrastructure**
- Supports transforming raw and streaming data into knowledge representations for fine-tuning and in-context agent reasoning.
- Enables continuous learning and optimization of AI agents beyond base model training.
- **Containerized Single Deployment**
- Simplifies operations with a turnkey containerized solution.
- Eliminates the complexity of managing multiple, disparate components and dependencies.
- **Multi-Cloud and Local Run Support**
- Runs anywhere—locally, on-premises, or in any cloud environment (AWS, Azure, GCP, OVHcloud, Scaleway).
- Supports data sovereignty and flexible deployment architectures.
- **Flexible Data and Model Integrations**
- Supports multiple vector databases (Qdrant, Milvus, Pinecone) and knowledge graph stores (Neo4j, Memgraph, FalkorDB).
- Native integration with LLM providers Anthropic, Google, Mistral, OpenAI, and local models with vLLM, Ollama, LM Studio.
- **Real-Time Data Streaming and Observability**
- Built-in streaming data integration with Apache Pulsar.
- Observability tooling including Prometheus and Grafana dashboards for tracking latency, costs, and system health.
- **Modular and Extensible Architecture**
- Swap or extend parts (e.g., vector stores, LLMs, graph databases) without platform redesign.
- Built for engineers who need flexibility and control over AI infrastructure components.
- **Domain Knowledge as a First-Class Citizen**
- Converts data into rich knowledge graphs to ground AI agents in reliable, structured information.
- Enables semantic retrieval for more accurate and context-aware AI responses.
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-14 14:25:52 -07:00
## Context Engineering
2025-04-20 16:32:55 -07:00
2025-08-14 14:27:33 -07:00
TrustGraph features a complete context engineering solution combinging the power of Knowledge Graphs and VectorDBs. Connect your data to automatically construct Knowledge Graphs with mapped Vector Embeddings to deliver richer and more accurate context to LLMs for trustworthy agents.
2025-04-20 16:32:55 -07:00
2025-07-02 19:44:53 -07:00
- **Automated Knowledge Graph Construction:** Data Transformation Agents processes source data to automatically **extract key entities, topics, and the relationships** connecting them. Vector emebeddings are then mapped to these semantic relationships for context retrieval.
- **Deterministic Graph Retrieval:** Semantic relationsips are retrieved from the knowledge graph *without* the use of LLMs. When an agent needs to perform deep research, it first performs a **cosine similarity search** on the vector embeddings to identify potentially relevant concepts and relationships within the knowledge graph. This initial vector search **pinpoints relevant entry points** within the structured Knowledge Graph which gets built into graph queries *without* LLMs that retrieve the relevant subgraphs.
2025-07-02 19:44:53 -07:00
- **Context Generation via Subgraph Traversal:** Based on the ranked results from the similarity search, agents are provided with only the relevant subgraphs for **deep context**. Users can configure the **number of 'hops'** (relationship traversals) to extend the depth of knowledge availabe to the agents. This structured **subgraph**, containing entities and their relationships, forms a highly relevant and context-aware input prompt for the LLM that is endlessly configurable with options for the number of entities, relationships, and overall subgraph size.
2025-04-20 16:32:55 -07:00
2025-08-08 10:24:50 -07:00
## Knowledge Cores
2025-04-07 17:21:05 -07:00
2025-08-08 10:21:26 -07:00
One of the biggest challenges currently facing RAG architectures is the ability to quickly reuse and integrate knowledge sets like long-term memory for LLMs. **TrustGraph** solves this problem by storing the results of the data ingestion process in reusable Knowledge Cores. Being able to store and reuse the Knowledge Cores means the data transformation process has to be run only once. These reusable Knowledge Cores can be loaded back into **TrustGraph** and used for GraphRAG. Some sample knowledge cores are available for download [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
- Set of Graph Edges
- Set of mapped Vector Embeddings
2025-08-08 10:21:26 -07:00
When a Knowledge Core is loaded into TrustGraph, the corresponding graph edges and vector embeddings are queued and loaded into the chosen graph and vector stores.
2025-04-07 17:21:05 -07:00
2025-06-13 11:21:23 -07:00
## Integrations
2025-06-12 16:45:49 -07:00
TrustGraph provides maximum flexibility so your agents are always powered by the latest and greatest components.
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/)