search

Cour-de-cassation / judilibre-search

API de recherche et de consultation de la plateforme JUDILIBRE.
15 stars 4 forks source link

readme

L'API Judilibre

La documentation présente est disponibles sur le Github du code source de l'API Judilibre

L'API Judilibre assure la publication des décisions rendues publiquement par la Cour de cassation, enrichies et pseudonymisées.

Au fur et à mesure du calendrier établi par l’arrêté du 28 avril 2021 s’ajouteront les décisions rendues par d’autres juridictions de l’ordre judiciaire, telles les décisions civiles, sociales et commerciales des cours d’appel (mars 2022).

L’API Judilibre, mise à disposition via le portail PISTE et accessible gratuitement après inscription, permet notamment de rechercher en plein texte ou suivant des critères spécifiques parmi l’ensemble de ces décisions.

Les données disponibles via l'API sont celles de la version du site de la Cour de cassation (https://courdecassation.fr/recherche-judilibre).

Cette version de l'API est une version bêta. Elle permet de recueillir vos remarques et vos suggestions d’amélioration. Elle est donc suceptible d'évoluer les prochains mois.

Conditions d'utilisation

L'utilisation de ces données est soumise :

Premiers pas sur Piste et sur l'API

L'accès piste : 4 étapes

API Endpoints

La documentation technique sur chaque méthode de l'API est disponible sur le portail api.gouv.fr (OpenAPI 3.0.2) PISTE (Swagger) ou sur le Github.

Les endpoints racine sont disponibles pour deux environnement (nécessitent donc l'enrôlement préalable et l'obtention d'un KeyId) :

Note : ces URLs ne sont pas directement accessibles via une navigation classique et nécessitent a minima la spécification de votre KeyId dans l'en-tête des requêtes (voir ci-après).

Tester l'API

Pour les plus rapides, vous avez identifié que votre KeyId dans votre APP_SANDBOX, vous pouvez forger vous-même vos requêtes :

curl -is -H "accept: application/json" -H "KeyId: %keyId%" -X GET "https://sandbox-api.piste.gouv.fr/cassation/judilibre/v1.0/search?query=brevet"

{"page":0,"page_size":10,"query":{"query":"brevet","field":[],"type":[],"theme":[],"chamber":[],"formation":[],"jurisdiction":[],"publication":[],"solution":[]},"total":2025,"previous_page":null,"next_page":"query=brevet&field=&type=&theme=&chamber=&formation=&jurisdiction=&publication=&solution=&page=1","took":25,"max_score":2934.1016,"results":[{"score":1,"highlights":{"text":["européen et d'un <em>brevet</em> français se résout par la substitution du <em>brevet</em>...}

Ou par navigation :

Vous verrez apparaître le JSON de réponse dans l'encadré juste après.

Exploitation du zonage

Le zonage désigne les informations permettant de découper le texte des décisions en sections identifiées (cf. /taxonomy?id=field) :

Le zonage est défini par un objet zones disponible dans le retour des API /decision et /export et qui se présente comme suit :

{
  "zones": {
    "introduction": [
      {
        "start": 0,
        "end": 1649
      }
    ],
    "expose": [
      {
        "start": 1649,
        "end": 2204
      }
    ],
    "moyens": [
      {
        "start": 2204,
        "end": 4753
      }
    ],
    "motivations": [
      {
        "start": 4753,
        "end": 7543
      }
    ],
    "dispositif": [
      {
        "start": 7543,
        "end": 7924
      }
    ],
    "annexes": [
      {
        "start": 7924,
        "end": 45372
      }
    ]
  }
}

Chaque zone contient une liste de fragments, dont les items start et end contiennent respectivement l'indice de début (inclus) et de fin (exclu) du fragment correspondant dans le texte intégral (propriété text).

Attention : chaque zone peut contenir plusieurs fragments et ceux-ci ne sont pas forcément séquentiels ! Autrement dit : il peut y avoir dans la zone moyens des fragments qui se situent, dans le texte, après certains fragments définis dans la zone motivations !

Afin de faciliter le traitement et l'affichage des zones côté front, il est recommandé de procéder à leur linéarisation préalable, comme suit (exemple en javascript) :

const text = result.text;
const zones = result.zones;

const orderedZones = [];
for (let zone in zones) {
  zones[zone].forEach((fragment) => {
    orderedZones.push({
      zone: zone,
      start: fragment.start,
      end: fragment.end,
    });
  });
}
orderedZones.sort((a, b) => {
  if (a.start < b.start) {
    return -1;
  }
  if (a.start > b.start) {
    return 1;
  }
  return 0;
});

// La liste orderedZones contient désormais les zones ordonnées séquentiellement :
orderedZones.forEach((zone) => {
  const textFragment = text.substring(zone.start, zone.end);
  console.log(`Zone: ${zone.zone}`);
  console.log(`Fragment: ${textFragment}`);
});

Tests de l'API via Docker

docker run --env WITHOUT_ELASTIC=true -p 80:8080/tcp opendatajustice/judilibre-search:master

Des données statiques, destinées aux tests fonctionnels de base, sont inclues :