ファイルアップロードAPI(一括)

アクセス権限
特権 サーバ管理 テナント管理 シナリオ設計 AIML編集者

複数のファイルをZIP形式で一括アップロードするAPIです。

アップロード可能なファイルは以下のとおりです。

  • xAIMLファイル
  • DATファイル
  • MAPファイル
  • SETファイル
  • NGワードファイル
  • 代替回答ファイル
  • ボット属性ファイル
  • ボット設定ファイル
  • ボットプロパティファイル
  • デフォルトPredicateファイル
ご注意

APIを実行したユーザの権限によりアップロード可能なファイルが異なります。
詳細は後述のZIPファイル仕様をご覧ください。

エンドポイント

URL

https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/projects/{projectId}/bots/{botId}/archive

リクエスト

Method PUT
Header Authorization ログインAPIで払い出したアクセストークンを指定します。
  Content-Type multipart/form-data
Body multipart/form-data形式(詳細はリクエストパラメータを参照)

レスポンス

ステータスコード 成功

  • 201(Created)

エラー

  • 400(Bad Request)
  • 401(Unauthorized)
  • 403(Forbidden)
  • 404(Not Found)
  • 409(Conflict)
  • 429(Too many requests)
  • 503(Service Unavailable)
Body 成功:なし エラー:JSON形式

URLパラメータ

パラメータ名 説明
projectId アップロード先のプロジェクトIDを指定します。
botId アップロード先のボットIDを指定します。

リクエストパラメータ

フィールド 必須 説明
uploadFile file アップロードするZIPファイルを設定します。
詳細はZIPファイル仕様をご覧ください。

ZIPファイル仕様

ファイル名 {任意}.zip
ファイルサイズ 最大500MB
ファイル内容 ZIPファイル内容をご覧ください。

ZIPファイル内容

ZIPファイルは下表のディレクトリ構成に準拠してください。
APIを実行したユーザの権限が必要権限を満たしていない場合、そのファイルは無視されます。(ファイルダウンロード時も同様です)

ZIPファイル内の各ファイルについての詳細は、こちらをご覧ください。

ディレクトリ名/ファイル名 種別 必要権限 説明
aiml ディレクトリ
  {シナリオID}.aiml ファイル なし xAIMLファイルです。
dat ディレクトリ
  {任意}.dat ファイル なし DATファイルです。
map ディレクトリ
  {カテゴリ名}.map ファイル シナリオ設計 MAPファイルです。
set ディレクトリ
  {カテゴリ名}.set ファイル シナリオ設計 SETファイルです。
ngword ディレクトリ
  {任意}.ng ファイル シナリオ設計 NGワードファイルです。
okword ディレクトリ
  {任意}.ans ファイル シナリオ設計 代替回答ファイルです。
prop ディレクトリ
  botattr.properties ファイル テナント管理者 ボット属性ファイルです。
  botconf.properties ファイル シナリオ設計 ボット設定ファイルです。
  bot.properties ファイル シナリオ設計 ボットプロパティファイルです。
  preddef.properties ファイル シナリオ設計 デフォルトPredicateファイルです。

レスポンスパラメータ

レスポンスパラメータはありません。

レスポンス例(エラー)

HTTPステータス/原因 レスポンス内容
400(Bad Request)
  パラメータなし なし
  拡張子相違 なし
  ファイルサイズ超過
  AIML構文エラー
  ファイル内容エラー
(zip内の個々のファイルのサイズ超過やMAP/SETファイルなどの内容エラー)
401(Unauthorized)
  パスワードが期限切れもしくは旧式や初期パスワード なし
429(Too many requests)
  ロックアウト なし
503(Service Unavailable)
  ディスク空き容量不足