最初のエージェントを作成する

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

Prerequisites

エージェントを作成する

このガイドでは、サンプル アプリケーションを使用してエージェントを作成する方法について説明します。このサンプルでは、エージェントの機能を簡単に確認でき、エージェント開発の開始点として使用できます。エージェントを追加するように既存のアプリケーションを変更する場合、サンプルにはアプリケーション ロジックに適したモデルが用意されています。

このクイックスタートでは、以下の操作を行います。

  • パートナーとして登録
  • ブランドとエージェントを作成する
  • Business Messages Helper Bot と会話して、さまざまな機能を調べることもできます
  • エージェントを設定してメッセージを送受信する

サンプルを使用せずにエージェントを作成するには、エージェントの作成をご覧ください。

パートナーとして登録

  1. Business Communications Developer Console を開きます。
  2. [ビジネス メッセージ] で [パートナー アカウントを作成] をクリックします。
  3. パートナー情報を入力します。

    フィールド
    お名前 氏名
    パートナー名 組織名
    パートナー ウェブサイト 組織のウェブサイト
    リージョン ビジネス メッセージ サービスをホストする地域
  4. ビジネス メッセージの利用規約を確認して同意します。

  5. [作成] をクリックします。

ビジネス メッセージ パートナーとして登録されました。Business Messages および Business Communications API を有効にした新しい Google Cloud プロジェクトが作成されています。このプロジェクトにはアクセスできず、既存の Google Cloud プロジェクトの妨げになることもありません。

Business Messages API と Business Communications API にアクセスできるようになりました。

サービス アカウントを作成する

  1. Business Communications Developer コンソールのホームページで、パートナー アカウントの設定 をクリックします。
  2. 左側のナビゲーションで、[サービス アカウント] をクリックします。
  3. [鍵を作成]、[作成] の順にクリックします。

    ブラウザがサービス アカウント キーをダウンロードします。安全な場所に保管してください。後でウェブ アプリケーションをデプロイし、Business Messages API と Business Communications API にアクセスする際に、このキーが必要になります。

ブランドとエージェントを作成する

エージェントは、ブランド(ユーザーが操作する会話エンティティ)の会話表現です。ビジネスを表すブランドを作成し、エージェントを作成して、消費者が会話でコミュニケーションできるようにします。

  1. Business Communications Developer Console を開き、ビジネス メッセージの Google アカウントでログインします。
  2. [Create Agent(エージェントを作成)] をクリックします。
  3. [エージェント タイプ] で [ビジネス メッセージ] を選択します。
  4. [ブランド名] と [エージェント名] の値を入力します。
  5. 次のいずれかを行います。
    • エージェントと会話して利用可能な機能を調べるには、[Enable Business Messages Helper Bot] を選択します。
    • エージェントをカスタマイズしてメッセージ処理の準備をするには、[Business Messages Helper Bot] をオフにします。
  6. [Create Agent(エージェントを作成)] をクリックします。

Business Messages Helper Bot を有効にしている場合は、すぐに会話を開始できます。それ以外の場合は、メッセージ処理用にエージェントを設定するに進みます。

Business Messages Helper Bot で機能を探しましょう

Business Messages Helper Bot を使うと、エージェントとの会話をすばやく開始して、プラットフォームが提供するサービスを体験できます。Helper Bot を有効にすることは任意ですが、最初のエージェントを作成するときに強くおすすめします。

Helper Bot を使うと、次のようなことができます。

  • 豊富な機能の詳細を見る
  • 機能の実装方法を学ぶ
  • エージェント設定用のリソースを検索

Helper Bot が有効になっていると、エージェントに代わってメッセージの送受信が行われるため、Webhook を設定する必要がありません。Webhook を設定するか、Dialogflow を有効にしてユーザー メッセージを処理するには、事前にヘルパーボットを無効にする必要があります。

Helper Bot と会話する

Business Messages Helper Bot を有効にすると、会話を開始できます。 エージェントの作成後すぐに、ダイアログが表示されます。

