Recommendations : documentation technique

Recommendations

Il existe un système de recommendations pour udata, sous la forme d'un plugin.

Ce plugin permet d'ajouter des recommendations à plusieurs jeux de données. Les recommendations peuvent provenir de plusieurs sources et sont triées par rapport à un score. Chaque source de recommendation doit exposer un JSON en HTTPS. Les recommendations sont triées par ordre décroissant sur chaque jeu de données par rapport à un score, fixé par chaque source de recommendation, allant de 100 à 1.

Le plugin permet un stockage de recommendations provenant de plusieurs sources dans les extras. Les n meilleures recommendations sont ensuite affichées en bas de page d'un jeu de données, faisant un lien vers d'autres jeux de données pertinents.

Ajout de recommendations

L'ajout de recommendations se fait à partir d'un tâche, qui est programmée à la fréquence XXXXX. La commande supprime toutes les recommendations puis ajoute toutes les recommendations provenant de multiples sources, telles que définies dans le fichier de configuration udata.cfg.

udata job run recommendations-add

Suppression de recommendations

Il est possible de supprimer toutes les recommendations à l'aide d'une tâche.

udata job run recommendations-clean

Sources de recommendations

data.gouv.fr utilise actuellement plusieurs sources de recommendations en production :

• des recommendations ajoutées à la main, qui permettent de faire un choix éditorial. Ce contenu peut être mis à jour sur le dépot etalab/datagouvfr-recommendations-edito à partir d'un fichier YAML. La validité des recommendations est vérifiée en CI et le document JSON est hébergé par GitHub Pages. La source est nommée matomo.
• des recommendations propres aux schémas. L'objectif est de recommander le jeu de données consolidé propre à chaque schéma : pour le JDD contenant les bornes IRVE de la Seine-Maritime, recommender le JDD de la base nationale consolidée des IRVE. Les données utilisées sont l'attribut schema sur les ressources et les données statiques de consolidation. La génération de ces recommendations est faites de manière automatique et régulière (CI/CD) et l'hébergement est sur GitHub Pages. Le code se trouve sur etalab/schema.data.gouv.fr. La source est nommée schemas.
• des recommendations par rapport aux visites sur data.gouv.fr. Le but est de générer des recommendations par rapport aux visites effectives sur data.gouv.fr, sur les 30 derniers jours. Ces recommendations pointent vers les 50 JDD les plus visités. La génération de ces recommendations est faites de manière automatique tous les 3 jours et l'hébergement est sur GitHub Pages. Le code se trouve sur etalab/piwik-covisits. La source est nommée edito.