Knowledge AI

The Knowledge AI (former Automated Learning) API contains methods for both it's related models: Documents, which contains the text to perform them, and Questions, which are assigned to Documents.

API SUBPATH: eva-al

Documents

Pagination and Listing

Returnig a pagination list of bot's documents

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/pagination

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

totalPagesinteger (int32)

totalElementsinteger (int64)

pageablePageableObject (object)

numberOfElementsinteger (int32)

sizeinteger (int32)

contentarray of DocumentPageDTO (object)

numberinteger (int32)

sortSortObject (object)

firstboolean

lastboolean

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/pagination', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "unpaged": false,
    "pageSize": 0,
    "paged": false,
    "pageNumber": 0,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "uuid": "text",
      "storageFileName": "text",
      "filename": "text",
      "collectionUUID": "text",
      "questions": 0,
      "questionsIds": [
        "text"
      ],
      "enabled": false,
      "selected": false,
      "date": 0,
      "uploaded": {
        "uuid": "text",
        "name": "text",
        "imageUrl": "text"
      },
      "tags": [
        "text"
      ],
      "format": "text"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "first": false,
  "last": false,
  "empty": false
}

Returning a list of possible words to autocomplete in search

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/quicksearch

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/quicksearch?searchTerm=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  "text"
]

Returnig a pagination list of bot's documents

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/list

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Response

200400401403404409422500

Ok

Body

*/*

uuidstring

Document uuid

filenamestring

Document name

storageFileNamestring

Document storage filename

collectionUUIDstring

Optional. Symbolic collectionUUID for document organizing

questionSizeinteger (int32)

Number of questions

enabledboolean

Document enabled

removedboolean

Document removed

updatedAtstring (date-time)

Date of last document update

trainingStatusstring

Document training status

formatstring

Format of the document. The possibles is inside enum DocumentFormat

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  {
    "uuid": "text",
    "filename": "text",
    "storageFileName": "text",
    "collectionUUID": "text",
    "questionSize": 0,
    "enabled": false,
    "removed": false,
    "updatedAt": "2024-12-21T12:25:05.722Z",
    "trainingStatus": "text",
    "format": "text"
  }
]

CRUD Operations

Upload new document

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Body

application/json

document*string (binary)

The document to upload

namestring

The document name to save

collectionUUIDstring

Optional. Symbolic collectionUUID for document organizing.

Response

201400401403404409422500

Created

Body

*/*

uuidstring

Document uuid

storageFilenamestring

Filename in minio

filenamestring

Filename in database

enabledboolean

True if document is enabled and false if not

tagsarray of string

Tags saved to the document

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "document": "binary"
    }),
});
const data = await response.json();

Response

201400401403404409422500

{
  "uuid": "text",
  "storageFilename": "text",
  "filename": "text",
  "enabled": false,
  "tags": [
    "text"
  ]
}

Show a document

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

documentUUID*string

A valid service Uuid

Response

200400401403404409422500

Ok

Body

*/*

filenamestring

Document name

enabledboolean

Document enabled

lastEditionLastModifiedDTO (object)

Last modified DTO

collectionUUIDstring

Optional. Symbolic collectionUUID for document organizing.

questionCountinteger (int32)

Number of questions

questionsIdsarray of string

Question uuids inside the document

tagsarray of TagDTO (object)

Tags of the document

formatstring

Format of the document. The possibles is inside enum DocumentFormat

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "filename": "text",
  "enabled": false,
  "lastEdition": {
    "name": "text",
    "image": "text",
    "date": 0
  },
  "collectionUUID": "text",
  "questionCount": 0,
  "questionsIds": [
    "text"
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "format": "text"
}

Update one document, the file document or the data (name, tags...)

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}/update

Path parameters

orgUUID*string

It is the organization uuid where the bot is.

envUUID*string

It is the environment uuid where the bot is.

botUUID*string

It is the identification of the bot.

documentUUID*string

It is the identification of the document

Query parameters

Body

multipart/form-data

documentstring (binary)

It is the new file to update

name*string

It is the new document name to update

collectionUUIDstring

Optional. Symbolic collectionUUID for document organizing. Sending this as null will overwrite existing repository Id.

Response

200400401403404409422500

Ok

Body

*/*

uuidstring

Document uuid

storageFilenamestring

Filename in minio

filenamestring

Filename in database

enabledboolean

True if document is enabled and false if not

tagsarray of string

