ID d'enrichissement

Si vous souhaitez appliquer un enrichissement personnalisé que vous avez créé pour une collection à une autre, vous devez connaître l'ID unique qui a été généré pour l'enrichissement lors de sa création. Utilisez l'API pour répertorier les enrichissements du projet dans lequel l'enrichissement personnalisé est utilisé. La liste renvoyée inclut les informations d'ID d'enrichissement.

Pour les enrichissements préconfigurés, les ID uniques ne changent pas. Le tableau suivant répertorie les ID associés à chaque type d'enrichissement prégénéré et identifie les langues de collection pour lesquelles l'enrichissement est pris en charge. Un enrichissement ne peut pas être appliqué à une collection sauf si la langue de la collection est prise en charge par l'enrichissement.

Pour plus d'informations sur toutes les langues prises en charge, voir Support de langue.

Appliquer des enrichissements à l'aide de l'API

Pour appliquer un enrichissement à l'aide de l'API, procédez comme suit:

1. Déterminez la base URL pour le point de terminaison et le jeton ou la clé API pour votre déploiement.

   Pour plus d'informations, voir Génération d'applications personnalisées avec l'API.

2. Obtenez l'ID de votre projet.

   Dans l'interface utilisateur du produit, accédez à la page Intégrer et déployer > Afficher les informations d'API, puis copiez l'ID de projet.

3. Si vous ne connaissez pas l'ID de la collection à laquelle vous souhaitez appliquer l'enrichissement, obtenez une liste de vos collections pour la trouver.

   Par exemple :

   GET $authentication $url/v2/projects/$project_id/collections?version=2019-11-22
   

   Le collection_id est renvoyé.

4. Envoyez une demande GET pour renvoyer la configuration de la collection qui répertorie les enrichissements appliqués.

   Par exemple :

   GET $authentication $url/v2/projects/$project_id/collections/$collection_id?version=2019-11-22
   

   Pour les ID d'enrichissement des enrichissements préconfigurés, voir ID d'enrichissement.

5. Ajoutez l'enrichissement que vous souhaitez appliquer.

   Par exemple, pour ajouter l'enrichissement Mots clés, vous pouvez inclure l'enrichissement dans la liste des enrichissements. Tout d'abord, obtenez son ID à partir de la table.

   L'ID d'enrichissement de mots clés est 701db916-fc83-57ab-0000-000000000018. Pour indiquer que vous souhaitez appliquer l'enrichissement Mots-clés au contenu de la zone text des documents de la collection, vous pouvez le représenter au format JSON comme suit:

   {
       "enrichment_id" : "701db916-fc83-57ab-0000-000000000018",
       "fields" : [ "text" ]
   }
   

   Tous les enrichissements que vous spécifiez remplacent les enrichissements par défaut. Par conséquent, si vous souhaitez conserver un enrichissement par défaut, n'oubliez pas de l'inclure dans la liste des enrichissements que vous appliquez à la collection. Pour la liste des enrichissements par défaut par type de projet, voir enrichissements par défaut par type de projet.

   Par exemple, pour conserver l'enrichissement Entities et ajouter l'enrichissement Mots-clés, vous pouvez spécifier ce qui suit dans le corps de la demande.

   "enrichments": [
     {
       "enrichment_id": "701db916-fc83-57ab-0000-00000000001e",
       "fields": [
         "text"
       ]
     },
     {
       "enrichment_id": "701db916-fc83-57ab-0000-000000000018",
       "fields": [
         "text"
       ]
     }
   ]
   

6. Soumettez le corps de demande JSON mis à jour avec la méthode update collection pour appliquer l'enrichissement à votre collection.

   Par exemple :

   POST $authentication -d '$requestBody' $url/v2/projects/$project_id/collections/$collection_id?version=2019-11-22