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

CRUD Operations

Bulk Operations

Questions

Paginations and Listings

CRUD Operations

Auxiliary Methods

Automated Learning

PreviousInstance API NextAutomated Learning NLP

Was this helpful?

#144: 4.5 - Gen AI (KAI, Rephrase, Assist) + What's New (Notifications)

Change request updated 1 year ago

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

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

pageinteger · int32 · default: 1

The number of page and the default is 1

Example: 1

linesPerPageinteger · int32 · default: 5

The number of services per pages and the default is 5

Example: 1

orderBystring · default: updatedAt

Field want to ordernate, the default is 'updatedAt'

directionstring · default: DESC

Direction of ordenation, ASC or DESC. The default is DESC

searchTermsstring[]

Names or tags to filter the search

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/pagination'

200

400

401

403

404

409

422

500

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

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

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

searchTermstringrequired

Word or part of word to get suggestion names of documents

limitinteger · int64 · default: 6

The limit of suggestions names in the response. The default value is 6

Example: 1

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/quicksearch?searchTerm=text'

200

400

401

403

404

409

422

500

[
  "text"
]

Returns a complete list containing all of the Bot's Documents

get

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

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/list'

200

400

401

403

404

409

422

500

[
  {
    "uuid": "text",
    "filename": "text",
    "storageFileName": "text",
    "questionSize": 1,
    "enabled": true,
    "removed": true,
    "updatedAt": "2025-02-22T16:54:10.755Z",
    "trainingStatus": "text",
    "questions": [
      {
        "name": "text",
        "enabled": true,
        "removed": true,
        "updatedAt": "2025-02-22T16:54:10.755Z",
        "questionVariables": [
          {
            "id": "text",
            "variable": "text"
          }
        ]
      }
    ]
  }
]

Retrieves information from a specific Document, provided its UUID.

get

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

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

documentUUIDstringrequired

A valid service Uuid

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}'

200

400

401

403

404

409

422

500

{
  "filename": "text",
  "content": "text",
  "enabled": true,
  "lastEdition": {
    "name": "text",
    "image": "text",
    "date": 1
  },
  "questionCount": 1,
  "questionsIds": [
    "text"
  ]
}

Uploads a new document

post

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

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

documentstring · binaryrequired

The txt document to upload

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents' \
  --header 'Content-Type: application/json' \
  --data '{"document":"text"}'

201

400

401

403

404

409

422

500

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

Created

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

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

documentUUIDstringrequired

A valid service Uuid

Body

enabledboolean

questionIdsstring[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}' \
  --header 'Content-Type: application/json' \
  --data '{"questionIds":[null]}'

204

400

401

403

404

409

422

500

No body

No content

Removes a Document from the Bot

delete

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

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

documentUUIDstringrequired

A valid document Uuid

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}'

204

400

401

403

404

409

422

500

No body

No Content

Bulk removes Documents with the provided uuid list.

delete

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

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

uuidsstring[]

A list of Uuid of question

Responses

application/json

*/*

application/json

*/*

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/massive-delete' \
  --header 'Content-Type: application/json' \
  --data '{"uuids":[null]}'

200

400

401

403

404

409

422

500

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

Exports more than one document

post

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

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

uuidsstring[]

A list of Uuid of question

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/export' \
  --header 'Content-Type: application/json' \
  --data '{"uuids":[null]}'

200

400

401

403

404

409

422

500

[
  "text"
]

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

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

pageinteger · int32 · default: 1

The number of page and the default is 1

Example: 1

linesPerPageinteger · int32 · default: 5

The number of services per pages and the default is 5

Example: 1

orderBystring · default: updatedAt

Field want to ordernate, the default is 'updatedAt'

directionstring · default: DESC

Direction of ordenation, ASC or DESC. The default is DESC

filenamesstring[]

Filename to filter the search

searchTermsstring[]

Names or tags to filter the search

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/pagination'

200

400

401

403

404

409

422

500

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 1,
  "number": 1,
  "empty": true,
  "content": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "variables": 1,
      "document": {
        "uuid": "text",
        "storageFilename": "text",
        "filename": "text",
        "enabled": true
      },
      "enabled": true,
      "selected": true,
      "lastModified": {
        "name": "text",
        "image": "text",
        "date": 1
      },
      "updatedAt": "2025-02-22T16:54:10.755Z",
      "tags": [
        "text"
      ]
    }
  ]
}

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

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