Tags saved to the document

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}/update', {
    method: 'PUT',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200400401403404409422500

{
  "uuid": "text",
  "storageFilename": "text",
  "filename": "text",
  "enabled": false,
  "tags": [
    "text"
  ]
}

Enable or disable document

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

documentUUID*string

A valid service Uuid

Body

application/json

enabledboolean

Response

200204400401403404409422500

OK

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404409422500

{
  "timestamp": 0,
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Remove document

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

documentUUID*string

A valid document Uuid

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "timestamp": 0,
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Bulk Operations

Exports more than one document

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/export

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Body

application/json

uuidsarray of string

A list of Uuid of question

Response

200400401403404409422500

Ok

Body

*/*

itemsstring (byte)

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/export', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404409422500

[
  "Ynl0ZXM="
]

Bulk removes Documents with the provided uuid list.

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/massive-delete

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Body

application/json

uuidsarray of string

A list of Uuid of question

Response

200400401403404409422500

Ok

Body

application/json

successarray of string

Name of files deleted successfully

errorsarray of string

name of files with error in deletion

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/massive-delete', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404409422500

{
  "success": [
    "text"
  ],
  "errors": [
    "text"
  ]
}

Questions

Paginations and Listings

Returnig a pagination list of bot's questions

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/pagination

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

totalPagesinteger (int32)

totalElementsinteger (int64)

pageablePageableObject (object)

numberOfElementsinteger (int32)

sizeinteger (int32)

contentarray of QuestionPageDTO (object)

numberinteger (int32)

sortSortObject (object)

firstboolean

lastboolean

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/pagination', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "unpaged": false,
    "paged": false,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "variables": 0,
      "document": {
        "uuid": "text",
        "storageFilename": "text",
        "filename": "text",
        "enabled": false
      },
      "enabled": false,
      "selected": false,
      "lastModified": {
        "name": "text",
        "image": "text",
        "date": 0
      },
      "tags": [
        "text"
      ],
      "updatedAt": "2024-12-21T12:25:05.722Z"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "first": false,
  "last": false,
  "empty": false
}

Returning a list of possible words to autocomplete in search

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/quicksearch

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/quicksearch?searchTerm=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  "text"
]

CRUD Operations

Create a brand new Question

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Body

application/json

documentId*string

A Uuid of a document assigned to this question.

name*string

Question name

descriptionstring

Question descrciption

variablesarray of string

List of examples of question

enabled*boolean

Question enabled/disabled status

evaluableboolean

Question evaluable status

transactionalboolean

Question transactional status

webhookstring

Webhook address endpoint

headersobject

Webhook headers

answerTemplates*array of AnswerTemplateRequestDTO (object)

Questions answer templates

tagsarray of TagDTO (object)

Questions tags

Response

201400401403404409422500

Created

Body

*/*

questionIdstring

Question id

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "answerTemplates": [
        {
          "channelId": "text",
          "channelTypeId": 0
        }
      ],
      "documentId": "text",
      "enabled": false,
      "name": "text"
    }),
});
const data = await response.json();

Response

201400401403404409422500

{
  "questionId": "text"
}

Retrieve info a specific given question

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

questionUUID*string

A valid question Uuid

Response

200201400401403404409422500

OK

Body

*/*

idstring

Question id

botIdstring

A uuid of bot assigned to this question

documentDocumentDTO (object)

DTO response with document created

namestring

Question name

descriptionstring

Question description

variablesarray of QuestionVariableDTO (object)

Question variables list

webhookstring

Answer endpoint webhook

headersstring

Webhook headers

transactionalboolean

Queston transactional status

enabledboolean

Question enabled status

removedboolean

Question removed status

updateContentboolean

True if the question content can be predict again because document update

evaluableboolean

Question evaluable status

tagsarray of TagDTO (object)

Question tags

answerTemplatesarray of AnswerTemplateRequestDTO (object)

Question answer templates

createdAtstring (date-time)

When question was created

updatedAtstring (date-time)

When question was updated

updatedBystring

User uuid that changed

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200201400401403404409422500

{
  "id": "text",
  "botId": "text",
  "document": {
    "uuid": "text",
    "storageFilename": "text",
    "filename": "text",
    "enabled": false
  },
  "name": "text",
  "description": "text",
  "variables": [
    {
      "id": "text",
      "variable": "text"
    }
  ],
  "webhook": "text",
  "headers": "text",
  "transactional": false,
  "enabled": false,
  "removed": false,
  "updateContent": false,
  "evaluable": false,
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "type": "text",
      "channelTypeId": 0,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "createdAt": "2024-12-21T12:25:05.722Z",
  "updatedAt": "2024-12-21T12:25:05.722Z",
  "updatedBy": "text"
}

Updates an question

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

questionUUID*string

A valid question Uuid

Body

application/json

documentId*string

A Uuid of a document assigned to this question.

name*string

Question name

descriptionstring

Question descrciption

variablesarray of string

List of examples of question

enabled*boolean

Question enabled/disabled status

evaluableboolean

Question evaluable status

transactionalboolean

Question transactional status

webhookstring

Webhook address endpoint

headersobject

Webhook headers

answerTemplates*array of AnswerTemplateRequestDTO (object)

Questions answer templates

tagsarray of TagDTO (object)

Questions tags

Response

200400401403404409422500

Ok

Body

*/*

