봇 내보내기 API – Kore.ai Documentation

봇 정의와 모든 관련 구성 요소를 내보내는 데 사용됩니다. 이 API는 내보내기 프로세스만 시작합니다. 내보내기 상태 API를 사용하여 내보내기 과정을 확인하고 내보내기가 완료된 후 파일을 다운로드할 수 있는 링크를 가져옵니다.

이 API를 사용하려면 앱에는 봇 정의 아래에 있는 봇 내보내기의 관리자 API 범위가 필요합니다.

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

쿼리 매개 변수

매개 변수	설명
host	환경 URL, 예: `https://bots.kore.ai`
BotID	봇 ID 또는 스트림 ID. 봇의 일반 설정 페이지에서 이를 액세스할 수 있습니다.

본문 매개 변수

매개 변수	설명
exportType	봇 유형 – ‘최근‘ 또는 ‘게시됨’
exportOptions (선택 사항)	모든 봇 구성 요소는 기본적으로 내보내집니다. 필요한 경우 내보내기에 포함할 구성 요소를 지정할 수 있습니다. "exportOptions": { "tasks": [ "botTask", "knowledgeGraph" ], "nlpData": [ "nlpSettings", "utterances", "standardResponses" ], "settings": [ "botSettings", "botVariables", "ivrSettings" ] },
subTasks (선택 사항)	부분 내보내기의 경우 내보낼 작업을 언급합니다. "subTasks": { "dialogs": ["<dialog Name 1>","<dialog Name 2>"], "alerts": ["<alert name 1>","<alert name 2>"], "actions": ["<action name 1>","<action name 2>"] }
IncludeDependentTasks (선택 사항)	내보낼 종속 작업을 포함합니다 "IncludeDependentTasks":
allTasks(선택 사항)	내보낼 모든 작업을 포함하려면 subTasks가 있는 경우 무시됩니다. "allTasks":

부분 가져오기 및 종속 작업의 선택적 매개 변수에 대한 자세한 내용은 여기를 참조하세요.

권한 부여

다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}

콘텐츠 유형 응답

application/json

샘플 요청

curl -X POST \
  https://{{host}}/api/public/bot/{{BotID}/export \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json' \
  -d '{
     "exportType": "published"
     }'

샘플 응답

{
    "status": "pending",
    "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
    "createdBy": "u-xxx-xxx-xxx-xxx-xxxxx",
    "exportType": "published",
    "requestType": "Botexport",
    "_id": "ber-xxxxx-xxx-xxx-xxx-xxxxx",
    "status": "pending",
    "createdOn": "2018-12-05T07:18:40.028Z",
    "__v": 0
}

使用済みボット定義および関連するすべてのコンポーネントをエクスポートするために使用されます。このAPIは、エクスポート処理を開始するだけです。エクスポートのステータスAPIを使用して、エクスポートの進捗状況を確認したり、エクスポートが完了した後にファイルをダウンロードするためのリンクを取得することができます。

このAPIを使用するために、アプリは [ボット定義] の [ボットのエクスポート] の管理APIスコープを必要とします。

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

クエリパラメータ

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

本文パラメータ

パラメータ	説明
exportType	ボットタイプ – 'latest' または 'published'
exportOptions（任意）	すべてのボットコンポーネントがデフォルトでエクスポートされます。必要に応じて、エクスポートに含まれるコンポーネントを指定することができます。 "exportOptions": { "tasks": [ "botTask", "knowledgeGraph" ], "nlpData": [ "nlpSettings", "utterances", "standardResponses" ], "settings": [ "botSettings", "botVariables", "ivrSettings" ] },
subTasks（任意）	部分的にエクスポートする場合は、エクスポートするタスクを指定します。 "subTasks": { "dialogs": ["<dialog Name 1>","<dialog Name 2>"], "alerts": ["<alert name 1>","<alert name 2>"], "actions": ["<action name 1>","<action name 2>"] }
IncludeDependentTasks（任意）	依存タスクをエクスポートに含めます "IncludeDependentTasks":
allTasks（任意）	すべてのタスクをエクスポートに含めるため、subTasksが存在する場合は無視されます "allTasks":

部分インポートと依存タスクのオプションパラメーターについては、こちらをご覧ください。

認証

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

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X POST \ https://{{host}}/api/public/bot/{{BotID}/export \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json' \ -d '{ "exportType": "published" }'

サンプル応答

{ "status": "pending", "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx", "createdBy": "u-xxx-xxx-xxx-xxx-xxxxx", "exportType": "published", "requestType": "Botexport", "_id": "ber-xxxxx-xxx-xxx-xxx-xxxxx", "status": "pending", "createdOn": "2018-12-05T07:18:40.028Z", "__v": 0 }

Used to export bot definition and all associated components. This API only initiates the export process. Use Export Status API to view the progress of the export and also to get a link to download the file once the export is completed.

To use this API, app needs the Admin API Scope of Bot Export under Bot Definition.

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

Query Parameters

Parameter	Description
host	Environment URL, for example, `https://bots.kore.ai`
BotID	Bot ID or Stream ID. You can access it from the General Settings page of the bot.

Body Parameters

Parameter	Description
exportType	Bot type – ‘latest‘ or ‘published‘
exportOptions (optional)	All bot components are exported by default. If needed, you may specify the components to be included in the export. "exportOptions": { "tasks": [ "botTask", "knowledgeGraph" ], "nlpData": [ "nlpSettings", "utterances", "standardResponses" ], "settings": [ "botSettings", "botVariables", "ivrSettings" ] },
subTasks (optional)	For partial export mention the tasks to be exported. "subTasks": { "dialogs": ["<dialog Name 1>","<dialog Name 2>"], "alerts": ["<alert name 1>","<alert name 2>"], "actions": ["<action name 1>","<action name 2>"] }
IncludeDependentTasks (optional)	To include dependent tasks for export "IncludeDependentTasks":
allTasks (optional)	To include all tasks for export, will be ignored if subTasks is present "allTasks":

For more on the optional parameters for partial import and dependent tasks, see here.

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/{{BotID}/export \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json' \
  -d '{
     "exportType": "published"
     }'

Sample Response

{
    "status": "pending",
    "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
    "createdBy": "u-xxx-xxx-xxx-xxx-xxxxx",
    "exportType": "published",
    "requestType": "Botexport",
    "_id": "ber-xxxxx-xxx-xxx-xxx-xxxxx",
    "status": "pending",
    "createdOn": "2018-12-05T07:18:40.028Z",
    "__v": 0
}