diff --git a/terms-extraction/README.md b/terms-extraction/README.md index 278ddaa..36601f0 100644 --- a/terms-extraction/README.md +++ b/terms-extraction/README.md @@ -4,7 +4,7 @@ ## Teeft -Le service Teeft renvoie les cinq termes les plus spécificiques d'un texte, en +Le service Teeft renvoie les termes les plus spécificiques d'un texte, en français ou en anglais. ### Bibliographie @@ -40,7 +40,7 @@ | nb | nombre de termes à récupérer au maximum (de `1` à `Infinity`, `5` par défaut) | | indent | `true` ou `false`, indente le JSON résultat ou non (`false` par défaut) | -#### Exemple de teeft/fr +##### Exemple de teeft/fr En entrée: @@ -99,7 +99,7 @@ | nb | nombre de termes à récupérer au maximum (de `1` à `Infinity`, `5` par défaut) | | indent | `true` ou `false`, indente le JSON résultat ou non (`false` par défaut) | -#### Exemple de teeft/en +##### Exemple de teeft/en En entrée: @@ -142,3 +142,83 @@ } ] ``` + +#### v1/teeft/with-numbers/fr + +Prend en entrée un JSON avec deux champs: `id` et `value`, et renvoie un JSON +avec un tableau de 5 termes (par défaut) dans le champ `value`. + +Ne fonctionne correctement que sur un texte en français de plusieurs +paragraphes. +La différence par rapport à [v1/teeft/fr](#v1teeftfr) est que les chiffres sont +encodés avant traitement (et décodés après), ce qui peut produire des termes +incluant des nombres. + +##### Paramètres + +| nom | description | +| :----- | :---------------------------------------------------------------------------- | +| nb | nombre de termes à récupérer au maximum (de `1` à `Infinity`, `5` par défaut) | +| indent | `true` ou `false`, indente le JSON résultat ou non (`false` par défaut) | + +#### v1/teeft/with-numbers/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. + +Cette version `with-numbers` de [v1/teeft/en](#v1/teeft/en) encode les chiffres +avant de traiter le texte, et les décode ensuite, évitant ainsi certains +mécanismes d'élimination des nombres. + +##### Paramètres + +| nom | description | +| :----- | :---------------------------------------------------------------------------- | +| nb | nombre de termes à récupérer au maximum (de `1` à `Infinity`, `5` par défaut) | +| indent | `true` ou `false`, indente le JSON résultat ou non (`false` par défaut) | + +##### Exemple + +En entrée: + +```json +[ + { + "id": "MPES-ERM_ER2023_000737", + "value": "Flow control based 5 MW wind turbine enhanced energy production for hydrogen generation cost reduction" + }, + { + "id": "MPES-ERM_ER2023_001916", + "value": "Study on the Motion Characteristics of 10 MW Superconducting Floating Offshore Wind Turbine Considering 2nd Order Wave Effect" + } +] +``` + +En sortie: + +```json +[ + { + "id": "MPES-ERM_ER2023_000737", + "value": + [ + "flow control", + "5 mw wind turbine", + "energy production", + "hydrogen generation cost" + ] + }, + { + "id": "MPES-ERM_ER2023_001916", + "value": + [ + "motion characteristics", + "10 mw", + "offshore wind turbine", + "2nd order wave" + ] + } +] +```