ML Utterance Train Status API

Back to API List

Retrieves the current ML training status for a bot.

Field	Value
Method	GET
Endpoint	https://{{host}}/api/public/bot/{{BotID}}/ml/train/status?language={{lang}}&state={{state}}
Content Type	application/json
Authorization	auth: {{JWT}} — See How to generate the JWT Token.
API Scope	App Builder: Train ML; Admin Console: Test and Train > Train ML

Path Parameters

Parameter	Required/Optional	Description
host	Required	The environment URL. For example, https://platform.kore.ai
BotID	Required	Bot ID or Stream ID. Accessible under General Settings on the App Builder.
language	Optional	Bot language identified by its acronym (for example, en for English, de for German). The user can set the default language of the bot.
state	Optional	Bot state: configured for the in-development version, published for the published version. Defaults to configured.

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

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
    }
}

Training in progress:

{
    "trainingStatus": "Inprogress",
    "isMlInSyncWithSentences": true,
    "isMlInSyncWithSynonyms": true,
    "isMlInSyncWithMlparams": true,
    "isMlInSyncWithTraits": true,
    "isMlInSyncWithSmallTalk": true,
    "isMlInSyncWithUBTraining": true
}

Failed training:

{
    "trainingStatus": "Failed",
    "isMlInSyncWithSentences": true,
    "isMlInSyncWithSynonyms": true,
    "isMlInSyncWithMlparams": true,
    "isMlInSyncWithTraits": true,
    "isMlInSyncWithSmallTalk": true,
    "isMlInSyncWithUBTraining": true
}