部署 Genesys Cloud 應用程式伺服器

您可以在 Genesys Cloud 中設定應用程式伺服器,在網路上顯示 Agent Assist 建議。

目標

整合 Genesys Cloud 涉及下列程序:

  1. 部署 UI 模組的後端伺服器,呼叫 Dialogflow API、註冊驗證權杖,並設定 Cloud Pub/Sub 和 Memorystore for Redis。
  2. Cloud Run 中部署 Genesys Cloud 應用程式伺服器,以便算繪 Agent Assist UI 模組。
  3. 建立 OAuth 用戶端
  4. 完成環境變數
  5. 在 Genesys Cloud 中設定互動小工具
  6. 在 Genesys Cloud 中,透過互動小工具設定 Agent Assist 整合。
  7. 在 Genesys Cloud 中設定 Messenger
  8. 使用 Genesys Cloud 網頁即時通訊和訊息工具測試整合。

事前準備

開始整合 Genesys Cloud 前,請先完成下列動作:

  1. 如果尚未設定 Google Cloud CLI,請先安裝。
  2. 按照 Google Cloud 操作說明建立服務帳戶,並指派 Dialogflow API 用戶端角色
  3. 如要存取 Genesys Cloud 存放區,請傳送電子郵件至 agent-assist-ui-modules-support@google.com。
  4. 部署 Agent Assist UI 模組的後端。部署後端伺服器時,請按照部署說明,將環境變數 AUTH_OPTION 指定為 GenesysCloud

使用 CLI 部署 Genesys Cloud 應用程式伺服器

  1. 使用下列程式碼,將 Git 存放區複製到本機電腦或開發環境:
    git clone https://github.com/GoogleCloudPlatform/agent-assist-integrations
    
  2. 在本地終端機中,使用下列程式碼將現用目錄變更為存放 Docker 檔案的存放區根目錄,然後執行 Google Cloud CLI 建構作業。
    cd genesyscloud/frontend
    
  3. 系統提示輸入服務名稱時,請按下 Enter 鍵接受預設值。
  4. 使用下列指令部署整合功能。將 PROJECT-ID 替換為代理程式的 Google Cloud 專案 ID,將 UI_MODULE_SERVICE_ACCOUNT 替換為服務帳戶用戶端電子郵件地址,並為 Cloud Run 設定 REGION
    gcloud run deploy $AA_MODULE_APPLICATION_SERVER 
    --source ./
    --service-account=$ui_module_service_account
    --memory 1Gi --platform managed
    --region us-central1
    --allow-unauthenticated
  5. 按一下「Enter」接受預設服務名稱。

詳情請參閱 Cloud Run 說明文件。在 Google Cloud 控制台的「Cloud Run」下方,您可以查看有效整合部署作業的清單。

建立 OAuth 用戶端

  1. 請按照 Genesys Cloud 說明文件中的操作說明,建立新的 OAuth 用戶端。
  2. 確認授權類型為「Code Authorization / PKCE」
  3. 將應用程式網址新增至「Authorized redirect URIs」(已授權的重新導向 URI) 部分。
  4. OAuth 2.0 用戶端權杖的有效時間更新為 3600 秒。這與 Dialogflow API 存取的預設 1 小時 JWT 權杖有效時間相符。如需自訂時間長度,請一併更新 OAuth 和 JWT 權杖的時間長度。
    {Application_SERVER_URL}?conversationProfile={CONVERSATION_PROFILE_NAME}&features={FEATURES}
    
    將 {APPLICATION_SERVER_URL} 替換為 UI 應用程式伺服器的網址。
  5. CONVERSATION_PROFILE_NAME 替換為對話設定檔名稱,例如 projects/your-project/locations/your-location/conversationProfiles/abc123
  6. {FEATURES} 替換為以半形逗號分隔的 Agent Assist 功能清單,應用程式會納入這些功能。重要事項:請只加入在對話設定檔中設定的功能。Genesys Cloud 支援下列功能
  7. 如要為 OAuth 用戶端新增範圍,請前往「範圍」部分。
  8. 選取下列範圍:alertingauthorizationconversationsnotificationsmessagingorganization

