mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 08:26:21 +02:00
109 lines
3.6 KiB
Markdown
109 lines
3.6 KiB
Markdown
|
|
# TrustGraph APIs
|
|
|
|
## Overview
|
|
|
|
If you want to interact with TrustGraph through APIs, there are 4
|
|
forms of API which may be of interest to you. All four mechanisms
|
|
invoke the same underlying TrustGraph functionality but are made
|
|
available for integration in different ways:
|
|
|
|
### Pulsar APIs
|
|
|
|
Apache Pulsar is a pub/sub system used to deliver messages between TrustGraph
|
|
components. Using Pulsar, you can communicate with TrustGraph components.
|
|
|
|
Pros:
|
|
- Provides complete access to all TrustGraph functionality
|
|
- Simple integration with metrics and observability
|
|
|
|
Cons:
|
|
- Integration is non-trivial, requires a special-purpose Pulsar client
|
|
library
|
|
- The Pulsar interfaces are likely something that you would not want to
|
|
expose outside of the processing cluster in a production or well-secured
|
|
deployment
|
|
|
|
### REST APIs
|
|
|
|
A component, `api-gateway`, provides a bridge between Pulsar internals and
|
|
the REST API which allows many services to be invoked using REST APIs.
|
|
|
|
Pros:
|
|
- Uses standard REST approach can be easily integrated into many kinds
|
|
of technology
|
|
- Can be easily protected with authentication and TLS for production-grade
|
|
or secure deployments
|
|
|
|
Cons:
|
|
- For a complex application, a long series of REST invocations has
|
|
latency and performance overheads - HTTP has limits on the number
|
|
of concurrent service invocations
|
|
- Lower coverage of functionality - service interfaces need to be added to
|
|
`api-gateway` to permit REST invocation
|
|
|
|
### Websocket API
|
|
|
|
The `api-gateway` component also provides access to services through a
|
|
websocket API.
|
|
|
|
Pros:
|
|
- Usable through a standard websocket library
|
|
- Can be easily protected with authentication and TLS for production-grade
|
|
or secure deployments
|
|
- Supports concurrent service invocations
|
|
|
|
Cons:
|
|
- 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
|
|
scenarios well
|
|
|
|
### Python SDK API
|
|
|
|
The `trustgraph-base` package provides a Python SDK that wraps the underlying
|
|
service invocations in a convenient Python API.
|
|
|
|
Pros:
|
|
- Native Python integration with type hints and documentation
|
|
- Simplified service invocation without manual message handling
|
|
- Built-in error handling and response parsing
|
|
- Convenient for Python-based applications and scripts
|
|
|
|
Cons:
|
|
- Python-specific, not available for other programming languages
|
|
- Requires Python environment and trustgraph-base package installation
|
|
- Less control over low-level message handling
|
|
|
|
## Flow-hosted APIs
|
|
|
|
There are two types of APIs: Flow-hosted which need a flow to be running
|
|
to operate. Non-flow-hosted which are core to the system, and can
|
|
be seen as 'global' - they are not dependent on a flow to be running.
|
|
|
|
Knowledge, Librarian, Config and Flow APIs fall into the latter
|
|
category.
|
|
|
|
## See also
|
|
|
|
- [TrustGraph websocket overview](websocket.md)
|
|
- [TrustGraph Pulsar overview](pulsar.md)
|
|
- API details
|
|
- [Text completion](api-text-completion.md)
|
|
- [Prompt completion](api-prompt.md)
|
|
- [Graph RAG](api-graph-rag.md)
|
|
- [Document RAG](api-document-rag.md)
|
|
- [Agent](api-agent.md)
|
|
- [Embeddings](api-embeddings.md)
|
|
- [Graph embeddings](api-graph-embeddings.md)
|
|
- [Document embeddings](api-document-embeddings.md)
|
|
- [Entity contexts](api-entity-contexts.md)
|
|
- [Triples query](api-triples-query.md)
|
|
- [Document load](api-document-load.md)
|
|
- [Text load](api-text-load.md)
|
|
- [Config](api-config.md)
|
|
- [Flow](api-flow.md)
|
|
- [Librarian](api-librarian.md)
|
|
- [Knowledge](api-knowledge.md)
|
|
- [Metrics](api-metrics.md)
|
|
- [Core import/export](api-core-import-export.md)
|
|
|