SET更新API

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

SETをカテゴリ単位で更新するAPIです。

ご注意

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

エンドポイント

URL

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

リクエスト

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 SETを更新したいプロジェクトのIDを指定します。
botId SETを更新したいボットのIDを指定します。

リクエストパラメータ

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

SETファイル仕様

ファイル名 {カテゴリ名} .set
カテゴリ名は1~99文字の間で指定してください。
文字コード UTF-8(BOMなし)
ファイル内容 「1行=1文字列」となるよう記述してください。複数記述する場合は別の行に記述してください。
また、文字列は1~200文字の間で記述してください。

言語がja-JPの場合、先頭行に正規化モードをオプションで指定できます。
 "#mode:exact" ヨミと品詞を付与しない
 "#mode:surface" ヨミと品詞を付与する(デフォルト)

サンプル
「いちご」「りんご」「アップル」「ストロベリー」を記述する例です。

レスポンスパラメータ

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

レスポンス例(エラー)

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