Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision
Révision précédente
serveurscrutari:json:type_qfiche [2014/10/07 21:50]
vincent [Paramètres communs optionnels]
serveurscrutari:json:type_qfiche [2019/11/26 01:12] (Version actuelle)
vincent [Objet retourné]
Ligne 9: Ligne 9:
  
   * //q// : séquence de recherche (est ignoré si qid est indiqué) (voir [[serveurscrutari:​json:​qsyntax|Syntaxe d'une recherche]])   * //q// : séquence de recherche (est ignoré si qid est indiqué) (voir [[serveurscrutari:​json:​qsyntax|Syntaxe d'une recherche]])
-  * //version// : version à utiliser (Version actuelle : 1)+  * //version// : version à utiliser (Version actuelle : 3)
  
 ==== Paramètres communs optionnels ==== ==== Paramètres communs optionnels ====
  
   * //q-mode// : mode d'​analyse de la chaine de recherche définie par le paramètre //q// (voir [[serveurscrutari:​json:​qsyntax|Syntaxe d'une recherche]])   * //q-mode// : mode d'​analyse de la chaine de recherche définie par le paramètre //q// (voir [[serveurscrutari:​json:​qsyntax|Syntaxe d'une recherche]])
-  * //langui// : langue à utiliser de préférence pour les intitulés+  * //lang// : langue à utiliser de préférence pour les intitulés
   * //​corpuslist//​ : limitation de la recherche aux corpus indiqués   * //​corpuslist//​ : limitation de la recherche aux corpus indiqués
   * //​baselist//​ : limitation de la recherche aux corpus des bases indiquées   * //​baselist//​ : limitation de la recherche aux corpus des bases indiquées
-  * //​categorylist//​ : limitation de la rercherche ​aux corpus appartenant aux catégories indiquées+  * //​categorylist//​ : limitation de la recherche ​aux corpus appartenant aux catégories indiquées 
 +  * //​thesauruslist//​ : pour les mots-clés, limiter la recherche aux thésaurus indiqués
   * //​langlist//​ : limitation de la recherche aux fiches dans des langues déterminé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+  * //start// : point de départ des fiches retournées ​; lorqu'il y a des catégories, le comportement exact est déterminé ​par le paramètre //​starttype//​
   * //limit// : limite du nombre de fiches retournées   * //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 [[serveurscrutari:​json:​fiche_fields|Champs des fiches]])   * //​fichefields//​ : champs qui se retrouveront dans les objets du tableau //​ficheArray//​ (voir [[serveurscrutari:​json:​fiche_fields|Champs des fiches]])
-  * //​motclefields//​ : champs qui se retrouveront dans les objets du tableau //motcleMap// (voir [[serveurscrutari:​json:​motcle_fields|Champs des mots-clés]])+  * //​motclefields//​ : champs qui se retrouveront dans les objets du tableau //motcleArray// (voir [[serveurscrutari:​json:​motcle_fields|Champs des mots-clés]]
 +  * //​fieldvariant//​ : variante de champs à utiliser pour les fiches comme les mots-clés (voir le fichier [[serveurscrutari:​config:​fields|fields.xml]] et [[serveurscrutari:​json:​fiche_fields|Champs des fiches]]) (ignoré si //​fichefields//​ ou //​motclefields//​ sont définis)
  
-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//​)+//​corpuslist//,​ //​baselist//,​ //​categorylist//​ et //​thesauruslist//​ peuvent être utiliser en mode d'​exclusion,​ c'est à dire pour indiquer des corpus, des bases, des catégories ou des thésaurus qui doivent être exclus de la recherche. Pour cela, il faut commencer le paramètre par un point d'​exclamation **!**. 
 + 
 +Dans tous les cas //​corpuslist//​ et //​baselist//​ s'​additionnent ​ (la liste des corpus sélectionnés ​est celle de //​corpuslist//​ ainsi que tous les corpus des bases indiquées par //​baselist//​). Si //​baselist//​ indique une exclusion et //​corpuslist//​ une inclusion (ou inversement),​ c'est le critère d'​exclusion qui a préséance sur le critère d'​inclusion (i.e. un corpus listé dans //​corpuslist//​ mais appartenant à une base exclue par //​baselist//​ sera exclu).
  
 ==== Paramètres spécifiques obligatoires ==== ==== Paramètres spécifiques obligatoires ====
Ligne 32: Ligne 40:
 ==== Paramètres spécifiques optionnels ==== ==== Paramètres spécifiques optionnels ====
  
