mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-07-05 11:22:11 +02:00
Update API specs
This commit is contained in:
parent
594deba73e
commit
b887675b4b
36 changed files with 11 additions and 193 deletions
|
|
@ -1,8 +0,0 @@
|
||||||
name: user
|
|
||||||
in: query
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
default: trustgraph
|
|
||||||
description: User identifier
|
|
||||||
example: alice
|
|
||||||
|
|
@ -43,15 +43,6 @@ properties:
|
||||||
type: string
|
type: string
|
||||||
description: Result of the action
|
description: Result of the action
|
||||||
example: "Paris is the capital of France"
|
example: "Paris is the capital of France"
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User context for this step
|
|
||||||
example: alice
|
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier for multi-tenancy
|
|
||||||
default: trustgraph
|
|
||||||
example: alice
|
|
||||||
streaming:
|
streaming:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: Enable streaming response delivery
|
description: Enable streaming response delivery
|
||||||
|
|
|
||||||
|
|
@ -14,14 +14,9 @@ properties:
|
||||||
- delete-collection
|
- delete-collection
|
||||||
description: |
|
description: |
|
||||||
Collection operation:
|
Collection operation:
|
||||||
- `list-collections`: List collections for user
|
- `list-collections`: List collections in workspace
|
||||||
- `update-collection`: Create or update collection metadata
|
- `update-collection`: Create or update collection metadata
|
||||||
- `delete-collection`: Delete collection
|
- `delete-collection`: Delete collection
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
default: trustgraph
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection identifier (for update, delete)
|
description: Collection identifier (for update, delete)
|
||||||
|
|
|
||||||
|
|
@ -12,13 +12,8 @@ properties:
|
||||||
items:
|
items:
|
||||||
type: object
|
type: object
|
||||||
required:
|
required:
|
||||||
- user
|
|
||||||
- collection
|
- collection
|
||||||
properties:
|
properties:
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection identifier
|
description: Collection identifier
|
||||||
|
|
|
||||||
|
|
@ -17,11 +17,6 @@ properties:
|
||||||
minimum: 1
|
minimum: 1
|
||||||
maximum: 1000
|
maximum: 1000
|
||||||
example: 20
|
example: 20
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
default: trustgraph
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection to search
|
description: Collection to search
|
||||||
|
|
|
||||||
|
|
@ -17,11 +17,6 @@ properties:
|
||||||
minimum: 1
|
minimum: 1
|
||||||
maximum: 1000
|
maximum: 1000
|
||||||
example: 20
|
example: 20
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
default: trustgraph
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection to search
|
description: Collection to search
|
||||||
|
|
|
||||||
|
|
@ -27,11 +27,6 @@ properties:
|
||||||
minimum: 1
|
minimum: 1
|
||||||
maximum: 1000
|
maximum: 1000
|
||||||
example: 20
|
example: 20
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
default: trustgraph
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection to search
|
description: Collection to search
|
||||||
|
|
|
||||||
|
|
@ -18,17 +18,12 @@ properties:
|
||||||
- unload-kg-core
|
- unload-kg-core
|
||||||
description: |
|
description: |
|
||||||
Knowledge core operation:
|
Knowledge core operation:
|
||||||
- `list-kg-cores`: List knowledge cores for user
|
- `list-kg-cores`: List knowledge cores in workspace
|
||||||
- `get-kg-core`: Get knowledge core by ID
|
- `get-kg-core`: Get knowledge core by ID
|
||||||
- `put-kg-core`: Store triples and/or embeddings
|
- `put-kg-core`: Store triples and/or embeddings
|
||||||
- `delete-kg-core`: Delete knowledge core by ID
|
- `delete-kg-core`: Delete knowledge core by ID
|
||||||
- `load-kg-core`: Load knowledge core into flow
|
- `load-kg-core`: Load knowledge core into flow
|
||||||
- `unload-kg-core`: Unload knowledge core from flow
|
- `unload-kg-core`: Unload knowledge core from flow
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier (for list-kg-cores, put-kg-core, delete-kg-core)
|
|
||||||
default: trustgraph
|
|
||||||
example: alice
|
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
description: Knowledge core ID (for get, put, delete, load, unload)
|
description: Knowledge core ID (for get, put, delete, load, unload)
|
||||||
|
|
@ -53,17 +48,12 @@ properties:
|
||||||
type: object
|
type: object
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
- user
|
|
||||||
- collection
|
- collection
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
description: Knowledge core ID
|
description: Knowledge core ID
|
||||||
example: core-123
|
example: core-123
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection identifier
|
description: Collection identifier
|
||||||
|
|
@ -89,17 +79,12 @@ properties:
|
||||||
type: object
|
type: object
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
- user
|
|
||||||
- collection
|
- collection
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
description: Knowledge core ID
|
description: Knowledge core ID
|
||||||
example: core-123
|
example: core-123
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection identifier
|
description: Collection identifier
|
||||||
|
|
|
||||||
|
|
@ -15,17 +15,12 @@ properties:
|
||||||
type: object
|
type: object
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
- user
|
|
||||||
- collection
|
- collection
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
description: Knowledge core ID
|
description: Knowledge core ID
|
||||||
example: core-123
|
example: core-123
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection identifier
|
description: Collection identifier
|
||||||
|
|
@ -48,17 +43,12 @@ properties:
|
||||||
type: object
|
type: object
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
- user
|
|
||||||
- collection
|
- collection
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
description: Knowledge core ID
|
description: Knowledge core ID
|
||||||
example: core-123
|
example: core-123
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection identifier
|
description: Collection identifier
|
||||||
|
|
|
||||||
|
|
@ -62,11 +62,6 @@ properties:
|
||||||
description: Collection identifier
|
description: Collection identifier
|
||||||
default: default
|
default: default
|
||||||
example: default
|
example: default
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
default: trustgraph
|
|
||||||
example: alice
|
|
||||||
document-id:
|
document-id:
|
||||||
type: string
|
type: string
|
||||||
description: Document identifier
|
description: Document identifier
|
||||||
|
|
|
||||||
|
|
@ -15,11 +15,6 @@ properties:
|
||||||
type: string
|
type: string
|
||||||
description: Document identifier
|
description: Document identifier
|
||||||
example: doc-456
|
example: doc-456
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
default: trustgraph
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection for document
|
description: Collection for document
|
||||||
|
|
|
||||||
|
|
@ -14,11 +14,6 @@ properties:
|
||||||
type: string
|
type: string
|
||||||
description: Document identifier
|
description: Document identifier
|
||||||
example: doc-123
|
example: doc-123
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
default: trustgraph
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection for document
|
description: Collection for document
|
||||||
|
|
|
||||||
|
|
@ -28,11 +28,6 @@ properties:
|
||||||
type: string
|
type: string
|
||||||
description: Operation name (for multi-operation documents)
|
description: Operation name (for multi-operation documents)
|
||||||
example: GetPerson
|
example: GetPerson
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
default: trustgraph
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection to query
|
description: Collection to query
|
||||||
|
|
|
||||||
|
|
@ -10,11 +10,6 @@ properties:
|
||||||
type: string
|
type: string
|
||||||
description: Natural language question
|
description: Natural language question
|
||||||
example: Who does Alice know that works in engineering?
|
example: Who does Alice know that works in engineering?
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
default: trustgraph
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection to query
|
description: Collection to query
|
||||||
|
|
|
||||||
|
|
@ -18,11 +18,6 @@ properties:
|
||||||
minimum: 1
|
minimum: 1
|
||||||
maximum: 100000
|
maximum: 100000
|
||||||
example: 100
|
example: 100
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
default: trustgraph
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection to query
|
description: Collection to query
|
||||||
|
|
|
||||||
|
|
@ -9,11 +9,6 @@ properties:
|
||||||
type: string
|
type: string
|
||||||
description: User query or question
|
description: User query or question
|
||||||
example: What are the key findings in the research papers?
|
example: What are the key findings in the research papers?
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier for multi-tenancy
|
|
||||||
default: trustgraph
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection to search within
|
description: Collection to search within
|
||||||
|
|
|
||||||
|
|
@ -9,11 +9,6 @@ properties:
|
||||||
type: string
|
type: string
|
||||||
description: User query or question
|
description: User query or question
|
||||||
example: What connections exist between quantum physics and computer science?
|
example: What connections exist between quantum physics and computer science?
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
description: User identifier for multi-tenancy
|
|
||||||
default: trustgraph
|
|
||||||
example: alice
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
description: Collection to search within
|
description: Collection to search within
|
||||||
|
|
|
||||||
|
|
@ -10,11 +10,10 @@ post:
|
||||||
Collections are organizational units for grouping:
|
Collections are organizational units for grouping:
|
||||||
- Documents in the librarian
|
- Documents in the librarian
|
||||||
- Knowledge cores
|
- Knowledge cores
|
||||||
- User data
|
- Workspace data
|
||||||
|
|
||||||
Each collection has:
|
Each collection has:
|
||||||
- **user**: Owner identifier
|
- **collection**: Unique collection ID (within the workspace)
|
||||||
- **collection**: Unique collection ID
|
|
||||||
- **name**: Human-readable display name
|
- **name**: Human-readable display name
|
||||||
- **description**: Purpose and contents
|
- **description**: Purpose and contents
|
||||||
- **tags**: Labels for filtering and organization
|
- **tags**: Labels for filtering and organization
|
||||||
|
|
@ -22,7 +21,7 @@ post:
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
### list-collections
|
### 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.
|
Returns array of collection metadata.
|
||||||
|
|
||||||
### update-collection
|
### update-collection
|
||||||
|
|
@ -30,7 +29,7 @@ post:
|
||||||
If it exists, metadata is updated. Allows setting name, description, and tags.
|
If it exists, metadata is updated. Allows setting name, description, and tags.
|
||||||
|
|
||||||
### delete-collection
|
### 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).
|
typically does not delete the associated data (documents, knowledge cores).
|
||||||
|
|
||||||
operationId: collectionManagementService
|
operationId: collectionManagementService
|
||||||
|
|
@ -44,22 +43,19 @@ post:
|
||||||
$ref: '../components/schemas/collection/CollectionRequest.yaml'
|
$ref: '../components/schemas/collection/CollectionRequest.yaml'
|
||||||
examples:
|
examples:
|
||||||
listCollections:
|
listCollections:
|
||||||
summary: List all collections for user
|
summary: List all collections in workspace
|
||||||
value:
|
value:
|
||||||
operation: list-collections
|
operation: list-collections
|
||||||
user: alice
|
|
||||||
listCollectionsFiltered:
|
listCollectionsFiltered:
|
||||||
summary: List collections filtered by tags
|
summary: List collections filtered by tags
|
||||||
value:
|
value:
|
||||||
operation: list-collections
|
operation: list-collections
|
||||||
user: alice
|
|
||||||
tag-filter: ["research", "AI"]
|
tag-filter: ["research", "AI"]
|
||||||
limit: 50
|
limit: 50
|
||||||
updateCollection:
|
updateCollection:
|
||||||
summary: Create/update collection
|
summary: Create/update collection
|
||||||
value:
|
value:
|
||||||
operation: update-collection
|
operation: update-collection
|
||||||
user: alice
|
|
||||||
collection: research
|
collection: research
|
||||||
name: Research Papers
|
name: Research Papers
|
||||||
description: Academic research papers on AI and ML
|
description: Academic research papers on AI and ML
|
||||||
|
|
@ -69,7 +65,6 @@ post:
|
||||||
summary: Delete collection
|
summary: Delete collection
|
||||||
value:
|
value:
|
||||||
operation: delete-collection
|
operation: delete-collection
|
||||||
user: alice
|
|
||||||
collection: research
|
collection: research
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
|
|
@ -84,13 +79,11 @@ post:
|
||||||
value:
|
value:
|
||||||
timestamp: "2024-01-15T10:30:00Z"
|
timestamp: "2024-01-15T10:30:00Z"
|
||||||
collections:
|
collections:
|
||||||
- user: alice
|
- collection: research
|
||||||
collection: research
|
|
||||||
name: Research Papers
|
name: Research Papers
|
||||||
description: Academic research papers on AI and ML
|
description: Academic research papers on AI and ML
|
||||||
tags: ["research", "AI", "academic"]
|
tags: ["research", "AI", "academic"]
|
||||||
- user: alice
|
- collection: personal
|
||||||
collection: personal
|
|
||||||
name: Personal Documents
|
name: Personal Documents
|
||||||
description: Personal notes and documents
|
description: Personal notes and documents
|
||||||
tags: ["personal"]
|
tags: ["personal"]
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,6 @@ get:
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
- `user`: User identifier (required)
|
|
||||||
- `document-id`: Document IRI to retrieve (required)
|
- `document-id`: Document IRI to retrieve (required)
|
||||||
- `chunk-size`: Size of each response chunk in bytes (optional, default: 1MB)
|
- `chunk-size`: Size of each response chunk in bytes (optional, default: 1MB)
|
||||||
|
|
||||||
|
|
@ -16,13 +15,6 @@ get:
|
||||||
security:
|
security:
|
||||||
- bearerAuth: []
|
- bearerAuth: []
|
||||||
parameters:
|
parameters:
|
||||||
- name: user
|
|
||||||
in: query
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
example: trustgraph
|
|
||||||
- name: document-id
|
- name: document-id
|
||||||
in: query
|
in: query
|
||||||
required: true
|
required: true
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,6 @@ get:
|
||||||
"m": { // Metadata
|
"m": { // Metadata
|
||||||
"i": "core-id", // Knowledge core ID
|
"i": "core-id", // Knowledge core ID
|
||||||
"m": [...], // Metadata triples array
|
"m": [...], // Metadata triples array
|
||||||
"u": "user", // User
|
|
||||||
"c": "collection" // Collection
|
"c": "collection" // Collection
|
||||||
},
|
},
|
||||||
"t": [...] // Triples array
|
"t": [...] // Triples array
|
||||||
|
|
@ -36,7 +35,6 @@ get:
|
||||||
"m": { // Metadata
|
"m": { // Metadata
|
||||||
"i": "core-id",
|
"i": "core-id",
|
||||||
"m": [...],
|
"m": [...],
|
||||||
"u": "user",
|
|
||||||
"c": "collection"
|
"c": "collection"
|
||||||
},
|
},
|
||||||
"e": [ // Entities array
|
"e": [ // Entities array
|
||||||
|
|
@ -56,7 +54,6 @@ get:
|
||||||
## Query Parameters
|
## Query Parameters
|
||||||
|
|
||||||
- **id**: Knowledge core ID to export
|
- **id**: Knowledge core ID to export
|
||||||
- **user**: User identifier
|
|
||||||
|
|
||||||
## Streaming
|
## Streaming
|
||||||
|
|
||||||
|
|
@ -86,13 +83,6 @@ get:
|
||||||
type: string
|
type: string
|
||||||
description: Knowledge core ID to export
|
description: Knowledge core ID to export
|
||||||
example: core-123
|
example: core-123
|
||||||
- name: user
|
|
||||||
in: query
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
example: alice
|
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: Export stream
|
description: Export stream
|
||||||
|
|
|
||||||
|
|
@ -69,25 +69,21 @@ post:
|
||||||
summary: Simple question
|
summary: Simple question
|
||||||
value:
|
value:
|
||||||
question: What is the capital of France?
|
question: What is the capital of France?
|
||||||
user: alice
|
|
||||||
streamingQuestion:
|
streamingQuestion:
|
||||||
summary: Question with streaming enabled
|
summary: Question with streaming enabled
|
||||||
value:
|
value:
|
||||||
question: Explain quantum computing
|
question: Explain quantum computing
|
||||||
user: alice
|
|
||||||
streaming: true
|
streaming: true
|
||||||
conversationWithHistory:
|
conversationWithHistory:
|
||||||
summary: Multi-turn conversation
|
summary: Multi-turn conversation
|
||||||
value:
|
value:
|
||||||
question: And what about its population?
|
question: And what about its population?
|
||||||
user: alice
|
|
||||||
history:
|
history:
|
||||||
- thought: User is asking about the capital of France
|
- thought: User is asking about the capital of France
|
||||||
action: search
|
action: search
|
||||||
arguments:
|
arguments:
|
||||||
query: "capital of France"
|
query: "capital of France"
|
||||||
observation: "Paris is the capital of France"
|
observation: "Paris is the capital of France"
|
||||||
user: alice
|
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: Successful response
|
description: Successful response
|
||||||
|
|
|
||||||
|
|
@ -75,7 +75,6 @@ post:
|
||||||
value:
|
value:
|
||||||
vectors: [0.023, -0.142, 0.089, 0.234, -0.067, 0.156, 0.201, -0.178]
|
vectors: [0.023, -0.142, 0.089, 0.234, -0.067, 0.156, 0.201, -0.178]
|
||||||
limit: 10
|
limit: 10
|
||||||
user: alice
|
|
||||||
collection: research
|
collection: research
|
||||||
largeQuery:
|
largeQuery:
|
||||||
summary: Larger result set
|
summary: Larger result set
|
||||||
|
|
|
||||||
|
|
@ -88,14 +88,12 @@ post:
|
||||||
value:
|
value:
|
||||||
data: JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PmVuZG9iagoyIDAgb2JqCjw8L1R5cGUvUGFnZXMvS2lkc1szIDAgUl0vQ291bnQgMT4+ZW5kb2JqCg==
|
data: JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PmVuZG9iagoyIDAgb2JqCjw8L1R5cGUvUGFnZXMvS2lkc1szIDAgUl0vQ291bnQgMT4+ZW5kb2JqCg==
|
||||||
id: doc-789
|
id: doc-789
|
||||||
user: alice
|
|
||||||
collection: research
|
collection: research
|
||||||
withMetadata:
|
withMetadata:
|
||||||
summary: Load with metadata
|
summary: Load with metadata
|
||||||
value:
|
value:
|
||||||
data: JVBERi0xLjQKJeLjz9MK...
|
data: JVBERi0xLjQKJeLjz9MK...
|
||||||
id: doc-101112
|
id: doc-101112
|
||||||
user: bob
|
|
||||||
collection: papers
|
collection: papers
|
||||||
metadata:
|
metadata:
|
||||||
- s: {v: "doc-101112", e: false}
|
- s: {v: "doc-101112", e: false}
|
||||||
|
|
|
||||||
|
|
@ -40,7 +40,6 @@ post:
|
||||||
- Higher = more context but slower
|
- Higher = more context but slower
|
||||||
- Lower = faster but may miss relevant info
|
- Lower = faster but may miss relevant info
|
||||||
- **collection**: Target specific document collection
|
- **collection**: Target specific document collection
|
||||||
- **user**: Multi-tenant isolation
|
|
||||||
|
|
||||||
operationId: documentRagService
|
operationId: documentRagService
|
||||||
security:
|
security:
|
||||||
|
|
@ -64,13 +63,11 @@ post:
|
||||||
summary: Basic document query
|
summary: Basic document query
|
||||||
value:
|
value:
|
||||||
query: What are the key findings in the research papers?
|
query: What are the key findings in the research papers?
|
||||||
user: alice
|
|
||||||
collection: research
|
collection: research
|
||||||
streamingQuery:
|
streamingQuery:
|
||||||
summary: Streaming query
|
summary: Streaming query
|
||||||
value:
|
value:
|
||||||
query: Summarize the main conclusions
|
query: Summarize the main conclusions
|
||||||
user: alice
|
|
||||||
collection: research
|
collection: research
|
||||||
doc-limit: 15
|
doc-limit: 15
|
||||||
streaming: true
|
streaming: true
|
||||||
|
|
|
||||||
|
|
@ -66,7 +66,6 @@ post:
|
||||||
value:
|
value:
|
||||||
vectors: [0.023, -0.142, 0.089, 0.234, -0.067, 0.156, 0.201, -0.178]
|
vectors: [0.023, -0.142, 0.089, 0.234, -0.067, 0.156, 0.201, -0.178]
|
||||||
limit: 10
|
limit: 10
|
||||||
user: alice
|
|
||||||
collection: research
|
collection: research
|
||||||
largeQuery:
|
largeQuery:
|
||||||
summary: Larger result set
|
summary: Larger result set
|
||||||
|
|
|
||||||
|
|
@ -77,13 +77,11 @@ post:
|
||||||
summary: Basic graph query
|
summary: Basic graph query
|
||||||
value:
|
value:
|
||||||
query: What connections exist between quantum physics and computer science?
|
query: What connections exist between quantum physics and computer science?
|
||||||
user: alice
|
|
||||||
collection: research
|
collection: research
|
||||||
streamingQuery:
|
streamingQuery:
|
||||||
summary: Streaming query with custom limits
|
summary: Streaming query with custom limits
|
||||||
value:
|
value:
|
||||||
query: Trace the historical development of AI from Turing to modern LLMs
|
query: Trace the historical development of AI from Turing to modern LLMs
|
||||||
user: alice
|
|
||||||
collection: research
|
collection: research
|
||||||
entity-limit: 40
|
entity-limit: 40
|
||||||
triple-limit: 25
|
triple-limit: 25
|
||||||
|
|
|
||||||
|
|
@ -62,7 +62,6 @@ post:
|
||||||
vectors: [0.023, -0.142, 0.089, 0.234, -0.067, 0.156, 0.201, -0.178]
|
vectors: [0.023, -0.142, 0.089, 0.234, -0.067, 0.156, 0.201, -0.178]
|
||||||
schema_name: customers
|
schema_name: customers
|
||||||
limit: 10
|
limit: 10
|
||||||
user: alice
|
|
||||||
collection: sales
|
collection: sales
|
||||||
filteredQuery:
|
filteredQuery:
|
||||||
summary: Search specific index
|
summary: Search specific index
|
||||||
|
|
|
||||||
|
|
@ -89,7 +89,6 @@ post:
|
||||||
email
|
email
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
user: alice
|
|
||||||
collection: research
|
collection: research
|
||||||
queryWithVariables:
|
queryWithVariables:
|
||||||
summary: Query with variables
|
summary: Query with variables
|
||||||
|
|
|
||||||
|
|
@ -61,10 +61,6 @@ post:
|
||||||
query:
|
query:
|
||||||
type: string
|
type: string
|
||||||
description: SPARQL 1.1 query string
|
description: SPARQL 1.1 query string
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
default: trustgraph
|
|
||||||
description: User/keyspace identifier
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
default: default
|
default: default
|
||||||
|
|
@ -78,7 +74,6 @@ post:
|
||||||
summary: SELECT query
|
summary: SELECT query
|
||||||
value:
|
value:
|
||||||
query: "SELECT ?s ?p ?o WHERE { ?s ?p ?o } LIMIT 10"
|
query: "SELECT ?s ?p ?o WHERE { ?s ?p ?o } LIMIT 10"
|
||||||
user: trustgraph
|
|
||||||
collection: default
|
collection: default
|
||||||
askQuery:
|
askQuery:
|
||||||
summary: ASK query
|
summary: ASK query
|
||||||
|
|
|
||||||
|
|
@ -79,13 +79,11 @@ post:
|
||||||
summary: Simple relationship question
|
summary: Simple relationship question
|
||||||
value:
|
value:
|
||||||
question: Who does Alice know?
|
question: Who does Alice know?
|
||||||
user: alice
|
|
||||||
collection: research
|
collection: research
|
||||||
complexQuestion:
|
complexQuestion:
|
||||||
summary: Complex multi-hop question
|
summary: Complex multi-hop question
|
||||||
value:
|
value:
|
||||||
question: What companies employ engineers that Bob collaborates with?
|
question: What companies employ engineers that Bob collaborates with?
|
||||||
user: bob
|
|
||||||
collection: work
|
collection: work
|
||||||
filterQuestion:
|
filterQuestion:
|
||||||
summary: Question with implicit filters
|
summary: Question with implicit filters
|
||||||
|
|
|
||||||
|
|
@ -87,14 +87,12 @@ post:
|
||||||
value:
|
value:
|
||||||
text: This is the document text...
|
text: This is the document text...
|
||||||
id: doc-123
|
id: doc-123
|
||||||
user: alice
|
|
||||||
collection: research
|
collection: research
|
||||||
withMetadata:
|
withMetadata:
|
||||||
summary: Load with RDF metadata using base64 text
|
summary: Load with RDF metadata using base64 text
|
||||||
value:
|
value:
|
||||||
text: UXVhbnR1bSBjb21wdXRpbmcgdXNlcyBxdWFudHVtIG1lY2hhbmljcyBwcmluY2lwbGVzLi4u
|
text: UXVhbnR1bSBjb21wdXRpbmcgdXNlcyBxdWFudHVtIG1lY2hhbmljcyBwcmluY2lwbGVzLi4u
|
||||||
id: doc-456
|
id: doc-456
|
||||||
user: alice
|
|
||||||
collection: research
|
collection: research
|
||||||
metadata:
|
metadata:
|
||||||
- s: {v: "doc-456", e: false}
|
- s: {v: "doc-456", e: false}
|
||||||
|
|
|
||||||
|
|
@ -81,7 +81,6 @@ post:
|
||||||
s:
|
s:
|
||||||
v: https://example.com/person/alice
|
v: https://example.com/person/alice
|
||||||
e: true
|
e: true
|
||||||
user: alice
|
|
||||||
collection: research
|
collection: research
|
||||||
limit: 100
|
limit: 100
|
||||||
allInstancesOfType:
|
allInstancesOfType:
|
||||||
|
|
@ -100,7 +99,6 @@ post:
|
||||||
p:
|
p:
|
||||||
v: https://example.com/knows
|
v: https://example.com/knows
|
||||||
e: true
|
e: true
|
||||||
user: alice
|
|
||||||
limit: 200
|
limit: 200
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,6 @@ post:
|
||||||
"m": { // Metadata
|
"m": { // Metadata
|
||||||
"i": "core-id", // Knowledge core ID
|
"i": "core-id", // Knowledge core ID
|
||||||
"m": [...], // Metadata triples array
|
"m": [...], // Metadata triples array
|
||||||
"u": "user", // User
|
|
||||||
"c": "collection" // Collection
|
"c": "collection" // Collection
|
||||||
},
|
},
|
||||||
"t": [...] // Triples array
|
"t": [...] // Triples array
|
||||||
|
|
@ -36,7 +35,6 @@ post:
|
||||||
"m": { // Metadata
|
"m": { // Metadata
|
||||||
"i": "core-id",
|
"i": "core-id",
|
||||||
"m": [...],
|
"m": [...],
|
||||||
"u": "user",
|
|
||||||
"c": "collection"
|
"c": "collection"
|
||||||
},
|
},
|
||||||
"e": [ // Entities array
|
"e": [ // Entities array
|
||||||
|
|
@ -51,7 +49,6 @@ post:
|
||||||
## Query Parameters
|
## Query Parameters
|
||||||
|
|
||||||
- **id**: Knowledge core ID
|
- **id**: Knowledge core ID
|
||||||
- **user**: User identifier
|
|
||||||
|
|
||||||
## Streaming
|
## Streaming
|
||||||
|
|
||||||
|
|
@ -77,13 +74,6 @@ post:
|
||||||
type: string
|
type: string
|
||||||
description: Knowledge core ID to import
|
description: Knowledge core ID to import
|
||||||
example: core-123
|
example: core-123
|
||||||
- name: user
|
|
||||||
in: query
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: User identifier
|
|
||||||
example: alice
|
|
||||||
requestBody:
|
requestBody:
|
||||||
required: true
|
required: true
|
||||||
content:
|
content:
|
||||||
|
|
|
||||||
|
|
@ -12,12 +12,12 @@ post:
|
||||||
- **Graph Embeddings**: Vector embeddings for entities
|
- **Graph Embeddings**: Vector embeddings for entities
|
||||||
- **Metadata**: Descriptive information about the knowledge
|
- **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
|
## Operations
|
||||||
|
|
||||||
### list-kg-cores
|
### 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
|
### get-kg-core
|
||||||
Retrieve a knowledge core by ID. Returns triples and/or graph embeddings.
|
Retrieve a knowledge core by ID. Returns triples and/or graph embeddings.
|
||||||
|
|
@ -58,7 +58,6 @@ post:
|
||||||
summary: List knowledge cores
|
summary: List knowledge cores
|
||||||
value:
|
value:
|
||||||
operation: list-kg-cores
|
operation: list-kg-cores
|
||||||
user: alice
|
|
||||||
getKnowledgeCore:
|
getKnowledgeCore:
|
||||||
summary: Get knowledge core
|
summary: Get knowledge core
|
||||||
value:
|
value:
|
||||||
|
|
@ -71,7 +70,6 @@ post:
|
||||||
triples:
|
triples:
|
||||||
metadata:
|
metadata:
|
||||||
id: core-123
|
id: core-123
|
||||||
user: alice
|
|
||||||
collection: default
|
collection: default
|
||||||
metadata:
|
metadata:
|
||||||
- s: {v: "https://example.com/core-123", e: true}
|
- s: {v: "https://example.com/core-123", e: true}
|
||||||
|
|
@ -91,7 +89,6 @@ post:
|
||||||
graph-embeddings:
|
graph-embeddings:
|
||||||
metadata:
|
metadata:
|
||||||
id: core-123
|
id: core-123
|
||||||
user: alice
|
|
||||||
collection: default
|
collection: default
|
||||||
metadata: []
|
metadata: []
|
||||||
entities:
|
entities:
|
||||||
|
|
@ -106,7 +103,6 @@ post:
|
||||||
triples:
|
triples:
|
||||||
metadata:
|
metadata:
|
||||||
id: core-456
|
id: core-456
|
||||||
user: bob
|
|
||||||
collection: research
|
collection: research
|
||||||
metadata: []
|
metadata: []
|
||||||
triples:
|
triples:
|
||||||
|
|
@ -116,7 +112,6 @@ post:
|
||||||
graph-embeddings:
|
graph-embeddings:
|
||||||
metadata:
|
metadata:
|
||||||
id: core-456
|
id: core-456
|
||||||
user: bob
|
|
||||||
collection: research
|
collection: research
|
||||||
metadata: []
|
metadata: []
|
||||||
entities:
|
entities:
|
||||||
|
|
@ -127,7 +122,6 @@ post:
|
||||||
value:
|
value:
|
||||||
operation: delete-kg-core
|
operation: delete-kg-core
|
||||||
id: core-123
|
id: core-123
|
||||||
user: alice
|
|
||||||
loadKnowledgeCore:
|
loadKnowledgeCore:
|
||||||
summary: Load core into flow
|
summary: Load core into flow
|
||||||
value:
|
value:
|
||||||
|
|
@ -161,7 +155,6 @@ post:
|
||||||
triples:
|
triples:
|
||||||
metadata:
|
metadata:
|
||||||
id: core-123
|
id: core-123
|
||||||
user: alice
|
|
||||||
collection: default
|
collection: default
|
||||||
metadata:
|
metadata:
|
||||||
- s: {v: "https://example.com/core-123", e: true}
|
- s: {v: "https://example.com/core-123", e: true}
|
||||||
|
|
@ -177,7 +170,6 @@ post:
|
||||||
graph-embeddings:
|
graph-embeddings:
|
||||||
metadata:
|
metadata:
|
||||||
id: core-123
|
id: core-123
|
||||||
user: alice
|
|
||||||
collection: default
|
collection: default
|
||||||
metadata: []
|
metadata: []
|
||||||
entities:
|
entities:
|
||||||
|
|
|
||||||
|
|
@ -26,5 +26,4 @@ examples:
|
||||||
vectors: [0.023, -0.142, 0.089, 0.234]
|
vectors: [0.023, -0.142, 0.089, 0.234]
|
||||||
schema_name: customers
|
schema_name: customers
|
||||||
limit: 10
|
limit: 10
|
||||||
user: trustgraph
|
|
||||||
collection: default
|
collection: default
|
||||||
|
|
|
||||||
|
|
@ -24,10 +24,6 @@ properties:
|
||||||
query:
|
query:
|
||||||
type: string
|
type: string
|
||||||
description: SPARQL 1.1 query string
|
description: SPARQL 1.1 query string
|
||||||
user:
|
|
||||||
type: string
|
|
||||||
default: trustgraph
|
|
||||||
description: User/keyspace identifier
|
|
||||||
collection:
|
collection:
|
||||||
type: string
|
type: string
|
||||||
default: default
|
default: default
|
||||||
|
|
@ -42,5 +38,4 @@ examples:
|
||||||
flow: my-flow
|
flow: my-flow
|
||||||
request:
|
request:
|
||||||
query: "SELECT ?s ?p ?o WHERE { ?s ?p ?o } LIMIT 10"
|
query: "SELECT ?s ?p ?o WHERE { ?s ?p ?o } LIMIT 10"
|
||||||
user: trustgraph
|
|
||||||
collection: default
|
collection: default
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue