Articles · API, Correspondance

Une API de correspondance qui montre son raisonnement

Publié le Par l’équipe de Crown Intelligence

Le nouveau point d’accès de correspondance évalue une personne, une entreprise ou un navire par rapport à une collection et explique chaque score, critère par critère. Voici comment l’appeler et comment lire la réponse.

Un score n’est pas une explication#

Un résultat de vérification doit être examiné par une personne, et souvent justifié devant un auditeur. Un simple chiffre comme 0.87 n’aide ni l’un ni l’autre. Ils doivent voir quels éléments concordent : le nom, la date de naissance, la nationalité, un numéro IMO.

Appeler l’API#

Envoyez une ou plusieurs requêtes à POST /api/match/<collection>, où la collection est l’une des suivantes : default, sanctions, peps, crime ou maritime :

curl -X POST "https://api.crownintelligence.net/api/match/sanctions" \
  -H "content-type: application/json" \
  -d '{"queries":{"q1":{"schema":"Person",
       "properties":{"name":["Jane Example"],
                     "birthDate":["1970"],
                     "nationality":["ca"]}}}}'

Chaque requête peut comporter un nom, une date de naissance, une nationalité, un numéro IMO et un type d’entité. Plusieurs requêtes peuvent être envoyées dans un même appel, chacune sous sa propre clé.

Lire la réponse#

Pour chaque requête, la réponse énumère les fiches candidates avec un score global, un indicateur match et une liste features. Chaque critère indique ce qui a été comparé, son score et sa pondération, ainsi qu’une explication en langage clair, par exemple quels éléments du nom concordent et dans quelle mesure. Chaque résultat indique aussi sa liste source, le programme lorsqu’il est publié, et la date de la dernière observation à la source, avec un lien vers la fiche complète.

Autres nouveautés#

  • /api/search/<collection> effectue des recherches au sein d’une seule collection.
  • /api/reconcile/<collection> offre la même fonction de correspondance à OpenRefine, de sorte qu’un tableur de noms puisse être rapproché de nos données.