NGワード更新API

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

NGワードを更新するAPIです。

ご注意

更新対象のNGワードは、リクエストのuploadFileの内容で置き換えられます。
(たとえば既に北海道が登録された状態で、神奈川県のみのファイルを指定した場合、北海道が削除されます)

エンドポイント

URL

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

リクエスト

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 NGワード更新先のプロジェクトIDを指定します。
botId NGワード更新先のボットIDを指定します。

リクエストパラメータ

名称 必須 説明
uploadFile file NGワードファイル仕様に準拠したファイルを指定します。

NGワードファイル仕様

ファイル名 {任意の名称}.ng
文字コード UTF-8
ファイル内容 1行=1NGワードとなるよう記述してください。
複数のNGワードを記述する場合は別の行に記述してください。
1つのNGワードは1~64文字以内に収めてください。

サンプル

または

レスポンスパラメータ

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

レスポンス例(エラー)

HTTPステータス/原因 レスポンス内容
400(Bad Request)
  ファイルサイズ超過
  ファイル内容エラー
401(Unauthorized)
  パスワードが期限切れもしくは旧式や初期パスワード なし
409(Conflict)
  キー重複
429(Too many requests)
  ロックアウト なし
503(Service Unavailable)
  ディスク空き容量不足