mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-06-03 20:05:13 +02:00
d35473f7f7
Introduces `workspace` as the isolation boundary for config, flows,
library, and knowledge data. Removes `user` as a schema-level field
throughout the code, API specs, and tests; workspace provides the
same separation more cleanly at the trusted flow.workspace layer
rather than through client-supplied message fields.
Design
------
- IAM tech spec (docs/tech-specs/iam.md) documents current state,
proposed auth/access model, and migration direction.
- Data ownership model (docs/tech-specs/data-ownership-model.md)
captures the workspace/collection/flow hierarchy.
Schema + messaging
------------------
- Drop `user` field from AgentRequest/Step, GraphRagQuery,
DocumentRagQuery, Triples/Graph/Document/Row EmbeddingsRequest,
Sparql/Rows/Structured QueryRequest, ToolServiceRequest.
- Keep collection/workspace routing via flow.workspace at the
service layer.
- Translators updated to not serialise/deserialise user.
API specs
---------
- OpenAPI schemas and path examples cleaned of user fields.
- Websocket async-api messages updated.
- Removed the unused parameters/User.yaml.
Services + base
---------------
- Librarian, collection manager, knowledge, config: all operations
scoped by workspace. Config client API takes workspace as first
positional arg.
- `flow.workspace` set at flow start time by the infrastructure;
no longer pass-through from clients.
- Tool service drops user-personalisation passthrough.
CLI + SDK
---------
- tg-init-workspace and workspace-aware import/export.
- All tg-* commands drop user args; accept --workspace.
- Python API/SDK (flow, socket_client, async_*, explainability,
library) drop user kwargs from every method signature.
MCP server
----------
- All tool endpoints drop user parameters; socket_manager no longer
keyed per user.
Flow service
------------
- Closure-based topic cleanup on flow stop: only delete topics
whose blueprint template was parameterised AND no remaining
live flow (across all workspaces) still resolves to that topic.
Three scopes fall out naturally from template analysis:
* {id} -> per-flow, deleted on stop
* {blueprint} -> per-blueprint, kept while any flow of the
same blueprint exists
* {workspace} -> per-workspace, kept while any flow in the
workspace exists
* literal -> global, never deleted (e.g. tg.request.librarian)
Fixes a bug where stopping a flow silently destroyed the global
librarian exchange, wedging all library operations until manual
restart.
RabbitMQ backend
----------------
- heartbeat=60, blocked_connection_timeout=300. Catches silently
dead connections (broker restart, orphaned channels, network
partitions) within ~2 heartbeat windows, so the consumer
reconnects and re-binds its queue rather than sitting forever
on a zombie connection.
Tests
-----
- Full test refresh: unit, integration, contract, provenance.
- Dropped user-field assertions and constructor kwargs across
~100 test files.
- Renamed user-collection isolation tests to workspace-collection.
210 lines
4.3 KiB
Python
210 lines
4.3 KiB
Python
"""
|
|
TrustGraph API Client Library
|
|
|
|
This package provides Python client interfaces for interacting with TrustGraph services.
|
|
TrustGraph is a knowledge graph and RAG (Retrieval-Augmented Generation) platform that
|
|
combines graph databases, vector embeddings, and LLM capabilities.
|
|
|
|
The library offers both synchronous and asynchronous APIs for:
|
|
- Flow management and execution
|
|
- Knowledge graph operations (triples, entities, embeddings)
|
|
- RAG queries (graph-based and document-based)
|
|
- Agent interactions with streaming support
|
|
- WebSocket-based real-time communication
|
|
- Bulk import/export operations
|
|
- Configuration and collection management
|
|
|
|
Quick Start:
|
|
```python
|
|
from trustgraph.api import Api
|
|
|
|
# Create API client
|
|
api = Api(url="http://localhost:8088/")
|
|
|
|
# Get a flow instance
|
|
flow = api.flow().id("default")
|
|
|
|
# Execute a graph RAG query
|
|
response = flow.graph_rag(
|
|
query="What are the main topics?",
|
|
collection="default"
|
|
)
|
|
```
|
|
|
|
For streaming and async operations:
|
|
```python
|
|
# WebSocket streaming
|
|
socket = api.socket()
|
|
flow = socket.flow("default")
|
|
|
|
for chunk in flow.agent(question="Hello"):
|
|
print(chunk.content)
|
|
|
|
# Async operations
|
|
async with Api(url="http://localhost:8088/") as api:
|
|
async_flow = api.async_flow()
|
|
result = await async_flow.id("default").text_completion(
|
|
system="You are helpful",
|
|
prompt="Hello"
|
|
)
|
|
```
|
|
"""
|
|
|
|
# Core API
|
|
from .api import Api
|
|
|
|
# Flow clients
|
|
from .flow import Flow, FlowInstance
|
|
from .async_flow import AsyncFlow, AsyncFlowInstance
|
|
|
|
# WebSocket clients
|
|
from .socket_client import SocketClient, SocketFlowInstance, build_term
|
|
from .async_socket_client import AsyncSocketClient, AsyncSocketFlowInstance
|
|
|
|
# Bulk operation clients
|
|
from .bulk_client import BulkClient
|
|
from .async_bulk_client import AsyncBulkClient
|
|
|
|
# Metrics clients
|
|
from .metrics import Metrics
|
|
from .async_metrics import AsyncMetrics
|
|
|
|
# Explainability
|
|
from .explainability import (
|
|
ExplainabilityClient,
|
|
ExplainEntity,
|
|
Question,
|
|
Grounding,
|
|
Exploration,
|
|
Focus,
|
|
Synthesis,
|
|
Reflection,
|
|
Analysis,
|
|
Observation,
|
|
Conclusion,
|
|
Decomposition,
|
|
Finding,
|
|
Plan,
|
|
StepResult,
|
|
EdgeSelection,
|
|
wire_triples_to_tuples,
|
|
extract_term_value,
|
|
)
|
|
|
|
# Types
|
|
from .types import (
|
|
Triple,
|
|
Uri,
|
|
Literal,
|
|
ConfigKey,
|
|
ConfigValue,
|
|
DocumentMetadata,
|
|
ProcessingMetadata,
|
|
CollectionMetadata,
|
|
StreamingChunk,
|
|
AgentThought,
|
|
AgentObservation,
|
|
AgentAnswer,
|
|
RAGChunk,
|
|
TextCompletionResult,
|
|
ProvenanceEvent,
|
|
)
|
|
|
|
# Exceptions
|
|
from .exceptions import (
|
|
ProtocolException,
|
|
TrustGraphException,
|
|
AgentError,
|
|
ConfigError,
|
|
DocumentRagError,
|
|
FlowError,
|
|
GatewayError,
|
|
GraphRagError,
|
|
LLMError,
|
|
LoadError,
|
|
LookupError,
|
|
NLPQueryError,
|
|
RowsQueryError,
|
|
RequestError,
|
|
StructuredQueryError,
|
|
UnexpectedError,
|
|
# Legacy alias
|
|
ApplicationException,
|
|
)
|
|
|
|
__all__ = [
|
|
# Core API
|
|
"Api",
|
|
|
|
# Flow clients
|
|
"Flow",
|
|
"FlowInstance",
|
|
"AsyncFlow",
|
|
"AsyncFlowInstance",
|
|
|
|
# WebSocket clients
|
|
"SocketClient",
|
|
"SocketFlowInstance",
|
|
"AsyncSocketClient",
|
|
"AsyncSocketFlowInstance",
|
|
"build_term",
|
|
|
|
# Bulk operation clients
|
|
"BulkClient",
|
|
"AsyncBulkClient",
|
|
|
|
# Metrics clients
|
|
"Metrics",
|
|
"AsyncMetrics",
|
|
|
|
# Explainability
|
|
"ExplainabilityClient",
|
|
"ExplainEntity",
|
|
"Question",
|
|
"Exploration",
|
|
"Focus",
|
|
"Synthesis",
|
|
"Analysis",
|
|
"Observation",
|
|
"Conclusion",
|
|
"EdgeSelection",
|
|
"wire_triples_to_tuples",
|
|
"extract_term_value",
|
|
|
|
# Types
|
|
"Triple",
|
|
"Uri",
|
|
"Literal",
|
|
"ConfigKey",
|
|
"ConfigValue",
|
|
"DocumentMetadata",
|
|
"ProcessingMetadata",
|
|
"CollectionMetadata",
|
|
"StreamingChunk",
|
|
"AgentThought",
|
|
"AgentObservation",
|
|
"AgentAnswer",
|
|
"RAGChunk",
|
|
"TextCompletionResult",
|
|
"ProvenanceEvent",
|
|
|
|
# Exceptions
|
|
"ProtocolException",
|
|
"TrustGraphException",
|
|
"AgentError",
|
|
"ConfigError",
|
|
"DocumentRagError",
|
|
"FlowError",
|
|
"GatewayError",
|
|
"GraphRagError",
|
|
"LLMError",
|
|
"LoadError",
|
|
"LookupError",
|
|
"NLPQueryError",
|
|
"RowsQueryError",
|
|
"RequestError",
|
|
"StructuredQueryError",
|
|
"UnexpectedError",
|
|
"ApplicationException", # Legacy alias
|
|
]
|
|
|