{"id":18069,"date":"2018-11-24T06:01:12","date_gmt":"2018-11-24T06:01:12","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?post_type=docs&p=15494"},"modified":"2021-03-25T07:41:06","modified_gmt":"2021-03-25T07:41:06","slug":"ml-training-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/ml-training-api\/","title":{"rendered":"ML Utterances Train API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To initiate ML training of a bot.<\/p>\n

To use this API, app needs the Admin API Scope of Train ML<\/em> under Test and Train<\/em>.<\/p>\n

POST<\/b> https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/ml\/train<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h3>\n\n\n\n\n\n\n
Parameter<\/b><\/th>\nRequired\/Optional<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n<\/thead>\n
host<\/td>\nRequired<\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n
BotID<\/td>\nRequired<\/td>\nBot ID or Stream ID. You can access it from the General Settings page of the bot.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Authorization<\/span><\/h3>\n

Invoke the API with JWT in the header as follows:<\/p>\n

auth: {{JWT}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Response Content Type<\/span><\/h3>\n

application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Sample Request<\/span><\/h3>\n
curl -X POST \\\r\n  https:\/\/{{host}}\/api\/public\/bot\/{{BotId}}\/ml\/train \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h3>\n
[\r\n    {\r\n        \"message\": \"Training Queued.\",\r\n        \"Training_ID\": \"5d14b03edba48abcb44375a1\"\r\n    }\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 initiate ML training of a bot. To use this API, app needs the Admin API Scope of Train ML under Test and Train. POST https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/ml\/train Query 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...","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-18069","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18069","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/comments?post=18069"}],"version-history":[{"count":6,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18069\/revisions"}],"predecessor-version":[{"id":22553,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18069\/revisions\/22553"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=18069"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=18069"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=18069"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}