mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 16:36:21 +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.
117 lines
3.3 KiB
YAML
117 lines
3.3 KiB
YAML
post:
|
|
tags:
|
|
- Flow Services
|
|
summary: Document Load - load binary documents (PDF, etc.)
|
|
description: |
|
|
Load binary documents (PDF, Word, etc.) into processing pipeline.
|
|
|
|
## Document Load Overview
|
|
|
|
Fire-and-forget binary document loading:
|
|
- **Input**: Document data (base64 encoded)
|
|
- **Process**: Extract text, chunk, embed, store
|
|
- **Output**: None (202 Accepted)
|
|
|
|
Asynchronous processing for PDF and other binary formats.
|
|
|
|
## Processing Pipeline
|
|
|
|
Documents go through:
|
|
1. **Text extraction**: PDF→text, DOCX→text, etc.
|
|
2. **Chunking**: Split into overlapping chunks
|
|
3. **Embedding**: Generate vectors for each chunk
|
|
4. **Storage**: Store chunks + embeddings
|
|
5. **Indexing**: Make searchable
|
|
|
|
Pipeline runs asynchronously.
|
|
|
|
## Supported Formats
|
|
|
|
- **PDF**: Portable Document Format
|
|
- **DOCX**: Microsoft Word
|
|
- **HTML**: Web pages
|
|
- Other formats via extractors
|
|
|
|
Format detected from content, not extension.
|
|
|
|
## Binary Encoding
|
|
|
|
Documents must be base64 encoded:
|
|
```python
|
|
with open('document.pdf', 'rb') as f:
|
|
doc_bytes = f.read()
|
|
encoded = base64.b64encode(doc_bytes).decode('utf-8')
|
|
```
|
|
|
|
## Metadata
|
|
|
|
Optional RDF triples:
|
|
- Document properties
|
|
- Source information
|
|
- Custom attributes
|
|
|
|
## Use Cases
|
|
|
|
- **PDF ingestion**: Process research papers
|
|
- **Document libraries**: Index document collections
|
|
- **Content migration**: Import from other systems
|
|
- **Automated processing**: Batch document loading
|
|
|
|
## No Response Data
|
|
|
|
Returns 202 Accepted immediately:
|
|
- Document queued
|
|
- Processing happens asynchronously
|
|
- No status tracking
|
|
- Query later to verify indexed
|
|
|
|
operationId: documentLoadService
|
|
security:
|
|
- bearerAuth: []
|
|
parameters:
|
|
- name: flow
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: Flow instance ID
|
|
example: my-flow
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../../components/schemas/loading/DocumentLoadRequest.yaml'
|
|
examples:
|
|
loadPdf:
|
|
summary: Load PDF document
|
|
value:
|
|
data: JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PmVuZG9iagoyIDAgb2JqCjw8L1R5cGUvUGFnZXMvS2lkc1szIDAgUl0vQ291bnQgMT4+ZW5kb2JqCg==
|
|
id: doc-789
|
|
collection: research
|
|
withMetadata:
|
|
summary: Load with metadata
|
|
value:
|
|
data: JVBERi0xLjQKJeLjz9MK...
|
|
id: doc-101112
|
|
collection: papers
|
|
metadata:
|
|
- s: {v: "doc-101112", e: false}
|
|
p: {v: "http://purl.org/dc/terms/title", e: true}
|
|
o: {v: "Quantum Entanglement Research", e: false}
|
|
- s: {v: "doc-101112", e: false}
|
|
p: {v: "http://purl.org/dc/terms/date", e: true}
|
|
o: {v: "2024-01-15", e: false}
|
|
responses:
|
|
'202':
|
|
description: Document accepted for processing
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties: {}
|
|
example: {}
|
|
'401':
|
|
$ref: '../../components/responses/Unauthorized.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/Error.yaml'
|