{"id":18071,"date":"2018-11-24T06:09:55","date_gmt":"2018-11-24T06:09:55","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?post_type=docs&p=15499"},"modified":"2021-03-25T07:37:28","modified_gmt":"2021-03-25T07:37:28","slug":"ml-utterances-import-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/ml-utterances-import-api\/","title":{"rendered":"ML Utterances Import API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Imports ML Utterances into a bot.<\/p>\n

To use this API, app needs the Bot Builder API scope of Utterances Import<\/em>.
\nOR the Admin API Scope of Utterances Import<\/em> under Test and Train<\/em>.<\/p>\n

POST<\/b> https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/mlimport<\/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<\/th>\nRequired\/Optional<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
host<\/td>\nRequired<\/td>\nThe bot environment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n
BotID<\/td>\nRequired<\/td>\nBot ID or Stream ID of the bot to import into. You can access it from the General Settings page of the bot.<\/td>\n<\/tr>\n<\/thead>\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

Body Parameters<\/span><\/h3>\n\n\n\n\n\n
Parameter<\/th>\nRequired\/Optional<\/th>\nDescription<\/th>\n<\/tr>\n
fileName<\/td>\nRequired<\/td>\nFull name of the ML Utterances file to import<\/td>\n<\/tr>\n
fileID<\/td>\nRequired<\/td>\nThe ID of the import file (provided by the cloud service where the file is uploaded).<\/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 with the following syntax:<\/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\/{{bot ID}}\/mlimport \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n  -H 'content-type: application\/json' \\\r\n  -d '{\r\n\"fileName\":\"MLUtterances.json\",\r\n\"fileId\": \"5beed4fd0b9a4b740c09dca2\"\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    \"status\": \"pending\",\r\n    \"streamId\": \"st-6ecb5ba2-5e31-5a40-b918-8cbee40f3fdb\",\r\n    \"createdBy\": \"u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91\",\r\n    \"requestType\": \"MLimport\",\r\n    \"_id\": \"bir-7ec861ee-5e6b-5165-b505-8820a275afdf\",\r\n    \"statusLogs\": [],\r\n    \"createdOn\": \"2019-06-27T12:03:30.748Z\",\r\n    \"__v\": 0\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":"Imports ML Utterances into a bot. To use this API, app needs the Bot Builder API scope of Utterances Import. OR the Admin API Scope of Utterances Import under Test and Train. POST https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/mlimport Query Parameters Parameter Required\/Optional Description host Required The bot environment URL, for example, https:\/\/bots.kore.ai BotID Required Bot ID or Stream ID...","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-18071","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\/18071","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=18071"}],"version-history":[{"count":5,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18071\/revisions"}],"predecessor-version":[{"id":22548,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18071\/revisions\/22548"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=18071"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=18071"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=18071"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}