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

release/v2.4 -> master (#844)

Browse source
This commit is contained in:
cybermaggedon 2026-04-22 15:19:57 +01:00 • committed by GitHub
parent a24df8e990
commit 89cabee1b4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
386 changed files with 7202 additions and 5741 deletions
Download patch file Download diff file Expand all files Collapse all files

21
specs/api/paths/collection-management.yaml
View file

@ -10,11 +10,10 @@ post:
Collections are organizational units for grouping:
- Documents in the librarian
- Knowledge cores
- User data
- Workspace data
Each collection has:
- **user**: Owner identifier
- **collection**: Unique collection ID
- **collection**: Unique collection ID (within the workspace)
- **name**: Human-readable display name
- **description**: Purpose and contents
- **tags**: Labels for filtering and organization
@ -22,7 +21,7 @@ post:
## Operations
### list-collections
List all collections for a user. Optionally filter by tags and limit results.
List all collections in the workspace. Optionally filter by tags and limit results.
Returns array of collection metadata.
### update-collection
@ -30,7 +29,7 @@ post:
If it exists, metadata is updated. Allows setting name, description, and tags.
### delete-collection
Delete a collection by user and collection ID. This removes the metadata but
Delete a collection by collection ID. This removes the metadata but
typically does not delete the associated data (documents, knowledge cores).
operationId: collectionManagementService
@ -44,22 +43,19 @@ post:
$ref: '../components/schemas/collection/CollectionRequest.yaml'
examples:
listCollections:
summary: List all collections for user
summary: List all collections in workspace
value:
operation: list-collections
user: alice
listCollectionsFiltered:
summary: List collections filtered by tags
value:
operation: list-collections
user: alice
tag-filter: ["research", "AI"]
limit: 50
updateCollection:
summary: Create/update collection
value:
operation: update-collection
user: alice
collection: research
name: Research Papers
description: Academic research papers on AI and ML
@ -69,7 +65,6 @@ post:
summary: Delete collection
value:
operation: delete-collection
user: alice
collection: research
responses:
'200':
@ -84,13 +79,11 @@ post:
value:
timestamp: "2024-01-15T10:30:00Z"
collections:
- user: alice
collection: research
- collection: research
name: Research Papers
description: Academic research papers on AI and ML
tags: ["research", "AI", "academic"]
- user: alice
collection: personal
- collection: personal
name: Personal Documents
description: Personal notes and documents
tags: ["personal"]

8
specs/api/paths/document-stream.yaml
View file

@ -8,7 +8,6 @@ get:
## Parameters
- `user`: User identifier (required)
- `document-id`: Document IRI to retrieve (required)
- `chunk-size`: Size of each response chunk in bytes (optional, default: 1MB)
@ -16,13 +15,6 @@ get:
security:
- bearerAuth: []
parameters:
- name: user
in: query
required: true
schema:
type: string
description: User identifier
example: trustgraph
- name: document-id
in: query
required: true

10
specs/api/paths/export-core.yaml
View file

@ -23,7 +23,6 @@ get:
"m": { // Metadata
"i": "core-id", // Knowledge core ID
"m": [...], // Metadata triples array
"u": "user", // User
"c": "collection" // Collection
},
"t": [...] // Triples array
@ -36,7 +35,6 @@ get:
"m": { // Metadata
"i": "core-id",
"m": [...],
"u": "user",
"c": "collection"
},
"e": [ // Entities array
@ -56,7 +54,6 @@ get:
## Query Parameters
- **id**: Knowledge core ID to export
- **user**: User identifier
## Streaming
@ -86,13 +83,6 @@ get:
type: string
description: Knowledge core ID to export
example: core-123
- name: user
in: query
required: true
schema:
type: string
description: User identifier
example: alice
responses:
'200':
description: Export stream

4
specs/api/paths/flow/agent.yaml
View file

@ -69,25 +69,21 @@ post:
summary: Simple question
value:
question: What is the capital of France?
user: alice
streamingQuestion:
summary: Question with streaming enabled
value:
question: Explain quantum computing
user: alice
streaming: true
conversationWithHistory:
summary: Multi-turn conversation
value:
question: And what about its population?
user: alice
history:
- thought: User is asking about the capital of France
action: search
arguments:
query: "capital of France"
observation: "Paris is the capital of France"
user: alice
responses:
'200':
description: Successful response

1
specs/api/paths/flow/document-embeddings.yaml
View file

@ -75,7 +75,6 @@ post:
value:
vectors: [0.023, -0.142, 0.089, 0.234, -0.067, 0.156, 0.201, -0.178]
limit: 10
user: alice
collection: research
largeQuery:
summary: Larger result set

2
specs/api/paths/flow/document-load.yaml
View file

@ -88,14 +88,12 @@ post:
value:
data: JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PmVuZG9iagoyIDAgb2JqCjw8L1R5cGUvUGFnZXMvS2lkc1szIDAgUl0vQ291bnQgMT4+ZW5kb2JqCg==
id: doc-789
user: alice
collection: research
withMetadata:
summary: Load with metadata
value:
data: JVBERi0xLjQKJeLjz9MK...
id: doc-101112
user: bob
collection: papers
metadata:
- s: {v: "doc-101112", e: false}

3
specs/api/paths/flow/document-rag.yaml
View file

@ -40,7 +40,6 @@ post:
- Higher = more context but slower
- Lower = faster but may miss relevant info
- **collection**: Target specific document collection
- **user**: Multi-tenant isolation
operationId: documentRagService
security:
@ -64,13 +63,11 @@ post:
summary: Basic document query
value:
query: What are the key findings in the research papers?
user: alice
collection: research
streamingQuery:
summary: Streaming query
value:
query: Summarize the main conclusions
user: alice
collection: research
doc-limit: 15
streaming: true

1
specs/api/paths/flow/graph-embeddings.yaml
View file

@ -66,7 +66,6 @@ post:
value:
vectors: [0.023, -0.142, 0.089, 0.234, -0.067, 0.156, 0.201, -0.178]
limit: 10
user: alice
collection: research
largeQuery:
summary: Larger result set

2
specs/api/paths/flow/graph-rag.yaml
View file

@ -77,13 +77,11 @@ post:
summary: Basic graph query
value:
query: What connections exist between quantum physics and computer science?
user: alice
collection: research
streamingQuery:
summary: Streaming query with custom limits
value:
query: Trace the historical development of AI from Turing to modern LLMs
user: alice
collection: research
entity-limit: 40
triple-limit: 25

1
specs/api/paths/flow/row-embeddings.yaml
View file

@ -62,7 +62,6 @@ post:
vectors: [0.023, -0.142, 0.089, 0.234, -0.067, 0.156, 0.201, -0.178]
schema_name: customers
limit: 10
user: alice
collection: sales
filteredQuery:
summary: Search specific index

1
specs/api/paths/flow/rows.yaml
View file

@ -89,7 +89,6 @@ post:
email
}
}
user: alice
collection: research
queryWithVariables:
summary: Query with variables

