将搜索微件添加到网页

本页介绍了如何使用搜索 widget 向网站添加搜索功能。

准备工作

在向网页添加搜索微件之前,请务必先配置搜索微件,具体方法请参阅为搜索微件配置结果。请注意,您无法调整网页中搜索微件的样式。

过程

向网页添加搜索微件的流程因您选择的授权类型而异:

  • 授权令牌:该 widget 使用代码库提供的 JWT 或 OAuth 令牌。您必须拥有自己的服务器,才能使用该服务器生成令牌。该身份验证令牌用于代表用户或服务账号进行 API 调用。生成身份验证令牌时,请使用 OAuth 范围 https://www.googleapis.com/auth/cloud-platform

  • 公开访问:该 widget 不会限制哪些人可以从搜索查询中获得结果。

添加使用授权令牌的 widget

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

    AI 应用

  2. 点击要修改的应用的名称。

  3. 点击集成

  4. 点击微件标签页。

  5. 选择基于 JWT 或 OAuth 作为 widget 授权类型。

  6. 指定微件页面的域名:

    1. 输入将显示该微件的网页的域名。

      例如,如果您要将该微件复制到网页 example.com/ai.htmlcymbal.example.com/search.html,请输入 example.com 作为网域。如果您只希望该微件在子网域中的某个网页上运行,请输入 cymbal.example.com

      如果您想在本地主机上测试该 widget,请输入 localhost

    2. 点击添加

  7. 针对要显示该微件的每个网域重复第 6 步。

  8. 点击保存

  9. 复制将以下代码复制到您的 Web 应用部分中提供的代码段。

  10. 可选:进行以下更改以自定义搜索微件的行为:

    • 如需改为在新标签页中打开网页上的搜索结果,请将以下代码添加到复制的代码段中。默认情况下,非结构化文档中的结果会在新标签页中打开,而网络中的结果会在与微件相同的页面中打开。

      anchorsTarget="_blank"
      

      例如:<gen-search-widget configId="..." anchorsTarget="_blank"></gen-search-widget>

    • 如需自定义搜索栏中的占位符文本,请将以下代码添加到复制的代码段中:

      placeholder="CUSTOM_PLACEHOLDER"
      

      例如:<gen-search-widget configId="..." placeholder="Start your search here"></gen-search-widget>

    • 如需在不使用触发器的情况下始终显示该 widget,请将以下代码添加到复制的代码段中:

      alwaysOpened
      

      例如:<gen-search-widget alwaysOpened></gen-search-widget>

  11. 在您的代码库中,生成授权令牌。

  12. 如需将授权令牌传递给微件,请使用将以下代码复制到您的 Web 应用部分中提供的第二个代码段“// Set authorization token”,并将文本 <JWT or OAuth token provided by you backend> 替换为授权令牌。

  13. 在当前令牌过期之前,通过重复上一步来定期设置新的令牌。

添加具有公开访问权限的 widget

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

    AI 应用

  2. 点击要修改的应用的名称。

    对于公开访问权限,请确保搜索应用未与任何受访问权限控制的数据存储区相关联。

  3. 点击集成

  4. 点击微件标签页。

  5. 选择公开访问作为 widget 授权类型。

  6. 指定微件页面的域名:

    1. 输入将显示该微件的网页的域名。

      例如,如果您要将该微件复制到网页 example.com/ai.htmlcymbal.example.com/search.html,请输入 example.com 作为网域。如果您只希望该微件在子网域中的网页上运行,请输入 cymbal.example.com

      如果您想在本地主机上测试该 widget,请输入 localhost

    2. 点击添加

  7. 针对要显示该微件的每个网域重复第 6 步。

  8. 点击保存

  9. 复制将以下代码复制到您的 Web 应用部分中提供的代码段。

  10. 可选:进行以下更改以自定义搜索微件的行为:

    • 如需改为在新标签页中打开网页上的搜索结果,请将以下代码添加到复制的代码段中。默认情况下,非结构化文档中的结果会在新标签页中打开,而网络中的结果会在与微件相同的页面中打开。

      anchorsTarget="_blank"
      

      例如:<gen-search-widget configId="..." anchorsTarget="_blank"></gen-search-widget>

    • 如需自定义搜索栏中的占位符文本,请将以下代码添加到复制的代码段中:

      placeholder="CUSTOM_PLACEHOLDER"
      

      例如:<gen-search-widget configId="..." placeholder="Start your search here"></gen-search-widget>

    • 如需在不使用触发器的情况下始终显示该 widget,请将以下代码添加到复制的代码段中:

      <gen-search-widget alwaysOpened></gen-search-widget>

  11. 将代码段粘贴到您的网页中。

嵌入式公开访问 widget 示例

如需查看嵌入到公开网页中的搜索微件,请参阅试用 Vertex AI Search 页面。

始终处于打开状态的 widget 的外观
“试用 Vertex AI Search”搜索 widget

此搜索微件适用于以下配置:

  <gen-search-widget
    configId="123456"
    anchorsTarget="_blank"
    placeholder="Search something about AI Applications"
    alwaysOpened>
  </gen-search-widget>