アプリケーション サーバーをデプロイする

このガイドでは、LivePerson で Agent Assist の候補を表示するために使用できるアプリケーション サーバーを設定するために必要な手順について説明します。アプリケーション サーバーは、同じディレクトリ内のプロキシ サーバーとともに使用されます。エージェント ワークスペースで UI モジュールをレンダリングする手順については、LivePerson のメイン チュートリアル ページをご覧ください。LivePerson でモジュールをレンダリングするには、アプリケーション サーバーとプロキシ サーバーの両方が必要です。

この統合デプロイは任意のホスティング プラットフォームで設定できますが、この手順では Google の Cloud Run を使用します。

構成

サービスをデプロイするときに、次の環境変数を定義する必要があります。アプリケーション サーバーを最初に作成するときは、LP_CLIENT_ID 変数と LP_CLIENT_SECRET 変数を空白のままにしてください。これらの変数は、Conversational Cloud アプリケーションを作成するときに LivePerson から提供されます。その際に、これらの変数を更新します。また、最初は APPLICATION_SERVER_URL と DF_PROXY_SERVER_URL もスキップします。これらの 2 つの変数は、アプリケーション サーバーとプロキシ サーバーがデプロイされ、必要な URL 値が返された後に設定されます。

  • LP_ACCOUNT_ID: LivePerson アカウント ID。
  • LP_CLIENT_ID: LivePerson クライアント ID。これは、Conversational Cloud アプリケーションがインストールされると、LivePerson から提供されます。（この変数は今はスキップしてください。情報が提供されたら更新します）。
  • LP_CLIENT_SECRET: LivePerson クライアント シークレット。これは、Conversational Cloud アプリケーションがインストールされると、LivePerson から提供されます。（この変数は今はスキップしてください。情報が提供されたら更新します）。
  • LP_SENTINEL_DOMAIN: https://developers.liveperson.com/domain-api.html にアクセスします。アカウント番号を入力し、「sentinel」のドメインを検索します。
  • LP_ACCOUNT_CONFIG_READONLY_DOMAIN: https://developers.liveperson.com/domain-api.html にアクセスします。アカウント番号を入力し、「accountConfigReadOnly」のドメインを検索します。
  • APPLICATION_SERVER_URL: UI アプリケーション サーバーの URL。（ここではスキップし、アプリケーション サーバーのデプロイ後に URL がわかったら更新します）。
  • DF_PROXY_SERVER_URL: プロキシ サーバーの URL。（ここではスキップし、プロキシ サーバーがデプロイされ、その URL がわかったら更新します）。
  • PROJECT_ID: Google Cloud プロジェクト ID。projects/ 接頭辞は含めないでください。

サンプル .env ファイル

    LP_ACCOUNT_ID = 12345678
    LP_CLIENT_ID = abc-123-f0f0
    LP_SENTINEL_DOMAIN = va.sentinel.liveperson.net
    LP_ACCOUNT_CONFIG_READONLY_DOMAIN = z1.acr.liveperson.net
    LP_CLIENT_SECRET = abc123abc123abc123abc123
    APPLICATION_SERVER_URL = https://my-project.wm.r.appspot.com
    DF_PROXY_SERVER_URL = https://proxy-server-dot-my-project.wm.r.appspot.com
    PROJECT_ID = my-project

デプロイ

UI アプリケーション サーバーは、Google Cloud ホスティング サービスにデプロイする必要があります。Google App Engine または Cloud Run のいずれかを使用することをおすすめします。以下の手順では、Cloud Run を例として使用します。

gcloud CLI を設定する

このチュートリアルで説明するデプロイ プロセスでは、gcloud CLI コマンドを使用します。このデプロイ用に gcloud CLI をローカルで設定する手順は次のとおりです。

  1. gcloud CLI のドキュメント ページで、オペレーティング システムを選択し、インストール手順に沿って操作します。
  2. gcloud config get-value project を実行して、Google Cloud Platform プロジェクトの構成を確認します。
  3. Dialogflow エージェントの設定に移動し、エージェントに関連付けられているプロジェクト ID を確認します。gcloud CLI で構成された Google Cloud Platform プロジェクトは、エージェントのプロジェクト ID と一致している必要があります。
  4. プロジェクト ID が一致しない場合は、gcloud config set project PROJECT-ID を実行します。PROJECT-ID は、ステップ 3 のプロジェクト ID に置き換えます。

サービス アカウントを設定する

統合が適切に機能するためには、Google Cloud Platform プロジェクトにサービス アカウントを作成する必要があります。詳細については、Dialogflow のドキュメントをご覧ください。

サービス アカウントを作成して統合を設定する手順は次のとおりです。

  1. Agent Assist リソースに関連付けられている Google Cloud Platform プロジェクトを選択します。
  2. Google Cloud Platform コンソールのナビゲーション メニューをクリックし、[IAM と管理] にカーソルを合わせて [サービス アカウント] をクリックします。
  3. [+ サービス アカウントを作成] をクリックし、詳細を入力して、Dialogflow Client API ロールを割り当てます。

必要な API の有効化

  1. 目的の Google Cloud Platform プロジェクトに移動します。
  2. Google Cloud Platform コンソールのナビゲーション メニューをクリックし、[お支払い] を選択します。プロジェクトに対して課金が有効になっていることを確認します。
  3. このプロジェクトで Cloud Build と Cloud Run API を有効にします。
  4. 次の Git リポジトリのクローンをローカルマシンまたは開発環境に作成します。git clone [repository url]
  5. ローカルマシンまたは開発環境でリポジトリのルート ディレクトリを開きます。

CLI を使用してデプロイする

ローカル ターミナルで、アクティブ ディレクトリをリポジトリのルート ディレクトリに変更します。

次のコマンドを実行して、リポジトリの状態を Google Cloud Platform Container Registry に保存します。PROJECT-ID は、Google Cloud Platform プロジェクト ID に置き換えます。

    gcloud builds submit --tag gcr.io/PROJECT-ID/agent-assist-modules-application-server

次のコマンドを使用して、インテグレーションを本番環境にデプロイします。PROJECT-ID はエージェントの Google Cloud Platform プロジェクト ID に、SERVICE-ACCOUNT-EMAIL はサービス アカウントのクライアント メールアドレスに置き換えます。

    gcloud run deploy --image gcr.io/PROJECT-ID/agent-assist-modules-application-server --service-account=SERVICE-ACCOUNT-EMAIL --memory 1Gi --platform managed
  • リージョンの入力を求められたら、リージョン（us-central1 など）を選択します。
  • サービス名の入力を求められたら、Enter キーを押してデフォルトを受け入れます。
  • 未認証の呼び出しを許可するよう求められたら、y キーを押します。

詳細については、Cloud Run のドキュメントをご覧ください。アクティブな統合デプロイのリストは、Google Cloud Platform Console の [Cloud Run] で確認できます。

環境変数

Cloud Run の手順に沿って、必要な環境変数を設定します。

サービスがデプロイされると、CLI はアプリケーションがデプロイされた URL（target_url）を出力します。この値を使用して APPLICATION_SERVER_URL 環境変数を設定します。

アプリケーション サーバーをシャットダウンする

アプリケーション サーバーをシャットダウンするには、Cloud Run サービスを削除する必要があります。

ローカル ターミナルで次のコマンドを実行し、以前に選択したターゲット プラットフォームを選択して、アクティブなデプロイを一覧表示します。

    gcloud beta run services list

次に、次のコマンドを実行します。

   gcloud beta run services delete agent-assist-modules-application-server