Définir des synonymes

Il est courant qu'une organisation utilise une terminologie unique ou des façons de faire référence à un concept ou à un élément. Vous devez définir des synonymes pour établir des équivalences de termes afin d'aider les utilisateurs à trouver des éléments lorsqu'ils effectuent une recherche.

Les synonymes sont définis en indexant des éléments avec le schéma _dictionaryEntry connu.

Les éléments de type _dictionaryEntry peuvent avoir les propriétés suivantes:

Propriété Type Description Obligatoire ?
_terme string Terme à définir. Les valeurs recommandées sont des mots ou des expressions sans trait d'union, sans ponctuation. Obligatoire
_synonyme chaîne (répété) Autres termes à inclure dans les requêtes correspondant à la chaîne définie dans _term. Obligatoire
_onlyApplicableForAttachedSearchApplications booléen Permet de regrouper des synonymes par source de données et application de recherche. Pour en savoir plus, consultez Définir des synonymes spécifiques à une source de données. Facultatif

Lorsqu'un utilisateur inclut la valeur de la propriété _term dans une requête, la requête effective devient term OR synonymes. Par exemple, si le terme "science-fiction" est défini avec le synonyme "fiction", une requête contenant le mot "science-fiction" correspond aux éléments contenant "science-fiction" ou "science-fiction".

Les synonymes ne sont pas appliqués de manière bidirectionnelle. Si la requête porte plutôt sur "science-fiction", Cloud Search n'applique aucun synonyme. La requête ne renvoie que les éléments contenant "Science-fiction". Les éléments avec "science-fiction" ne sont pas inclus.

Pour que les deux termes soient interchangeables, définissez chaque terme séparément:

Terme Synonymes
science fiction science-fiction
science-fiction science fiction

Lors du traitement des requêtes, le trait d'union et les autres signes de ponctuation sont supprimés avant l'application des synonymes. La requête utilisateur "Science-fiction" correspond à la requête _term "Science-fiction". Pour créer des synonymes pour des termes pouvant être utilisés par les utilisateurs, commencez par normaliser les _term afin d'utiliser des espaces blancs au lieu des traits d'union.

Pour reprendre l'exemple, les définitions suivantes associent les requêtes de recherche "science-fiction", "science fiction", "science fiction" et "science-fiction" :

Terme Synonymes
science fiction science-fiction, science-fiction
science-fiction science-fiction, science-fiction
science-fiction science fiction, science-fiction

Par défaut, les synonymes d'une source de données s'appliquent à l'ensemble d'un domaine. Plus précisément, les synonymes sont appliqués aux applications de recherche pour toutes les recherches, quelle que soit la source de données. Si vous souhaitez utiliser des synonymes spécifiques à une source de données, consultez Définir des synonymes spécifiques à une source de données.

Définir des synonymes globaux à l'aide du SDK Cloud Search

Vous pouvez utiliser le SDK Content Connector pour définir des termes et leurs synonymes. Pour savoir comment créer un connecteur, consultez Créer un connecteur de contenu.

L'extrait de code suivant illustre la création d'une RepositoryDoc représentant le terme et le synonyme en fonction d'un enregistrement de fichier CSV:

DictionaryConnector.java
/**
 * 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();
}

Tenez compte des points suivants lorsque vous définissez des synonymes:

  • Les entrées de synonymes doivent être publiques. Dans l'exemple précédent, il suffit pour cela de définir la LCA sur DOMAIN_PUBLIC_ACL.
  • Les propriétés suivantes ne doivent pas être définies pour votre fichier de configuration, car elles remplacent le paramètre public du domaine dans votre code :
    • defaultAcl.mode=FALLBACK
    • defaultAcl.public=true

Définir des synonymes d'application spécifiques à la recherche

Par défaut, les synonymes sont appliqués à toutes les sources de données de toutes les applications de recherche.

Supposons toutefois que votre organisation dispose d'équipes d'ingénieurs et de ventes distinctes, et que vous souhaitiez offrir à chaque équipe une expérience de recherche différente, avec des synonymes de postes spécifiques. Dans ce cas, vous pouvez créer une application de recherche avec une source de données et des synonymes spécifiques à l'ingénierie, et une autre avec une source de données et des synonymes spécifiques aux ventes. Pour atteindre cet objectif, indexez chaque synonyme dans une source de données spécifique à l'aide de _onlyApplicableForAttachedSearchApplications=true. Ce paramètre limite les synonymes afin qu'ils ne soient appliqués qu'aux applications de recherche qui incluent une source de données spécifique.

Par exemple, en ajoutant la ligne de code suivante à l'exemple de code précédent, vous vous assurez que les synonymes indexés sont spécifiques à la source de données:

structuredData.put("_onlyApplicableForAttachedSearchApplications", true);