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
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

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

Query parameters
validOnlybooleanOptional

Boolean that filters the search in order to find only trainings that obtained success

Default: false
pageinteger · int32Required

Current page, starting at 1

Default: 1
sizeinteger · int32Required

Size of the page

Default: 5
orderBystringOptional

Field want to ordernate, the default is 'updatedAt'

Default: updatedAt
directionstringOptional

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

Default: DESC
Responses
200
Ok
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/list?page=1&size=5 HTTP/1.1
Host: 
Accept: */*
{
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "pageable": {
    "unpaged": true,
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 1
  },
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 1,
  "content": [
    {
      "id": "text",
      "version": "text",
      "status": "text",
      "statusDocument": "text",
      "statusFAQ": "text",
      "accuracy": 1,
      "updatedAt": "text",
      "errorMsg": "text",
      "errorDocument": "text",
      "errorFAQ": "text",
      "statistics": {
        "success": 1,
        "errorr": 1
      },
      "user": {
        "name": "text",
        "imageUrl": "text"
      }
    }
  ],
  "number": 1,
  "empty": true
}

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
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

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

Query parameters
formTrainingstring · enumOptionalPossible values:
Responses
200
Ok
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training HTTP/1.1
Host: 
Accept: */*
{
  "trainingAvailable": "text",
  "currentVersion": 1,
  "nextVersion": 1
}

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
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

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

Responses
200
Ok
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/training-availability HTTP/1.1
Host: 
Accept: */*
{
  "trainingAvailable": "text",
  "currentVersion": 1,
  "nextVersion": 1
}

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
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

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

Query parameters
validOnlybooleanOptional

Boolean that filters the search in order to find only trainings that obtained success

Default: false
pageinteger · int32Required

Current page, starting at 1

Default: 1
sizeinteger · int32Required

Size of the page

Default: 5
orderBystringOptional

Field want to ordernate, the default is 'updatedAt'

Default: updatedAt
directionstringOptional

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

Default: DESC
Responses
200
Ok
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn?page=1&size=5 HTTP/1.1
Host: 
Accept: */*
{
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "pageable": {
    "unpaged": true,
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 1
  },
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 1,
  "content": [
    {
      "id": "text",
      "version": "text",
      "status": "text",
      "statusDocument": "text",
      "statusFAQ": "text",
      "accuracy": 1,
      "updatedAt": "text",
      "errorMsg": "text",
      "errorDocument": "text",
      "errorFAQ": "text",
      "statistics": {
        "success": 1,
        "errorr": 1
      },
      "user": {
        "name": "text",
        "imageUrl": "text"
      }
    }
  ],
  "number": 1,
  "empty": true
}

Request an Automated Learning training.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

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

Responses
200
Ok
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn HTTP/1.1
Host: 
Accept: */*

No content

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
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

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

Responses
200
Ok
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn/availability HTTP/1.1
Host: 
Accept: */*
{
  "trainingAvailable": "text",
  "currentVersion": 1,
  "nextVersion": 1
}

Was this helpful?

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

Change request updated