自然言語を理解して自然言語で応答する Dialogflow CX Google Chat アプリを構築する

このページでは、Dialogflow を使用して、自然言語を理解して自然言語で応答できる Google Chat アプリを作成する方法について説明します。このガイドでは、Google Chat と直接統合されている Dialogflow CX を使用します。Dialogflow ES を使用して Dialogflow ES Google Chat アプリを作成することもできます。手順については、Dialogflow ES Google Chat ガイドをご覧ください。

たとえば、レンタカーを利用したいユーザー向けの Chat アプリを考えてみましょう。ユーザーは「車を借りたい」と入力するでしょう。Chat アプリは「どこで借りますか？」という質問を返すでしょう。こうして、ユーザーとの間で人間同士のような会話が始まります。レンタカーの予約手続きの際に、Chat アプリは人間の話し方を理解し、人間のような話し方で応答します。

これはほんの一例です。Dialogflow Chat アプリは、あらゆる種類のやり取りに役立ちます。人間の自然な会話が必要な場合は、Dialogflow Chat アプリが必要です。事前構築済みエージェントを使用すると、すぐに使い始めることができ、次のような Dialogflow の機能を利用できます。

• フライトを予約する
• 医師の診察の予約をする
• 料理の宅配を注文する
• 小売商品カタログに関する質問（商品に他の色があるかどうかなど）に回答する

目標

• 環境をセットアップする。
• Dialogflow CX エージェントを作成してデプロイする。
• Dialogflow CX エージェントを搭載した Chat アプリを作成してデプロイします。
• Chat アプリをテストします。

前提条件

• Google Chat へのアクセス権を持つビジネスまたはエンタープライズ向け Google Workspace アカウント。
• 課金を有効にした Google Cloud プロジェクト。既存のプロジェクトで課金が有効になっていることを確認するには、プロジェクトの課金ステータスを確認するをご覧ください。プロジェクトを作成して課金管理を設定するには、Google Cloud プロジェクトを作成するをご覧ください。

アーキテクチャ

次の図は、Dialogflow で構築された Chat アプリのアーキテクチャを示しています。

上の図では、Dialogflow Chat アプリを操作しているユーザーの情報フローは次のとおりです。

1. ユーザーが、ダイレクト メッセージまたは Chat スペースで Chat アプリにメッセージを送信します。
2. Google Cloud に存在する Dialogflow 仮想エージェントがメッセージを受信して処理し、レスポンスを生成します。
3. 必要に応じて、Dialogflow Webhook を使用して、Dialogflow エージェントがプロジェクト管理システムやチケット ツールなどの外部サードパーティ サービスとやり取りできるようにします。
4. Dialogflow エージェントは、Chat の Chat アプリ サービスにレスポンスを返します。
5. レスポンスが Chat スペースに配信されます。

環境を設定する

1. Google Cloud コンソールで、Google Chat API と Dialogflow API を有効にします。

   API を有効にする

2. 正しい Cloud プロジェクトで API を有効にしていることを確認し、[次へ] をクリックします。

3. 正しい API を有効にしていることを確認し、[有効にする] をクリックします。

Dialogflow CX エージェントを作成する

Dialogflow CX エージェントは、エンドユーザーとの同時会話を処理する仮想エージェントです。人間の言語のニュアンスを理解する自然言語理解モジュールです。Dialogflow は、会話中のエンドユーザーのテキストをアプリやサービスが理解できる構造化データに変換します。システムに必要な種類の会話が処理されるように Dialogflow エージェントを設計、構築します。

Dialogflow エージェントは、コールセンターの担当者と似ています。予想される会話のシナリオに対処できるようにトレーニングを行いますが、完璧にする必要はありません。

Dialogflow CX エージェントを作成する手順は次のとおりです。

1. Dialogflow CX コンソールで、Dialogflow CX コンソールを開きます。メニュー menu > [Dialogflow CX] をクリックします。

   Dialogflow CX コンソールに移動

2. Google Cloud プロジェクトを選択します。プロジェクトを見つけるには、[すべて] をクリックして検索する必要があります。

3. 事前構築済みのエージェントを選択することも、独自のエージェントを作成することもできます。エージェントのカスタマイズを後で詳しく確認する場合は、事前構築済みエージェントのいずれかを選択します。エージェントの機能を確認する場合にも役立ちます。

   事前構築済みエージェントを選択する手順は次のとおりです。

   1. [Use prebuilt agents] をクリックします。

   2. 事前構築済みのエージェントを選択します。このガイドでは、[旅行: レンタカー] を選択します。

      エージェントは、エージェントが使用する機能の数と会話ロジックの複雑さに基づいて、初級、中級、上級にランク付けされます。中級または上級のエージェントを選択すると、Google Cloud コンソールで機能や API を有効にすることなど、エージェント固有のカスタマイズと設定が必要になる場合があります。

   3. [エージェントとしてインポート] をクリックします。

   独自のエージェントを作成する手順は次のとおりです。

   1. [Create Agent（エージェントを作成）] をクリックします。
   2. [自動生成] を選択してデータストア エージェントを作成するか、[独自に構築] を選択して他の種類のエージェントを作成します。

   エージェントの作成プロセスの詳細なチュートリアルについては、Dialogflow CX エージェントを作成するをご覧ください。

4. エージェントの基本設定を構成します。

   1. [表示名] に表示名を入力します。
   2. お好みのロケーションをお選びください詳細な位置情報の設定を変更する場合は、[編集] をクリックします。
   3. 使用するタイムゾーンを選択します。
   4. エージェントのデフォルト言語を選択します。 エージェントのデフォルトの言語は、作成後に変更できません。

5. [作成] をクリックします。Dialogflow CX がエージェントの作成を開始し、エージェントのデフォルトの開始フローを表示します。

6. 必要に応じて、エージェントをカスタマイズします。エージェントのカスタマイズ プロセスの詳細なチュートリアルについては、Dialogflow CX エージェントを作成するをご覧ください。

7. ベスト プラクティスとして、エージェントをテストします。

   1. [Test agent] をクリックします。
   2. [環境内でエージェントをテストする] を選択します。
   3. [環境] で [ドラフト] を選択します。
   4. Flow で [Default Start Flow] を選択します。
   5. [ページ] で [開始ページ] を選択します。
   6. [エージェントに問い合わせる] 作成バーに「Hello」と入力して、Enter キーを押します。エージェントは自己紹介して応答します。
   7. テスト用会話のサンプルを実施して、テストを完了します。

8. Dialogflow CX エージェントが作成されます。Dialogflow CX コンソールに戻ります。メニュー menu > [Dialogflow CX] をクリックします。

   Dialogflow CX コンソールに移動

9. [エージェント] で、more_vert > [名前をコピー] をクリックします。この名前を保存します。Chat アプリの構成時に使用します。

Chat アプリを作成して Dialogflow エージェントに接続する

Dialogflow CX エージェントを作成したら、次の手順で Chat アプリに変換します。

1. Google Cloud コンソールで、Google Chat API に移動します。「Google Chat API」を検索し、[Google Chat API]、[管理] の順にクリックします。

   Chat API に移動

2. [構成] をクリックして、Chat アプリを設定します。

   1. [アプリ名] に「Dialogflow App」と入力します。
   2. [アバターの URL] に「https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png」と入力します。
   3. [説明] に「Responds to real human conversation」と入力します。
   4. [機能] で、[1:1 のメッセージを受信する] と [スペースとグループの会話に参加する] を選択します。
   5. [接続設定] で [Dialogflow] を選択します。
   6. [Dialogflow の設定] で [Dialogflow CX] を選択します。
   7. [エージェントまたは環境リソース名] に、Dialogflow CX エージェントを作成するの末尾にコピーした Dialogflow CX エージェント名を貼り付けます。
   8. ドメイン内の特定のユーザーおよびグループにこの Chat 用アプリの利用を許可するを選択し、メールアドレスを入力します。
   9. [ログ] で [エラーを Logging にロギング] を選択します。

