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.
132 lines
4.1 KiB
YAML
132 lines
4.1 KiB
YAML
post:
|
|
tags:
|
|
- Flow Services
|
|
summary: Structured Query - question to results (all-in-one)
|
|
description: |
|
|
Ask natural language questions and get results directly.
|
|
|
|
## Structured Query Overview
|
|
|
|
Combines two operations in one call:
|
|
1. **NLP Query**: Generate GraphQL from question
|
|
2. **Rows Query**: Execute generated query
|
|
3. **Return Results**: Direct answer data
|
|
|
|
Simplest way to query knowledge graph with natural language.
|
|
|
|
## Comparison with Other Services
|
|
|
|
### Structured Query (this service)
|
|
- **Input**: Natural language question
|
|
- **Output**: Query results (data)
|
|
- **Use when**: Want simple, direct answers
|
|
|
|
### NLP Query + Rows Query (separate calls)
|
|
- **Step 1**: Convert question → GraphQL
|
|
- **Step 2**: Execute GraphQL → results
|
|
- **Use when**: Need to inspect/modify query before execution
|
|
|
|
### Triples Query (low-level)
|
|
- **Input**: RDF pattern
|
|
- **Output**: Matching triples
|
|
- **Use when**: Need precise control over graph queries
|
|
|
|
## Response Format
|
|
|
|
Returns standard GraphQL response:
|
|
- **data**: Query results (null if error)
|
|
- **errors**: Field-level errors (array of strings)
|
|
- **error**: System-level error (generation or execution failure)
|
|
|
|
## Error Handling
|
|
|
|
Three types of errors:
|
|
1. **Query generation failed**: Couldn't understand question
|
|
- Error in `error` object
|
|
- data = null
|
|
2. **Query execution failed**: Generated query had errors
|
|
- Errors in `errors` array
|
|
- data may be partial
|
|
3. **System error**: Infrastructure issue
|
|
- Error in `error` object
|
|
|
|
## Performance
|
|
|
|
Convenience vs control trade-off:
|
|
- **Faster development**: One call instead of two
|
|
- **Less control**: Can't inspect/modify generated query
|
|
- **Simpler code**: No need to handle intermediate steps
|
|
|
|
operationId: structuredQueryService
|
|
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/query/StructuredQueryRequest.yaml'
|
|
examples:
|
|
simpleQuestion:
|
|
summary: Simple relationship question
|
|
value:
|
|
question: Who does Alice know?
|
|
collection: research
|
|
complexQuestion:
|
|
summary: Complex multi-hop question
|
|
value:
|
|
question: What companies employ engineers that Bob collaborates with?
|
|
collection: work
|
|
filterQuestion:
|
|
summary: Question with implicit filters
|
|
value:
|
|
question: Which researchers work on quantum computing?
|
|
responses:
|
|
'200':
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../../components/schemas/query/StructuredQueryResponse.yaml'
|
|
examples:
|
|
successfulQuery:
|
|
summary: Successful query with results
|
|
value:
|
|
data:
|
|
person:
|
|
name: Alice
|
|
knows:
|
|
- name: Bob
|
|
email: bob@example.com
|
|
- name: Carol
|
|
email: carol@example.com
|
|
errors: []
|
|
partialResults:
|
|
summary: Partial results with errors
|
|
value:
|
|
data:
|
|
person:
|
|
name: Alice
|
|
knows: null
|
|
errors:
|
|
- Cannot query field 'nonexistent' on type 'Person'
|
|
generationFailed:
|
|
summary: Query generation failed
|
|
value:
|
|
data: null
|
|
errors: []
|
|
error:
|
|
type: QUERY_GENERATION_ERROR
|
|
message: Could not understand question structure
|
|
'401':
|
|
$ref: '../../components/responses/Unauthorized.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/Error.yaml'
|