API Thésaurus INRAE

Cette page s’adresse aux agents INRAE qui souhaitent utiliser le Thésaurus INRAE comme référentiel thématique dans un système d’information ou dans une application. Il présente les services disponibles. Les développeurs et chefs de projets informatiques qui souhaitent savoir comment paramétrer l’API se référeront à la documentation technique.

 

Le Thésaurus INRAE est exposé via la Plateforme d’intégration comme d’autres référentiels institutionnels.

Accès au service

L’accès aux API de la Plateforme d’intégration nécessite la création d’un compte utilisateur. Si vous n’en avez pas, demandez un compte utilisateur.

Accéder au service.  Pour en savoir plus sur la Plateforme d’intégration, lire plus bas.

Les utilisateurs hors INRAE sont invités à utiliser l’API publique Swagger disponible à cette adresse : https://consultation.vocabulaires-ouverts.inrae.fr/api/

Origine des données exposées

L’API expose les données issues de la version courante du Thésaurus INRAE, le référentiel thématique d’INRAE.

C’est une liste structurée de plus de 15 000 concepts, représentés linguistiquement par des termes (100% français, 66% anglais), et reliés par des relations sémantiques (générique-spécifique; association). Ils peuvent avoir une définition et des relations d’équivalence vers des concepts d’autres référentiels publics (thésaurus et ontologies).

Les concepts sont organisés au sein de 62 micro-thésaurus couvrant les domaines d’intérêt de l’institut. Ils peuvent aussi être présentés au sein de groupes (ou collections). Le Thésaurus INRAE est représenté dans le modèle standard SKOS (W3C).

Exemple pour le concept « pois / pea »
Bleu : concepts ; Marron : (micro)thésaurus ; Jaune : classe RDF ; Blanc : divers

Consulter la documentation ou visiter le Thésaurus INRAE.

Services disponibles

Actuellement, l’API Thésaurus offre les services qui permettent de :

  • récupérer l’ensemble des concepts du Thésaurus INRAE
  • chercher un ou plusieurs concepts en indiquant une chaîne de caractères (éventuellement plusieurs)
  • distinguer les concepts actifs (ou valides) des concepts inactifs (dits obsolètes ou dépréciés)

Note : l’API est en cours de construction. De nouveaux services et des évolutions seront disponibles prochainement. Faites-nous part de vos besoins : contactez-nous.

/concepts

Retourne les informations détaillées de tous les concepts correspondant aux filtres de recherche passés en paramètres. /concepts/actifs ne renvoie que les concepts valides et /concepts/inactifs que les concepts obsolètes.

Filtres

  • label : sur les termes (prefLabel, altLabel et hiddenLabel en SKOS) des concepts.  Il est possible d’indiquer plusieurs chaînes de recherche en utilisant plusieurs fois ce paramètre. Ex. : /concepts?label=abeille&label=prairie&label=...Il renverra les concepts ayant un terme contenant « abeille » OU « prairie » ;
    Le label peut aussi être recherché avec un joker ( * ) en début, au milieu ou à la fin de la chaîne recherchée. Par exemple, pour recherche les termes finissant par « plant » comme « eggplant » ou « refrigerating plant » : /concepts?label=*plant.
    La recherche est insensible à la casse, aux accents et fonctionne avec un minimum 3 caractères ;
  • limit : Nombre d’éléments à retourner par la requête. La valeur est un nombre entier positif (10 par défaut, 500 maximum) ;
  • offset : Indice de l’élément de départ dans la collection. Cette indice permet de naviguer dans les résultats lorsque la réponse est composée de plusieurs pages contenant une réponse partielle. La valeur est un nombre entier positif (0 par défaut).

Informations renvoyées

  • uri : Identifiant du concept ;
  • deprecated : Spécifie si le concept est actif (false) ou inactif (true) ;
  • topConceptOf : Microthésaurus et thésaurus pour lesquels le concept est situé au 1er niveau de la hiérarchie ;
  • conceptScheme : Microthésaurus et thésaurus auxquels appartient le concept ;
  • prefLabel : Etiquette lexicale préférentielle du concept dans une langue donnée ;
  • altLabel : Etiquette lexicale alternative (synonyme) du concept ;
  • hiddenLabel : Etiquette lexicale cachée, utilisée par le système lors d’opérations de recherche textuelle libre (libellés potentiellement mal orthographiés) afin que l’utilisateur puisse trouver le bon concept, mais qui doit être masquée à l’utilisateur ;
  • narrower : Lien hiérarchique vers un concept plus spécifique ;
  • broader : Lien hiérarchique vers un concept plus générique ;
  • definition : Explication formelle d’un concept dans une langue donnée. La source de la définition est indiquée dans un élément « source » ;
  • collection : Groupes nommés de concepts pouvant appartenir à des microthésaurus différents ;
  • exactMatch : Identifiant d’une ressource externe au thésaurus, par exemple l’uri d’un concept défini dans un autre thésaurus. La propriété « exactMatch » indique une équivalence entre les 2 ressources, i.e. qu’elles peuvent être utilisés de façon interchangeable dans une large majorité d’applications de recherche d’informations.

Pour plus de détails, consulter la documentation et le modèle de données dans la Console API sur le Plateforme d’intégration.

Dans quels cas utiliser l’API Thésaurus INRAE

L’API a pour vocation de répondre à différents besoins :

  • alimenter un module d’indexation permettant à l’utilisateur de rechercher le ou les concepts pertinents pour annoter un document, un jeu de données… Dans ce cas, utiliser /concepts/actifs
  • à partir d’une liste de termes enregistrés dans un tableur Excel et de la fonction =SERVICEWEB(), vérifier leur présence dans le thésaurus et récupérer les identifiants des concepts correspondants le cas échéant. Dans ce cas, on voudra interroger tous les concepts, y compris ceux qui sont inactifs (obsolètes). Utiliser /concepts

Qu’est-ce que la Plateforme d’intégration ?

Ce service de la DSI vise à permettre à vos applications ou processus informatiques d’intégrer les données référentielles du système d’information institutionnel par différents mécanismes et protocoles tels que :

  • des API REST. Cela permet la récupération de données à la demande tout en diminuant la saisie d’information dans votre application. Vous connaissez peut-être ce service sous le nom de PADRE (Plateforme d’Acquisition des Données Référentielle d’Exposition);
  • des Web services SOAP ;
  • des flux / fichiers de données délivrés régulièrement. Ils sont une représentation statique de données extraites d’un système d’information ;
  • des évènements. Ce sont des Messages d’informations en temps réel sur des données de références.

La Plateforme d’intégration assure un haut niveau de disponibilité des ressources exposées. Accéder au catalogue (en intranet) pour voir les référentiels disponibles.

Pour plus d’informations sur la Plateforme d’intégration, voir la documentation technique générique et la section dans Ariane.