Ceci est une ancienne révision du document !


type = q-fiche

Cette requête JSON est la requête principale de Scrutari car c'est elle qui permet de faire une recherche sur les fiches. Elles retournent toutes les fiches ainsi que tous les mots-clés qui ont servi à la recherche.

Paramètres

Paramètres communs obligatoires

  • q : séquence de recherche (est ignoré si qid est indiqué) (voir Syntaxe d'une recherche)
  • version : version à utiliser (Version actuelle : 1)

Paramètres communs optionnels

  • q-mode : mode d'analyse de la chaine de recherche définie par le paramètre q (voir Syntaxe d'une recherche)
  • langui : langue à utiliser de préférence pour les intitulés
  • corpuslist : limitation de la recherche aux corpus indiqués
  • baselist : limitation de la recherche aux corpus des bases indiquées
  • categorylist : limitation de la rercherche aux corpus appartenant aux catégories indiquées
  • langlist : limitation de la recherche aux fiches dans des langues déterminées
  • start : point de départ des fiches retournées, s'il y a plusieurs groupes de fiches, le point de départ est évaluée par rapport à l'ordre global des fiches (si il y a 15 fiches dans un premier groupe et 40 dans un second groupe, le point de départ 20 correspond à la cinquième fiche du second groupe
  • limit : limite du nombre de fiches retournées
  • startype : complement du paramètre start indiquant le comportement de la sélection (n'est utile que s'il y a des catégories), les valeurs possibles sont les suivantes :
    • global (valeur par défaut) : le point de départ est évaluée par rapport à l'ordre global des fiches (si il y a 15 fiches dans la première catégorie et 40 dans une catégorie, le point de départ 20 correspond à la cinquième fiche du second groupe)
    • in_all : le point de départ est évalué pour chaque catégorie prise séparément : le paramétrage start=1 et limit=50 renverra les cinquante premières fiches de chaque catégorie
    • in: … : comme précédemment sauf que le point de départ n'est évalué que pour les catégories listées après in:
  • fichefields : champs qui se retrouveront dans les objets du tableau ficheArray (voir Champs des fiches)
  • motclefields : champs qui se retrouveront dans les objets du tableau motcleMap (voir Champs des mots-clés)

Note : corpuslist et baselist s'additionnent (la liste des corpus sélectionnés eet celle de corpuslist ainsi que tous les corpus des bases indiquées par baselist)

Paramètres spécifiques obligatoires

  • qid : au lieu du paramètre q, il est possible d'indiquer l'identifiant du recherche déjà effectuée (afin, par exemple de récupérer l'information sur une plage de fiches). q et qid sont mutuellement excluants (qid ayant la préséance sur q), autrement dit c'est la présence de l'un des deux qui est obligatoire.

Paramètres spécifiques optionnels

  • intitules : rajoute des intitulés, peut prendre les valeurs corpus (intitulés des corpus) et complement (intitulés des compléments) (séparés par une virgule), les intitulés sont dans la langue de l'interface ou, sinon, dans la langue par défaut du corpus, peut également prendre la valeur attributes pour indiquer l'insertion du descriptif des attributs
  • origin : origine de la recherche (chaine libre qui permet d'avoir une idée dans les journaux de l'origine de la recherche)
  • flt (flt-indexation, flt-date, flt-qid) : filtres appliqués constituant une présélection de fiches avant la recherche (voir Syntaxe des filtres)
  • ponderation : poids des différents facteurs dans le calcul de la pertinence (voir Pondération de la pertinence

Objet retourné

{
  ficheSearchResult: {
    q:, //séquence de recherche (chaine)
    qId:, //identifiant de la recherche (chaine)
    qLength:, //longueur de la séquence de recherche (i.e. nombre de composants de la séquence) (entier >= 0)
    qSource:, // chaine originale de la recherche transmise par l'internaute (chaine)
    langUi:, //rappel de la langue de préférence pour l'interface (optionnel, absent si non défini dans la requête initiale) (chaine)
    ficheCount:, //nombre de fiches trouvées
    ficheMaximum:, //nombre de fiches sur lesquelles a porté la recherche
    motcleCount:, //nombre de mots-clés contenant au moins un des composants de la séquence de recherche
    ficheGroupType:, // type de groupement des fiches, prend la valeur "category" (regroupement par catégorie) ou "none" (pas de regroupement)
    ficheGroupArray: [ //tableau des groupes de fiches répondant aux critères de recherche, vide s'il n'y aucune fiche
      { // chaque groupe de fiches est un objet
        category:  { // objet décrivant la catégorie du groupement, présent uniquement si ficheGroupType="category", autrement dit, si des catégoires sont définies pour le moteur en question
        {
          rank:, // rang de la catégorie(entier > 0)
          name:, // nom de la catégorie (chaine)
          title:// intitulé de la catégorie dans la langue d'interface (chaine)
        },
        ficheCount:,//Nombre total de fiches dans le groupe
        ficheArray: [ //tableau des fiches (sa longueur est inférieur à ficheCount si le paramètre start est défini
          { // chaque fiche est un objet
            __fichefields__ // série de propriétés définies par le paramètre fichefields
            codemotcleArray: [...] // tableau des codes des mots-clés participant à la recherche et indexant la fiche (tableau d'entiers > 0)
          }
        ]
      }
    ],
    motcleArray: [ // tableau des mots-clés, vide s'il n'y a aucun mot-clé
      {
        __motclefields__ // série propriétés définies par le paramètre motclefields
      }
    ],
    corpusIntituleArray: [ // tableau des intitulés de corpus, si le paramètre intitule est défini
      {
        codecorpus:, // code du corpus (entier > 0)
        corpus:, // intitulé du corpus (chaine)
        fiche:, // intitulé d'une fiche (chaine)
        complement_XXX:// intitulé du complément de numéro XXX
      }
    ],
    attributes: {//objet identique à l'objet attributes de type=engine (présent si le paramètre intitules a la valeur attributes)}
  }
}

Version 0

{
 ficheGroupType:"corpusclasse" (remplacé de "category")
 
corpusClasse:  { // à la place category
        {
          rank:, // rang de la classe (entier > 0)
          name:, // nom de la classe (chaine)
          intitule:// intitulé de la classe dans la langue d'interface (chaine)
        },
serveurscrutari/json/type_qfiche.1412798879.txt.gz · Dernière modification: 2014/10/08 22:07 par vincent
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0