DOCUMENTATION

機械学習の発話のエクスポートAPI

ボットの機械学習の発話をエクスポートするために使用します。リクエストIDが作成され、そこから機械学習の発話のエクスポートのステータスAPIを使用してボットのダウンロードリンクを生成することができます。

このAPIを使用するために、アプリは [発話のインポート] のボットビルダーのAPIスコープを必要とします。あるいは、[テストとトレーニング] にある [発話のエクスポート] の管理者のAPIスコープを必要とします。

ポスト https://{{host}}/api/public/bot/{{BotID}}/mlexport

クエリパラメータ

パラメータ	必須/任意	説明
ホスト	必須	環境URL（例： https://bots.kore.ai）
ボットID	必須	ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。

認証

以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X POST \ 'https://{{host}}/api/public/bot/{{bot_id}}/mlexport?state=configured&=&type=csv' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json'

サンプル応答

{ "status": "IN_PROGRESS", "percentageComplete": 0, "streamId": "st-bcd6c75d-9ef1-5861-aa13-fb3290e7fbb1", "createdBy": "u-05ec6214-a26f-55d7-b474-7353cddac928", "jobType": "ML_UTTERANCE", "action": "EXPORT", "fileType": "JSON", "statusLogs": [], "_id": "ds-cb3e478a-a33e-5264-a49c-74c7fccb06c4", "lMod": "2019-12-27T11:40:06.000Z", "createdOn": "2019-12-27T11:40:06.746Z", "__v": 0 }

On this Page

ML Utterances Export API

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 and Train.

POST https://{{host}}/api/public/bot/{{BotID}}/mlexport

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 the bot.

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X POST \ 'https://{{host}}/api/public/bot/{{bot_id}}/mlexport?state=configured&=&type=csv' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json'

Sample Response

{
"status": "IN_PROGRESS",
"percentageComplete": 0,
"streamId": "st-bcd6c75d-9ef1-5861-aa13-fb3290e7fbb1",
"createdBy": "u-05ec6214-a26f-55d7-b474-7353cddac928",
"jobType": "ML_UTTERANCE",
"action": "EXPORT",
"fileType": "JSON",
"statusLogs": [],
"_id": "ds-cb3e478a-a33e-5264-a49c-74c7fccb06c4",
"lMod": "2019-12-27T11:40:06.000Z",
"createdOn": "2019-12-27T11:40:06.746Z",
"__v": 0
}

On this Page