網址範例:

https://my-project.wm.run.app?conversationProfile=projects/my-project/conversationProfiles/abc123&features=CONVERSATION_SUMMARIZATION,AGENT_COACHING,PROACTIVE_GENERATIVE_KNOWLEDGE_ASSIST

建議您為內嵌 iframe 啟用彈出式驗證,確保登入體驗順暢無礙。

完成環境變數

Genesys Cloud 應用程式會使用下列環境變數。如要設定環境變數,請按照 Cloud Run 操作說明執行。

  • OAUTH_CLIENT_ID:Genesys Cloud OAuth 用戶端 ID。
  • GENESYS_CLOUD_REGIONGenesys Cloud 區域。例如:美國西部(奧勒岡) 的代碼為 usw2.pure.cloud。預設值為 mypurecloud.com
  • GENESYS_CLOUD_ENVIRONMENT:Genesys Cloud 環境。預設值為 prod
  • PROXY_SERVER:Agent Assist 後端連接器的網址。
  • APPLICATION_SERVER_URL:UI 應用程式伺服器的網址。
  • PROJECT_ID: Google Cloud 專案 ID。
  • CONVERSATION_PROFILE:要使用的對話設定檔。這應與 OAuth 用戶端重新導向網址中的設定檔相符。
  • FEATURES:以半形逗號分隔的常數,代表 Agent Assist 功能。這應與 OAuth 用戶端的重新導向網址中的功能相符。
  • CHANNEL:選擇整合類型,值可以是「語音」或「即時通訊」。

.env 檔案範例:

OAUTH_CLIENT_ID={your-oauth-client-id}
GENESYS_CLOUD_REGION={your-pure-cloud-region}
GENESYS_CLOUD_ENVIRONMENT={your-pure-cloud-environment}
PROXY_SERVER={your-proxy-server-endpoint}
PROJECT_ID={your-gcp-project-id}
CONVERSATION_PROFILE={your-conversation-profile}
FEATURES=ARTICLE_SUGGESTION,CONVERSATION_SUMMARIZATION
CHANNEL={use-voice-or-chat}

建立 OAuth 用戶端時,Genesys Cloud 也會提供用戶端 ID。

使用更新後的環境變數執行部署指令。

    gcloud run deploy $AA_MODULE_APPLICATION_SERVER 
--source ./
--service-account=$ui_module_service_account
--memory 1Gi --platform managed
--region us-central1
--allow-unauthenticated
--set-env-vars ^~^OAUTH_CLIENT_ID=$OAUTH_CLIENT_ID~GENESYS_CLOUD_REGION=$GENESYS_CLOUD_REGION~GENESYS_CLOUD_ENVIRONMENT=$GENESYS_CLOUD_ENVIRONMENT~CONVERSATION_PROFILE=$CONVERSATION_PROFILE~FEATURES=$FEATURES~PROJECT_ID=$PROJECT_ID~APPLICATION_SERVER_URL=''~PROXY_SERVER=$PROXY_SERVER~APPLICATION_SERVER_URL=$APPLICATION_SERVER_URL

Genesys Cloud 應用程式伺服器必須部署至 Google Cloud 代管服務。使用 App Engine 或 Cloud Run。

關閉應用程式伺服器

  1. 刪除 Cloud Run 服務。
  2. 在本機終端機中執行下列指令:
    gcloud run services list
    
  3. 選取先前選擇的目標平台,列出有效部署作業。
  4. 請執行下列指令:
    gcloud run services delete agent-assist-modules-application-server
    

價格免責事項

如果您使用 Genesys Cloud 整合服務,則須支付基礎 Cloud Run 服務的相關費用。

後續步驟