diff --git a/authors-tools/README.md b/authors-tools/README.md index 8c02df8..cd8fa97 100755 --- a/authors-tools/README.md +++ b/authors-tools/README.md @@ -1,54 +1,60 @@ - # Authors-tools -URL du webservice : https://authors-tools-1.services.inist.fr. +URL du webservice : . Elle offre plusieurs services autour des auteurs dans les notices bibliographiques: -- `orcid-disambiguation`: octroie un orcid a un auteur si celui-ci existe dans l'API ORCID. -- `ml-orcid`: utilise des méthodes de Machine Learning pour désambigüsier un corpus co-écrit par un `nom d'auteurs` (à distinguer d'`auteur`) +- `orcid-disambiguation`: octroie un ORCID à un auteur si celui-ci existe dans + l'API ORCID, +- `ml-orcid`: utilise des méthodes de Machine Learning pour désambigüiser un + corpus co-écrit par un `nom d'auteurs` (à distinguer d'`auteur`). Pas encore + disponible. ## Utilisation ### v1/orcid-disambiguation -**Fichier d'entrée** -Un objet au format json représenté comme suite : -```python -objet = { - "id" : "0000-0002-8279-9690", - "value" : { - "authorname" : "Laurent DUPONT", - "title" : "Applying a Living Lab Approach to Smart Grid Training Course Design", - "affiliation" : "Université de Lorraine ERPI / ENSGSI: NANCY, FR ", - "publication_date" : 2020 +### Fichier d'entrée + +Un objet au format JSON représenté comme suit : + +```json +{ + "id" : "0000-0002-8279-9690", + "value" : { + "authorname" : "Laurent DUPONT", + "title" : "Applying a Living Lab Approach to Smart Grid Training Course Design", + "affiliation" : "Université de Lorraine ERPI / ENSGSI: NANCY, FR ", + "publication_date" : 2020 } } ``` -L'`id` peut prendre n'importe quel valeur qui permet d'identifier l'objet. Dans le cas ci-dessus, nous avons choisi l'Orcid de l'auteur. -`value` contient la notice. les champs de la notice qui seront traités sont : -`authorname`, `title`, `affiliation`, `coauthors`, `ids`, `keywords`, `publication_date`, `journal`, `email`. -**NB** : Seul le champ authorname est obligatoire. +L'`id` peut prendre n'importe quelle valeur qui permet d'identifier l'objet. +Dans le cas ci-dessus, nous avons choisi l'ORCID de l'auteur. +`value` contient la notice. +Les champs de la notice qui seront traités sont : `authorname`, `title`, +`affiliation`, `coauthors`, `ids`, `keywords`, `publication_date`, `journal`, +`email`. -**Fichier de sortie** +> **NB** : Seul le champ `authorname` est obligatoire. -On a : -```python -objet = { - "id" : "000-0002-8279-9690", - "value" : { - "orcid": "000-0002-8279-9690" - "score" : 0.23076923076923078, +### Fichier de sortie + +On a : + +```json +{ + "id" : "000-0002-8279-9690", + "value" : { + "orcid": "000-0002-8279-9690" + "score" : 0.23076923076923078 + } } ``` - - - - ## ML disambiguation **En cours d'élaboration**