コンパイルAPI

ボット単位でxAIMLファイルをコンパイルし、DATファイルを生成するAPIです。

このAPIはコンパイル処理の完了前にレスポンスが返る非同期APIです
コンパイルの状態は、レスポンスのstatusUriに記述されたコンパイル状態確認APIで確認できます。

エンドポイント

URL

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

リクエスト

Method	POST
Header	Authorization	ログインAPIで払い出したアクセストークンを指定します。
Body	なし

レスポンス

ステータスコード	成功 202（Accepted） エラー 401（Unauthorized） 403（Forbidden） 404（Not Found） 409（Conflict） 429（Too many requests） 503（Service Unavailable）
Body	JSON形式。（詳細はレスポンスパラメータを参照）

URLパラメータ

パラメータ名	説明
projectId	コンパイル対象のプロジェクトIDを指定します。
botId	コンパイル対象のボットIDを指定します。

リクエストパラメータ

リクエストパラメータはありません。

レスポンスパラメータ

キー		型	必須	説明
statusUri		string	○	コンパイル状態確認APIのエンドポイントURLが設定されます。

レスポンス例（正常）

レスポンス例（エラー）

HTTPステータス／原因		レスポンス内容
401（Unauthorized）
	トークン不正	なし
	パスワードが期限切れもしくは旧式や初期パスワード	なし
403（Forbidden）
	アクセス権不正	なし
	プロジェクトID不正	なし
404（Not Found）
	ボットID不正	1 {"error": "not found", "keys":["xx"]}
	コンパイル対象のAIMLが存在しない	1 {"error": "compile target not found"}
409（Conflict）
	コンパイル処理中	1 {"error": "processing"}
429（Too many requests）
	ロックアウト	なし
503（Service Unavailable）
	AIML構文エラー	1 2 3 4 5 6 7 {   "error": "AIML validation error",   "details": [     {"file": "XXX.aiml", "message": "xxxxxxx"},     {"file": "XXX.aiml", "message": "xxxxxxx"}   ] }