构建内置 Gemini Enterprise AI 代理的 Google Chat 应用

本页面介绍了如何构建可在 Google Chat 中运行并与 Gemini Enterprise AI 智能体交互的 Google Workspace 插件。

AI 智能体可以自主感知环境、进行推理,并执行复杂的多步骤操作来实现既定目标。在本教程中,您将使用 “创意生成”智能体 ,该智能体由 Google 默认提供,可帮助 企业用户进行创新和解决问题。

作为聊天应用的“创意生成”代理。

下图展示了架构和消息传递模式:

使用 Gemini Enterprise AI 智能体实现的聊天应用的架构。

在上图中,与使用 Gemini Enterprise AI 智能体实现的 Chat 应用交互的用户具有以下信息流:

  1. 用户通过私信或在 Chat 聊天室中向 Chat 应用发送消息。
  2. Chat 应用逻辑(在 Apps 脚本中实现或作为具有 HTTP 端点的 Web 服务器)接收并处理消息。
  3. Gemini Enterprise AI 智能体接收并处理交互。
  4. (可选)Chat 应用或 AI 智能体可以与 Google Workspace 服务(例如日历或表格)或其他 Google 服务(例如 Google 地图或 YouTube)集成。
  5. Chat 应用使用 Google Chat API 异步发送响应,以传达 AI 智能体的进度。
  6. 响应会传递给用户。

目标

  • 设置环境。
  • 部署 Chat 应用。
  • 配置 Chat 应用。
  • 测试 Chat 应用。

前提条件

设置环境

启用 Chat API

在使用 Google API 之前,您需要在 Google Cloud 项目中启用它们。 您可以在单个 Google Cloud 项目中启用一个或多个 API。

在 Google Cloud 控制台中,启用 Google Chat API。

启用 API

配置 OAuth 权限请求页面

所有使用 OAuth 2.0 的应用都需要配置权限请求页面。通过配置应用的 OAuth 权限请求页面,您可以定义向用户和应用审核者显示哪些内容,还可以注册应用以便以后发布。

  1. 在 Google API 控制台中,依次点击菜单 > Google Auth 平台 > 品牌塑造

    前往“品牌塑造”

  2. 如果您已配置 Google Auth 平台,则可以在品牌塑造受众群体数据访问权限中配置以下 OAuth 权限请求页面设置。如果您看到一条消息,提示尚未配置 Google Auth 平台,请点击开始使用
    1. 应用信息 下的应用名称 中,输入应用的名称。
    2. 用户支持邮箱中,选择一个支持邮箱,供用户针对其同意情况与您联系。
    3. 点击下一步
    4. 受众群体 下,选择内部
    5. 点击下一步
    6. 联系信息下,输入一个邮箱,以便您接收有关项目变更的通知。
    7. 点击下一步
    8. 完成 部分,查看《Google API 服务用户数据政策》,如果您同意,请选择我同意 Google API 服务:用户数据政策
    9. 点击继续
    10. 点击创建
  3. 目前,您可以跳过添加范围。 将来,当您创建的应用供您的 Google Workspace 组织外部使用时,您必须将 用户类型 更改为 外部。然后, 添加应用所需的授权范围。如需了解详情,请参阅完整的 配置 OAuth 权限请求页面指南。

在 Google Cloud 控制台中创建服务账号

按照以下步骤创建具有 Discovery Engine User 角色的新服务账号:

Google Cloud 控制台

  1. 在 Google Cloud 控制台中,依次点击菜单 > IAM 和管理 > 服务账号

    转到“服务账号”

    其余步骤会显示在 Google Cloud 控制台中。

  2. 选择 Google Cloud 项目。
  3. 点击创建服务账号
  4. 输入要在 Google Cloud 控制台中显示的服务账号名称。
  5. 如果您现在不想设置访问权限控制,请点击完成 以完成服务账号的创建过程。如需立即设置访问权限控制,请点击创建并继续 ,然后继续执行下一步。
  6. 可选:向您的服务账号分配角色,以授予对 Google Cloud 项目资源(除了 Google Workspace 资源之外)的访问权限。如需了解详情,请参阅管理对项目、文件夹和组织的访问权限
  7. 点击继续
  8. 可选:输入可以管理此服务账号并使用其执行操作的用户或群组。如需了解详情,请参阅服务账号模拟
  9. 点击完成 以完成服务账号的创建过程。

    记下服务账号的电子邮件地址。

gcloud CLI

  1. 创建服务账号:
    gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
      --display-name="SERVICE_ACCOUNT_NAME"
  2. 可选:向您的服务账号分配角色,以授予对 Google Cloud 项目资源(除了 Google Workspace 资源之外)的访问权限。如需了解详情,请参阅管理对项目、文件夹和组织的访问权限

服务账号会显示在服务账号页面上。

创建一个私钥

