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.

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

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

pageinteger · int32Optional

The number of page and the default is 1

Default: 1Example: 1

linesPerPageinteger · int32Optional

The number of services per pages and the default is 5

Default: 5Example: 1

orderBystringOptional

Field want to ordernate, the default is 'updatedAt'

Default: updatedAt

directionstringOptional

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

Default: DESC

searchTermsstring[]Optional

Names or tags to filter the search

Responses

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/pagination HTTP/1.1
Host: 
Accept: */*

{
  "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,
  "content": [
    {
      "uuid": "text",
      "storageFileName": "text",
      "filename": "text",
      "questions": 1,
      "questionsIds": [
        "text"
      ],
      "enabled": true,
      "selected": true,
      "date": 1,
      "uploaded": {
        "uuid": "text",
        "name": "text",
        "imageUrl": "text"
      }
    }
  ],
  "number": 1,
  "empty": true
}

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

get

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 · int64Optional

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

Default: 6Example: 1

Responses

Responsestring[]

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

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

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Responses

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/list HTTP/1.1
Host: 
Accept: */*

[
  {
    "uuid": "text",
    "filename": "text",
    "storageFileName": "text",
    "questionSize": 1,
    "questions": [
      {
        "name": "text",
        "questionVariables": [
          {
            "id": "text",
            "variable": "text"
          }
        ],
        "enabled": true,
        "removed": true,
        "updatedAt": "2025-04-27T11:31:16.086Z"
      }
    ],
    "enabled": true,
    "removed": true,
    "updatedAt": "2025-04-27T11:31:16.086Z",
    "trainingStatus": "text"
  }
]

Retrieves information from a specific Document, provided its UUID.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

documentUUIDstringRequired

A valid service Uuid

Responses

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID} HTTP/1.1
Host: 
Accept: */*

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

Removes a Document from the Bot

delete

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

documentUUIDstringRequired

A valid document Uuid

Responses

delete

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID} HTTP/1.1
Host: 
Accept: */*

No content

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

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

pageinteger · int32Optional

The number of page and the default is 1

Default: 1Example: 1

linesPerPageinteger · int32Optional

The number of services per pages and the default is 5

Default: 5Example: 1

orderBystringOptional

Field want to ordernate, the default is 'updatedAt'

Default: updatedAt

directionstringOptional

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

Default: DESC

filenamesstring[]Optional

Filename to filter the search

searchTermsstring[]Optional

Names or tags to filter the search

Responses

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/pagination HTTP/1.1
Host: 
Accept: */*

{
  "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,
  "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
      },
      "tags": [
        "text"
      ],
      "updatedAt": "2025-04-27T11:31:16.086Z"
    }
  ],
  "number": 1,
  "empty": true
}

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

get

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 · int64Optional

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

Default: 6Example: 1

Responses

Responsestring[]

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Retrieves information from a specific Question, provided its UUID.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

questionUUIDstringRequired

A valid question Uuid

Responses

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "botId": "text",
  "document": {
    "uuid": "text",
    "storageFilename": "text",
    "filename": "text",
    "enabled": true
  },
  "name": "text",
  "description": "text",
  "variables": [
    {
      "id": "text",
      "variable": "text"
    }
  ],
  "webhook": "text",
  "headers": "text",
  "transactional": true,
  "enabled": true,
  "removed": true,
  "evaluable": true,
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "createdAt": "2025-04-27T11:31:16.086Z",
  "updatedAt": "2025-04-27T11:31:16.086Z",
  "updatedBy": "text"
}

Uploads a new document

post

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

post

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "document": "binary"
}

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

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

put

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

documentUUIDstringRequired

A valid service Uuid

Body

enabledbooleanOptional

questionIdsstring[]Optional

Responses

put

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "enabled": true,
  "questionIds": [
    "text"
  ]
}

No content

Bulk removes Documents with the provided uuid list.

delete

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses

delete

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/massive-delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "uuids": [
    "text"
  ]
}

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

Exports more than one document

post

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses

Responsestring · byte[]

post

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/export HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "uuids": [
    "text"
  ]
}

[
  "Ynl0ZXM="
]

Create a brand new Question

post

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

descriptionstringOptional

Question descrciption

variablesstring[]Optional

List of examples of question

enabledbooleanRequired

Question enabled/disabled status

evaluablebooleanOptional

Question evaluable status

transactionalbooleanOptional

Question transactional status

webhookstringOptional

Webhook address endpoint

headersobjectOptional

Webhook headers

Responses

post

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 306

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "variables": [
    "text"
  ],
  "enabled": true,
  "evaluable": true,
  "transactional": true,
  "webhook": "text",
  "headers": {},
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ]
}

{
  "questionId": "text"
}

Updates a Question.

put

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

descriptionstringOptional

Question descrciption

variablesstring[]Optional

List of examples of question

enabledbooleanRequired

Question enabled/disabled status

evaluablebooleanOptional

Question evaluable status

transactionalbooleanOptional

Question transactional status

webhookstringOptional

Webhook address endpoint

headersobjectOptional

Webhook headers

Responses

put

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 306

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "variables": [
    "text"
  ],
  "enabled": true,
  "evaluable": true,
  "transactional": true,
  "webhook": "text",
  "headers": {},
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ]
}

{
  "id": "text",
  "botId": "text",
  "document": {
    "uuid": "text",
    "storageFilename": "text",
    "filename": "text",
    "enabled": true
  },
  "name": "text",
  "description": "text",
  "variables": [
    {
      "id": "text",
      "variable": "text"
    }
  ],
  "webhook": "text",
  "headers": "text",
  "transactional": true,
  "enabled": true,
  "removed": true,
  "evaluable": true,
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "createdAt": "2025-04-27T11:31:16.086Z",
  "updatedAt": "2025-04-27T11:31:16.086Z",
  "updatedBy": "text"
}

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

delete

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses

delete

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "uuids": [
    "text"
  ]
}

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

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

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

variablestringOptional

Example of the question

Responses

post

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/variable HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "variable": "text"
}

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

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

questionsIdsstring[]Optional

List the questions ids

Responses

put

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/change-enable HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "questionsIds": [
    "text"
  ]
}

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

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

DTO if Automated Learning is to be enabled or disabled

valuebooleanRequired

Parameter's value

Responses

put

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/automated-learning/change-bot-enable HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "value": true
}

No content

Automated Learning

Automated Learning

Documents

CRUD Operations

Bulk Operations

Questions

Paginations and Listings

CRUD Operations

Auxiliary Methods