diff --git a/terms-extraction/README.md b/terms-extraction/README.md index 730d65b..9f711dc 100644 --- a/terms-extraction/README.md +++ b/terms-extraction/README.md @@ -1,10 +1,56 @@ # Terms extraction +Ce serveur propose des services d'extraction de termes dans des textes. + ## Teeft +Le service Teeft renvoie les cinq termes les plus spécificiques d'un texte, en +français ou en anglais. + +### Bibliographie + +Cuxac P., Kieffer N., Lamirel J.C. : SKEEFT: indexing method taking into account the structure of the document. 20th Collnet meeting, 5-8 Nov 2019, Dalian, China. + ### Configuration Paquets npm nécessaires: - `@ezs/teeft`, - `@ezs/basics` + +### Utilisation + +- [v1/teeft/fr](#v1/teeft/fr) +- [v1/teeft/en](#v1/teeft/en) + +#### v1/teeft/fr + +Prend en entrée un JSON avec deux champs: `id` et `value`, et renvoie un JSON +avec un tableau de 5 termes (au plus) dans le champ `value`. + +Ne fonctionne correctement que sur un texte en français de plusieurs +paragraphes. +Peut être perturbé par la présence de formules mathématiques, chimiques, *etc.*, +ou de tableaux. + +##### Paramètres de v1/teeft/fr + +| nom | description | +| :----- | :--------------------------------------------------------------------- | +| indent | `true` ou `false`, indente le JSON résultat ou non (`false` par défaut) | + +#### v1/teeft/en + +Prend en entrée un JSON avec deux champs: `id` et `value`, et renvoie un JSON +avec un tableau de 5 termes (au plus) dans le champ `value`. + +Ne fonctionne correctement que sur un texte en anglais de plusieurs paragraphes. + +Peut être perturbé par la présence de formules mathématiques, chimiques, *etc.*, +ou de tableaux. + +##### Paramètres de v1/teeft/en + +| nom | description | +| :----- | :--------------------------------------------------------------------- | +| indent | `true` ou `false`, indente le JSON résultat ou non (`false` par défaut) |