Moissonneur de l'API ISTEX

Le programme istex-api-harvester est un utilitaire en ligne de commande permettant de moissonner les corpus requêtés par l'API de la plateforme Istex. Il est écrit en NodeJS.

Avantages :

• il gère l'authentification au serveur en dehors du réseau interne de l'Inist-CNRS
• il permet d'extraire de gros corpus, sans limitation de taille
• il est possible de paramétrer la taille du corpus à télécharger (paramètre size)
• plusieurs modes de tri sont proposés en supplément du tri par pertinence effectué par défaut : un tri des documents en fonction de certain champs (paramètre sortBy), ou bien un tri aléatoire (paramètre rankBy=random) avec la possibilité de retrouver cet ordre aléatoire grâce au chiffre unique randomSeed

Mode d'emploi :

• ce programme est disponible sur GitHub.

Installation :

• suivre les étapes suivantes :

  • installation de Git (Windows, MacOS ou Linux) : https://git-scm.com/downloads ou plus spécifiquement pour Windows : https://gitforwindows.org/ et Linux Ubuntu : https://guide.ubuntu-fr.org/server/git.html
  • installation de NodeJs (Windows, MacOS ou Linux) : https://nodejs.org/en/download/

  • cloner la distribution

    git clone https://github.com/istex/istex-api-harvester.git

  • lancement du terminal Git Bash depuis le dossier ainsi créé : Démarrer /Toutes les Applications / Git Bash
  • installation du moissonneur : npm install -g istex-api-harvester

Astuces :

• les options de cet utilitaire sont listées sur le dépôt GitHub
• il est nécessaire d'indiquer le nombre de documents à extraire. Sans précision, aucun document n'est moissonné.

• les métadonnées au format JSON étant extraites par défaut, si on ne souhaite que les fichiers textes, utiliser l'option -M avec une chaîne vide, c’est-à-dire un blanc entre doubles quotes : -M ""

  • Exemple : moissonnage du texte intégral au format txt, sans les métadonnées, de 590 documents correspondant à la requête querya1.txt, à télécharger dans le répertoire «corpusAncien»

  istex-api-harvester -F txt -M "" -o corpusAncien -s 600 --query="'cat querya1.txt'"

• si le corpus est volumineux, il faut augmenter la durée de vie de la fonction Scroll. Celle-ci est de 30 s par défaut. Avec un tel délai, le parcours des 100 résultats de la "page courante" peut s’avérer trop long et entraîner une erreur 404 renvoyée par l'API.

  • Exemple : moissonnage du texte intégral au format PDF et des métadonnées associées de 17 257 documents contenant le terme "arctic" dans le titre ou le résumé, à télécharger dans le répertoire Polaris (la durée de vie de la fonction Scroll a été portée à 5 mn)

  istex-api-harvester -t 5m -F pdf -o Polaris -s 17500 -q "title:arctic OR abstract:arctic"