如需为服务账号创建并下载私钥,请按以下步骤操作:

  1. 在 Google Cloud 控制台中,依次点击菜单 > IAM 和管理 > 服务账号

    转到“服务账号”

    其余步骤会显示在 Google Cloud 控制台中。

  2. 选择 Google Cloud 项目。
  3. 点击要为其创建密钥的服务账号的电子邮件地址。
  4. 点击密钥 标签页。
  5. 点击添加密钥 下拉菜单,然后选择创建新密钥
  6. 选择 JSON 作为密钥类型 ,然后点击创建

    系统会为您生成新的公钥/私钥对,并将其作为服务账号密钥文件下载到您的 计算机。将下载的 JSON 文件另存为工作目录中的credentials.json 。此文件是此密钥的唯一副本。下载密钥文件后,您无法再次下载。如需了解如何安全地存储 密钥,请参阅 管理服务账号密钥的最佳实践

如需详细了解服务账号,请参阅 Google Cloud IAM 文档中的服务账号

创建并配置 Chat 应用项目

  1. 在 Google API 控制台中,依次点击菜单 > IAM 和管理 > 设置

    前往“IAM 和管理”设置

  2. 记下项目编号项目 ID 字段。

  3. 前往 Gemini Enterprise:

    打开 Gemini Enterprise

  4. 记下应用的位置ID

  5. 点击以下按钮,打开 GE AI 智能体快速入门 Apps 脚本项目。

    打开项目

  6. 依次点击 概览 > 用于创建副本的图标 制作副本

  7. 在 Apps 脚本项目中, 依次点击 项目设置图标 项目设置 > 修改脚本属性 > 添加脚本属性 ,以添加以下脚本属性:

    1. REASONING_ENGINE_RESOURCE_NAME ,其中包含使用在之前的步骤中记下的信息组成的 Gemini Enterprise 应用资源。

      projects/PROJECT_ID/locations/APP_LOCATION/collections/default_collection/engines/APP_ID
      
    2. SERVICE_ACCOUNT_KEY ,其中包含在之前的步骤中下载的服务账号的 JSON 密钥,例如 { ... }

  8. 点击保存脚本属性

  9. 在 Apps 脚本项目中, 点击 项目设置图标 项目设置

  10. Google Cloud Platform (GCP) 项目 下,点击 更改项目

  11. GCP 项目编号 中,粘贴在 之前的步骤中记下的 Google Cloud 项目编号。

  12. 点击设置项目 。Cloud 项目和 Apps 脚本项目现已连接。

创建测试部署

您需要此 Apps 脚本项目的部署 ID,以便在下一步中使用。

如需获取 Head 部署 ID,请执行以下操作:

  1. 在 Chat 应用 Apps 脚本项目中, 依次点击 部署 > 测试部署
  2. Head 部署 ID 下,点击 用于创建副本的图标 复制
  3. 点击完成

配置 Chat 应用

使用 Apps 脚本部署,按照以下步骤部署 Google Chat 应用以进行测试:

  1. API 控制台中,搜索 Google Chat API, 然后点击 Google Chat API
  2. 点击管理
  3. 点击配置 并设置 Chat 应用:

    1. 应用名称 字段中,输入 GE Quickstart
    2. 头像网址 字段中,输入 https://developers.google.com/workspace/add-ons/images/quickstart-app-avatar.png
    3. 说明 字段中,输入 GE Quickstart
    4. 功能 下,选择加入聊天室和群组对话
    5. 在连接设置下,选择 Apps 脚本项目
    6. 部署 ID 字段中,粘贴您之前复制的 Head 部署 ID。
    7. 在“可见性”下,选择您网域中的特定人员和群组,然后输入您的电子邮件地址。
  4. 点击保存

Chat 应用已准备好响应消息。

测试 Chat 应用

如需测试 Chat 应用,请打开与 Chat 应用的私信聊天室并发送消息:

  1. 使用您在添加自己作为受信任的测试人员时提供的 Google Workspace 账号打开 Google Chat。

    转到 Google Chat

  2. 点击 发起新聊天
  3. 添加 1 位或多位用户 字段中,输入 Chat 应用的名称。
  4. 从结果中选择 Chat 应用。系统会打开一条私信。

  5. 在与应用来往的新私信中,输入 I need to find ideas!,然后按 enter

    Chat 应用会使用默认创意生成 智能体响应进行回复。

如需添加受信任的测试人员并详细了解如何测试互动功能,请参阅 测试 Google Chat 应用的互动功能

问题排查

当 Google Chat 应用或 卡片返回错误时, Chat 界面会显示一条消息,提示“出了点问题” 或“无法处理您的请求”。有时,Chat 界面不会显示任何错误消息,但 Chat 应用或卡片会产生意外结果;例如,卡片消息可能不会显示。

虽然 Chat 界面中可能不会显示错误消息, 但当您为 Chat 应用启用错误日志记录功能后,系统会提供描述性错误消息和日志数据,帮助您修复错误。如需查看、 调试和修复错误方面的帮助,请参阅 排查和修复 Google Chat 错误

清理

为避免因本教程中使用的 资源导致您的 Google Cloud 账号产生费用,我们建议您删除 Cloud 项目。

  1. 在 Google API 控制台中,前往管理资源 页面。依次点击 菜单 > IAM 和管理 > 管理资源

    转到资源管理器

  2. 在项目列表中,选择要删除的项目,然后点击 删除 .
  3. 在对话框中输入项目 ID,然后点击关停 以删除 项目。