5
specs/api/paths/flow/sparql-query.yaml
View file

@ -61,10 +61,6 @@ post:
query:
type: string
description: SPARQL 1.1 query string
user:
type: string
default: trustgraph
description: User/keyspace identifier
collection:
type: string
default: default
@ -78,7 +74,6 @@ post:
summary: SELECT query
value:
query: "SELECT ?s ?p ?o WHERE { ?s ?p ?o } LIMIT 10"
user: trustgraph
collection: default
askQuery:
summary: ASK query

2
specs/api/paths/flow/structured-query.yaml
View file

@ -79,13 +79,11 @@ post:
summary: Simple relationship question
value:
question: Who does Alice know?
user: alice
collection: research
complexQuestion:
summary: Complex multi-hop question
value:
question: What companies employ engineers that Bob collaborates with?
user: bob
collection: work
filterQuestion:
summary: Question with implicit filters

2
specs/api/paths/flow/text-load.yaml
View file

@ -87,14 +87,12 @@ post:
value:
text: This is the document text...
id: doc-123
user: alice
collection: research
withMetadata:
summary: Load with RDF metadata using base64 text
value:
text: UXVhbnR1bSBjb21wdXRpbmcgdXNlcyBxdWFudHVtIG1lY2hhbmljcyBwcmluY2lwbGVzLi4u
id: doc-456
user: alice
collection: research
metadata:
- s: {v: "doc-456", e: false}

2
specs/api/paths/flow/triples.yaml
View file

@ -81,7 +81,6 @@ post:
s:
v: https://example.com/person/alice
e: true
user: alice
collection: research
limit: 100
allInstancesOfType:
@ -100,7 +99,6 @@ post:
p:
v: https://example.com/knows
e: true
user: alice
limit: 200
responses:
'200':

10
specs/api/paths/import-core.yaml
View file

@ -23,7 +23,6 @@ post:
"m": { // Metadata
"i": "core-id", // Knowledge core ID
"m": [...], // Metadata triples array
"u": "user", // User
"c": "collection" // Collection
},
"t": [...] // Triples array
@ -36,7 +35,6 @@ post:
"m": { // Metadata
"i": "core-id",
"m": [...],
"u": "user",
"c": "collection"
},
"e": [ // Entities array
@ -51,7 +49,6 @@ post:
## Query Parameters
- **id**: Knowledge core ID
- **user**: User identifier
## Streaming
@ -77,13 +74,6 @@ post:
type: string
description: Knowledge core ID to import
example: core-123
- name: user
in: query
required: true
schema:
type: string
description: User identifier
example: alice
requestBody:
required: true
content:

12
specs/api/paths/knowledge.yaml
View file

@ -12,12 +12,12 @@ post:
- **Graph Embeddings**: Vector embeddings for entities
- **Metadata**: Descriptive information about the knowledge
Each core has an ID, user, and collection for organization.
Each core has an ID and collection for organization (within the workspace).
## Operations
### list-kg-cores
List all knowledge cores for a user. Returns array of core IDs.
List all knowledge cores in the workspace. Returns array of core IDs.
### get-kg-core
Retrieve a knowledge core by ID. Returns triples and/or graph embeddings.
@ -58,7 +58,6 @@ post:
summary: List knowledge cores
value:
operation: list-kg-cores
user: alice
getKnowledgeCore:
summary: Get knowledge core
value:
@ -71,7 +70,6 @@ post:
triples:
metadata:
id: core-123
user: alice
collection: default
metadata:
- s: {v: "https://example.com/core-123", e: true}
@ -91,7 +89,6 @@ post:
graph-embeddings:
metadata:
id: core-123
user: alice
collection: default
metadata: []
entities:
@ -106,7 +103,6 @@ post:
triples:
metadata:
id: core-456
user: bob
collection: research
metadata: []
triples:
@ -116,7 +112,6 @@ post:
graph-embeddings:
metadata:
id: core-456
user: bob
collection: research
metadata: []
entities:
@ -127,7 +122,6 @@ post:
value:
operation: delete-kg-core
id: core-123
user: alice
loadKnowledgeCore:
summary: Load core into flow
value:
@ -161,7 +155,6 @@ post:
triples:
metadata:
id: core-123
user: alice
collection: default
metadata:
- s: {v: "https://example.com/core-123", e: true}
@ -177,7 +170,6 @@ post:
graph-embeddings:
metadata:
id: core-123
user: alice
collection: default
metadata: []
entities: