フルフィルメント

エージェントの会話のターンでは、エージェントはエンドユーザーに対し、質問への回答、情報に対するクエリ、セッションの終了のいずれかで応答する必要があります。また、動的レスポンスの生成や、ターンのアクションを実行するには、エージェントによるサービスへの問い合わせが必要な場合があります。フルフィルメントは、このすべてを行うために使用されます。

フルフィルメントには次のいずれかを含めることができます。

  • 静的レスポンス メッセージ。
  • 動的レスポンスやアクションの実行のための Webhook 呼び出し。
  • パラメータ値を設定またはオーバーライドするパラメータのプリセット。

エージェントのターンの間に、複数のフルフィルメントを呼び出して、それぞれがレスポンス メッセージを生成することが可能です(生成が必要な場合もあります)。Dialogflow CX は、こうしたレスポンスをレスポンス キューに保持します。エージェントのターンが終了すると、Dialogflow CX は順序付けされたレスポンスをエンドユーザーに送信します。

フルフィルメントのユースケース

フルフィルメントを使用すると、次の場所でレスポンス メッセージを提供できます。

これらのユースケースごとに、コンソールでフルフィルメント編集ペインが開きます。

フルフィルメントのスクリーンショット

エージェントの回答(ダイアログ オプション)

フルフィルメントの作成時に、設計時にエージェントのレスポンス メッセージを定義します。実行時に、これらのレスポンスはレスポンス キューに追加されます。

レスポンス メッセージにはいくつかの種類があります。これについては、次のサブセクションで説明します。コンソールを使用する場合、フルフィルメント パネルには最初のエージェント ダイアログ カードがありますが、[ダイアログ レスポンスを追加] をクリックして、他のレスポンス メッセージ タイプ用のカードを追加できます。

静的なテキスト レスポンス

静的テキスト レスポンス メッセージは、ユーザーにテキスト ダイアログを提供します。インテント検出 API 呼び出しまたは統合呼び出しで音声合成を使用している場合、このテキストによって音声コンテンツが生成されます。これらのメッセージでは、提供されたテキストは音声合成マークアップ言語(SSML)を使用します。

複数のテキスト レスポンス カードを定義し、各カード内に複数のテキスト レスポンスを定義できます。複数のカードを定義すると、実行時に 1 つのレスポンスに連結されます。カード内で複数のレスポンスを定義すると、実行時にカード内のメッセージの 1 つがランダムに選択されます。

これらのテキスト メッセージには、パラメータ参照とインライン システム関数を含めることができます。

カスタム ペイロード

一部の統合では、リッチ レスポンスを処理するためのカスタム ペイロード レスポンスがサポートされています。これらのカスタム ペイロードは、統合ドキュメントで定義されている JSON 形式で指定する必要があります。例については、Dialogflow CX Messenger のカスタム ペイロード形式をご覧ください。

カスタム ペイロード JSON にはパラメータ参照を含めることができます。JSON 文字列値として扱うには、二重引用符で囲みます。次に例を示します。

{
  "someField": "$session.params.date"
}

カスタム ペイロード JSON の深さは 24 レベルに制限する必要があります。

開発した統合にカスタム ペイロードを送信することもできます。これは Dialogflow CX で処理されないので、独自のビジネス ロジックで処理する必要があります。

詳細については、カスタム ペイロード テンプレートをご覧ください。

人間のエージェントへの引き継ぎ

このレスポンスは、会話を人間のエージェントに引き渡す必要があることをインテント検出 API 呼び出し元に通知します。Dialogflow CX は、このシグナルのみを使用して、測定の目的で引き渡された会話を識別します。このセッション状態が変更されることはありません。

このシグナルを使用すると、システムまたは統合が、会話を引き渡すために必要なアクションを実行できます。Dialogflow CX ではこのデータに対して構造が適用されないため、システムに適した構造を選択できます。

会話の成功メタデータ

このレスポンスは、Dialogflow CX エージェントとの会話が成功したことをインテント検出 API 呼び出し元に通知します。Dialogflow CX はこのシグナルを使用して、測定の目的で成功した会話を識別します。このセッション状態がなんらかの形で変更されることはありません。

システムまたは統合でこのシグナルを使用して、必要なアクションを実行できます。Dialogflow CX ではこのデータに対して構造が適用されないため、システムに適した構造を選択できます。

事前に録音した音声を再生する

このレスポンスは、この機能をサポートする統合の音声ファイルを再生します。

音声ファイルのファイル形式の要件は、統合によって異なる場合があります。たとえば、Dialogflow CX Phone Gateway の要件をご覧ください。

パートナー テレフォニー統合の場合、音声ファイルの URL にパートナーがアクセスできる必要があります。Cloud Storage の一般公開ファイルなど、一般公開されている URL には、パートナーが常にアクセスできます。パートナーは、音声ファイルへのアクセスを制限することもできます。詳しくは、パートナーのドキュメントをご覧ください。

出力音声テキスト

このレスポンスはテキスト レスポンスに似ていますが、音声合成にのみ適用されます。エージェントがテキスト セッションと音声セッションの両方を処理できる場合は、一意のテキスト レスポンスと出力音声テキスト レスポンスを使用して、テキストと音声で異なるユーザー エクスペリエンスを作成できます。音声セッションに出力音声テキストが指定されている場合、書式なしテキストのレスポンスは無視されます。

エージェントがテキスト セッションと音声セッションの両方を処理し、同じレスポンス メッセージが必要な場合は、テキスト セッションと音声セッションの両方にテキスト レスポンスを使用します。

出力音声テキストは、テキスト レスポンスと同様に連結されます。出力音声テキスト レスポンスがテキストと SSML の混在である場合、連結された結果は SSML として扱われます。テキストまたは SSML のいずれかを一貫して使用することをおすすめします。

条件付きレスポンス

このレスポンス タイプは、条件付きレスポンスを提供します。

一般的な形式を次に示します。

if [condition]
  [response]
elif [condition]
  [response]
elif [condition]
  [response]
else
  [response]
endif

ここで

  • [condition] では、ルート条件と同じ形式を使用します。
  • [response] はテキスト レスポンスです。
  • elif ブロックと else ブロックは省略可能です。

次に例を示します。

if $session.params.user-age >= 21
  Ok, you may enter.
else
  Sorry, you cannot enter.
endif

[condition] と [response] はどちらも、インライン システム関数を使用して、会話中に動的な値を生成できます。詳細については、システム関数とルート条件をご覧ください。[condition] は、フルフィルメントの開始時のセッション状態に基づいて解決されます。[response] がセッション状態に依存している場合、フルフィルメントの終了時に更新されたセッション状態に基づいて解決されます。

多言語エージェントの場合、[condition] はすべての言語に共通ですが、[response] は言語に固有です。コンソールで 1 つの言語の [condition] を変更すると、この部分はエージェントのすべての言語で更新されます。これは新しい条件になるため、[condition] の更新時に選択した言語以外のすべての言語で [response] がクリアされます。

テレフォニー通話の転送

通話の転送は、Dialogflow CX Phone Gateway でのみ使用できます。

一部のテレフォニー統合では、通話の転送先に米国の電話番号を指定できます。実行時に、Dialogflow CX エージェントが通話の転送を使用してフルフィルメントをトリガーすると、呼び出しは指定された番号に転送され、エージェントの処理は一時停止します。

データストア ツールのレスポンス

このレスポンス タイプは、リンクされたデータストア ツールから返されるエージェント レスポンスを構成します。このフルフィルメントでデータストア ツールを構成した場合、データストア ツールのレスポンス カードが自動的に入力されます。

  • ソースリンク: 回答後にユーザーに返す引用の最大数を設定します。引用は、データストア内の情報源へのリンクであり、ボタンとしてレンダリングされます。デフォルトは 1 です。
  • インライン引用: 回答の後にリンクを一覧表示するのではなく、文ごとに返されるインライン引用の数を制限します。
  • 生成的フォールバック: データストアが空の結果を返した場合に、AI 生成のレスポンスを試行するようにエージェントを構成します。これが失敗した場合、エージェントは静的レスポンスを使用します。
  • 静的レスポンス: 最後のフィールドに静的テキスト レスポンスを入力して、ユーザーに逐語的に送信します。

チャネル固有のレスポンス メッセージ

