向网页中添加搜索 widget

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

准备工作

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

过程

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

添加使用授权令牌的 widget

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

    AI Applications

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

  3. 点击 Integration (集成)。

  4. 点击 Widget (微件)标签页。

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

  6. 指定 widget 页面的域名:

    1. 输入将显示 widget 的页面的域名。

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

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

    2. 点击 Add (添加)。

  7. 针对将显示 widget 的每个网域重复执行第 6 步。

  8. 点击保存

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

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

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

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

  13. 定期设置新令牌,方法是在当前令牌到期之前重复执行上一步。

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

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

    AI Applications

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

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

  3. 点击 Integration (集成)。

  4. 点击 Widget (微件)标签页。

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

  6. 指定 widget 页面的域名:

    1. 输入将显示 widget 的页面的域名。

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

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

    2. 点击 Add (添加)。

  7. 针对将显示 widget 的每个网域重复执行第 6 步。

  8. 点击保存

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

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

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

      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 的示例

如需查看嵌入在公开网页中的搜索 widget,请参阅 试用!

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

此搜索 widget 适用于以下配置:

  <gen-search-widget
    configId="123456"
    anchorsTarget="_blank"
    placeholder="Search the Agent Search documentation"
    alwaysOpened>
  </gen-search-widget>