VocalDocscontracts 1.65.0

Knowledge bases

Knowledge bases, their versions, Sources, Documents, queries and evaluations.

OperationSummaryScopeReleased inPhase 0 host
GET /v1/knowledge-basesList Knowledge basesknowledge:read1.53.0served
POST /v1/knowledge-basesCreate a Knowledge baseknowledge:write1.53.0served
GET /v1/knowledge-bases/{knowledge_base_id}Read a Knowledge baseknowledge:read1.53.0served
PATCH /v1/knowledge-bases/{knowledge_base_id}Update the Knowledge base draftknowledge:write1.53.0served
DELETE /v1/knowledge-bases/{knowledge_base_id}Archive a Knowledge baseknowledge:write1.53.0served
GET /v1/knowledge-bases/{knowledge_base_id}/documentsList a Knowledge base's Documentsknowledge:read1.53.0served
POST /v1/knowledge-bases/{knowledge_base_id}/documentsUpload a Documentknowledge:write1.53.0served
GET /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}Read a Documentknowledge:read1.53.0served
DELETE /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}Delete a Documentknowledge:write1.53.0served
GET /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}/contentRead a Document's contentknowledge:read1.53.0served
POST /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}/purgePurge a Document from every versionknowledge:write1.53.0served
POST /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}/reviewReview a quarantined Documentknowledge:write1.53.0served
GET /v1/knowledge-bases/{knowledge_base_id}/eval-queriesList a Knowledge base's corpusknowledge:read1.53.0served
POST /v1/knowledge-bases/{knowledge_base_id}/eval-queriesAdd a query to the retrieval-quality corpusknowledge:write1.53.0served
GET /v1/knowledge-bases/{knowledge_base_id}/eval-queries/{eval_query_id}Read a corpus queryknowledge:read1.53.0served
PATCH /v1/knowledge-bases/{knowledge_base_id}/eval-queries/{eval_query_id}Update a corpus queryknowledge:write1.53.0served
DELETE /v1/knowledge-bases/{knowledge_base_id}/eval-queries/{eval_query_id}Delete a corpus queryknowledge:write1.53.0served
POST /v1/knowledge-bases/{knowledge_base_id}/evaluationsEvaluate a version or the working setknowledge:write1.53.0served
GET /v1/knowledge-bases/{knowledge_base_id}/evaluations/{evaluation_id}Read an Evaluationknowledge:read1.53.0served
GET /v1/knowledge-bases/{knowledge_base_id}/ingestion-runsList a Knowledge base's Ingestion runsknowledge:read1.53.0served
GET /v1/knowledge-bases/{knowledge_base_id}/ingestion-runs/{run_id}Read an Ingestion runknowledge:read1.53.0served
POST /v1/knowledge-bases/{knowledge_base_id}/queryQuery a Knowledge baseknowledge:read1.53.0served
GET /v1/knowledge-bases/{knowledge_base_id}/sourcesList a Knowledge base's Sourcesknowledge:read1.53.0served
POST /v1/knowledge-bases/{knowledge_base_id}/sourcesAdd a Source to a Knowledge baseknowledge:write1.53.0served
GET /v1/knowledge-bases/{knowledge_base_id}/sources/{source_id}Read a Sourceknowledge:read1.53.0served
PATCH /v1/knowledge-bases/{knowledge_base_id}/sources/{source_id}Update a Sourceknowledge:write1.53.0served
DELETE /v1/knowledge-bases/{knowledge_base_id}/sources/{source_id}Delete a Sourceknowledge:write1.53.0served
POST /v1/knowledge-bases/{knowledge_base_id}/sources/{source_id}/syncSync a Source nowknowledge:write1.53.0served
GET /v1/knowledge-bases/{knowledge_base_id}/versionsList a Knowledge base's versionsknowledge:read1.53.0served
POST /v1/knowledge-bases/{knowledge_base_id}/versionsPublish the working set as a new versionknowledge:write1.53.0served
GET /v1/knowledge-bases/{knowledge_base_id}/versions/{version}Read a Knowledge base versionknowledge:read1.53.0served
POST /v1/knowledge-bases/{knowledge_base_id}/versions/{version}/activateActivate a Knowledge base versionknowledge:write1.53.0served
POST /v1/knowledge-bases/{knowledge_base_id}/versions/{version}/retireRetire a Knowledge base versionknowledge:write1.53.0served