{"id":18085,"date":"2018-11-24T08:49:34","date_gmt":"2018-11-24T08:49:34","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?post_type=docs&p=15549"},"modified":"2021-03-25T07:50:06","modified_gmt":"2021-03-25T07:50:06","slug":"ml-utterances-export-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/ml-utterances-export-api\/","title":{"rendered":"ML Utterances Export API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Used to export the ML utterances of a bot. It creates a request ID from which we can generate the Download link of the bot using ML Utterance Export Status API<\/a>.<\/p>\n

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

POST<\/b> https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/mlexport<\/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
Parameter<\/b><\/th>\nRequired\/Optional<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\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 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 \\ 'https:\/\/{{host}}\/api\/public\/bot\/{{bot_id}}\/mlexport?state=configured&=&type=csv' \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n  -H 'content-type: application\/json'<\/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\": \"IN_PROGRESS\",\r\n\"percentageComplete\": 0,\r\n\"streamId\": \"st-bcd6c75d-9ef1-5861-aa13-fb3290e7fbb1\",\r\n\"createdBy\": \"u-05ec6214-a26f-55d7-b474-7353cddac928\",\r\n\"jobType\": \"ML_UTTERANCE\",\r\n\"action\": \"EXPORT\",\r\n\"fileType\": \"JSON\",\r\n\"statusLogs\": [],\r\n\"_id\": \"ds-cb3e478a-a33e-5264-a49c-74c7fccb06c4\",\r\n\"lMod\": \"2019-12-27T11:40:06.000Z\",\r\n\"createdOn\": \"2019-12-27T11:40:06.746Z\",\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":"Used to export the ML utterances of a bot. It creates a request ID from which we can generate the Download link of the bot using ML Utterance Export Status API. To use this API, app needs the Bot Builder API scope of Utterances Export. OR the Admin API Scope of Utterances Export under Test...","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-18085","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\/18085","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=18085"}],"version-history":[{"count":6,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18085\/revisions"}],"predecessor-version":[{"id":23066,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18085\/revisions\/23066"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=18085"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=18085"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=18085"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}