ボットビルダーにおいて、それぞれのボットとタスクには、HTTPリクエストメソッドに返される標準的なHTTPステータスコードに対するアクションに加えて、事前定義済みのエラーメッセージのセットが含まれています。
ほとんどの場合、エンドユーザーへの応答はデフォルトの応答とアクションで十分なのですが、デフォルトでは定義されていない他のHTTPステータスコードを扱ったり、エラーメッセージ自体をカスタマイズしたり、エラー発生時のKore.aiによるデフォルトの応答を変更したりする必要があることもあります。
このトピックでは、Kore.aiボットとタスクのエラーメッセージをカスタマイズして作成する方法について説明します。
ボットまたはタスクを作成する際、ボットまたはタスク設定のエラーメッセージセクションで、HTTPステータスコードのエラーメッセージを追加またはカスタマイズすることができます。
カスタムステータスコード
ボットまたはタスクには、デフォルトで約25種類のHTTPステータスコードが定義されています。HTTPステータスコードをカスタマイズするには、
- ボットビルダーでボットまたはタスクを開きます。
- トップメニューから 構築タブを選択します
- 左側メニューから 設定->一般設定をクリックします。
- 下にスクロールしてエラーメッセージセクションを探します。
- カスタマイズするコードの編集アイコンをクリックして、エラーメッセージの設定ダイアログを開きます。
- メッセージタイプフィールドで、以下のいずれかを選択します。
- カスタム – エンドユーザー向けのエラー固有のメッセージを定義するためのカスタムメッセージフィールドを表示します。
- ソース – 2XX範囲のHTTPステータスコード(成功メッセージ)以外のHTTPステータスコードに対するJSON応答のペイロードからのJSONパスを定義することができる、エラーパスフィールドを表示します。
- アクションフィールドでは、エラーの繰り返しフィールドで定義済みの連続エラー回数に達したときに取るべきアクションを指定します。以下のうちいずれかを選択します。
- 無効 – タスクは、エラー発生時に 非アクティブに設定されています。エンドユーザーは、必要に応じてタスクをアクティブにすることができます。
- 再スケジュール – エラーが発生したときにタスクを再試行するまでの経過時間を分単位で定義するための再試行の間隔フィールドを表示します。
- 認証の無効化 – エラーが発生すると、タスクに定義された認証メカニズムが無効化されます。同じ認証メカニズムを使用している他のタスクも無効化されます。
- 通知 – エラーメッセージをエンドユーザーインターフェイスに表示します。
- メッセージフィールド(デフォルトのメッセージに対してのみ利用可能)に、エンドユーザー用に表示するテキストメッセージを入力します。
- エラーの繰り返し フィールドにおいえ、アクションが実行されるまでに返さなければならないエラーコードの連続回数を指定します。デフォルトでは、エラーの繰り返しフィールドは「1」に設定されています。
- 追加をクリックし、カスタムエラーメッセージを保存してエラーメッセージを設定ダイアログを閉じます。
新しいHTTPステータスコードを作成するには、エラーメッセージを追加をクリックして、前のセクションで説明したように新しいコードのフィールドを定義してから追加をクリックします。