apunkt/trustgraph
1
0
Fork 0
mirror of https://github.com/trustgraph-ai/trustgraph.git synced 2026-05-29 17:25:15 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README for 0.18.14 release

Browse source
This commit is contained in:
Jack Colquitt 2024-12-30 09:59:53 -08:00 • committed by GitHub
parent 78822a6692
commit ff695c07ad
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 15 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -26,13 +26,14 @@ TrustGraph is a fully agentic AI system for complex unstructured data. Extract y
- 🔢 **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
- 📚 **Multiple Knowledge Graph Options**: Full integration with **Memgraph**, **Neo4j**, or **Cassandra**
- 📚 **Multiple Knowledge Graph Options**: Full integration with **Memgraph**, **FalkorDB**, **Neo4j**, or **Cassandra**
- 🧮 **Multiple VectorDB Options**: Full integration with **Pinecone**, **Qdrant**, or **Milvus**
- 🎛️ **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
- 🖥️ **Configuration Portal**: Build the `YAML` configuration with drop down menus and selectable parameters
- 🕵️ **Data Workbench**: Explore your data with a 3D semantic visualizer
## Getting Started
@ -43,31 +44,32 @@ There are four ways of interacting with TrustGraph:
- [**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.
The `TrustGraph CLI` installs the commands for interacting with TrustGraph while running along with the Python SDK. The `Configuration Portal` 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
pip3 install trustgraph-cli==0.18.14
```
> [!NOTE]
> The `TrustGraph CLI` version must match the desired `TrustGraph` release version.
### Configuration UI
### Configuration Portal
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.
TrustGraph is endlessly customizable by editing the `YAML` launch files. The `Configuration Portal` provides a quick and intuitive tool for building a custom configuration that deploys with Docker, Podman, Minikube, or Google Cloud. There is a `Configuration Portal` 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.18.7) 🚀](https://dev.config-ui.demo.trustgraph.ai/)
- [**Configuration Portal** (Stable 0.18.14) 🚀](https://config-ui.demo.trustgraph.ai/)
- [**Configuration Portal** (Latest 0.19.0) 🚀](https://dev.config-ui.demo.trustgraph.ai/)
The `Configuration UI` has three sections:
The `Configuration Portal` has 4 important 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
- **Data Workbench** 🕵️: Add the **Data Workbench** to the configuration available on port `8888`
- **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:
The `Configuration Portal` 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
@ -92,8 +94,8 @@ TrustGraph `YAML` files are available [here](https://github.com/trustgraph-ai/tr
| Release Type | Release Version |
| ------------ | --------------- |
| Latest | [0.18.7](https://github.com/trustgraph-ai/trustgraph/releases/download/v0.18.7/deploy.zip) |
| Stable | [0.17.16](https://github.com/trustgraph-ai/trustgraph/releases/download/v0.17.16/deploy.zip) |
| Latest | [0.19.0](https://github.com/trustgraph-ai/trustgraph/releases/download/v0.19.0/deploy.zip) |
| Stable | [0.18.14](https://github.com/trustgraph-ai/trustgraph/releases/download/v0.18.14/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:
@ -102,7 +104,7 @@ TrustGraph is fully containerized and is launched with a `YAML` configuration fi
- `gcp-k8s`
> [!NOTE]
> As more integrations have been added, the number of possible combinations of configurations has become quite large. It is recommended to use the `Config UI` to build your deployment configuration. Each directory contains `YAML` configuration files for the default component selections.
> As more integrations have been added, the number of possible combinations of configurations has become quite large. It is recommended to use the `Configuration Portal` to build your deployment configuration. Each directory contains `YAML` configuration files for the default component selections.
**Docker**:
```