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

Empty docs

Browse source
This commit is contained in:
Cyber MacGeddon 2024-12-28 14:26:37 +00:00
parent fe4a915e78
commit 9b4dacbb5f
8 changed files with 20 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/apis/README.md
View file

@ -1,10 +1,12 @@
# TrustGraph APIs overview # TrustGraph APIs
## Overview
If you want to interact with TrustGraph through APIs, there are 3 If you want to interact with TrustGraph through APIs, there are 3
forms of API which may be of interest to you: forms of API which may be of interest to you:
## Pulsar APIs ### Pulsar APIs
Apache Pulsar is a pub/sub system used to deliver messages between TrustGraph Apache Pulsar is a pub/sub system used to deliver messages between TrustGraph
components. Using Pulsar, you can communicate with TrustGraph components. components. Using Pulsar, you can communicate with TrustGraph components.
@ -12,6 +14,7 @@ components. Using Pulsar, you can communicate with TrustGraph components.
Pros: Pros:
- Provides complete access to all TrustGraph functionality - Provides complete access to all TrustGraph functionality
- Simple integration with metrics and observability - Simple integration with metrics and observability
Cons: Cons:
- Integration is non-trivial, requires a special-purpose Pulsar client - Integration is non-trivial, requires a special-purpose Pulsar client
library library
@ -19,7 +22,7 @@ Cons:
expose outside of the processing cluster in a production or well-secured expose outside of the processing cluster in a production or well-secured
deployment deployment
## REST APIs ### REST APIs
A component, `api-gateway`, provides a bridge between Pulsar internals and A component, `api-gateway`, provides a bridge between Pulsar internals and
the REST API which allows many services to be invoked using REST APIs. the REST API which allows many services to be invoked using REST APIs.
@ -29,6 +32,7 @@ Pros:
of technology of technology
- Can be easily protected with authentication and TLS for production-grade - Can be easily protected with authentication and TLS for production-grade
or secure deployments or secure deployments
Cons: Cons:
- For a complex application, a long series of REST invocations has - For a complex application, a long series of REST invocations has
latency and performance overheads - HTTP has limits on the number latency and performance overheads - HTTP has limits on the number
@ -36,7 +40,7 @@ Cons:
- Lower coverage of functionality - service interfaces need to be added to - Lower coverage of functionality - service interfaces need to be added to
`api-gateway` to permit REST invocation `api-gateway` to permit REST invocation
## Websocket API ### Websocket API
The `api-gateway` component also provides access to services through a The `api-gateway` component also provides access to services through a
websocket API. websocket API.
@ -46,8 +50,20 @@ Pros:
- Can be easily protected with authentication and TLS for production-grade - Can be easily protected with authentication and TLS for production-grade
or secure deployments or secure deployments
- Supports concurrent service invocations - Supports concurrent service invocations
Cons: Cons:
- Websocket service invocation is a little more complex to develop than - Websocket service invocation is a little more complex to develop than
using a basic REST API, particular if you want to cover all of the error using a basic REST API, particular if you want to cover all of the error
scenarios well scenarios well
## Further reading
- [TrustGraph websocket overview](websocket.md)
- [TrustGraph Pulsar overview](pulsar.md)
- API details
- [Graph RAG](api-graph-rag.md)
- [Document load](api-document-load.md)
- [Agent](api-agent.md)
- [Embeddings](api-embeddings.md)
- [Text completion](api-text-completion.md)

0
docs/apis/api-agent.md Normal file
View file

0
docs/apis/api-document-load.md Normal file
View file

0
docs/apis/api-embeddings.md Normal file
View file

0
docs/apis/api-graph-rag.md Normal file
View file

0
docs/apis/api-text-completion.md Normal file
View file

0
docs/apis/pulsar.md Normal file
View file

0
docs/apis/websocket.md Normal file
View file