{"id":18070,"date":"2018-11-24T06:04:51","date_gmt":"2018-11-24T06:04:51","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?post_type=docs&p=15497"},"modified":"2023-07-26T15:15:43","modified_gmt":"2023-07-26T14:15:43","slug":"ml-training-status-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/ml-training-status-api\/","title":{"rendered":"ML Utterance Train Status API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To get the ML training status.<\/p>\n

 <\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nGET<\/td>\n<\/tr>\n
Endpoint<\/b><\/td>\nhttps:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/ml\/train\/status?language={{lang}}&state={{state}}<\/code><\/span><\/td>\n<\/tr>\n
Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/b><\/td>\nauth: {{JWT}}<\/code><\/p>\n

See How to generate the JWT Token<\/a>.<\/td>\n<\/tr>\n

API Scope<\/b><\/td>\n\n
    \n
  • Bot Builder: Train ML<\/li>\n
  • Admin Console: Test and Train > Train ML<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t

     <\/p>\n

    Path Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\nMandate<\/th>\n<\/tr>\n
    host<\/b><\/td>\nThe environment URL. For example, https:\/\/bots.kore.ai<\/code><\/td>\nRequired<\/td>\n<\/tr>\n
    BotID<\/b><\/td>\nThe Bot ID<\/b> or Stream ID<\/b> to be accessed under General Settings<\/b> on the Bot Builder.<\/td>\nRequired<\/td>\n<\/tr>\n
    language<\/b><\/td>\nThe Bot language which is identified by the language acronym. For example, en<\/em> for English and de<\/em> for German.
    \nThe user can set the default language of the bot.<\/td>\n    		Optional<\/td>\n<\/tr>\n
    state<\/b><\/td>\nThe state of the bot configured<\/em> for the In-Development version and published<\/em> for the published version.
    \nSet by default to configured<\/em><\/td>\n    		Optional<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t

     <\/p>\n

    Sample Request<\/span><\/h2>\n
    curl -X GET \\\r\n  https:\/\/{{host}}\/api\/public\/bot\/{{BotId}}\/ml\/train\/status \\\r\n  -H 'Content-Type: application\/json' \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
     <\/p>\n
    Body Parameters<\/span><\/h2>\n
    No Body Parameters are passed.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Sample Response<\/span><\/h2>\n
    For successful training<\/strong><\/p>\n
    {\r\n    \"trainingStatus\": \"Finished\",\r\n    \"isMlInSyncWithSentences\": true,\r\n    \"isMlInSyncWithSynonyms\": true,\r\n    \"isMlInSyncWithMlparams\": true,\r\n    \"isMlInSyncWithTraits\": true,\r\n    \"isMlInSyncWithSmallTalk\": true,\r\n    \"isMlInSyncWithUBTraining\": true,\r\n    \"isMlInSyncWithEntityNode\": true,\r\n    \"isMlInSyncWithIntentNode\": true,\r\n    \"isMlInSyncWithPatterns\": true,\r\n    \"isMlInSyncWithBTUtterances\": true,\r\n    \"trainDetails\": {\r\n        \"nlpVersion\": 3,\r\n        \"trainVersion\": 3\r\n    }\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    For training in-progress<\/strong><\/p>\n
    {\r\n    \"trainingStatus\": \"Inprogress\",\r\n    \"isMlInSyncWithSentences\": true,\r\n    \"isMlInSyncWithSynonyms\": true,\r\n    \"isMlInSyncWithMlparams\": true,\r\n    \"isMlInSyncWithTraits\": true,\r\n    \"isMlInSyncWithSmallTalk\": true,\r\n    \"isMlInSyncWithUBTraining\": true\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    For failed training<\/strong><\/p>\n
    {\r\n    \"trainingStatus\": \"Failed\",\r\n    \"isMlInSyncWithSentences\": true,\r\n    \"isMlInSyncWithSynonyms\": true,\r\n    \"isMlInSyncWithMlparams\": true,\r\n    \"isMlInSyncWithTraits\": true,\r\n    \"isMlInSyncWithSmallTalk\": true,\r\n    \"isMlInSyncWithUBTraining\": true\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"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}} See How to generate the JWT Token. API Scope Bot Builder: Train ML Admin Console: Test and Train > Train ML   Path Parameters Parameter Description Mandate host The environment URL. For example, https:\/\/bots.kore.ai Required BotID The Bot...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-18070","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18070","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=18070"}],"version-history":[{"count":16,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18070\/revisions"}],"predecessor-version":[{"id":58425,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18070\/revisions\/58425"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=18070"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=18070"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=18070"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}