Capacités
La configuration des capacités d'une colonne influence les filtres disponibles dans l'API ainsi que ceux de l'affichage tabulaire du jeu de données sur un portail. Cette configuration doit être réalisée pour chaque colonne d'un jeu de données, dans la section Schéma de la page d'édition du jeu de données.
Pour activer ou désactiver les capacités d'une colonne, sélectionnez la colonne souhaitée, puis suivez ces étapes :
- Cliquez sur le bouton Configuration technique ;
- Activez ou désactivez les capacités selon vos besoins ;
- Appliquez les modifications à votre schéma.
Les capacités sont définies par colonne, et c'est le type de chaque colonne qui définit les capacités disponibles. Lorsque vous activez une capacité spécifique, un suffixe correspondant est débloqué dans l'API. Ce suffixe doit être ajouté à la clé de la colonne pour être utilisé.
Prenons l'exemple du jeu de données des Journées Européennes du Patrimoine 2025 en Bretagne. La clé de la colonne intitulée "Description courte - FR" est description_courte_fr (accessible en cliquant sur le schéma).
Si vous souhaitez appliquer le filtre contient les caractères sur cette colonne, vous devrez ajouter le suffixe _contains à cette clé, ce qui donne description_courte_fr_contains. Pour vérifier si la chaîne de caractères "visit" est présente dans les valeurs de cette colonne, vous devez inclure le paramètre description_courte_fr_contains=visit dans votre requête :
https://demo.koumoul.com/data-fair/api/v1/datasets/journees-europeennes-du-patrimoine-2025-bretagne/lines?size=20&page=1&q_mode=complete&description_courte_fr_contains=visit
=> 5 lignes ont la chaîne de caractères "visit" dans leur "Description courte - FR".
Dans les sections suivantes, nous allons explorer les différents suffixes disponibles.
Capacités sur un champ textuel
- Filtrable sur valeur exacte débloque : _eq : égal, _in : dans, _neq : n'est pas égal, _nin : n'est pas de dans et _starts : commence par. Cette capacité débloque également les sections de recherche égal et commence par sur la colonne du tableau ainsi que le bouton de filtre par valeur exacte.
Le filtre _eq est un filtre "strictement égal à".
Le filtre _in est un filtre "strictement égal à une des valeurs". Dans le tableau, si plusieurs valeurs sont renseignées dans le filtre égal, c'est ce suffixe qui sera utilisé dans la requête d'API.
Le filtre _neq est un filtre "strictement different de". (disponible qu'à partir de l'API).
Le filtre _nin est un filtre "strictement different de chacune des valeurs" . (disponible qu'à partir de l'API).
Le filtre _starts est un filtre éxact sur le début de la chaine de caratère. Ce filtre est sensible à la casse, autrement dit, si la valeur commence par une majuscule, il faudra commencer par la même majuscule dans le filtre.
- Texte analysé pour recherche textuelle débloque : _search : contient les mots => recherche sur mot exact. Exemple : recherche sur le mot visiteur => contient les résultats pour le mot visiteur => 1 résultat.
Dans le tableau de données, il y a une seule et unique ligne où la colonne intitulée Description courte - Fr inclut spécifiquement le mot visiteur dans les données de cette colonne.
- Texte analysé spécifiquement pour la langue française débloque : _search : contient les mots => recherche sur mot approximatif. Il y a plus de résultats sur cette cabalité que sur la précédente. Exemple : recherche sur le mot visiteur => contient les résultats du mot visite également par exemple => 7 résultats.
Dans le tableau de données, il y a septs lignes où la colonne intitulée Description courte - Fr inclut les mots proches de visiteur, tels que visiteurs, visite, visites etc. les données de cette colonne.
Si les deux capacité Texte analysé pour recherche textuelle et Texte analysé spécifiquement pour la langue française sont cochées, c'est cette dernière qui sera appliquée.
- Texte filtrable sur groupe de caractères débloque : _contains : contient des caractères => recherche exacte sur une suite de caractères.
Exemple :
recherche sur mel => 0 résultat
recherche sur Mel => 1 résultat
Dans le tableau de données, il y a trois lignes où la colonne intitulée Description courte - Fr inclut les carateres visiteur, tels que le mot visiteur ou le mot visiteurs les données de cette colonne.
Capacités non liées aux filtres :
- Triable et groupables débloque : paramètre sort et les routes values_agg et valeurs disctictes. Ajoute les fleches de tri sur la tableau.
- Statitiques de mots : débloque la route words_agg (Exemple : https://koumoul.com/data-fair/api/v1/datasets/c5sgtpezly8px-2p329wnwz0/words_agg?field=description_courte_fr) utilisé dans les visualisations
Capacité sur un champ nombre
- Filtrable sur valeur exacte débloque : _eq : égal, _in : dans, _neq : n'est pas égal, _nin : n'est pas de dans et _gte : supérieur ou égal et _lte : inférieur ou égal
- Triable et groupable débloque : Calculer une métrique (metric_agg) => Ajoute les fleches de tri sur la tableau
Capacité sur un champ date ou date et heure
- Filtrable sur valeur exacte débloque : _eq : égal, _in : dans, _neq : n'est pas égal, _nin : n'est pas de dans et _gte : supérieur ou égal et _lte : inférieur ou égal Affiche les champs de recherche supérieur ou égal et inférieur ou égal dans le tableau
- Triable et groupable débloque : Calculer une métrique (metric_agg) => Affiche les fleches de tri sur la tableau
Capacité sur un champ booléen
- Filtrable sur valeur exacte débloque : _eq : égal, _in : dans, _neq : n'est pas égal et _nin : n'est pas de dans Affiche les deux valeurs de filtre oui/non sur le tableau
- Triable et groupable débloque : Calculer une métrique (metric_agg) => Ajoute les fleches de tri sur la tableau
Si vous avez des remarques sur ce cours, n'hésitez pas à nous les communiquer.