フルフィルメントを定義する際に、チャネル固有のレスポンス メッセージを作成して、テキスト チャット、音声、SMS、チャネルをサポートする特定の統合を対象としたターゲット レスポンスなどを作成できます。チャネルに固有ではないレスポンス メッセージは、デフォルトのレスポンス メッセージと呼ばれます。

実行時に、インテント検出リクエストでチャネルが指定されている場合は、Dialogflow CX はデフォルトのレスポンス メッセージまたはチャネル固有のレスポンス メッセージを選択します。チャネル固有のレスポンス メッセージを使用している場合でも、デフォルトのレスポンス メッセージを定義することをおすすめします。デフォルトのレスポンス メッセージは、システムが有効なチャネルを提供できない場合の代替として機能します。

チャネル名は、任意のテキストに設定できるカスタム フィールドです。ランタイム呼び出しに Dialogflow CX API を直接使用している場合は、任意のチャネル名を使用できます。既存の統合を使用している場合は、統合で認識されるチャネル名を使用する必要があります。

設計時にチャネル固有のレスポンス メッセージを設定する

コンソールを使用してフルフィルメントにチャネル固有のレスポンス メッセージを提供するには:

  • デフォルトのレスポンス メッセージを追加したら、[チャネルを追加] をクリックして、チャネル固有のレスポンス メッセージを追加します。[チャンネルを追加] をもう一度クリックして、チャンネルを追加します。

API を使用してフルフィルメントにチャネル固有のレスポンス メッセージを提供するには:

  • 各レスポンス メッセージの Fulfillment.messages[i].channel フィールドを、選択したチャネルに設定します。このフィールドが設定されていない場合、レスポンスはデフォルトのレスポンス メッセージとして扱われます。

実行時にチャネル固有のレスポンス メッセージを使用する

チャネルをサポートする既存の統合を使用している場合、統合の実装でこれらの手順が実行されます。

チャネル固有のレスポンス メッセージを受信するには、インテント検出リクエスト メッセージでチャネルを指定する必要があります。Sessions タイプの detectIntent メソッドの queryParams.channel フィールドをご覧ください。

セッション リファレンスのプロトコルとバージョンを選択:

プロトコル V3 V3beta1
REST セッション リソース セッション リソース
RPC セッション インターフェース セッション インターフェース
C++ SessionsClient 利用できません
C# SessionsClient 利用できません
Go SessionsClient 利用できません
Java SessionsClient SessionsClient
Node.js SessionsClient SessionsClient
PHP 利用不可 利用できません
Python SessionsClient SessionsClient
Ruby 利用不可 利用できません

リクエストでチャネルが定義されていない場合、またはフルフィルメントで一致するチャネルが見つからない場合、Dialogflow CX はデフォルトのレスポンス メッセージを返します。

カスタムのペイロード テンプレート

カスタム ペイロードを頻繁に使用する場合は、カスタム ペイロード テンプレートを使用します。カスタム ペイロードは大きくて複雑な場合があるため、テンプレートを使用するとエージェントの作成プロセスが簡素化されます。

これらのテンプレートをエージェント設定で指定すると、エージェントのフルフィルメントを作成するときに選択できるようになります。

たとえば、「はい」ボタンと「いいえ」ボタンの JSON ペイロードをカスタム ペイロード テンプレートとして定義できます。これらのボタンを必要とするフルフィルメントを作成する場合は、フルフィルメントの作成時にテンプレートを選択します。

フルフィルメントのカスタム ペイロードのテンプレートを選択すると、テンプレートの内容がペイロードに挿入されます。必要に応じてペイロードを編集できます。

テンプレートを変更しても、変更内容は、参照されているすべてのフルフィルメント ペイロードに自動的に反映されません。

カスタム ペイロード テンプレートを作成するには、エージェントの一般設定をご覧ください。

フルフィルメントの作成時にカスタム ペイロード テンプレートを選択するには、フルフィルメントのカスタム ペイロードの作成時に [Select template] をクリックします。

Webhook の呼び出し

フルフィルメントが Webhook をトリガーすると、エージェントはサービスにリクエストを送信します。Webhook は、アクションの実行、動的レスポンス メッセージの提供、パラメータ値のオーバーライド、現在のページの変更を行うことができます。

