メッセージを処理する前に呼び出しを行う

事前メッセージのウェブフックは、顧客が入力を行うたびに外部サービスまたはアプリケーションに呼び出しを行います。 外部サービスは、あなたのアシスタントがメッセージを処理する前に、メッセージを処理することができます。

各メッセージがアシスタントによって処理される前にウェブフックを起動したい場合は、アシスタントに事前メッセージウェブフックを追加します。

重要: カスタム・チャネルを使用している場合、プレメッセージWebhookは /message APIバージョン2(ステートレスおよびステートフル)のみで動作します。 詳細については、 API リファレンス. すべての組み込みチャネル統合で、この API が使用されます。

プレメッセージWebhookは以下のような用途に使用できます:

  • 顧客の入力をアシスタントが使う言語に翻訳する。

  • 顧客が送信する可能性のある個人情報 (E メール・アドレスや社会保障番号など) を確認し、削除します。

このウェブフックは、ポストメッセージウェブフックと連携して使用できます。 例えば、ポストメッセージウェブフックは、応答を顧客の言語に翻訳し直したり、プライバシー上の理由で削除された情報を再度追加するといったことができます。 詳しくは、メッセージの処理後に呼び出しを行う を参照してください。

注: プライベート・エンドポイントが使用されている環境では、ウェブフックはインターネット上にトラフィックを送信することに留意してください。

会話中に必要な時に一度だけアクションを実行する必要がある場合は、ダイアログWebhookを使用します。 例えば、アシスタントが口座番号、ユーザーID、口座の秘密など、必要な情報をすべて収集した時点で条件は満たされる。 詳細については、 ダイアログからプログラムコールを行うを参照してください。

Web フックの定義

すべての着信メッセージの前処理に使用する Webhook URL を 1 つ定義できます。

開始前に

外部サービスへのプログラム呼び出しは、以下の要件を満たしていなければならない:

  • アシスタントがデプロイされ、お客様と対話している実稼働環境では、Web フックをセットアップしてテストしないでください。
  • 呼び出しは POST HTTP 要求であること。
  • 要求本体は JSON オブジェクト (Content-Type: application/json) でなければなりません。
  • 呼び出しは 30 秒以内に戻らなければなりません。
注: 外部サービスがGETリクエストのみをサポートしている場合、あるいは実行時に URL パラメータを動的に指定する必要がある場合は、実行時の値を含むJSONペイロードでPOSTリクエストを受け付ける中間サービスを作成することを検討する。 その後、中間サービスは、これらの値を URL パラメーターとして渡してターゲット・サービスに要求を行い、応答をダイアログに返すことができます。

展開方法を選択する

ポストメッセージ Webhook を設定するための正しい手順を表示するには、使用するデプロイメント方法を選択します。

使用している配置タイプを確認するには、[ 管理] メニュー 管理メニュー をクリックします。 Switch to classic experienceと表示されている場合は、 新しいエクスペリエンスを使っていることになります。 Switch to new experienceと表示されている場合は、 クラシック・エクスペリエンスを使用しています。

注: 展開タイプは watsonx Orchestrate には適用されません。

次のリンクを使用して、配置タイプに基づく手順について確認してください: