To get the ML training status.
| Method | GET |
| Endpoint | https://{{host}}/api/public/bot/{{BotID}}/ml/train/status?language={{lang}}&state={{state}} |
| Content Type | application/json |
| Authorization | auth: {{JWT}}
|
| API Scope |
|
Path Parameters
| Parameter | Description | Mandate |
|---|---|---|
| host | The environment URL. For example, https://bots.kore.ai |
Required |
| BotID | The Bot ID or Stream ID to be accessed under General Settings on the Bot Builder. | Required |
| language | The Bot language which is identified by the language acronym. For example, en for English and de for German. The user can set the default language of the bot. |
Optional |
| state | The state of the bot configured for the In-Development version and published for the published version. Set by default to configured |
Optional |
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}}' \
Body Parameters
No Body Parameters are passed.
Sample Response
For successful training
{
"trainingStatus": "Finished",
"isMlInSyncWithSentences": true,
"isMlInSyncWithSynonyms": true,
"isMlInSyncWithMlparams": true,
"isMlInSyncWithTraits": true,
"isMlInSyncWithSmallTalk": true,
"isMlInSyncWithUBTraining": true,
"isMlInSyncWithEntityNode": true,
"isMlInSyncWithIntentNode": true,
"isMlInSyncWithPatterns": true,
"isMlInSyncWithBTUtterances": true,
"trainDetails": {
"nlpVersion": 3,
"trainVersion": 3
}
}
For training in-progress
{
"trainingStatus": "Inprogress",
"isMlInSyncWithSentences": true,
"isMlInSyncWithSynonyms": true,
"isMlInSyncWithMlparams": true,
"isMlInSyncWithTraits": true,
"isMlInSyncWithSmallTalk": true,
"isMlInSyncWithUBTraining": true
}
For failed training
{
"trainingStatus": "Failed",
"isMlInSyncWithSentences": true,
"isMlInSyncWithSynonyms": true,
"isMlInSyncWithMlparams": true,
"isMlInSyncWithTraits": true,
"isMlInSyncWithSmallTalk": true,
"isMlInSyncWithUBTraining": true
}