Download OpenAPI specification:
Handles all ingress and egress of data to/from the QAECY Cue pipelines + calls to the agent.
| x-project-id required | string Project ID |
| file required | string <binary> File to upload |
| filename required | string Full file path as represented in host system. If nothing is provided the name of the file is used. |
| customMetadata | string Default: "" Any relevant custom metadata from the host system formatted as stringified JSON |
| skipLoading | boolean Default: false Whether the file should be invisible to the loading events that would normally be triggered by it |
| skipProcessing | boolean Default: false Whether the file should be invisible to the processing events that would normally be triggered by it |
| providerId | string Default: "" Necessary to distinguish duplicate files uploaded from different document systems. Reflected in file location UUIDs. Default value is an empty string. |
{- "message": "report.pdf was successfully uploaded to project ffd5c559-1821-4e8c-a956-08f61f352e3b!",
- "uuid": "6ad3e777-87e8-56e1-8f37-d7fcf07e3f50"
}| x-project-id required | string Project ID |
| projectId required | string The project ID (will soon be removed and read from headers) |
{- "projectId": "string"
}| x-project-id required | string Project ID |
| prompt required | string Chat prompt |
| projectId required | string The project id (will soon be removed and read from headers) |
| target | string Default: "page_summaries" The target vector collection, out of the currently supported ones (page_summaries, document_summaries) |
| limit | number Default: 20 Number of the vector results included in the retrieval |
| queryType | string Default: "vector" Perform vector-only (vector) or hybrid (hybrid) search which includes fts |
| identifiers | Array of strings The identifiers of the documents that the search should be constrained to |
| x-project-id required | string Project ID |
| query required | string The query |
| projectId required | string The project id (will soon be removed and read from headers) |
| identifiers | Array of strings The identifiers of the documents that the query should be constrained to |
{- "query": "string",
- "projectId": "string",
- "identifiers": [
- "string"
]
}| x-project-id required | string Project ID |
| question required | string Search query |
| projectId required | string The project id (will soon be removed and read from headers) |
| target | string Default: "page_summaries" The target collection, out of the currently supported ones (page_summaries, document_summaries) |
| limit | number Default: 20 Number of results included |
| queryType | string Default: "vector" Perform vector-only (vector) or hybrid (hybrid) search which includes fts |
| identifiers | Array of strings The identifiers of the documents that the search should be constrained to |
{- "question": "string",
- "projectId": "string",
- "target": "page_summaries",
- "limit": 20,
- "queryType": "vector",
- "identifiers": [
- "string"
]
}| x-project-id required | string Project ID |
| projectId required | string The project id (will soon be removed and read from headers) |
| fileNames required | Array of strings Default: [] Array containing the list of filenames to be deleted, prefixed with their full path |
| blobNames | Array of strings Default: [] Array containing the list of blobs to be deleted, prefixed with the projectId |
| removeGraphs | boolean Default: true Remove all the associated (also derived) information from the knowledge graph |
| removeVectors | boolean Default: true Remove all the associated vector embeddings from the vector store |
| removeRaw | boolean Default: true Remove the raw blob files |
| removeProcessed | boolean Default: true Remove all the processed / derivative files that where produced from the files |
| deleteAll | boolean Default: false Bypass other settings and delete all raw and processed files as well as knowledge graph and vector store data |
{- "projectId": "string",
- "fileNames": [ ],
- "blobNames": [ ],
- "removeGraphs": true,
- "removeVectors": true,
- "removeRaw": true,
- "removeProcessed": true,
- "deleteAll": false
}| x-project-id required | string Project ID |
| query required | string The query |
{- "head": {
- "vars": [
- "s",
- "p",
- "o"
]
}, - "results": {
- "bindings": [
- {
- "o": {
- "type": "literal",
- "value": "John Doe"
}
}
]
}
}Experimental: This API is subject to change or removal
| resourceID required | string UUID of the resource |
| includeSchema | boolean Include schema in the response |
| x-project-id required | string Project ID |
[- {
- "@context": {
}, - "@id": "3715f1eb-bfa6-44b7-99ee-932f25f65d68",
- "@type": "qcy:EntityMention",
- "qcy:value": "John Doe",
- "qcy:hasEntityCategory": {
- "@id": "qcy-e:Person"
}
}
]Experimental: This API is subject to change or removal
| sourceID required | string Source file identified by its location content UUID |
| includeSchema | boolean Include schema in the response |
| x-project-id required | string Project ID |
[- {
- "@context": {
}, - "@id": "3715f1eb-bfa6-44b7-99ee-932f25f65d68",
- "@type": "qcy:EntityMention",
- "qcy:value": "John Doe",
- "qcy:hasEntityCategory": {
- "@id": "qcy-e:Person"
}
}
]