idstring

Question id

botIdstring

A uuid of bot assigned to this question

documentDocumentDTO (object)

DTO response with document created

namestring

Question name

descriptionstring

Question description

variablesarray of QuestionVariableDTO (object)

Question variables list

webhookstring

Answer endpoint webhook

headersstring

Webhook headers

transactionalboolean

Queston transactional status

enabledboolean

Question enabled status

removedboolean

Question removed status

updateContentboolean

True if the question content can be predict again because document update

evaluableboolean

Question evaluable status

tagsarray of TagDTO (object)

Question tags

answerTemplatesarray of AnswerTemplateRequestDTO (object)

Question answer templates

createdAtstring (date-time)

When question was created

updatedAtstring (date-time)

When question was updated

updatedBystring

User uuid that changed

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "answerTemplates": [
        {
          "channelId": "text",
          "channelTypeId": 0
        }
      ],
      "documentId": "text",
      "enabled": false,
      "name": "text"
    }),
});
const data = await response.json();

Response

200400401403404409422500

{
  "id": "text",
  "botId": "text",
  "document": {
    "uuid": "text",
    "storageFilename": "text",
    "filename": "text",
    "enabled": false
  },
  "name": "text",
  "description": "text",
  "variables": [
    {
      "id": "text",
      "variable": "text"
    }
  ],
  "webhook": "text",
  "headers": "text",
  "transactional": false,
  "enabled": false,
  "removed": false,
  "updateContent": false,
  "evaluable": false,
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "type": "text",
      "channelTypeId": 0,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "createdAt": "2024-12-21T12:25:05.722Z",
  "updatedAt": "2024-12-21T12:25:05.722Z",
  "updatedBy": "text"
}

Delete an question. The question is disabled via the 'removed' parameter rather than deleted from the DB

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Body

application/json

uuidsarray of string

A list of Uuid of question

Response

200400401403404409422500

No Content

Body

*/*

successarray of string

Name of files deleted successfully

errorsarray of string

name of files with error in deletion

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404409422500

{
  "success": [
    "text"
  ],
  "errors": [
    "text"
  ]
}

Auxiliary Methods

Validate examples

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/variable

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Body

application/json

variablestring

Example of the question

Response

200400401403404409422500

Ok

Body

*/*

idstring

Variable id

variablestring

The variable value

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/variable', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404409422500

[
  {
    "id": "text",
    "variable": "text"
  }
]

Enable and disable questions

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/change-enable

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Body

application/json

questionsIdsarray of string

List the questions ids

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/change-enable', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404409422500

{
  "timestamp": 0,
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Knowledge AI

Return all limits to upload documents

GET/org/{orgUUID}/env/{envUUID}/documents/limits

Path parameters

orgUUID*string

It is the id that represents an organization.

envUUID*string

It is the id that represents an environment.

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

sizeDocumentSizeDTO (object)

Max size file for txt and pdf that is registered in config server. These values is in bytes

textSizeDocumentSizeTextDTO (object)

Max size text file for txt and pdf that is registered in config server. The value of txt is in KB and pdf is in MB

pageDocumentPagesDTO (object)

Max pages pdf that is registered in config server

limitinteger (int32)

Maximum of documents per bot

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/documents/limits', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "size": {
    "txt": 0,
    "pdf": 0
  },
  "textSize": {
    "txt": "text",
    "pdf": "text"
  },
  "page": {
    "pdf": 0
  },
  "limit": 0
}