从 Custom Search Site Restricted JSON API 迁移

如果您使用可编程搜索引擎的 Custom Search Site Restricted JSON API,则可以使用 Vertex AI Search 在几分钟内创建和部署 Google 品质的网站限定搜索。如需部署应用,您可以使用搜索 widget,只需将代码从 Google Cloud 控制台直接复制到网页中,无需编写任何代码。或者,您也可以实现 API 部署,以控制搜索功能在您网站上的显示方式。如需详细了解如何使用此 API,请参阅获取包含网站数据的应用的搜索结果的 REST 标签页,以及 REST 参考文档中的 servingConfigs.search 方法。

除了 Vertex AI Search 随搜索结果返回的标准短摘要之外,您还可以为搜索添加高级功能。这些功能包括为搜索结果生成摘要搜索并跟进(用于允许跟进问题的情境感知型搜索),以及提取式回答(用于与每个搜索结果一起返回的提取文本)。若要为网络搜索启用这些高级功能,您需要验证域名,并且需要支付额外的索引编制费用。

您还可以过滤排序搜索结果,并应用宣传控件,以将链接显示为宣传结果。

如需了解详情,请参阅 Vertex AI Agent Builder 价格页面。

设置 Vertex AI Search

如需设置 Vertex AI Search,请按以下步骤操作:

  1. 在 Google Cloud 控制台的项目选择器页面上,选择您用于自定义搜索网站专用 JSON API 的项目。

  2. 开启 Vertex AI Agent Builder

创建搜索应用

如需创建搜索应用,请按以下步骤操作:

  1. 在 Google Cloud 控制台中,前往 Agent Builder 页面。

    Agent Builder

  2. 点击创建应用

  3. 创建应用页面的搜索网站下方,点击创建

  4. 确保企业版功能已开启。这对于网站搜索是必需的。如需了解详情,请参阅企业版功能

  5. 关闭高级 LLM 功能。关闭此设置后,您将获得与可编程搜索引擎的 Custom Search Site Restricted JSON API 类似的功能。如果您不需要搜索摘要或搜索跟进功能,请关闭此设置。如需了解详情,请参阅高级 LLM 功能

  6. 您的应用名称字段中,输入应用的名称。

  7. 贵公司或组织的外部名称字段中,输入贵公司或组织的通用名称。

  8. 选择全球作为应用的位置,然后点击继续

  9. 数据存储区页面上,点击创建数据存储区

  10. 选择数据源窗格中,选择网站内容

  11. 关闭高级网站索引编制功能。关闭此设置后,您将获得与可编程搜索引擎的 Custom Search Site Restricted JSON API 类似的功能。如果您不需要搜索摘要或搜索跟进功能,或者您不拥有您指定的网域,请停用此设置。如需了解详情,请参阅高级网站索引编制

  12. 指定要编入索引的网址模式窗格的要包含的网站字段中,输入要搜索的网站的网址模式,然后点击继续

  13. 配置数据存储区窗格中,输入数据存储区的显示名称,然后点击创建

  14. 数据存储区页面上,选择新的数据存储区,然后点击创建

部署搜索应用

确定您计划如何对 Vertex AI Search 搜索应用进行身份验证:使用 OAuth 2.0 或 API 密钥。如需了解每种方法的优点和缺点,请参阅身份验证简介

部署搜索应用 (OAuth 2.0)

如需使用 OAuth 2.0 身份验证部署搜索应用,请按以下步骤操作:

  1. 如需设置 OAuth 2.0,请参阅向 Vertex AI Agent Builder 进行身份验证中的 On Google Cloud。请务必向服务账号添加 Discovery Engine UserDiscovery Engine Viewer 角色。

  2. 通过以下任一方式部署搜索应用:

部署搜索应用(API 密钥)

如需使用 API 密钥进行身份验证来部署搜索应用,请按以下步骤操作:

  1. 创建 API 密钥:

    1. 在 Google Cloud 控制台中,转到凭据页面。

      凭据

    2. 如果您尚未进入项目,请在 Google Cloud 控制台页面顶部的项目列表中选择您的项目。

    3. 点击创建凭据,然后选择 API 密钥请勿添加任何引荐来源网址限制。部分用户隐私设置不会传递引荐来源网址。

      • 请记下生成的 API 密钥,您将在调用 searchLite 方法时使用。
    4. 为提高安全性,请向您的 API 密钥添加 HTTP 限制,以限制对 https://discoveryengine.googleapis.com/* 的 Vertex AI Agent Builder 服务的访问权限。

  2. 使用该 API 部署搜索应用。 请参阅 获取包含网站数据的应用的搜索结果(API 键)以及 REST 参考文档中的 servingConfigs.searchLite 方法。如需对网页搜索查询的结果进行排序,请参阅对网页搜索结果进行排序

身份验证简介

可编程搜索引擎的 Custom Search Site Restricted JSON API 使用 API 密钥进行身份验证。不过,除了少数例外情况外,Vertex AI Search 需要使用 OAuth 2.0。如果您想继续使用 API 密钥进行身份验证,则需要通过 API 调用使用 searchLite 方法。

如果您选择通过 OAuth 2.0 进行身份验证,则需要使用 search 方法和 answer 方法查询您的网站;此外,您还可以通过无代码搜索 widget 部署搜索应用。

下表列出了将 searchLite 方法与 API 密钥身份验证搭配使用与将 searchanswer 方法与 OAuth 2.0 身份验证搭配使用之间的区别。

功能/方法 searchLite 方法 search 方法
Authentication API 密钥 OAuth 2.0
可使用搜索微件
搜索摘要
搜索公共网站

后续步骤