从 Custom Search Site Restricted JSON API 迁移

如果您使用可编程搜索引擎的 Custom Search Site Restricted JSON API，则可以使用 Vertex AI Search 在几分钟内创建并部署 Google 品质的网站受限搜索。如需部署应用，您可以将代码从 Google Cloud 控制台直接复制到网页中，然后使用搜索 widget，无需编写任何代码。或者，您也可以实现 API 部署，以便控制搜索功能在您网站上的显示方式。 如需详细了解如何使用该 API，请参阅 Get search results for an app with website data（获取包含网站数据的应用的搜索结果）的 REST 标签页，以及 REST 参考中的 servingConfigs.search 方法。

除了 Vertex AI Search 随搜索结果返回的标准简短摘要外，您还可以为搜索添加高级功能。其中包括搜索结果的生成式摘要、可进行后续提问的上下文感知型后续搜索，以及随每个搜索结果返回的提取文本的提取式答案。若要使用这些高级网页搜索功能，您需要验证网域，并且会产生额外的索引编制费用。

您还可以过滤或排序搜索结果，并应用推广控制将链接显示为推广结果。

如需了解详情，请参阅 AI 应用价格页面。

设置 Vertex AI Search

如需设置 Vertex AI Search，请按照以下步骤操作：

  1. 在 Google Cloud 控制台的项目选择器页面上，选择您一直用于 Custom Search Site Restricted JSON API 的项目。

  2. 开启 AI Applications。

创建搜索应用

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

  1. 在 Google Cloud 控制台中，前往 AI Applications 页面。

    AI 应用

  2. 点击创建应用。

  3. 在创建应用页面的在 AI 模式下搜索网站下方，点击创建。

  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，请参阅对 AI 应用进行身份验证中的在 Google Cloud 上。请务必向服务账号添加 Discovery Engine User 或 Discovery Engine Viewer 角色。

  2. 通过以下方式之一部署搜索应用：

部署搜索应用 (API 密钥)

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

  1. 创建 API 密钥：

    1. 在 Google Cloud 控制台中，前往凭据页面。

      凭据

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

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

      • 请记下生成的 API 密钥，将用于调用 searchLite 方法。

    4. 为提高安全性，请向您的 API 密钥添加 HTTP 限制，以限制对 https://discoveryengine.googleapis.com/* 的 AI Applications 服务的访问权限。

  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 密钥身份验证）与使用 search 和 answer 方法（采用 OAuth 2.0 身份验证）之间的区别。

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

后续步骤