使用済みボット定義および関連するすべてのコンポーネントをエクスポートするために使用されます。このAPIは、エクスポート処理を開始するだけです。エクスポートのステータスAPIを使用して、エクスポートの進捗状況を確認したり、エクスポートが完了した後にファイルをダウンロードするためのリンクを取得することができます。
このAPIを使用するために、アプリは [ボット定義] の [ボットのエクスポート] の管理APIスコープを必要とします。
ポスト https://{{host}}/api/public/bot/{{BotID}}/export
クエリパラメータ
パラメータ | 説明 |
---|---|
ホスト | 環境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 }