Training
The training API handles all training methods for bots that both use AL or not.
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.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entity you are searching belong to
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training HTTP/1.1
Host:
Accept: */*
{
"trainingAvailable": "text",
"currentVersion": 1,
"nextVersion": 1,
"documentStatus": "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.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entity you are searching belong to
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/training-availability HTTP/1.1
Host:
Accept: */*
{
"trainingAvailable": "text",
"currentVersion": 1,
"nextVersion": 1,
"documentStatus": "text"
}Returns a page of the bot's trainings. If validOnly is sent with value true, only successfull trainings are shown, instead.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entity you are searching belong to
Boolean that filters the search in order to find only trainings that obtained success
falseCurrent page, starting at 1
1Size of the page
5Field want to ordernate, the default is 'updatedAt'
updatedAtDirection of ordenation, ASC or DESC. The default is DESC
DESCGET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/list?page=1&size=5 HTTP/1.1
Host:
Accept: */*
{
"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
}Knowledge AI Training
It is the organization uuid where the bot is.
It is the environment uuid where the bot is.
It is the identification of the bot.
Optional structure. used to add new rules into the training and bypass new fields into KAI's register-doc v2
Optional. Maximum size of a chunk.
Optional. Limit of overlapping characters between chunks. Bigger overlap preserves context but increases token usage.
Optional. A list of collectionUUIDs (Document groups) to train. If empty, it trains all documents instead.
Optional. A list of documentIds to train. If empty, it trains all documents instead.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 93
{
"windowsLength": 1,
"overlap": 1,
"filterCollectionUuids": [
"text"
],
"filterDocumentIds": [
"text"
]
}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.
It is the organization uuid where the bot is.
It is the environment uuid where the bot is.
It is the identification of the bot.
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn/availability HTTP/1.1
Host:
Accept: */*
{
"trainingAvailable": "text",
"currentVersion": 1,
"nextVersion": 1,
"documentStatus": "text"
}Returns a page of the bot's trainings. If validOnly is sent with value true, only successfull trainings are shown, instead.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entity you are searching belong to
Boolean that filters the search in order to find only trainings that obtained success
falseCurrent page, starting at 1
1Size of the page
5Field want to ordernate, the default is 'updatedAt'
updatedAtDirection of ordenation, ASC or DESC. The default is DESC
DESCGET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn?page=1&size=5 HTTP/1.1
Host:
Accept: */*
{
"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
}Last updated
Was this helpful?