Training

The training API handles all training methods for bots that both use AL or not.

API SUBPATH: eva-training

The Training APIs are as simple as it can be - Both contain 3 methods, one for listing, one that requests a new training, and a last one which discerns whether a training should be available as of now. If you send a trainign request while the /training-availability does not inform it's available, the training proccess will fail at the nlp.

Standard Training

Returns a page of the bot's trainings. If validOnly is sent with value true, only successfull trainings are shown, instead.

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

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entity you are searching belong to

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

totalPagesinteger (int32)

totalElementsinteger (int64)

numberOfElementsinteger (int32)

firstboolean

lastboolean

pageablePageableObject (object)

sortSort (object)

sizeinteger (int32)

contentarray of TrainingListingDTO (object)

numberinteger (int32)

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/list?page=1&size=5', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "totalPages": 0,
  "totalElements": 0,
  "numberOfElements": 0,
  "first": false,
  "last": false,
  "pageable": {
    "unpaged": false,
    "paged": false,
    "pageNumber": 0,
    "pageSize": 0,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    },
    "offset": 0
  },
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "size": 0,
  "content": [
    {
      "id": "text",
      "version": "text",
      "status": "text",
      "statusDocument": "text",
      "statusFAQ": "text",
      "accuracy": 0,
      "updatedAt": "text",
      "errorMsg": "text",
      "errorDocument": "text",
      "errorFAQ": "text",
      "statistics": {
        "success": 0,
        "errorr": 0
      },
      "user": {
        "name": "text",
        "imageUrl": "text"
      }
    }
  ],
  "number": 0,
  "empty": false
}

Creates a request for a bot training, which will be sent to it's nlp-adequate training MS. Returns a TrainingAvailabilityDTO with the current training version and status.

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

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entity you are searching belong to

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

trainingAvailablestring

currentVersioninteger (int32)

nextVersioninteger (int32)

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

{
  "trainingAvailable": "text",
  "currentVersion": 0,
  "nextVersion": 0
}

Returns a TrainingAvailabilityDTO indicating wether there is an ongoing training and if a new one is elibigle. When a new value is eligible, the next version number will be sent instead.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/training-availability

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entity you are searching belong to

Response

200400401403404409422500

Ok

Body

*/*

trainingAvailablestring

currentVersioninteger (int32)

nextVersioninteger (int32)

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

{
  "trainingAvailable": "text",
  "currentVersion": 0,
  "nextVersion": 0
}

Automated Learning Training

Returns a page of the bot's trainings. If validOnly is sent with value true, only successfull trainings are shown, instead.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entity you are searching belong to

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

totalPagesinteger (int32)

totalElementsinteger (int64)

numberOfElementsinteger (int32)

firstboolean

lastboolean

pageablePageableObject (object)

sortSort (object)

sizeinteger (int32)

contentarray of TrainingListingDTO (object)

numberinteger (int32)

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn?page=1&size=5', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "totalPages": 0,
  "totalElements": 0,
  "numberOfElements": 0,
  "first": false,
  "last": false,
  "pageable": {
    "unpaged": false,
    "paged": false,
    "pageNumber": 0,
    "pageSize": 0,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    },
    "offset": 0
  },
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "size": 0,
  "content": [
    {
      "id": "text",
      "version": "text",
      "status": "text",
      "statusDocument": "text",
      "statusFAQ": "text",
      "accuracy": 0,
      "updatedAt": "text",
      "errorMsg": "text",
      "errorDocument": "text",
      "errorFAQ": "text",
      "statistics": {
        "success": 0,
        "errorr": 0
      },
      "user": {
        "name": "text",
        "imageUrl": "text"
      }
    }
  ],
  "number": 0,
  "empty": false
}

Request an Automated Learning training.

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entity you are searching belong to

Response

200400401403404409422500

Ok

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

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

Returns a TrainingAvailabilityDTO indicating wether there is an ongoing training and if a new one is elibigle. When a new value is eligible, the next version number will be sent instead.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn/availability

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entity you are searching belong to

Response

200400401403404409422500

Ok

Body

*/*

trainingAvailablestring

currentVersioninteger (int32)

nextVersioninteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn/availability', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "trainingAvailable": "text",
  "currentVersion": 0,
  "nextVersion": 0
}