ボットのエクスポートAPI

使用済みボット定義および関連するすべてのコンポーネントをエクスポートするために使用されます。この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 }

On this Page

Bot Export API

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
}

On this Page