定义同义词

在引用某种概念或事物时，组织通常会采用独特的术语或多种引用方式。建议您定义同义词以建立等效术语，从而帮助用户在搜索时找到相关项。

注意 ：只能为第三方数据源定义自定义同义词，而不能为 Google Workspace 数据源（例如 Google 云端硬盘或 Gmail）定义自定义同义词。

如需定义同义词，您可以使用 _dictionaryEntry 常用架构来将项编入索引。

类型为 _dictionaryEntry 的项可以具有以下属性：

属性	类型	说明	是否必需？
_term	string	需要定义的术语。推荐值是不带连字符的字词或不带标点符号的短语。	必填
_synonym	string (repeated)	需要包含在与 _term 中定义的字符串匹配的查询中的替代术语。	必填
_onlyApplicableForAttachedSearchApplications	boolean	可让您按数据源和搜索应用对同义词进行分组。如需了解详情，请参阅定义特定于数据源的同义词。	可选

注意 ：使用 _dictionaryEntry 架构编入索引的项不会计入搜索应用中的数据源限制。

当用户在查询中包含 _term 属性的值时，有效查询将变为“字词 OR 同义词”。例如，如果术语 "scifi" 使用同义词 "science fiction" 进行定义，则包含字词 "scifi" 的查询会匹配包含 "scifi" 或 "science fiction." 的项

同义词只能单向应用。如果您在查询中添加了 "science fiction,"，则 Cloud Search 将不会在查询中应用任何同义词。该查询仅匹配包含 "science fiction." 的项。包含 "scifi" 的项会被忽略。

如需让两个术语可以相互换用，请分别定义各个术语：

术语	同义词
scifi	science fiction
science fiction	scifi

在查询处理期间，系统会在应用同义词之前移除连字符和其他标点符号。用户查询 "sci-fi" 与 _term "sci fi." 匹配。如需为用户可能用连字符连接的术语创建同义词，请首先将 _term 标准化以使用空格而非连字符。

继续上面的示例，以下用户查询定义将 "sci-fi," "sci fi," "scifi," 和 "science fiction" 视为可以相互换用：

术语	同义词
scifi	science fiction, sci fi
sci fi	science fiction, scifi
science fiction	scifi, sci fi

注意 ：您最长可能需要等待 5 小时才能处理同义词并用其来重写查询。

默认情况下，任何数据源中的同义词都适用于整个网域。具体而言，无论数据源如何，同义词都会应用于搜索应用中的所有搜索。如果您需要数据源专用同义词，请参阅定义数据源专用同义词。

使用 Cloud Search SDK 定义全局同义词

您可以使用 Content Connector SDK 定义术语及其同义词。有关构建连接器的说明，请参阅创建内容连接器。

以下代码段演示了如何根据 CSV 文件记录构建表示术语和同义词的 RepositoryDoc：

DictionaryConnector.java

在 GitHub 上查看

/**
 * Creates a document for indexing.
 *
 * For this connector sample, the created document is domain public
 *  searchable. The content is a simple text string.
 *
 * @param record The current CSV record to convert
 * @return the fully formed document ready for indexing
 */
private ApiOperation buildDocument(CSVRecord record) {
  // Extract term and synonyms from record
  String term = record.get(0);
  List<String> synonyms = StreamSupport.stream(record.spliterator(), false)
      .skip(1) // Skip term
      .collect(Collectors.toList());

  Multimap<String, Object> structuredData = ArrayListMultimap.create();
  structuredData.put("_term", term);
  structuredData.putAll("_synonym", synonyms);

  if (Configuration.getBoolean("dictionary.attachedToSearchApp", false).get()) {
    structuredData.put("_onlyApplicableForAttachedSearchApplications", true);
  }

  String itemName = String.format("dictionary/%s", term);

  // Using the SDK item builder class to create the item
  Item item =
      IndexingItemBuilder.fromConfiguration(itemName)
          .setItemType(IndexingItemBuilder.ItemType.CONTENT_ITEM)
          .setObjectType("_dictionaryEntry")
          .setValues(structuredData)
          .setAcl(DOMAIN_PUBLIC_ACL)
          .build();

  // Create the fully formed document
  return new RepositoryDoc.Builder()
      .setItem(item)
      .build();
}

定义同义词时，请注意以下事项：

• 同义词条目必须在网域范围内公开。在上述示例中，这是通过将 ACL 设置为 DOMAIN_PUBLIC_ACL 来实现的。
• 不得为配置文件定义以下属性，因为这些属性会替换代码中的网域公开设置：
  • defaultAcl.mode=FALLBACK
  • defaultAcl.public=true

定义特定于搜索应用的同义词

默认情况下，同义词会应用于所有搜索应用中的所有数据源。

不过，假设贵组织有单独的工程团队和销售团队，并且您希望为每个团队提供不同的搜索体验，包括特定于工作角色的同义词。在这种情况下，您可以创建一个使用工程专用数据源和同义词的搜索应用，以及另一个使用销售专用数据源和同义词的搜索应用。为实现此目标，请使用 _onlyApplicableForAttachedSearchApplications=true 为特定数据源中的每个同义词编制索引。此设置会限制同义词，使其仅应用于包含特定数据源的搜索应用。

例如，将以下代码行添加到上一个代码示例中可确保编入索引的同义词因数据源而异：

structuredData.put("_onlyApplicableForAttachedSearchApplications", true);