3. [保存] をクリックします。

Chat アプリは、Chat でメッセージを受信して返信できるようになりました。

Chat アプリをテストする

Google Chat でメッセージを送信して、Dialogflow CX Chat アプリをテストします。

1. 信頼できるテスターとして自分自身を追加したときに指定した Google Workspace アカウントを使用して Google Chat を開きます。

   Google Chat に移動

2. [add 新しいチャット] をクリックします。
3. [1 人以上を追加] フィールドに、Chat アプリの名前を入力します。

4. 検索結果から Chat アプリを選択します。ダイレクト メッセージが開きます。

5. そのアプリの新しいダイレクト メッセージに、「Hello」と入力して enter を押します。

   Dialogflow Chat アプリは、自己紹介して応答します。

6. サンプル テスト会話を行って、テストを完了します。

テスト会話の例

Dialogflow CX コンソールまたは Google Chat で Dialogflow CX Chat アプリをテストするには、次の会話を行います。この説明は、Dialogflow CX エージェントがユーザーの自然言語を解釈し、会話の各ステップで独自の自然言語レスポンスを生成する仕組みを理解するのに役立ちます。この会話のサンプルは、旅行: レンタカーというビルド済みエージェントに基づいています。

Dialogflow からカード メッセージを送信する

Dialogflow は、テキスト メッセージまたはカード メッセージで応答できます。カード メッセージで応答するには、フルフィルメントでカスタム ペイロードとして指定します。

次の JSON は、フルフィルメントでカスタム ペイロードとしてカード メッセージを送信する方法を示しています。

