Syntaxe des requêtes

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

__Pour apprendre à interroger l’API (Part1) et (Part2) n'hésitez pas à consulter les tutoriels multimédias :

__

La recherche s'effectue sous la forme :

• Formatage des résultats renvoyés :

{
    total : nombre de résultats,
    hits : [{
            id : id du document,
            title : titre du document,
            abstract : résumé du document,
            metadata : [{
                    type : type MIME du document,
                    uri : URI d'accès au document,
                    original : document d'origine éditeur ou généré par nos soins
                }
                ,
                ...
                (suite des formats de métadonnées disponibles)
            ],
            fulltext : [{
                    type : type MIME du document,
                    uri : URI d'accès au document,
                    original : document d'origine éditeur ou généré par nos soins
                }
                ,
                ...
                (suite des formats de fulltext disponibles)
            ]}
        ,
        (suite des résultats)
        ...
    ]
}

Les requêtes prises en charge sont celles suivant la syntaxe de la bibliothèque de recherche Lucene.

De manière générale, une requête est une suite de termes recherchés.

De base, les termes sont recherchés dans tous les champs indexés (titre, auteur, résumé, fulltext...).

Les termes cherchés sont reliés par des opérateurs booléens, l'opérateur OR étant celui par défaut. Les opérateurs supportés sont OR, AND, NOT, ainsi que les opérateurs d'inclusion/exclusion + et -.

L'utilisation d'expressions régulières est également disponible, à l'aide des délimiteurs //. Elles se basent sur la classe java RegExp.

Il est également possible d'effectuer des recherches de type "fuzzy", basées sur la distance de Damerau-Levenshtein. Pour cela, il suffit de rajouter le symbole ~ (tilde) à la fin du terme recherché.

La recherche de proximité permet, quant à elle, de trouver une suite de mots, distant d'une valeur définie. Il suffit d'utiliser les "" (guillemets) pour rassembler les mots, puis d'ajouter un ~ (tilde) accompagné de la distance (nombre entier).

L'API permet également de privilégier des termes lors de la recherche, avec l'aide du symbole ^ (puissance) suivant le ou les termes à amplifier, et accompagné d'un nombre facteur. Plus ce nombre est élevé, plus le terme sera privilégié par rapport aux autres. Ce nombre est obligatoirement un nombre positif, mais peut être inférieur à 1 (par exemple, 0.5).

Il est possible d'interroger un champ particulier, à partir du moment où ce dernier est bien indexé. En effet, tous les objets documentaires sont homogénéisés, c'est-à-dire qu'un même type d'information est disponible dans le même nom de champ. Par exemple, pour savoir à quel corpus appartient un objet, il suffira de consulter le champ corpusName, quelque soit l'objet documentaire. Mais tous les objets documentaires ne se valant pas, certaines informations peuvent manquer pour certains, et être restitué pour d'autres, comme par exemple pour le champ pii.

En règle générale, les informations concernant le document (article ou chapitre) en lui-même sont directement indiquées par leur nom (par exemple title ou genre), alors que les informations liées à la revue ou à l'ebook doivent être précédées de host (par exemple host.title ou host.genre). Pour de plus amples détails sur la granularité ou pour voir l'ensemble des champs indexés, consultez la section qui lui est consacrée.

Pour interroger un champ particulier, il suffit d'indiquer son nom et d'ajouter : (deux points) avant la requête qui lui sera liée.

Il est également possible de chercher sur un intervalle, avec l'utilisation des [] (crochets) et des {} (parenthèses) et du mot clé TO (en majuscules). Les crochets sont inclusifs, alors que les accolades, à l'inverse, sont exclusives. L'intervalle peut se faire sur des nombres, mais également sur des mots : il s'agit alors d'un intervalle alphabétique.

Pour plus de détails sur cette syntaxe, nous vous invitons à consulter la documentation officielle.