我的服务模式是什么?
所有 Suite: Enterprise 或 Enterprise Plus
Support,含 Guide Enterprise

帮助中心联合搜索支持终端用户在帮助中心搜索结果中查看外部内容。这意味着,当终端用户在您的帮助中心搜索时,搜索结果不仅限于您的帮助中心文章或社区帖子。联合搜索可以将搜索范围扩大到外部知识库、学习管理软件、博客和您网站的页面等。您的终端用户还可以按类型(例如按博客文章)筛选搜索。

外部内容搜索结果显示在帮助中心搜索、背景信息面板的知识部分以及统一搜索 API 回复中。它们不会显示在支持搜索的其他界面中,例如即时搜索或文章搜索 API。

您可以使用以下任一方法在帮助中心进行联合搜索:

  • 网络抓取程序:可用于在帮助中心进行联合搜索,而无需使用开发者资源。您可在帮助中心搜索设置中设置多个抓取程序,用以抓取相同或不同网站的内容并将其编入索引。
  • 联合搜索 API:REST API 支持您将外部内容的记录提取到 Zendesk 搜索索引中。此方法要求开发者构建并维护一个中间件层,以便将托管外部内容的网站与帮助中心整合起来。

您可以同时使用 API 和抓取程序。但是,如果您通过 API 删除了来源或类型,则为已删除的来源或类型创建或更新记录的抓取程序都将停止工作。

本文章涵盖以下主题:

  • 关于网络抓取程序方法
  • 关于联合搜索 API 方法
  • 外部内容来源和类型

关于网络抓取程序方法

您可以设置一个或多个网络抓取程序,以抓取相同或不同网站中的外部内容并建立索引,供在帮助中心进行搜索的用户使用。

要设置网络抓取程序以进行联合搜索,请参阅使用网络抓取程序对外部内容建立索引。

关于联合搜索 API 方法

开发者可通过 Zendesk 提供的 REST API 建立自定义整合,从而将外部内容记录提取到您的帮助中心搜索索引中。要提取外部内容进行搜索,开发者必须将托管外部内容的应用程序和外部内容 API 整合在一起。

Zendesk 联合搜索说明图

配置后,API 会提取外部内容记录,并将其添加到帮助中心搜索索引。当帮助中心搜索引擎回复用户搜索查询时,已建立索引的记录即可供帮助搜索引使用。
注意:如果您的帮助中心主题创建于 2019 年 9 月 25 日之前,您可能需要修改主题以使用联合搜索。

要使用 API 配置联合搜索,请自行完成与 Zendesk REST API 的整合,然后提取您要在搜索结果中显示的内容。请参阅联合搜索 API 参考文档。

设置联合搜索之后,您需要选择帮助中心搜索结果中包含和排除的内容。请参阅在帮助中心搜索结果中包含外部内容。

在专员的背景信息面板“知识”部分的搜索结果中,您还可以包括外部内容。请参阅配置背景信息面板中的知识组别。

外部内容来源和类型

无论您使用哪种设置方法,联合搜索提取的每条内容记录都带有内容源和内容类型,方便终端用户筛选搜索结果。来源是指外部内容的来源,例如论坛、问题跟踪程序或学习管理系统。“类型”是指内容的类型,例如博客文章、技术注释或错误报告。请参阅管理帮助中心外部内容的来源和类型筛选。

您可以使用联合搜索 API 或在设置网络抓取程序时定义来源和类型。如果您使用 API 定义来源和类型,它们将在网络抓取程序设置期间可供选择。同样,如果您在设置网络抓取程序时创建内容来源和类型,它们将反映在外部内容类型和外部内容源 API 中。

您可以配置搜索结果,以包含或排除外部内容来源。当外部内容包含在帮助中心搜索中时,搜索筛选器将按来源和类型名称对内容进行分组,方便用户轻松找到所需的信息。“来源”根据来源对内容进行分组(例如博客),“类型”根据内容类型(例如开发者文档)对内容进行分组。

在创建外部内容来源和类型时,请考虑实用的分组和名称,因为这将有助于终端用户在帮助中心轻松筛选并找到正在搜索的内容。

由 Zendesk 提供技术支持