{
  'cardsV2': [{
    'cardId': 'createCardMessage',
    'card': {
      'header': {
        'title': 'A card message!',
        'subtitle': 'Sent from Dialogflow',
        'imageUrl': 'https://developers.google.com/chat/images/chat-product-icon.png',
        'imageType': 'CIRCLE'
      },
      'sections': [
        {
          'widgets': [
            {
              'buttonList': {
                'buttons': [
                  {
                    'text': 'Read the docs!',
                    'onClick': {
                      'openLink': {
                        'url': 'https://developers.google.com/workspace/chat'
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  }]
}

制限と考慮事項

• Chat インタラクション イベントはサポートが限定されており、考慮事項がいくつかあります。
  • 次のインタラクション イベント タイプがサポートされています。
    • MESSAGE
    • ADDED_TO_SPACE
    • CARD_CLICKED
  • MESSAGE イベントまたは ADDED_TO_SPACE イベントの場合、Dialogflow エージェントに送信されるクエリ入力は、Chat メッセージの argumentText フィールドの値に対応しています。メッセージにスラッシュ コマンドが含まれている場合は、代わりに text フィールドの値が使用されます。
  • CARD_CLICKED イベントの場合、Dialogflow エージェントに送信されるクエリ入力は CARD_CLICKED.functionName 形式になります。ここで、functionName は、インタラクティブ カード要素（ボタンなど）に関連付けられた Action オブジェクトの function フィールドの値に対応します。
  • 各 Chat インタラクション イベントの完全な JSON ペイロードは、クエリ パラメータのカスタム ペイロードとして Dialogflow に送信されます。このペイロードには、WebhookRequest.payload フィールドの値をクエリすることで Dialogflow Webhook からアクセスできます。
• スラッシュ コマンドへの応答とカードまたはダイアログからのデータの受信に関する考慮事項:
  • Dialogflow Chat アプリがスラッシュ コマンドを含むメッセージを受信すると、クエリ入力には text フィールドの値のみが含まれます。text フィールドはスラッシュ コマンドの名前（/command など）で始まります。このフィールドを使用して、スラッシュ コマンドを検出するように Dialogflow エージェントのインテントを構成できます。
  • Dialogflow エージェントが Chat インタラクション イベントの JSON ペイロードを処理する必要がある場合は、Dialogflow Webhook を使用してクエリ パラメータのカスタム ペイロードを検査します。
  • Dialogflow エージェントからダイアログを表示するには、DIALOG アクション レスポンスを含むメッセージを含む単一のカスタム JSON ペイロードで応答します。
  • カードから入力されたデータを処理するために、Dialogflow エージェントはテキスト CARD_CLICKED で始まるインテントを検出し、適切なアクションを含む単一のカスタム JSON ペイロードで応答できます。
• リンク プレビューはサポートされていません。
• Dialogflow エージェントが 1 つのメッセージでのみ応答する場合、そのメッセージは Google Chat に同期的に送信されます。Dialogflow エージェントが複数のメッセージで応答する場合、Chat API の spaces.messages リソースで create メソッドをメッセージごとに 1 回呼び出すことで、すべてのメッセージが非同期で Chat に送信されます。
• Dialogflow CX と Chat の統合を使用する場合は、Dialogflow エージェントと Chat アプリを同じ Google Cloud プロジェクトに設定する必要があります。異なる Cloud プロジェクトで Dialogflow と Chat を設定する必要がある場合は、中間サーバーを設定して接続を容易にできます。方法については、GitHub のDialogflow CX のチャット統合の例をご覧ください。

トラブルシューティング

Google Chat アプリまたはカードからエラーが返されると、Chat インターフェースに「エラーが発生しました」というメッセージが表示されます。または「リクエストを処理できません」というメッセージが表示されます。Chat UI にエラー メッセージが表示されない場合でも、Chat アプリまたはカードで予期しない結果が生成されることがあります（カード メッセージが表示されないなど）。

チャット UI にエラー メッセージが表示されない場合でも、チャットアプリのエラー ロギングがオンになっている場合は、エラーの修正に役立つ説明的なエラー メッセージとログデータが利用できます。エラーの表示、デバッグ、修正については、Google Chat エラーのトラブルシューティングと修正をご覧ください。

クリーンアップ

このチュートリアルで使用したリソースに対して Google Cloud アカウントで課金されないようにするには、Cloud プロジェクトを削除することをおすすめします。

1. Google Cloud コンソールで、[リソースの管理] ページに移動します。メニュー menu > [IAM と管理] > [リソースを管理] をクリックします。

   Resource Manager に移動

2. プロジェクト リストで、削除するプロジェクトを選択し、[削除] delete をクリックします。
3. ダイアログでプロジェクト ID を入力し、[シャットダウン] をクリックしてプロジェクトを削除します。

関連トピック

• Dialogflow CX は、Dialogflow エージェントの設計にステートマシン アプローチを採用しています。これにより、会話を明確かつ明示的に制御し、エンドユーザー エクスペリエンスと開発ワークフローを改善できます。Dialogflow Chat アプリを構築する場合は、Dialogflow CX を使用することをおすすめします。
  • エージェントの構築と構成の詳細については、Dialogflow CX エージェントをご覧ください。
  • エージェントの構築と構成方法の詳細なチュートリアルについては、Dialogflow CX エージェントを作成するをご覧ください。
  • code Codelab: Dialogflow CX データストア エージェントを構築する方法の例については、Codelab Gemini を使用して Google Chat 用アプリを作成するのナレッジ チャット アプリをご覧ください。
  • code Codelab: Dialogflow CX 会話エージェントの構築方法の例については、Codelab Gemini を使用して Google Chat 用アプリを作成するのフィードバック チャットアプリをご覧ください。
• Dialogflow ES は、Chat アプリで Dialogflow を使用するもう 1 つの方法です。