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

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

Options: PARTIAL_NLP, PARTIAL_INTENT_NLP, PARTIAL_ENTITY_NLP, COMPLETE, COMPLETE_INTENT, COMPLETE_ENTITY

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training'

200

400

401

403

404

409

422

500

200

{
  "trainingAvailable": "text",
  "currentVersion": 1,
  "nextVersion": 1,
  "documentStatus": "text"
}

Ok

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

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/training-availability'

200

400

401

403

404

409

422

500

200

{
  "trainingAvailable": "text",
  "currentVersion": 1,
  "nextVersion": 1,
  "documentStatus": "text"
}

Ok

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

validOnlyboolean · default: falseoptional

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

pageinteger · int32 · default: 1required

Current page, starting at 1

sizeinteger · int32 · default: 5required

Size of the page

orderBystring · default: "updatedAt"optional

Field want to ordernate, the default is 'updatedAt'

directionstring · default: "DESC"optional

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/list?page=1&size=1'

200

400

401

403

404

409

422

500

200

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

Ok

Knowledge AI Training

Creates a request for a automated-learn training

post

Path parameters

orgUUIDstringrequired

It is the organization uuid where the bot is.

envUUIDstringrequired

It is the environment uuid where the bot is.

botUUIDstringrequired

It is the identification of the bot.

Body

windowsLengthinteger · int32optional

Optional. Maximum size of a chunk.

overlapinteger · int32optional

Optional. Limit of overlapping characters between chunks. Bigger overlap preserves context but increases token usage.

filterCollectionUuidsstring[]optional

Optional. A list of collectionUUIDs (Document groups) to train. If empty, it trains all documents instead.

filterDocumentIdsstring[]optional

Optional. A list of documentIds to train. If empty, it trains all documents instead.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn' \
  --header 'Content-Type: application/json' \
  --data '{
    "windowsLength": 1,
    "overlap": 1,
    "filterCollectionUuids": [
      "text"
    ],
    "filterDocumentIds": [
      "text"
    ]
  }'

202

400

401

403

404

409

422

500

202

No body

Accepted

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

It is the organization uuid where the bot is.

envUUIDstringrequired

It is the environment uuid where the bot is.

botUUIDstringrequired

It is the identification of the bot.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn/availability'

200

400

401

403

404

409

422

500

200

{
  "trainingAvailable": "text",
  "currentVersion": 1,
  "nextVersion": 1,
  "documentStatus": "text"
}

Ok

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

validOnlyboolean · default: falseoptional

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

pageinteger · int32 · default: 1required

Current page, starting at 1

sizeinteger · int32 · default: 5required

Size of the page

orderBystring · default: "updatedAt"optional

Field want to ordernate, the default is 'updatedAt'

directionstring · default: "DESC"optional

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn?page=1&size=1'

200

400

401

403

404

409

422

500

200

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

Ok