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

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

xAIMLファイルをアップロードするAPIです。

複数のxAIMLファイルを一括でアップロードする場合は、ファイルアップロードAPI(一括)をご利用ください。

エンドポイント

URL

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

リクエスト

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 アップロードするファイルを設定します。
また、ファイルサイズの上限は5MBです。

レスポンスパラメータ

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

レスポンス例(エラー)

HTTPステータス/原因 レスポンス内容
400(Bad Request)
  パラメータなし なし
  拡張子相違 なし
  ファイルサイズ超過
  AIML構文エラー
401(Unauthorized)
  パスワードが期限切れもしくは旧式や初期パスワード なし
409(Conflict)
  AIML単体アップロード時 基本シナリオIDと重複
429(Too many requests)
  ロックアウト なし
503(Service Unavailable)
  ディスク空き容量不足