MAP更新API

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

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

ご注意

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

エンドポイント

URL

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

リクエスト

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

リクエストパラメータ

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

MAPファイル仕様

ファイル名 {カテゴリ名}.map
カテゴリ名は1~99文字の間で設定してください。
文字コード UTF-8(BOMなし)
ファイル内容 置換前後の文字列の組み合わせを、タブ区切りで記述してください。
「1行=1組み合わせ」となるよう記述してください。複数の組み合わせを記述する場合は別の行に記述してください。

また、置換前後の文字列は以下に準拠してください。
 置換前:1~200文字
 置換後:1文字以上

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

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

レスポンスパラメータ

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

レスポンス例(エラー)

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