To get the status of the ML training.
To use this API, app needs the Admin API Scope of Train ML under Test and Train.
GET https://{{host}}/api/public/bot/{{BotID}}/ml/train/status?language={{lang}}&state={{state}}
Path Parameters
| Parameter | Required/Optional | Description |
|---|---|---|
| host | Required | Environment URL, for example, https://bots.kore.ai |
| BotID | Required | Bot ID or Stream ID. You can access it from the General Settings page of the bot. |
| language | Optional | The bot language, for example, en for English and de for German. Set by default to the default language of the bot |
| state | Optional | State of the bot, configured for In-Development version and published for published version Set by default to configured |
Authorization
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
Response Content Type
application/json
Sample Request
curl -X GET \
https://{{host}}/api/public/bot/{{BotId}}/ml/train/status \
-H 'Content-Type: application/json' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
Sample Response
For successful training
{
"trainingStatus": "Finished",
"isMlInSyncWithSentences": true,
"isMlInSyncWithSynonyms": true,
"isMlInSyncWithMlparams": true,
"isMlInSyncWithTraits": true
}
For training in-progress
{
"trainingStatus": "Inprogress",
"isMlInSyncWithSentences": true,
"isMlInSyncWithSynonyms": true,
"isMlInSyncWithMlparams": true,
"isMlInSyncWithTraits": true
}
For failed training
{
"trainingStatus": "Failed",
"isMlInSyncWithSentences": true,
"isMlInSyncWithSynonyms": true,
"isMlInSyncWithMlparams": true,
"isMlInSyncWithTraits": true
}