searchTermstringrequired

Word or part of word to get suggestion names of documents

limitinteger · int64 · default: 6

The limit of suggestions names in the response. The default value is 6

Example: 1

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/quicksearch?searchTerm=text'

200

400

401

403

404

409

422

500

[
  "text"
]

Retrieves information from a specific Question, provided its UUID.

get

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

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

questionUUIDstringrequired

A valid question Uuid

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID}'

201

400

401

403

404

409

422

500

{
  "id": "text",
  "botId": "text",
  "document": {
    "uuid": "text",
    "storageFilename": "text",
    "filename": "text",
    "enabled": true
  },
  "name": "text",
  "description": "text",
  "webhook": "text",
  "headers": "text",
  "transactional": true,
  "enabled": true,
  "removed": true,
  "evaluable": true,
  "createdAt": "2025-02-22T16:54:10.755Z",
  "updatedAt": "2025-02-22T16:54:10.755Z",
  "updatedBy": "text",
  "variables": [
    {
      "id": "text",
      "variable": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ]
}

Created

Create a brand new Question

post

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

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

documentIdstringrequired

A Uuid of a document assigned to this question.

namestringrequired

Question name

descriptionstring

Question descrciption

enabledbooleanrequired

Question enabled/disabled status

evaluableboolean

Question evaluable status

transactionalboolean

Question transactional status

webhookstring

Webhook address endpoint

headersobject

Webhook headers

variablesstring[]

List of examples of question

answerTemplatesobject[]required

Questions answer templates

tagsobject[]

Questions tags

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions' \
  --header 'Content-Type: application/json' \
  --data '{"documentId":"text","name":"text","enabled":true,"headers":{},"variables":[null],"answerTemplates":[{"content":{},"channelTypeId":1,"channelId":"text"}],"tags":[{"name":"text"}]}'

201

400

401

403

404

409

422

500

{
  "questionId": "text"
}

Created

Updates a Question.

put

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

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

questionUUIDstringrequired

A valid question Uuid

Body

documentIdstringrequired

A Uuid of a document assigned to this question.

namestringrequired

Question name

descriptionstring

Question descrciption

enabledbooleanrequired

Question enabled/disabled status

evaluableboolean

Question evaluable status

transactionalboolean

Question transactional status

webhookstring

Webhook address endpoint

headersobject

Webhook headers

variablesstring[]

List of examples of question

answerTemplatesobject[]required

Questions answer templates

tagsobject[]

Questions tags

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID}' \
  --header 'Content-Type: application/json' \
  --data '{"documentId":"text","name":"text","enabled":true,"headers":{},"variables":[null],"answerTemplates":[{"content":{},"channelTypeId":1,"channelId":"text"}],"tags":[{"name":"text"}]}'

200

400

401

403

404

409

422

500

{
  "id": "text",
  "botId": "text",
  "document": {
    "uuid": "text",
    "storageFilename": "text",
    "filename": "text",
    "enabled": true
  },
  "name": "text",
  "description": "text",
  "webhook": "text",
  "headers": "text",
  "transactional": true,
  "enabled": true,
  "removed": true,
  "evaluable": true,
  "createdAt": "2025-02-22T16:54:10.755Z",
  "updatedAt": "2025-02-22T16:54:10.755Z",
  "updatedBy": "text",
  "variables": [
    {
      "id": "text",
      "variable": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "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

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

uuidsstring[]

A list of Uuid of question

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions' \
  --header 'Content-Type: application/json' \
  --data '{"uuids":[null]}'

200

400

401

403

404

409

422

500

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

No Content

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

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

variablestring

Example of the question

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/variable' \
  --header 'Content-Type: application/json'

200

400

401

403

404

409

422

500

[
  {
    "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

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

questionsIdsstring[]

List the questions ids

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/change-enable' \
  --header 'Content-Type: application/json' \
  --data '{"questionsIds":[null]}'

204

400

401

403

404

409

422

500

No body

No Content

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

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Body

valuebooleanrequired

Parameter's value

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-learning/change-bot-enable' \
  --header 'Content-Type: application/json' \
  --data '{"value":true}'

200

400

401

403

404

409

422

500

No body