フルフィルメントの Webhook 設定は次のとおりです。

X 項目
Webhook を有効にする これにより、フルフィルメントの Webhook が有効になります。
Webhook Webhook リソースを選択します。
タグ ここで指定したテキストタグは、Webhook サービスに送信される Webhook リクエストの WebhookRequest.fulfillmentInfo.tag フィールドに入力されます。これを使用すると、フルフィルメント固有の方法で Webhook の動作を制御できます。
部分的なレスポンスを返す 部分的なレスポンスの再生をキャンセルできるようにします。詳しくは、音声の詳細設定をご覧ください。

パラメータのプリセット

フルフィルメントを使用して、現在のパラメータ値を設定またはオーバーライドするプリセットを指定します。これらのプリセットは、静的レスポンス メッセージを解決する前、または Webhook を呼び出す前に適用されます。

システム関数を使用して、動的に生成された値にパラメータをプリセットすることもできます。

以下にいくつか例を示します。

  • パラメータ now を現在の時刻に設定します。

    パラメータ 値
    今 $sys.func.NOW()
  • 既存のパラメータ counter を 1 増やします。

    パラメータ 値
    カウンタ $sys.func.ADD($session.params.counter, 1)
  • 複合オブジェクトの値をすべて維持しながら、パラメータ new-cost を other-cost パラメータ値に設定します。

    パラメータ 値
    new-cost $sys.func.IDENTITY($session.params.other-cost)

データストア ツール

この機能の詳細については、データストア ツールのドキュメントをご覧ください。

音声の詳細設定

これらの音声の詳細設定は、ページの音声設定、フローの音声設定、エージェントの音声設定をオーバーライドできます。

レスポンス キュー

エージェントのターンの間に、複数のフルフィルメントを呼び出して、それぞれがレスポンス メッセージを生成することが可能です。Dialogflow CX は、こうしたレスポンスをレスポンス キューに保持します。

ストリーミング API に対する部分レスポンス

デフォルトでは、Dialogflow CX はエージェントのターンが終了した後にのみ、順序付けされたレスポンスをエンドユーザーに送信します。Streaming API を使用する場合に、キューに入っているレスポンスを部分レスポンスとして返すには、フルフィルメントで部分レスポンスを返すオプションを有効にします。詳細については、ページのライフサイクルをご覧ください。

たとえば、Webhook が長時間実行される可能性がある場合に、フルフィルメントに静的レスポンスを追加して部分的なレスポンスを有効にできます。これにより、Dialogflow CX はレスポンス キューをフラッシュし、Webhook を呼び出す前にすべてのメッセージを部分的なレスポンスとして送信します。

以下の場合、部分的なレスポンスはサポートされていません。

シミュレータでこの機能をテストするには、部分的なレスポンスを有効にします。

シミュレータの部分レスポンスのスクリーンショット

次の例では、Webhook が完了するまでに 5 秒かかり、部分的な回答は有効にしないものとします。Dialogflow CX エージェントの会話のターンは、Webhook が完了するまで終了しません。この 5 秒間のターンでは、Webhook を待機している間にレスポンスがキューに格納され、ターンが完了するまでエンドユーザーに返されません。これは、ユーザー エクスペリエンスの低下につながります。

部分的なレスポンスを使用しない場合。

最初のフルフィルメントで部分レスポンスを有効にすると、Dialogflow CX は直ちに最初のフルフィルメント メッセージを返して Webhook を呼び出します。Webhook が完了すると、Dialogflow CX から最終レスポンスが返されます。このシナリオでは、エンドユーザーがしばらく待つように指示されるため、エンドユーザー エクスペリエンスが向上します。また、Webhook 呼び出しは、エンドユーザーに送信されるレスポンスと同時に実行されます。

部分的なレスポンスを使用します。

音声合成マークアップ言語(SSML)

テキストまたは出力音声テキストのフルフィルメント フィールドで音声合成マークアップ言語(SSML)を使用できます。これにより、一時停止の詳細や頭字語、日付、時刻、略語、検査すべきテキストのオーディオ形式を指定することで、音声応答をカスタマイズできます。

構文の詳細については、Text-to-Speech SSML のドキュメントをご覧ください。