Helper Bot を操作するには、このダイアログで次の手順を行います。

  1. エージェントのテスト URL にアクセスします。そのための方法はいくつかあります。

    • [Android] ボタンまたは [iOS] ボタンをクリックします。次に、対応するモバイル デバイスで QR コードをスキャンし、[Launch] をクリックします。 または、[Android URL をコピー] または [iOS URL をコピー] をクリックして、エージェントのテスト URL をコピーします。
    • [送信] をクリックして URL をメールアドレスに送信します。
  2. モバイル デバイスで URL を開きます。(iOS デバイスには、Google マップ アプリが必要です)。

Helper Bot を無効にする

エージェントをカスタマイズして起動の準備をする前に、Business Messages Helper Bot を無効にする必要があります。

Helper Bot を無効にするには、次のコマンドを実行します。

  1. Business Communications Developer Console を開きます。
  2. エージェントを選択します。
  3. 画面左のナビゲーションで [Integrations] をクリックします。
  4. [Helper Bot] で [無効にする] をクリックします。

Helper Bot を無効にすると、エージェントとのメッセージの送受信が停止します。これで、メッセージング フローを処理するようにエージェントを設定できるようになりました。

メッセージ処理用にエージェントを設定する

このガイドでは、ユーザー メッセージを処理するように設計された Webhook を使用して、Echo Bot を Google Cloud Platform(GCP)にデプロイします。

Echo Bot は、ユーザーにメッセージをエコーするサンプル アプリケーションです。このツールを使用すると、エージェントとの会話の中で、推奨アクションリッチカードなどのさまざまな機能をテストできます。また、Echo Bot をエージェント開発の出発点として使用することもできます。

以下の手順を実施します。

  • Echo Bot のサンプルを GCP にデプロイする
  • ビジネス メッセージ パートナー アカウントの Webhook URL を設定する
  • エージェントに関する基本情報を登録する

このガイドを終了すると、エージェントがメッセージを送受信できるようになります。

GCP にウェブ アプリケーションをデプロイする

ビジネス メッセージは、ユーザーからのメッセージをインフラストラクチャ内の Webhook に転送します。このガイドでは、事前構成済みの Webhook に Echo Bot サンプルコードのソースコードをデプロイします。メッセージを受信するためのウェブ インフラストラクチャがすでにある場合は、そのウェブサービスで新しい Webhook を作成できますが、ロジックは自分で構成する必要があります。詳しくは、パートナー レベルの Webhook を設定するをご覧ください。

クラウド環境を作成する

Echo Bot のサンプルをデプロイするには、クラウド環境が必要です。

GCP プロジェクトをクラウド環境として作成する手順は次のとおりです。

  1. Google Cloud Console プロジェクト セレクタを開きます。

    Google Cloud プロジェクトを作成したことがない場合は、利用規約に同意する必要があります。

  2. [プロジェクトの作成] をクリックします。

  3. 新しいプロジェクトの名前と場所を入力します。

    • プロジェクト ID が自動的に生成され、プロジェクト名の下に表示されます。
    • [ロケーション] フィールドで [参照] をクリックして、プロジェクトの潜在的なロケーションを表示します。Google Workspace の組織が見つからない場合は、Google Workspace アカウントにログインしていません。組織を作成せずにプロジェクトを作成できますが、一部の機能が制限されます。詳しくは、組織リソースのメリットをご覧ください。
  4. [作成] をクリックします。

  5. [メニュー] をクリックします。

  6. [料金] をクリックします。

  7. [請求先アカウントをリンク] をクリックします。

  8. 新しい請求先アカウントを作成するか、プロジェクトに既存の請求先アカウントを追加します。支払いオプションについては、Google Cloud の無料プログラム機能をご覧ください。

