Automated Learning

The 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

Returns the pagination of a Bot's Documents. Pagination starts at page 1 instead of the standard 0.

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)

firstboolean

lastboolean

sortSort (object)

sizeinteger (int32)

contentarray of DocumentPageDTO (object)

numberinteger (int32)

emptyboolean

Request

JavaScriptCurl

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

Response

{
  "pageable": {
    "paged": false,
    "unpaged": false,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    }
  },
  "first": false,
  "last": false,
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "content": [
    {
      "uuid": "text",
      "storageFileName": "text",
      "filename": "text",
      "questionsIds": [
        "text"
      ],
      "enabled": false,
      "selected": false,
      "uploaded": {
        "uuid": "text",
        "name": "text",
        "imageUrl": "text"
      }
    }
  ],
  "empty": false
}

Returns a list of possible words to autocomplete in a search for Document names

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

JavaScriptCurl

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

Response

[
  "text"
]

Returns a complete list containing all of the 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

questionSizeinteger (int32)

Number of questions

questionsarray of QuestionListDTO (object)

DTO question list

enabledboolean

Document enabled

removedboolean

Document removed

updatedAtstring (date-time)

Date of last document update

trainingStatusstring

Request

JavaScriptCurl

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

Response

[
  {
    "uuid": "text",
    "filename": "text",
    "storageFileName": "text",
    "questions": [
      {
        "name": "text",
        "questionVariables": [
          {
            "id": "text",
            "variable": "text"
          }
        ],
        "enabled": false,
        "removed": false,
        "updatedAt": "2024-05-20T10:34:36.955Z"
      }
    ],
    "enabled": false,
    "removed": false,
    "updatedAt": "2024-05-20T10:34:36.955Z",
    "trainingStatus": "text"
  }
]

CRUD Operations

Retrieves information from a specific Document, provided its UUID.

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

contentstring

Document content

enabledboolean

Document enabled

lastEditionLastModifiedDTO (object)

Last modified DTO

questionCountinteger (int32)

Number of questions

questionsIdsarray of string

Question uuids inside the document

Request

JavaScriptCurl

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

Response

{
  "filename": "text",
  "content": "text",
  "enabled": false,
  "lastEdition": {
    "name": "text",
    "image": "text"
  },
  "questionsIds": [
    "text"
  ]
}

Uploads a 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

Body

application/json

document*string (binary)

The txt document to upload

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

Request

JavaScriptCurl

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

{
  "uuid": "text",
  "storageFilename": "text",
  "filename": "text",
  "enabled": false
}

Enable or disables a Document. All questions whose UUID are provided also have their enabling set by the sent value.

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

questionIdsarray of string

Response

204400401403404409422500

No content

Request

JavaScriptCurl

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();

Removes a Document from the Bot

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

JavaScriptCurl

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

Bulk Operations

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

JavaScriptCurl

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

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

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

JavaScriptCurl

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

[
  "Ynl0ZXM="
]

Questions

Paginations and Listings

Returns the pagination of a Bot's Questions. Pagination starts at page 1 instead of the standard 0.

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)

firstboolean

lastboolean

sortSort (object)

sizeinteger (int32)

contentarray of QuestionPageDTO (object)

numberinteger (int32)

emptyboolean

Request

JavaScriptCurl

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

Response

{
  "pageable": {
    "paged": false,
    "unpaged": false,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    }
  },
  "first": false,
  "last": false,
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "content": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "document": {
        "uuid": "text",
        "storageFilename": "text",
        "filename": "text",
        "enabled": false
      },
      "enabled": false,
      "selected": false,
      "lastModified": {
        "name": "text",
        "image": "text"
      },
      "tags": [
        "text"
      ],
      "updatedAt": "2024-05-20T10:34:36.955Z"
    }
  ],
  "empty": false
}

Returns a list of possible words to autocomplete in a search for Question names

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

JavaScriptCurl

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

Response

[
  "text"
]

CRUD Operations

Retrieves information from a specific Question, provided its UUID.

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

201400401403404409422500

Created

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

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

JavaScriptCurl

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

Response

{
  "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,
  "evaluable": false,
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "type": "text",
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "createdAt": "2024-05-20T10:34:36.955Z",
  "updatedAt": "2024-05-20T10:34:36.955Z",
  "updatedBy": "text"
}

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

JavaScriptCurl

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

Response

{
  "questionId": "text"
}

Updates a 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

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

JavaScriptCurl

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"
        }
      ],
      "documentId": "text",
      "enabled": false,
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "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,
  "evaluable": false,
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "type": "text",
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "createdAt": "2024-05-20T10:34:36.955Z",
  "updatedAt": "2024-05-20T10:34:36.955Z",
  "updatedBy": "text"
}

Deletes a Question. The question is symbolically removed via the 'removed' parameter rather than deleted from the database.

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

JavaScriptCurl

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

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

Auxiliary Methods

Validate sample availability. This endpoint returns if a variable/sample for the question is not previously registered and still available. Variables sent through the Create Question endpoint should be validated here beforehand. The Question Creation endpoint will not inform you the cause of the error it will throw otherwise.

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

JavaScriptCurl

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

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

Bulk enables or disables Questions. All questions included whose UUID are included in the body have their enabling field reversed.

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

JavaScriptCurl

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();

Automated Learning

Endpoint to enable or disable the Automated Learning in a bot. This change has no effect unless the bot's corresponding environment also has this feature enabled.

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

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Body

application/json

value*boolean

Parameter's value

Response

200400401403404409422500

Ok

Request

JavaScriptCurl

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