Accès aux enrichissements

Toutes les URL suivantes sont accédées via la méthode HTTP GET.

Les URL d'accès aux enrichissements sont de la forme :

| Syntaxe | |------------ | ------------- | | URI | https://api.istex.fr/document/{id}/enrichments/{type} | | Paramètres | - {id} : l'identifiant ISTEX du document auquel correspond la notice,
- {type} : type de l'enrichissement (ex : "multicat" pour les catégories WOS et Science-Metrix). | | Code de retour | - 200 si OK,
- 404 si le fichier n'est pas trouvé| | Détails | La liste des enrichissements disponibles pour un objet documentaire est accessible si on ne précise pas de type.
On obtiendra alors un JSON avec cette liste, par exemple :

{
  id: "087661D669BF44CA05AA6CE08ADD6399F6A439C4",
  enrichments: {
    multicat: [{
      original: false,
      mimetype: "application/tei+xml",
      extension: "tei",
      uri: "https://api.istex.fr/document/087661D669BF44CA05AA6CE08ADD6399F6A439C4/enrichments/multicat"
    }]
  }
}

Si le document interrogé ne possède aucun enrichissement, l'API renverra un message JSON, comme :

{
  id: "0134F1716893F9118DCE7278BE3333CC40D50461",
  _error: "Il n'existe actuellement aucun résultat pour ce type de data"
}

Pour plus de détails sur les champs envoyés en réponse, consultez le chapitre correspondant.

Il est possible de récupérer plusieurs types d'enrichissement en une seule fois en séparant les types voulus par des ,(virgules).
Dans ce cas, l'API renverra une archive au format ZIP.

Pour consolider les enrichissements avec le TEI présent dans le fulltext, il suffit d'activer l'option ?consolidate dans la requête.
La consolidation peut se combiner avec la récupération de plusieurs types d'enrichissement.| | Types existants | - abesAuthors : auteurs extraits du Hub de métadonnées de l'ABES,
- abesSubjects : sujets extraits du Hub de métadonnées de l'ABES,
- multicat : catégories Web Of Science et Science-Metrix du document,
- nb : catégories déterminées par méthode bayésienne naïve,
- refBibs : références bibliographiques extraites de GROBID,
- teeft : Term Extraction for English FullText, extraction sur le fulltext anglais par étiquetage morpho-syntaxique ,
- unitex : entités nommées détectées par Unitex-CasSys. | | Exemple | https://api.istex.fr/document/0134F1716893F9118DCE7278BE3333CC40D50461/enrichments
https://api.istex.fr/document/087661D669BF44CA05AA6CE08ADD6399F6A439C4/enrichments
https://api.istex.fr/document/087661D669BF44CA05AA6CE08ADD6399F6A439C4/enrichments/multicat
https://api.istex.fr/document/087661D669BF44CA05AA6CE08ADD6399F6A439C4/enrichments/multicat?consolidate
https://api.istex.fr/document/0B894D0911C91F04D21BD372C741AAD5C8781B35/enrichments/multicat,refBibs
https://api.istex.fr/document/0B894D0911C91F04D21BD372C741AAD5C8781B35/enrichments/multicat,refBibs?consolidate

Proposer des enrichissements

Si vous avez une idée d'enrichissement et que vous souhaitez l'intégrer dans l'API, vous pouvez nous contacter à api-team@listes.istex.fr.

L'enrichissement en question se doit d'être un fichier TEI de la forme :

document
  └── teiCorpus
          └── TEI                             (1)
              └── standOff
                  ├──   teiHeader             (2)
                  │       ├── fileDesc
                  │   │   └── titleStmt
                  │   │       ├── title
                  │   │       ├── respStmt
                  │   │       │   ├── resp
                  │   │       │   └── name
                  │   │       └── extent
                  │   └── revisionDesc
                  │       └── change
                  └ ...

(1) : TEI sont les balises contenant l'enrichissement en question. L'arborescence se doit d'être exacte pour pouvoir intégrer le TEI de base.

(2) : teiHeader est la balise contenant les informations pouvant décrire le type d'enrichissement (title), un descriptif sur ce dernier (resp), les personnes liées (name), les corpus concernés (extent) ou encore les différentes dates de mise à jour (change)

Les TEI doivent impérativement contenir l'identifiant ISTEX sous la forme istex-{id} pour permettre le recoupement avec les données actuelles.

Exemple :