-  * //intitules// : rajoute des intituléspeut prendre ​les valeurs ​//​corpus// ​(intitulés ​des corpuset //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 corpuspeut également prendre la valeur attributes pour indiquer ​l'insertion du descriptif des attributs+  * //insert//: gère les objets supplémentaires dans l'​objet Json retourné, les valeurs ​possibles ​(séparées par des virgulessont les suivantes : 
 +      * //-motclearray// : le tableau ​des mots-clés est inséré ​par défautce paramètre permet ​de l'éviter 
 +      * //​-searchmeta//​ : les informations sur la recherche sont insérées ​par défaut, ​ce paramètre permet de l'éviter 
 +      * //​engineinfo//​ : insère les informations sur le moteur (équivalent de [[serveurscrutari:​json:​type_engine|type = engine&​data=all]] moins les statistiques)
   * //origin// : origine de la recherche (chaine libre qui permet d'​avoir une idée dans les journaux de l'​origine de la recherche)   * //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 [[serveurscrutari:​json:​filtersyntax|Syntaxe des filtres]])   * //flt// (//​flt-indexation//,​ //​flt-date//,​ //​flt-qid//​) : filtres appliqués constituant une présélection de fiches avant la recherche (voir [[serveurscrutari:​json:​filtersyntax|Syntaxe des filtres]])
   * //​ponderation//​ : poids des différents facteurs dans le calcul de la pertinence (voir [[serveurscrutari:​json:​ponderation|Pondération de la pertinence]]   * //​ponderation//​ : poids des différents facteurs dans le calcul de la pertinence (voir [[serveurscrutari:​json:​ponderation|Pondération de la pertinence]]
 +  * //​wildchar//​ : indique si une troncature doit être appliquée automatiquement (application d'un astérisque automatique au début ou à la fin du terme), les valeurs possibles sont //both//, //end// (valeur par défaut), //start// et //none//
   ​   ​
  
  
 ===== Objet retourné ===== ===== Objet retourné =====
 +
 +Version 3 :
 +
 +<code javascript>​
 +{
 +  ficheSearchResult:​ {
 +    searchMeta : { //objet contenant les informations sur la recherche
 +      q: … , //séquence de recherche (chaine)
 +      qId: … , //​identifiant de la recherche (chaine)
 +      lang: … , //langue utilisée pour l'​interface (valeur du paramètre lang s'il était présent) (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
 +      options: { // objet des options
 +        baselist: { // si la recherche se fait sur une sélection de base
 +          exclude: …, //booléen sir la liste est exclusive ou inclusive
 +          array: [
 +            … code des bases
 +          ]
 +        },
 +        langlist:, // même modèle que langlist
 +        corpuslist:,​ // même modèle que corpuslist
 +        thesauruslist:​ // même modèle que thesauruslist
 +      }
 +    },
 +    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égories 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 peut être largement inférieure à ficheCount si le paramètre start est défini)
 +          { // chaque fiche est un objet
 +            __fichefields__ // série de propriétés définies par les paramètres fichefields ou fieldvariant
 +            codemotcleArray:​ [...] // tableau des codes des mots-clés participant à la recherche et indexant la fiche (tableau d'​entiers > 0), peut être étendu à tous les mots-clés indexant la fiche (voir les champs d'une fiche)
 +          }
 +        ]
 +      }
 +    ],
 +    motcleArray:​ [ // tableau des mots-clés, vide s'il n'y a aucun mot-clé
 +      {
 +        __motclefields__ // série propriétés définies par les paramètres motclefields ou fieldvariant
 +      }
 +    ],
 +    engineInfo: {//objet identique à l'​objet produit par type=engine (présent si le paramètre insert contient la valeur engineinfo)
 +      …
 +    }
 +  }
 +}
 +
 +</​code>​
 +
 +Version 1 et 2 :
  
 <code javascript>​ <code javascript>​
Ligne 46: Ligne 115:
     q: … , //séquence de recherche (chaine)     q: … , //séquence de recherche (chaine)
     qId: … , //​identifiant de la 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) +    ​lang: … , //​langue ​utilisée ​pour l'​interface (valeur du paramètre lang s'il était présent) (chaine)
-    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     ficheCount: … , //nombre de fiches trouvées
     ficheMaximum:​ … , //nombre de fiches sur lesquelles a porté la recherche     ficheMaximum:​ … , //nombre de fiches sur lesquelles a porté la recherche
Ligne 61: Ligne 128:
           title: … // intitulé de la catégorie dans la langue d'​interface (chaine)           title: … // intitulé de la catégorie dans la langue d'​interface (chaine)
         },         },
-        ficheArray: [ //tableau des fiches+        ​ficheCount: ​ … ,//Nombre total de fiches dans le groupe 
 +        ​ficheArray: [ //tableau des fiches ​(sa longueur peut être largement inférieure à ficheCount si le paramètre start est défini)
           { // chaque fiche est un objet           { // chaque fiche est un objet
-            __fichefields__ // série ​de propriétés définies par le paramètre ​fichefields+            __fichefields__ // série propriétés définies par les paramètres ​fichefields ​ou fieldvariant
             codemotcleArray:​ [...] // tableau des codes des mots-clés participant à la recherche et indexant la fiche (tableau d'​entiers > 0)             codemotcleArray:​ [...] // tableau des codes des mots-clés participant à la recherche et indexant la fiche (tableau d'​entiers > 0)
           }           }
Ligne 71: Ligne 139:
     motcleArray:​ [ // tableau des mots-clés, vide s'il n'y a aucun mot-clé     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+        __motclefields__ // série propriétés définies par les paramètres ​motclefields ​ou fieldvariant
       }       }
     ],     ],
Ligne 90: Ligne 158:
 </​code>​ </​code>​
  
-===== Version 0 =====+Version 0 :
  
 <code javascript>​ <code javascript>​
serveurscrutari/json/type_qfiche.1412711459.txt.gz · Dernière modification: 2014/10/07 21:50 par vincent
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0