Create a new knowledge base

POST /api/v1/rag/kb

Create a new knowledge base

JavaScript

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    name: '<string>',
    type: 'Files',
    description: '<string>',
    settings: {},
    embeddingsName: '<string>'
  })
};

fetch('https://blackbox.dasha.ai/api/v1/rag/kb', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "type": "Files",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "statistics": {
    "knowledgeBaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "storageByDocumentType": {},
    "documentsByStatus": {
      "Uploaded": 123,
      "Queued": 123,
      "Processing": 123,
      "Indexed": 123,
      "Failed": 123,
      "Cancelled": 123,
      "PendingDelete": 123,
      "Deleting": 123
    }
  },
  "settings": {},
  "embeddingsName": "<string>",
  "status": "Active"
}

Body

Knowledge base creation request

name · string · required

Required string length: 1 - 255

type · enum<string> · required

Available options: Files

description · string | null

Maximum string length: 1000

settings · object

embeddingsName · string | null

Maximum string length: 255

Response

201

text/plain

Created

id · string<uuid>

customerId · string<uuid>

name · string | null

description · string | null

type · enum<string>

Available options: Files

createdAt · string<date-time>

updatedAt · string<date-time>

statistics · object

Show child attributes

settings · object

embeddingsName · string | null

status · enum<string>

Available options: Active, PendingDelete, Deleting