このチュートリアルでは、Gemini を搭載した Vertex AI を使用して、Chat スペースでの会話に基づいて質問に回答する Google Chat 用アプリを作成する方法について説明します。Chat 用アプリは、Google Workspace Events API と Pub/Sub を使用して、Chat スペースに投稿された質問をリアルタイムで認識して回答します。アプリがメンションされていない場合でも同様です。
Chat 用アプリは、スペースで送信されたすべてのメッセージをデータソースとナレッジベースとして使用します。質問が投稿されると、Chat 用アプリは以前に共有された回答を確認し、そのうちの 1 つを共有します。回答が見つからない場合は、回答できないことを伝えます。各回答で、ユーザーは補助アクション ボタンをクリックしてスペース管理者を名前リンクし、回答を求めることができます。Gemini AI を使用することで、Google Chat アプリは、追加されたスペースでの会話を継続的に学習し、知識ベースを適応させ、拡大させます。
従業員のオンボーディングとサポートのスペースで Chat 用アプリがどのように機能するかは次のとおりです。
-
図 1: Charlie が AI ナレッジ アシスタントの Chat 用アプリを Chat スペースに追加します。 -
図 2. Dana は、会社で講演のトレーニングを提供しているかどうかを尋ねます。 -
図 3. AI ナレッジ アシスタント Chat 用アプリは、Chat スペースの会話履歴に基づいて Dana の質問に回答するよう Gemini を使用して Vertex AI にプロンプトを送信し、回答を共有します。
前提条件
Google Chat へのアクセス権を持つ Business または Enterprise の Google Workspace アカウント。
次の操作を行うための Google Cloud サービスへのアクセス権:
- Google Cloud プロジェクトを作成します。
- Google Cloud 請求先アカウントを Cloud プロジェクトにリンクします。アクセス権があるかどうかを確認するには、課金を有効にするために必要な権限をご覧ください。
- 認証されていない Google Cloud 関数の呼び出しを使用します。これは、Google Cloud 組織がドメイン制限付き共有を使用しているかどうかを確認することで検証できます。
必要に応じて、Google Cloud 管理者にアクセス権または権限をリクエストします。
Google Cloud CLI を使用する場合は、gcloud CLI で動作するように構成された Node.js 開発環境。Node.js 開発環境の設定をご覧ください。
目標
- 生成 AI を使用して、Chat スペースの会話で共有された知識に基づいて質問に回答する Chat 用アプリを構築します。
- 生成 AI を使用した場合:
- 従業員からの質問を検出し、回答します。
- Chat スペースで進行中の会話から継続的に学習します。
- Chat アプリに直接メッセージが送信されていない場合でも、Chat スペース内のメッセージをリアルタイムでリッスンして応答します。
- Firestore データベースへの書き込みと読み取りによってメッセージを永続化します。
- 質問に対する回答が見つからない場合にスペース管理者をメンションすることで、Chat スペースでの共同作業を促進します。
アーキテクチャ
次の図は、AI ナレッジ アシスタントの Chat 用アプリで使用される Google Workspace と Google Cloud リソースのアーキテクチャを示しています。
AI ナレッジ アシスタント Chat 用アプリの仕組みは次のとおりです。
ユーザーが AI ナレッジ アシスタント Chat 用アプリを Chat スペースに追加します。
Chat 用アプリは、Chat スペースに追加したユーザーに認証と認可の構成を求めるメッセージを表示します。
Chat 用アプリは、Chat API の
spaces.messages.listメソッドを呼び出してスペースのメッセージを取得し、取得したメッセージを Firestore データベースに保存します。Chat 用アプリは、Google Workspace Events API の
subscriptions.createメソッドを呼び出して、スペース内のメッセージなどのイベントのリスニングを開始します。サブスクリプションの通知エンドポイントは、Eventarc を使用してイベントを Chat 用アプリに転送する Pub/Sub トピックです。Chat 用アプリがスペースに紹介メッセージを投稿します。
Chat スペースのユーザーがメッセージを投稿します。
Chat 用アプリは、Pub/Sub トピックからメッセージをリアルタイムで受信します。
Chat 用アプリがメッセージを Firestore データベースに追加します。
ユーザーが後でメッセージを編集または削除すると、Chat 用アプリは更新または削除されたイベントをリアルタイムで受信し、Firestore データベース内のメッセージを更新または削除します。
Chat 用アプリは、Gemini を使用して Vertex AI にメッセージを送信します。
このプロンプトは、メッセージに質問が含まれているかどうかを確認するよう Vertex AI with Gemini に指示します。Gemini は、Firestore に保存されている Chat スペースのメッセージ履歴に基づいて質問に回答し、Google Chat アプリが Chat スペースにメッセージを送信します。一致しない場合は、返信しないでください。
Vertex AI with Gemini が質問に回答すると、Chat 用アプリは、アプリ認証を使用して Chat API の
spaces.messages.createメソッドを呼び出し、回答を投稿します。Vertex AI with Gemini が質問に回答できない場合、Chat アプリは、Chat スペースの履歴でその質問の回答が見つからないことを示すメッセージを投稿します。
メッセージには、ユーザーがクリックできる補助アクション ボタンが常に含まれています。このボタンをクリックすると、Chat 用アプリがスペース管理者を @メンションして回答を求めます。
Chat 用アプリは、Google Workspace Events API から、Chat スペースのサブスクリプションがまもなく期限切れになるというライフサイクル通知を受け取ります。
- Chat 用アプリは、Google Workspace Events API の
subscriptions.patchメソッドを呼び出して、サブスクリプションの更新リクエストを送信します。
- Chat 用アプリは、Google Workspace Events API の
Chat スペースから Chat 用アプリが削除された場合:
Chat 用アプリは、Google Workspace Events API の
subscriptions.deleteメソッドを呼び出してサブスクリプションを削除します。Chat 用アプリは、Firestore から Chat スペースのデータを削除します。
AI ナレッジ アシスタント Chat 用アプリで使用されるプロダクトを確認する
AI ナレッジ アシスタント Chat 用アプリは、次の Google Workspace と Google Cloud プロダクトを使用します。
- Gemini を搭載した Vertex AI API: 生成 AI プラットフォーム。AI 知識アシスタントの Chat 用アプリは、Gemini を使用した Vertex AI API を使用して、従業員の質問を認識、理解し、回答します。
-
Chat API: メッセージなどの Chat インタラクション イベントを受信して応答する Google Chat アプリを開発するための API。AI ナレッジ アシスタント Chat 用アプリは、Chat API を使用して次のことを行います。
- Chat から送信された操作イベントを受信して応答します。
- スペースで送信されたメッセージを一覧表示します。
- スペースでユーザーの質問に回答を投稿します。
- 名前やアバター画像など、Chat での表示方法を決定する属性を構成します。
- Google Workspace Events API: この API を使用すると、Google Workspace アプリケーション全体でイベントに登録し、変更通知を管理できます。AI ナレッジ アシスタント Chat 用アプリは、Google Workspace Events API を使用して Chat スペースに投稿されたメッセージをリッスンします。これにより、言及されていない場合でも質問を検出して回答できます。
- Firestore: サーバーレスのドキュメント データベース。AI ナレッジ アシスタントの Chat 用アプリは、Firestore を使用して Chat スペースで送信されたメッセージに関するデータを保存します。
- Pub/Sub: Pub/Sub は、メッセージを生成するサービスと処理するサービスを切り離す、非同期のスケーラブルなメッセージング サービスです。AI ナレッジ アシスタント Chat 用アプリは、Pub/Sub を使用して Chat スペースからサブスクリプション イベントを受信します。
- Eventarc: Eventarc を使用すると、基盤となるインフラストラクチャを実装、カスタマイズ、またはメンテナンスすることなく、イベント ドリブン アーキテクチャを構築できます。AI ナレッジ アシスタント Chat 用アプリは、Eventarc を使用して、Pub/Sub から Chat スペースと、サブスクリプション イベントを受信して処理する Cloud Functions の関数にイベントを転送します。
-
Cloud Functions: サーバーやランタイム環境を管理せずに、Chat のインタラクション イベントとサブスクリプション イベントに応答する単一目的のスタンドアロン関数を作成できる軽量のサーバーレス コンピューティング サービス。AI ナレッジ アシスタント Chat 用アプリは、次の 2 つの Cloud Functions を使用します。
-
app: Chat がインタラクション イベントを送信する HTTP エンドポイントをホストし、これらのイベントを処理して応答するロジックを実行するコンピューティング プラットフォームとして機能します。 -
eventsApp: Pub/Sub サブスクリプションからのメッセージなどの Chat スペース イベントを受信して処理します。
- Cloud Build: 自動ビルドを実行する、フルマネージドの継続的インテグレーション、デリバリー、デプロイ プラットフォーム。
- Cloud Run: コンテナ化アプリを実行するためのフルマネージド環境。
-
環境を準備する
このセクションでは、Chat 用アプリの Google Cloud プロジェクトを作成して構成する方法について説明します。
Google Cloud プロジェクトを作成する
Google Cloud コンソール
- Google Cloud コンソールで、メニュー > [IAM と管理] > [プロジェクトを作成] に移動します。
-
[プロジェクト名] フィールドに、プロジェクトのわかりやすい名前を入力します。
省略可: プロジェクト ID を編集するには、[編集] をクリックします。プロジェクトの作成後にプロジェクト ID を変更することはできないため、プロジェクトのライフタイムを考慮してニーズに合った ID を指定してください。
- [ロケーション] フィールドで、[参照] をクリックして、プロジェクトの候補となるロケーションを表示します。[選択] をクリックします。
- [作成] をクリックします。Google Cloud コンソールが [ダッシュボード] ページに移動し、数分以内にプロジェクトが作成されます。
gcloud CLI
次のいずれかの開発環境で、Google Cloud CLI（gcloud）にアクセスします。
-
Cloud Shell: gcloud CLI がすでに設定されているオンライン ターミナルを使用するには、Cloud Shell をアクティブにします。
Cloud Shell をアクティブにする -
ローカルシェル: ローカル開発環境を使用するには、gcloud CLI をインストールして初期化します。
Cloud プロジェクトを作成するには、gcloud projects createコマンドを使用します。gcloud projects create PROJECT_ID
Cloud プロジェクトに対する課金を有効にする
Google Cloud コンソール
- Google Cloud コンソールで、[お支払い] に移動します。[メニュー] > [お支払い] > [マイ プロジェクト] をクリックします。
- [組織を選択] で、Google Cloud プロジェクトに関連付けられている組織を選択します。
- プロジェクトの行で、[アクション] メニュー（）を開き、[お支払い情報を変更] をクリックして、Cloud 請求先アカウントを選択します。
- [アカウントを設定] をクリックします。
gcloud CLI
- 使用可能な請求先アカウントを一覧表示するには、次のコマンドを実行します。
gcloud billing accounts list - 請求先アカウントを Google Cloud プロジェクトにリンクします。
gcloud billing projects link PROJECT_ID --billing-account=BILLING_ACCOUNT_ID次のように置き換えます。
PROJECT_IDは、課金を有効にする Cloud プロジェクトのプロジェクト ID です。BILLING_ACCOUNT_IDは、Google Cloud プロジェクトにリンクする請求先アカウント ID です。
API を有効にする
Google Cloud コンソール
Google Cloud コンソールで、Google Chat API、Vertex AI API、Cloud Functions API、Firestore API、Cloud Build API、Pub/Sub API、Google Workspace Events API、Eventarc API、Cloud Run Admin API を有効にします。
正しい Cloud プロジェクトで API を有効にしていることを確認し、[次へ] をクリックします。
正しい API を有効にしていることを確認し、[有効にする] をクリックします。
gcloud CLI
必要に応じて、現在の Cloud プロジェクトを作成したプロジェクトに設定します。
gcloud config set project PROJECT_IDPROJECT_ID は、作成した Cloud プロジェクトのプロジェクト ID に置き換えます。
Google Chat API、Vertex AI API、Cloud Functions API、Firestore API、Cloud Build API、Pub/Sub API、Google Workspace Events API、Eventarc API、Cloud Run Admin API を有効にします。
gcloud services enable chat.googleapis.com \ aiplatform.googleapis.com \ cloudfunctions.googleapis.com \ firestore.googleapis.com \ cloudbuild.googleapis.com \ pubsub.googleapis.com \ workspaceevents.googleapis.com \ eventarc.googleapis.com \ run.googleapis.com
認証と権限付与の設定
認証と認可により、Chat 用アプリは Google Workspace と Google Cloud のリソースにアクセスできます。
このチュートリアルでは、Google Chat アプリを内部的に公開するため、プレースホルダ情報を使用しても問題ありません。Google Chat 用アプリを外部に公開する前に、同意画面のプレースホルダ情報を実際の情報に置き換えます。
OAuth 同意画面を構成し、スコープを指定して、アプリを登録する
Google Cloud コンソールで、メニュー > > [ブランディング] に移動します。
をすでに構成している場合は、[ブランディング]、[対象ユーザー]、[データアクセス] で次の OAuth 同意画面の設定を構成できます。[ まだ設定されていません] というメッセージが表示された場合は、[使ってみる] をクリックします。
- [アプリ情報] の [アプリ名] に「
AI knowledge assistant」と入力します。 - [ユーザー サポートメール] で、メールアドレスまたは適切な Google グループを選択します。
- [次へ] をクリックします。
- [対象] で [内部] を選択します。[内部] を選択できない場合は、[外部] を選択します。
- [次へ] をクリックします。
- [連絡先情報] で、プロジェクトに対する変更の通知を受け取るメールアドレスを入力します。
- [次へ] をクリックします。
- [完了] で、Google API サービスのユーザーデータに関するポリシーを確認し、同意する場合は [Google API サービス: ユーザーデータに関するポリシーに同意します] を選択します。
- [続行] をクリックします。
- [作成] をクリックします。
- ユーザータイプとして [外部] を選択した場合は、テストユーザーを追加します。
- [オーディエンス] をクリックします。
- [テストユーザー] で [ユーザーを追加] をクリックします。
- メールアドレスと他の承認済みテストユーザーを入力し、[保存] をクリックします。
- [アプリ情報] の [アプリ名] に「
[データアクセス] > [スコープを追加または削除] をクリックします。パネルが表示され、Google Cloud プロジェクトで有効にした各 API のスコープのリストが表示されます。
[Manually add scopes] に、次のスコープを貼り付けます。
https://www.googleapis.com/auth/chat.messages
[Add to Table] をクリックします。
[更新] をクリックします。
アプリに必要なスコープを選択したら、[データアクセス] ページで [保存] をクリックします。
OAuth クライアント ID 認証情報を作成する
Google Cloud コンソールで、メニュー > [API とサービス] > [認証情報] に移動します。
[認証情報を作成] > [OAuth クライアント ID] をクリックします。
[アプリケーションの種類] > [ウェブ アプリケーション] をクリックします。
[名前] フィールドに、認証情報の名前を入力します。この名前は Google Cloud コンソールにのみ表示されます。
[承認済みのリダイレクト URI] の下の [URI を追加] をクリックします。
[URI 1] に、次のように入力します。
https://REGION-PROJECT_ID.cloudfunctions.net/app/oauth2次のように置き換えます。
- REGION: Cloud Functions のリージョン（
us-central1など）。後で 2 つの Cloud Functions を作成するときに、リージョンをこの値に設定する必要があります。 - PROJECT_ID: 作成した Cloud プロジェクトのプロジェクト ID。
- REGION: Cloud Functions のリージョン（
[作成] をクリックします。
[OAuth クライアントを作成しました] ウィンドウで、[JSON をダウンロード] をクリックします。
ダウンロードしたファイルを
credentials.jsonとして保存します。後で、2 つの Cloud Functions を作成するときに、各デプロイにcredentials.jsonファイルを含めます。[OK] をクリックします。
Pub/Sub トピックを作成する
Pub/Sub トピックは、Google Workspace Events API と連携して、メッセージなどの Chat スペース内のイベントをサブスクライブし、Chat 用アプリにリアルタイムで通知します。
Pub/Sub トピックを作成する手順は次のとおりです。
Google Cloud コンソール
Google Cloud コンソールで、メニュー > [Pub/Sub] に移動します。
[トピックを作成] をクリックします。
[トピック ID] に「
events-api」と入力します。[デフォルトのサブスクリプションを追加する] の選択を解除します。
[暗号化] で、[Google が管理する暗号鍵] を選択します。
[作成] をクリックします。Pub/Sub トピックが表示されます。
この Pub/Sub トピックと Google Workspace Events API が連携して動作するように、Chat IAM ユーザーに Pub/Sub トピックへの投稿権限を付与します。
[events-api] パネルの [権限] で、[プリンシパルを追加] をクリックします。
[プリンシパルの追加] の [新しいプリンシパル] に「
chat-api-push@system.gserviceaccount.com」と入力します。[ロールを割り当てる] の [ロールを選択] で、[Pub/Sub] > [Pub/Sub パブリッシャー] を選択します。
[保存] をクリックします。
gcloud CLI
トピック ID
events-apiを使用して Pub/Sub トピックを作成します。gcloud pubsub topics create events-apiChat IAM ユーザーに Pub/Sub トピックに投稿する権限を付与します。
gcloud pubsub topics add-iam-policy-binding events-api \ --member='serviceAccount:chat-api-push@system.gserviceaccount.com' \ --role='roles/pubsub.publisher'
Firestore データベースを作成する
Firestore データベースは、メッセージなどの Chat スペースのデータを永続化して取得します。データモデルは定義しません。データモデルは、サンプルコードの model/message.js ファイルと services/firestore-service.js ファイルによって暗黙的に設定されます。
AI ナレッジ アシスタント Chat 用アプリのデータベースは、 コレクションに整理された ドキュメントに基づく NoSQL データモデルを使用します。詳細については、Firestore データモデルをご覧ください。
次の図は、AI ナレッジ アシスタントの Chat 用アプリのデータモデルの概要を示しています。
ルートには次の 2 つのコレクションが含まれています。
spaces。各ドキュメントは、Chat 用アプリが追加された Chat スペースを表します。各メッセージは、messagesサブコレクション内のドキュメントで表されます。users。各ドキュメントは、Chat スペースに Chat 用アプリを追加したユーザーを表します。
コレクション、ドキュメント、フィールドの定義を表示する
spaces
AI ナレッジ アシスタント Chat 用アプリを含む Chat スペース。
| フィールド | |
|---|---|
Document ID | String特定のスペースの一意の ID。Chat API のスペースのリソース名の一部。 |
messages | Subcollection of Documents (Chat スペースで送信されたメッセージ。Firebase の message の Document ID に対応します。 |
spaceName | StringChat API 内のスペースの一意の名前。Chat API のスペースのリソース名に対応します。 |
messages
Chat スペースで送信されたメッセージ。
| フィールド | |
|---|---|
Document ID | String特定のメッセージの一意の ID。 |
name | StringChat API のメッセージの一意の名前。Chat API のメッセージのリソース名に対応します。 |
text | Stringメッセージのテキスト本文。 |
time | String (Timestamp format)メッセージが作成された時刻。 |
users
AI ナレッジ アシスタント Chat 用アプリを Chat スペースに追加したユーザー。
| フィールド | |
|---|---|
Document ID | String特定のユーザーの一意の ID。 |
accessToken | StringGoogle Workspace API の呼び出しに使用される OAuth 2.0 ユーザー認証時に付与されるアクセス トークン。 |
refreshToken | StringOAuth 2.0 ユーザー認証時に付与された更新トークン。 |
Firestore データベースを作成する方法は次のとおりです。
Google Cloud コンソール
Google Cloud コンソールで、メニュー > [Firestore] に移動します。
[データベースを作成] をクリックします。
[Firestore モードの選択] で、[ネイティブ モード] をクリックします。
[続行] をクリックします。
データベースを構成します。
[データベースに名前を付ける] で、[データベース ID] を
(default)のままにします。[ロケーション タイプ] で [リージョン] を選択します。
[リージョン] で、データベースのリージョン（
us-central1など）を指定します。パフォーマンスを最適化するには、Chat 用アプリの Cloud Functions と同じロケーションまたは近隣のロケーションを選択します。
[データベースを作成] をクリックします。
gcloud CLI
ネイティブ モードで Firestore データベースを作成します。
gcloud firestore databases create \ --location=LOCATION \ --type=firestore-nativeLOCATION は、Firestore リージョンの名前（
us-central1など）に置き換えます。パフォーマンスを最適化するには、Chat 用アプリの Cloud Functions と同じロケーションまたは近隣のロケーションを選択します。
Chat 用アプリを作成してデプロイする
Google Cloud プロジェクトが作成され、構成されたので、Chat 用アプリをビルドしてデプロイする準備が整いました。このセクションでは、次の操作を行います。
- 2 つの Cloud Functions を作成してデプロイします。1 つは Chat インタラクション イベントに応答し、もう 1 つは Pub/Sub イベントに応答します。
- Google Chat API の構成ページで Chat 用アプリを作成してデプロイします。
Cloud Functions を作成してデプロイする
このセクションでは、次の 2 つの Cloud Functions の関数を作成してデプロイします。
app: Chat から HTTP リクエストとして受信したイベントに応答する Chat 用アプリのコードをホストして実行します。eventsApp: Pub/Sub からのメッセージなどの Chat スペース イベントを受信して処理します。
これらの Cloud Functions が、AI ナレッジ アシスタント Chat 用アプリのアプリケーション ロジックを構成します。
必要に応じて、Cloud Functions を作成する前に、GitHub でホストされているサンプルコードを確認して理解してください。
app を作成してデプロイする
Google Cloud コンソール
GitHub からコードを zip ファイルとしてダウンロードします。
ダウンロードした ZIP ファイルを解凍します。
抽出されたフォルダには、Google Workspace サンプル リポジトリ全体が含まれています。
抽出したフォルダで、
google-chat-samples-main/node/ai-knowledge-assistantディレクトリに移動します。google-chat-samples/node/ai-knowledge-assistantディレクトリに、認証と認可のために OAuth クライアント ID 認証情報を作成したときにダウンロードしたcredentials.jsonファイルを追加します。ai-knowledge-assistantフォルダの内容を zip ファイルに圧縮します。ZIP ファイルには、次のファイルとフォルダが含まれている必要があります。
.gcloudignore.gitignoreREADME.mddeploy.shenv.jsevents_index.jshttp_index.jsindex.jscredentials.jsonpackage-lock.jsonpackage.jsoncontrollers/model/services/test/
Google Cloud コンソールで、メニュー アイコン > [Cloud Functions] に移動します。
Chat 用アプリの Google Cloud プロジェクトが選択されていることを確認します。
[ 関数を作成] をクリックします。
[関数の作成] ページで、関数を設定します。
- [環境] で、[Cloud Run 関数] を選択します。
- [関数名] に「
app」と入力します。 - [リージョン] で、
us-central1などのリージョンを選択します。このリージョンは、認証と認可のために OAuth クライアント ID 認証情報を作成したときに、承認済みのリダイレクト URI で設定したリージョンと一致している必要があります。 - [トリガーのタイプ] で、[HTTPS] を選択します。
- [認証] で、[未認証の呼び出しを許可] を選択します。
- [次へ] をクリックします。
[ランタイム] で [Node.js 20] を選択します。
[エントリ ポイント] で、デフォルトのテキストを削除して
appと入力します。[ソースコード] で [ZIP アップロード] を選択します。
[宛先バケット] で、バケットを作成するか、選択します。
- [探す] をクリックします。
- バケットを選択します。
- [選択] をクリックします。
Google Cloud は、このバケットに zip ファイルをアップロードし、コンポーネント ファイルを抽出します。Cloud Functions は、コンポーネント ファイルを Cloud Functions にコピーします。
[Zip file] で、GitHub からダウンロードして展開し、再圧縮した zip ファイルをアップロードします。
- [探す] をクリックします。
- zip ファイルに移動して選択します。
- [開く] をクリックします。
[デプロイ] をクリックします。
[Cloud Functions の詳細] ページが開き、関数が 2 つの進行状況インジケーター（ビルド用とサービス用）とともに表示されます。両方の進行状況インジケーターが消えてチェックマークに置き換わると、関数がデプロイされ、準備が完了します。
サンプルコードを編集して定数を設定します。
- [Cloud Functions の詳細] ページで、[編集] をクリックします。
- [次へ] をクリックします。
- [ソースコード] で [インライン エディタ] をオンにします。
- インライン エディタで
env.jsファイルを開いて編集します。- project の値を Cloud プロジェクト ID に設定します。
- location の値を Cloud Functions のリージョン（
us-central1など）に設定します。
[デプロイ] をクリックします。
gcloud CLI
GitHub からコードのクローンを作成します。
git clone https://github.com/googleworkspace/google-chat-samples.gitこの AI ナレッジ アシスタント Chat 用アプリのコードが格納されているディレクトリに切り替えます。
cd google-chat-samples/node/ai-knowledge-assistantgoogle-chat-samples/node/ai-knowledge-assistantディレクトリに、認証と認可のために OAuth クライアント ID 認証情報を作成したときにダウンロードしたcredentials.jsonファイルを追加します。env.jsファイルを編集して環境変数を設定します。- project の値を Cloud プロジェクト ID に設定します。
- location の値を Cloud Functions のリージョン（
us-central1など）に設定します。
Cloud Functions を Google Cloud にデプロイします。
gcloud functions deploy app \ --gen2 \ --region=REGION \ --runtime=nodejs20 \ --source=. \ --entry-point=app \ --trigger-http \ --allow-unauthenticatedREGION は、
env.jsファイルで設定された値（us-central1など）と一致するように、Cloud 関数のリージョンの値に置き換えます。
eventsApp を作成してデプロイする
Google Cloud コンソール
Google Cloud コンソールで、メニュー アイコン > [Cloud Functions] に移動します。
Chat 用アプリの Google Cloud プロジェクトが選択されていることを確認します。
[ 関数を作成] をクリックします。
[関数の作成] ページで、関数を設定します。
- [環境] で、[Cloud Run 関数] を選択します。
- [関数名] に「
eventsApp」と入力します。 - [リージョン] で、
us-central1などのリージョンを選択します。このリージョンは、認証と認可のために OAuth クライアント ID 認証情報を作成したときに、承認済みのリダイレクト URI で設定したリージョンと一致している必要があります。 - [トリガーのタイプ] で、[Cloud Pub/Sub] を選択します。
- [Cloud Pub/Sub トピック] で、作成した Pub/Sub トピック名を選択します。このトピック名は
projects/PROJECT/topics/events-apiの形式です。ここで、PROJECT は Cloud プロジェクト ID です。 Service account(s) might not have enough permissions to deploy the function with the selected trigger.で始まるメッセージが表示された場合は、[すべて許可] をクリックします。- [次へ] をクリックします。
[ランタイム] で [Node.js 20] を選択します。
[エントリ ポイント] で、デフォルトのテキストを削除して
eventsAppと入力します。[ソースコード] で、[Cloud Storage の ZIP] を選択します。
[Cloud Storage のロケーション] で、[参照] をクリックします。
appCloud Functions を作成したときに ZIP ファイルをアップロードしたバケットを選択します。アップロードした ZIP ファイルをクリックします。
[選択] をクリックします。
[デプロイ] をクリックします。
[Cloud Functions の詳細] ページが開き、関数が 3 つの進行状況インジケーター（ビルド、サービス、トリガー）とともに表示されます。3 つの進行状況インジケータがすべて消えてチェックマークに置き換わると、関数がデプロイされ、準備が完了します。
サンプルコードを編集して定数を設定します。
- [Cloud Functions の詳細] ページで、[編集] をクリックします。
- [次へ] をクリックします。
- [ソースコード] で [インライン エディタ] をオンにします。
- インライン エディタで
env.jsファイルを開いて編集します。- project の値を Cloud プロジェクト ID に設定します。
- location の値を Cloud Functions のリージョン（
us-central1など）に設定します。
[デプロイ] をクリックします。
gcloud CLI
gcloud CLI で、まだそのディレクトリにいない場合は、GitHub から以前にクローンを作成したこの AI ナレッジ アシスタント Chat 用アプリのコードが格納されているディレクトリに切り替えます。
cd google-chat-samples/node/ai-knowledge-assistantgoogle-chat-samples/node/ai-knowledge-assistantディレクトリに、認証と認可のために OAuth クライアント ID 認証情報を作成したときにダウンロードしたcredentials.jsonファイルを追加します。env.jsファイルを編集して環境変数を設定します。- project の値を Cloud プロジェクト ID に設定します。
- location の値を Cloud Functions のリージョン（
us-central1など）に設定します。
Cloud Functions を Google Cloud にデプロイします。
gcloud functions deploy eventsApp \ --gen2 \ --region=REGION \ --runtime=nodejs20 \ --source=. \ --entry-point=eventsApp \ --trigger-topic=events-apiREGION は、
env.jsファイルで設定された値（us-central1など）と一致するように、Cloud 関数のリージョンの値に置き換えます。
app Cloud Functions のトリガー URL をコピーします。
Google Cloud コンソールで Chat 用アプリを構成する際に、次のセクションで app Cloud Functions のトリガー URL を貼り付けます。
Google Cloud コンソール
Google Cloud コンソールで、メニュー アイコン > [Cloud Functions] に移動します。
Cloud Functions のリストの [名前] 列で、[
app] をクリックします。[トリガー] をクリックします。
URL をコピーします。
gcloud CLI
appCloud Functions の関数を記述します。gcloud functions describe appurlプロパティをコピーします。
Google Cloud コンソールで Chat 用アプリを構成する
このセクションでは、Google Cloud コンソールで Chat API を構成する方法について説明します。Chat アプリの名前や、Chat アプリが Chat インタラクション イベントを送信する Cloud Functions のトリガー URL など、Chat アプリに関する情報を使用します。
Google Cloud コンソールで、メニュー > [その他のプロダクト] > [Google Workspace] > [プロダクト ライブラリ] > [Google Chat API] > [管理] > [構成] をクリックします。
[アプリ名] に「
AI knowledge assistant」と入力します。[アバターの URL] に「
https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/live_help/default/24px.svg」と入力します。[説明] に「
Answers questions with AI」と入力します。[インタラクティブ機能を有効にする] 切り替えボタンをクリックしてオンにします。
[機能] で、[スペースとグループの会話に参加する] を選択します。
[接続設定] で、[HTTP エンドポイント URL] を選択します。
[HTTP エンドポイント URL] に、
appCloud Functions のトリガー URL をhttps://REGION-PROJECT_ID.cloudfunctions.net/appの形式で貼り付けます。ここで、REGION は Cloud Functions のリージョン（us-central1など）、PROJECT_ID は作成した Cloud プロジェクトのプロジェクト ID です。[公開設定] で、[Workspace ドメイン内の特定のユーザーおよびグループにこの Chat 用アプリの利用を許可する] を選択し、メールアドレスを入力します。
必要に応じて、[ログ] で [エラーを Logging に記録する] を選択します。
[保存] をクリックします。構成が保存されたことを示すメッセージが表示され、Chat 用アプリをテストする準備が整います。
Chat アプリをテストする
AI ナレッジ アシスタント Chat 用アプリをテストするには、AI ナレッジ アシスタント Chat 用アプリが回答できる質問をメッセージを含む Chat スペースでします。
AI ナレッジ アシスタントの Chat 用アプリをテストする方法は次のとおりです。
- AI ナレッジ アシスタント Chat 用アプリを既存の Chat スペースに追加し、そのスペースに関連する質問をします。
- Chat スペースを作成し、データソースとして使用するメッセージをいくつか投稿します。メッセージは、
Answer 20 common onboarding questions employees ask their teams.などのプロンプトを使用して Gemini から取得できます。または、Chat を使用した開発の概要ガイドからいくつかの段落を貼り付けて、それについて質問することもできます。
このチュートリアルでは、Chat スペースを作成し、Chat を使用した開発の概要ガイドからいくつかの段落を貼り付けます。
Google Chat を開きます。
Chat スペースを作成する:
[チャットを新規作成] > [スペースを作成] をクリックします。
[Space name] に「
Testing AI knowledge assistant app」と入力します。[このスペースの用途] で [共同作業] を選択します。
[アクセス設定] で、スペースにアクセスできるユーザーを選択します。
[作成] をクリックします。
データソースとして使用するメッセージを追加します。
ウェブブラウザで、Chat を使用した開発の概要ガイドにアクセスします。
ガイドのコンテンツをコピーして、作成した Chat スペースに貼り付けます。
AI ナレッジ アシスタントの Chat 用アプリを追加します。
メッセージ作成バーに「
@AI knowledge assistant」と入力し、表示された候補メニューで AI ナレッジ アシスタントの Chat 用アプリを選択して、enterを押します。AI ナレッジ アシスタントの Chat 用アプリをスペースに追加するかどうかを確認するメッセージが表示されます。[Add to space] をクリックします。
Chat 用アプリをスペースに初めて追加する場合は、Chat 用アプリの認証と認可を構成する必要があります。
- [構成] をクリックします。
- 新しいブラウザ ウィンドウまたはタブが開き、Google アカウントの選択を求めるメッセージが表示されます。テストに使用するアカウントを選択します。
- AI ナレッジ アシスタントの Chat 用アプリがリクエストする権限を確認します。権限を付与するには、[許可] をクリックします。
- 「
You may close this page now.」というメッセージが表示されます。ブラウザのウィンドウまたはタブを閉じて、Chat スペースに戻ります。
質問する:
メッセージ作成バーに、
What are Google Chat apps?のような質問を入力します。AI ナレッジ アシスタントの Chat 用アプリが回答します。
回答が正確でない場合や十分でない場合は、AI の会話履歴の改善に役立てるため、[ サポートを受ける] をクリックします。AI ナレッジ アシスタントの Chat 用アプリがスペースの管理者をメンションし、質問に回答するよう依頼します。次回からは、AI ナレッジ アシスタントの Chat 用アプリが回答を認識します。
考慮事項、代替アーキテクチャの選択肢、次のステップ
このセクションでは、AI ナレッジ アシスタントの Chat 用アプリを構築するその他の方法について説明します。
Firestore、Cloud Storage、または Chat API で List Messages を呼び出す
このチュートリアルでは、Chat アプリが質問に回答するたびに Chat API で Message リソースの list メソッドを呼び出すよりもパフォーマンスが向上するため、メッセージなどの Chat スペースのデータを Firestore データベースに保存することをおすすめします。また、list messages を繰り返し呼び出すと、Chat 用アプリが API 割り当ての上限に達する可能性があります。
ただし、Chat スペースの会話履歴が長すぎると、Firestore の使用コストが高くなる可能性があります。
Cloud Storage は Firestore の代替手段です。AI ナレッジ アシスタント Chat 用アプリがアクティブになっているスペースごとに独自のオブジェクトが作成されます。各オブジェクトは、スペース内のすべてのメッセージを含むテキスト ファイルです。このアプローチの利点は、テキスト ファイルの全内容を Gemini を使用して Vertex AI に一度にフィードできることですが、欠点は、Cloud Storage のオブジェクトに追加することはできず、置き換えることしかできないため、会話履歴の更新に手間がかかることです。このアプローチは、メッセージ履歴を定期的に更新する場合は意味がありませんが、メッセージ履歴を定期的に（たとえば週に 1 回）バッチ更新する場合は適しています。
トラブルシューティング
Google Chat 用アプリまたはカードがエラーを返すと、Chat インターフェースに「エラーが発生しました」というメッセージが表示されます。または「リクエストを処理できません。」と表示されることがあります。Chat UI にエラー メッセージが表示されない場合でも、Chat 用アプリやカードで予期しない結果が生じることがあります。たとえば、カード メッセージが表示されないことがあります。
Chat UI にエラー メッセージが表示されない場合でも、Chat 用アプリのエラー ロギングが有効になっている場合は、エラーの修正に役立つ説明的なエラー メッセージとログデータを利用できます。エラーの表示、デバッグ、修正については、Google Chat のエラーのトラブルシューティングと修正をご覧ください。
クリーンアップ
このチュートリアルで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、Cloud プロジェクトを削除することをおすすめします。
- Google Cloud コンソールで、[リソースの管理] ページに移動します。メニュー アイコン > [IAM と管理] > [リソースの管理] をクリックします。
- プロジェクト リストで、削除するプロジェクトを選択し、[削除] をクリックします。
- ダイアログでプロジェクト ID を入力し、[シャットダウン] をクリックしてプロジェクトを削除します。