在 SAP Fiori 应用中启用文本和模糊搜索

ABAP RESTful 应用程序编程模型 › 开发 › 开发通用功能 › 在 SAP Fiori 应用中启用文本和模糊搜索

本主题中的描述是指 SAP HANA 上下文中提供的文本和模糊搜索的功能范围。

文本和模糊搜索

全文搜索(或仅文本搜索)使您能够识别满足查询的自然语言术语,并且可以选择按与查询的相关性(排名)对其进行排序。最常见的搜索类型是查找包含指定术语的文本,并按与这些术语相似的顺序返回。

模糊搜索是 SAP HANA 的快速容错搜索功能。容错搜索的基本概念是,即使搜索词(用户输入)包含附加或缺失字符,甚至拼写错误,数据库查询也会返回记录。模糊搜索可用于各种应用程序 - 例如,在结构化数据库内容中触发容错搜索,例如搜索名为 'coffe krisp biscuit' 的产品,您会找到 'Toffee Crisp Biscuits'。

在 SAP Fiori UI 屏幕中提供自由式搜索功能

在 ABAP RESTful 编程模型的上下文中,只需在数据模型定义中启用文本和模糊搜索功能。为此,您可以使用相应的文本和模糊搜索注释(下面列出)在指定的 CDS 视图中实施它。

备注

但是,作为应用程序开发人员,您必须确保您的 CDS 视图适合启用文本和模糊搜索。有关详细信息,请参阅 SAP HANA 搜索开发人员指南中的相应主题。

文本和模糊搜索的注释

顾名思义,搜索注释启用 CDS 视图元素上的搜索功能。

首先,您需要在视图级别使用以下 CDS 注释:

注释和值

影响

@Search.searchable: true/false

定义 CDS 视图通常是否与搜索场景相关。此注释提供常规开关,以及快速检测视图是否与搜索相关的方法。将 设置为值 true 以通过 @Search 注释启用搜索支持。在此,必须至少将一个视图字段定义为元素级别的 @defaultSearchElement。

元素级别的注释(必填)为:

注释和值

影响

@Search.defaultSearchElement: true/false

指定在全文本搜索中考虑注释元素。

为缺省搜索注释的所有视图元素均定义搜索范围。(将对具有此注释的所有元素执行搜索。)

@Search.fuzzinessThreshold: <value>

此注释指定要在模糊搜索中考虑,元素必须具有的最低模糊性级别。

<value> 定义模糊搜索的阈值(比较两个字符串或两个术语时如何计算模糊评分)。

可能的值为:0..1。默认值为 1。模糊搜索算法计算每个字符串比较的模糊分数。分数越高,字符串越相似。1.0 分表示字符串相同。0.0 分表示字符串没有共同点。

@Search.ranking: <value>

如果自由式搜索词与元素的值匹配,则此注释指定元素(视图字段)的值与排名的相关性。

排名可具有以下值:
  • HIGH - 元素具有高相关性;通常,这对于标识及其描述很有用。

  • MEDIUM - 元素具有中等相关性;通常为重要元素指定。

  • LOW - 尽管元素与自由式搜索相关,但此元素的命中对结果项目的排名没有实际意义。

提示

对于模糊搜索阈值,我们建议使用缺省值 0.7 作为开头。稍后,您可以根据使用搜索的体验微调值。您还可以使用从用户处收集的反馈来微调搜索。

示例

以下清单实施搜索产品的搜索模型。模型定义来自数据源 db_pd,该数据源已指定搜索的持久层。数据源提供产品数据和文本参考字段。

注释 @Search.searchable: true 将视图标记为可搜索。此外,元素 Name 和 Category 使用 @Search.defaultSearchElement: true 进行注释。这意味着在搜索 UI 上启用了自由式搜索,可以在其中搜索注释的元素。注释 @Search.fuzzinessThreshold: 0.7 (0.8) 定义应将文本搜索应用于相似度值为 70% 的元素 Category 以及相似度值为 80% 的元素 Name。

  ...

  @Search.searchable : true

  define view SearchForPuducts as select from db_pd

	key pd_id as ID,

	@Search.defaultSearchElement : true
	@Search.fuzzinessThreshold : 0.8
	@Search.ranking : #HIGH
	pd_text as Name,

	@Search.defaultSearchElement : true
	@Search.fuzzinessThreshold : 0.7
	@Search.ranking : #LOW
	pd_category as Category
  }

结果

如果使用 OData 服务的搜索注释公开 CDS 视图,则 OData 实体集会收到注释 sap:searchable: true。

下图显示了使用含示例 CDS 视图的 OData 服务的 Fiori UI。

标准过滤器允许搜索产品类别和产品名称。