ML 발화 내보내기 API – Kore.ai Documentation

봇의 ML 발화를 내보내는 데 사용됩니다. 이것은 ML 발화 내보내기 상태 API를 이용하여 봇의 다운로드 링크를 생성할 수 있는 요청 ID를 생성합니다.

이 API를 사용하려면 앱에 발화 내보내기의 봇 빌더 API 범위가 필요합니다. 또는 테스트 및 훈련 아래의 발화 내보내기의 관리자 API 범위가 필요합니다.

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

쿼리 매개 변수

매개 변수	필수/선택 사항	설명
host	필수	환경 URL(예: https://bots.kore.ai)
BotID	필수	봇 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
}

ボットの機械学習の発話をエクスポートするために使用します。リクエスト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 }

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
}