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 :

Syntaxe
URI https://api.istex.fr/document/?q={query}
Paramètres - q= : la lettre clé permettant d'indiquer que ce qui suit est la requête, - {query} : la chaîne de recherche. Celle-ci correspond à une requête du type "Google" ou "Bing". Plus de précisions sur cette page de la documentation de Lucene.
Code de retour - 200 si OK, - 500 en cas de problème (dans ce cas, contacter api-bug@listes.istex.fr)
  • 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...).

Exemples
Recherche des documents contenant le mot "Controllability" dans tous les champs indexés https://api.istex.fr/document/?q=Controllability
Recherche des documents contenant le mot "test" dans tous les champs indexés https://api.istex.fr/document/?q=test

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 -.

Exemples
Recherche des documents contenant le terme "api" ou "study" dans un de leurs champs indexés https://api.istex.fr/document/?q=api OR study https://api.istex.fr/document/?q=api study
Recherche des documents contenant le terme "test" et "study" dans un de leurs champs indexés https://api.istex.fr/document/?q=test AND study
Recherche des documents contenant le terme "test" mais pas "study" dans un de leurs champs indexés

https://api.istex.fr/document/?q=test NOT study

https://api.istex.fr/document/?q=api -study

L'utilisation de jokers * et ? est possible, permettant de remplacer un certain nombre de caractères.

Exemples
Recherche des documents contenant un terme commençant par "te", ayant 0, 1 ou plusieurs caractères supplémentaires et finissant par un "t" dans un de leurs champs indexés (ex: "test", "tegument") https://api.istex.fr/document/?q=te*t
Recherche des documents contenant un terme commençant par "te", ayant 1 caractère supplémentaire et finissant par un "t" dans un de leurs champs indexés (ex: "tet", "test") https://api.istex.fr/document/?q=te?t

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

Exemples
Recherche des documents contenant le terme "ham", "jam" ou "hamster" dans un de leurs champs indexés https://api.istex.fr/document/?q=/[hj]am(ster)?/
Recherche des documents contenant un terme avec 25 caractères parmi les lettres A, C, G et T dans un de leurs champs indexés https://api.istex.fr/document/?q=/[CGAT]{25}/

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é.

Exemples
Recherche des documents contenant un terme proche du mot "ham" dans un de leurs champs indexés https://api.istex.fr/document/?q=ham~

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).

Exemples
Recherche des documents contenant les termes "ham" et "jam" distants d'une longueur de 10 mots dans un de leurs champs indexés https://api.istex.fr/document/?q="ham jam"~10

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).

Exemples
Recherche des documents contenant les termes "ham" et "jam", avec une importance deux fois plus grande pour "ham" https://api.istex.fr/document/?q=ham^2 jam https://api.istex.fr/document/?q=ham^4 jam^2 https://api.istex.fr/document/?q=ham jam^0.5
Recherche des documents contenant les termes "ham jam" et "old", avec une importance deux fois plus grande pour "ham jam" https://api.istex.fr/document/?q="ham jam"^2 old

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.

Exemples
Recherche des documents contenant le terme "api" et dont un titre contient le mot "study" https://api.istex.fr/document/?q=api AND title:study
Recherche des documents contenant le terme "api" et dont un titre de série contient le mot "computer" https://api.istex.fr/document/?q=api AND host.title:computer

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.

Exemples
Recherche des documents contenant une date de publication entre 1900 et 1905 https://api.istex.fr/document/?q=publicationDate:[1900 TO 1905] https://api.istex.fr/document/?q=publicationDate:{1899 TO 1906} https://api.istex.fr/document/?q=publicationDate:{1889 TO 1906}
Recherche des documents contenant un terme entre "half" et "ham" dans son titre https://api.istex.fr/document/?q=title:[half TO ham]

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

results matching ""

    No results matching ""