Echo Bot のサンプルをデプロイする

  1. gcloud CLI をインストールします。ここで使用するサンプルコードを Google Cloud にデプロイします。
  2. Echo Bot サンプル(Node.jsJavaPython)をダウンロードして解凍します。

  3. サービス アカウントの作成でダウンロードした JSON 認証情報ファイルを sample's resource フォルダにコピーし、認証情報の名前を &bt-bm-agent-service-account-credentials.json" に変更します。この認証情報ファイルのパスは、ダウンロードしたサンプルによって異なります。

    Node.js

    ./bm-nodejs-echo-bot/full_sample/resources/bm-agent-service-account-credentials.json
    

    Java

    ./bm-java-echo-bot/full_sample/src/main/resources/bm-agent-service-account-credentials.json
    

    Python

    ./bm-python-echo-bot/full_sample/resources/bm-agent-service-account-credentials.json
    
  4. ターミナルで、sample_sample サンプルのディレクトリに移動します。

  5. ターミナルで次のコマンドを実行して、サンプルをデプロイします。

    Node.js

    gcloud config set project PROJECT_ID
    gcloud app create
    gcloud app deploy
    

    PROJECT_ID は、Cloud 環境の作成で作成したプロジェクトのプロジェクト ID です。プロジェクト ID は、Google Cloud のプロジェクト ダッシュボードに表示されます。

    Java

    gcloud config set project PROJECT_ID
    gcloud app create
    mvn appengine:deploy
    

    PROJECT_ID は、Cloud 環境の作成で作成したプロジェクトのプロジェクト ID です。プロジェクト ID は、Google Cloud のプロジェクト ダッシュボードに表示されます。

    Python

    gcloud config set project PROJECT_ID
    gcloud app create
    gcloud app deploy
    

    PROJECT_ID は、Cloud 環境の作成で作成したプロジェクトのプロジェクト ID です。プロジェクト ID は、Google Cloud のプロジェクト ダッシュボードに表示されます。

  6. 最後のコマンドの出力に記載されている、デプロイしたアプリケーションの URL をメモします。Webhook URL のベースは、次のとおりです。

    Deployed service [default] to [https://PROJECT_ID.appspot.com]

Webhook を設定する

Echo Bot がデプロイされたので、メッセージの受信を開始するための(動作中の)Webhook URL を指定する必要があります。

  1. Business Communications Developer Console でアカウント設定を開きます。
  2. 正しいパートナー アカウントが選択されていることを確認します。
  3. [ビジネス メッセージの Webhook URL] で [設定] をクリックします。
  4. [Webhook endpoint URL] に、アプリケーションの URL + "/callback" を入力します。

    エンドポイントの形式は "https://PROJECT_ID.appspot.com/callback" です。

    このエンドポイントは、GCP にデプロイしたサンプルのアプリケーション ロジックで事前定義されています。

  5. Play Console で [確認] をクリックします。

    ビジネス メッセージによって Webhook の確認が完了すると、ダイアログが閉じます。

Business Communications API を使用して Webhook を構成するには、例: Webhook URL を更新するをご覧ください。

ビジネス メッセージのテスト フレームワークを使用すると、ビジネス メッセージのペイロードに Webhook が正常に応答するかどうかをテストできます。

エージェント情報の入力

エージェントの設定を完了するための基本情報を入力します。

  1. Business Communications Developer Console を開きます。
  2. 左側のナビゲーションで [エージェント情報] をクリックします。
  3. 必要に応じて値を更新するか、次の提案を使用してください。

    フィールド
    ウェルカム メッセージ Echo Bot の会話へようこそ。
    プライバシー ポリシー https://policies.google.com/privacy
  4. [保存] をクリックします。

会話を開始

Echo Bot を操作する手順は次のとおりです。

  1. Business Communications Developer Console を開きます。
  2. 左側のナビゲーションで [エージェント情報] をクリックします。
  3. [エージェントのテスト URL] で [Android] ボタンまたは [iOS] ボタンをクリックします。
  4. 対応するモバイル デバイスで QR コードをスキャンするか、[Android URL をコピー] または [iOS URL をコピー] をクリックしてエージェントのテスト URL をコピーします。

    [送信] をクリックして、URL をメールアドレスに送信することもできます。

  5. モバイル デバイスで URL を開きます。(iOS デバイスの場合、Google マップ アプリが必要です)。

エージェントのウェルカム メッセージが挨拶します。この時点で、Echo Bot を操作できます。返信するメッセージがエコーされます。また、「カルーセル」、「カード」、「チップ」などの特定の文字列を送信することで、さまざまな機能を呼び出すこともできます。

次のステップ

これで最初のエージェントが作成されました。ビジネス メッセージや、プラットフォームでできることなどについて、詳細をご確認ください。