帮助中心联合搜索支持终端用户在帮助中心搜索结果中查看外部内容。这意味着,当终端用户在您的帮助中心搜索时,搜索结果不仅限于您的帮助中心文章或社区帖子。联合搜索可以将搜索范围扩大到外部知识库、学习管理软件、博客和您网站的页面等。您的终端用户还可以按类型(例如按博客文章)筛选搜索。
您可以使用以下任一方法在帮助中心进行联合搜索:
- 联合搜索 API:REST API,支持您将外部内容的记录提取到 Zendesk 搜索索引中。此方法要求开发者构建并维护一个中间件层,以便将托管外部内容的网站与帮助中心整合起来。
- 搜索抓取程序:可在 Guide 的“搜索”设置中配置,搜索抓取程序可用于在帮助中心实施联合搜索,无需开发者资源。您可在帮助中心搜索设置中设置多个抓取程序,用以抓取相同或不同网站的内容并将其编入索引。
您可以同时使用 API 和抓取程序。但是,如果您通过 API 删除了来源或类型,则为已删除的来源或类型创建或更新记录的抓取程序都将停止工作。
本文章涵盖以下主题:
搜索抓取程序的工作方式
您可以设置一个或多个搜索抓取程序,以抓取外部内容并将其编入索引,供在帮助中心进行搜索的用户使用。您要抓取的外部网站必须有一个网站地图,其中列出了搜索抓取程序可以抓取的页面。此外,您要抓取的页面必须是公开的(无需身份验证)。如果您想在帮助中心添加已通过身份验证的内容,必须使用外部内容 API。
配置后,抓取程序每 12 到 24 小时运行一次,访问您在设置期间指定的网站地图中的页面,并将这些来源的内容提取到帮助中心搜索索引中。搜索抓取程序会在初始页面加载时将页面源中的内容编入索引,即使该内容已被 UI 元素(如可折叠面板)隐藏。然而,由于抓取程序不运行 JavaScript,它们无法抓取 JavaScript 呈现的内容或初始页面加载后动态呈现的其他内容。抓取程序也无法抓取所访问页面上的链接。它们只能按照配置访问网站地图中可以使用的页面。
您可以设置多个抓取程序,以抓取相同或不同网站的内容并将其编入索引。请参阅设置搜索抓取程序。
当用户进行搜索时,抓取程序发现的相关外部内容将进行排名,并显示在搜索结果页面上,用户可以筛选结果,并单击链接以在另一个浏览器标签中查看外部内容链接。有关筛选的更多信息,请参阅面向终端用户的帮助中心指南。
联合搜索 API 的工作方式
开发者可通过 Zendesk 提供的 REST API 建立自定义整合,从而将外部内容记录提取到您的帮助中心搜索索引中。要提取外部内容进行搜索,开发者必须将托管外部内容的应用程序和外部内容 API 整合在一起。
配置后,API 会提取外部内容记录,并将其添加到帮助中心搜索索引。当帮助中心搜索引擎回复用户搜索查询时,已建立索引的记录即可供帮助搜索引使用。
有关更多信息,请参阅设置 Zendesk 联合搜索 API。
外部内容来源和类型
无论您使用哪种设置方法,联合搜索提取的每条内容记录都带有内容源和内容类型,方便终端用户筛选搜索结果。请参阅编辑搜索筛选。
您可以使用联合搜索 API 或在 Guide 中设置搜索抓取程序时定义来源和类型。如果您使用 API 定义来源和类型,它们将在搜索抓取程序设置期间可供选择。同样,如果您在设置搜索抓取程序时创建内容来源和类型,它们将反映在 external_content_type 和 external_content_source API 中。请参阅 Zendesk 联合搜索 API 参考。
您可以配置搜索结果,以包含或排除外部内容来源。当外部内容包含在帮助中心搜索中时,搜索筛选器将按来源和类型名称对内容进行分组,方便用户轻松找到所需的信息。“来源”根据来源对内容进行分组(例如博客),“类型”根据内容类型(例如开发者文档)对内容进行分组。
在创建外部内容来源和类型时,请考虑实用的分组和名称,因为这将有助于终端用户在帮助中心轻松筛选并找到正在搜索的内容。请参阅编辑搜索筛选。
联合搜索的已知限制
以下是联合搜索的所有已知限制:
- 外部内容搜索结果显示在帮助中心搜索、背景信息面板的知识部分,以及统一搜索 API 回复中。它们不会显示在支持 Guide 搜索的其他界面中,例如即时搜索或文章搜索 API。
- 搜索抓取程序不适用于使用 gzip 文件压缩编码的网站。您将不会看到来自这些网站的搜索结果。
- 搜索抓取程序不会遵守在外部网站 robots.txt 记录中设置的抓取延迟。