Communauté

Doc produitsMenu

Plateforme Coveo 7.0 >
Aide à l'administrateur > Intégration Coveo > Recherche et récupération de résultats à l'aide de la recherche XML

Recherche et récupération de résultats à l'aide de la recherche XML

La Plateforme Coveo peut retourner des résultats de recherche dans un format XML. L'utilisation de la recherche XML est utile afin d'intégrer facilement des résultats de recherche Coveo dans une application de tierce partie ou dans un site Web sans avoir à appeler l'API (Application Programming Interface) de Coveo. Ceci est effectué en utilisant les communications requête/réponse HTTP de base sur des résultats de recherche intégrés dans un point d'accès Web.

Exemple : Pour ajouter des résultats de recherche à un site Web à l'aide de la recherche XML :

  1. Ajoutez une page de recherche XML à votre site.

  2. Effectuez une recherche à l'aide de la page de recherche XML de Coveo.

  3. Analysez le XML afin d'afficher les résultats.

Vous pouvez obtenir des résultats de recherche XML à l'aide de XMLsearch.aspx dans l'URL de recherche dans cette forme :

http://[CoveoServer]/XMLSearch.aspx?[Query]

Exemple : La recherche de united oil financial statements year ended 2003 à partir de l'interface de recherche Intranet dans un serveur Coveo retourne 4 résultats.

À l'aide de l'URL suivante de ce serveur Coveo :

https://localhost/XMLsearch.aspx?BasicQuery=united oil financial statements year ended 2003 @sysspversion

retourne les 4 mêmes résultats, mais dans le format XML suivant : 

<QueryResults xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Executed>true</Executed>
  <BasicQuery>
    united oil financial statements year ended 2003 @sysspversion
  </BasicQuery>
  <AdvancedQuery/>
  <ExpandedQuery/>
  <TotalCount>4</TotalCount>
  <Time>0.047</Time>
  <Filtered>false</Filtered>
  <Optimized>false</Optimized>
  <Results>
    <QueryResult>...</QueryResult>
    <QueryResult>
      <UniqueId>172622!-1!</UniqueId>
      <Title>Financial funding United Oil Draft</Title>
      <Uri>
        https://sp2010.demo.coveo.com/Finance/Shared Documents/Funding Reports/Financial funding United oil Sharepoint.docx
      </Uri>
      <PrintableUri>
        https://sp2010.demo.coveo.com/Finance/Shared Documents/Funding Reports/Financial funding United oil Sharepoint.docx
      </PrintableUri>
      <TargetUri>
        https://sp2010.demo.coveo.com/Finance/Shared Documents/Funding Reports/Financial funding United oil Sharepoint.docx
      </TargetUri>
      <Score>2710</Score>
      <PercentageScore>52.927528381347656</PercentageScore>
      <Size>293386</Size>
      <IsAttachment>false</IsAttachment>
      <ContainsAttachment>true</ContainsAttachment>
      <ModifiedDate>2010-09-21T18:39:25</ModifiedDate>
      <IndexedDate>2011-03-01T16:21:36</IndexedDate>
      <IsTopResult>false</IsTopResult>
      <Rating>3</Rating>
      <IsUserRating>false</IsUserRating>
      <LastView>0001-01-01T00:00:00</LastView>
      <NumberOfViews>0</NumberOfViews>
    </QueryResult>
    <QueryResult>...</QueryResult>
    <QueryResult>...</QueryResult>
  </Results>
  <ExceptionCode>1</ExceptionCode>
  <ExceptionContext/>
</QueryResults>

Note : La production de résultats de recherche XML ne contient pas tous les contrôles de l'interface de recherche par défaut. Par exemple, les facettes ne s'y trouvent pas.

Paramètres disponibles

Dans la requête, vous pouvez utiliser les paramètres qui sont décrits dans le tableau suivant.

Nom Type Description Valeurs possibles
AdvancedQuery Chaîne Expression de requête avancée. (selon la syntaxe de recherche)
AllRemoteServers Booléen Définir à true afin d'inclure tous les serveurs distants dans la requête. [true, false]
BasicQuery Chaîne Expression de requête de base. (selon la syntaxe de recherche)
CollectionIds Chaîne séparée par des virgules Identifiants des collections dans lesquelles la requête devrait être effectuée. Si aucune collection n'est spécifiée, toutes les collections sont sélectionnées.
CollectionNames Chaîne séparée par des virgules Noms des collections dans lesquelles la requête devrait être effectuée. Collections disponibles.

Si les collections spécifiées n'existent pas, elles sont rejetées.
DefaultTimeOut Entier Le délai d'expiration à utiliser lors de la recherche dans des serveurs distants (en millisecondes). À utiliser uniquement si AllRemoteServers est défini à true. [0…]
DoNotLog Booléen Définir à true afin de désactiver la journalisation de requêtes. [true, false]
ExcerptLength Entier Longueur de l'extrait à récupérer pour chaque résultat (en caractères). Définissez cette propriété à une valeur autre que zéro afin de récupérer un extrait. [0…]
ExpandQuery Booléen Définir à true afin d'activer l'expansion de requêtes à l'aide du thésaurus. [true, false]
FilterByField Chaîne Le champ personnalisé à utiliser pour le filtrage de doublons personnalisés. Tout champ disponible, avec @ comme préfixe.
FilterDuplicates Booléen Définir à true afin d'activer le filtrage de doublons. [true, false]
FirstResult Entier Index basé sur 0 du premier résultat à récupérer. [0…49999]
ImpersonatorChain Chaîne séparée par des virgules Information sur l'authentification (chaîne d'utilisateurs à personnifier) pour l'exécution de la requête.  
NeedCachedDocumentUris Booléen Définir à true pour retrouver les URI qui servent les versions en cache des résultats. [true, false]
NeedConcepts Booléen Définir à true afin de retrouver les concepts pour chaque résultat. [true, false]
NeededFields Chaîne séparée par des virgules Liste de champs dont la valeur devrait être retrouvée. Tout champ disponible, avec @ comme préfixe.
NeedHighlights Booléen Définir à True afin de retrouver les points saillants pour le titre, l'extrait, etc. [true, false]
NeedParsedQuery Booléen Définir à true afin de retrouver l'information de requête qui a été analysée. Pendant l'exécution d'une requête, l'information analysée est disponible dans QueryResults.ParsedQuery. [true, false]
NeedQueryCorrections Booléen Définir à true pour retrouver les corrections potentielles à apporter à la requête. [true, false]
NumberOfResults Entier Nombre maximal de résultats à retrouver. [1…50000]
Optimize Booléen Définir à true pour activer les optimisations exactes de chaîne de requête. [true, false]
PreferredLanguage Chaîne Nom facultatif de la langue prioritaire pour les résultats [english,french]
SavedQueryOrFilter Chaîne La requête ou le filtre sauvegardé, effectué en série, à inclure dans la recherche.  
SortByField Chaîne Nom facultatif du champ à utiliser pour le tri de résultats. (selon les champs configurés comme pouvant être triés)

Utilisé seulement si SortCriteria est en [FieldAscending, FieldDescending]

SortCriteria Chaîne Critère de tri à utiliser pour le tri de résultats.

Note : dans les versions antérieures à 1413.1808 ce paramètre était intitulé SortBy.

[Relevancy, ModifiedDateAscending, ModifiedDateDescending, FieldAscending, FieldDescending]
SummaryLength Entier Longueur du résumé à retrouver pour chaque résultat (en mots). Définir cette propriété à une valeur autre que zéro afin de retrouver un résumé. [0…]
TimeZoneOffset Entier Décalage entre l'heure locale et l'UTC pour l'utilisateur final, en minutes. [-720…720]
UseCollaborativeRanking Booléen Définir à true afin d'activer l'appréciation collaborative pour cette requête. [true, false]
UseWildcards Booléen Définir à true afin d'activer les caractères de remplacement pour cette requête. [true, false]

Exemple : Une requête plus complexe combinant plusieurs paramètres : http://localhost/XMLSearch.aspx?BasicQuery=@uri&collectionnames=portal,test&NumberOfResults=4&SortBy=ModifiedDateDescending
&ExcerptLength=200&SummaryLength=60&NeedConcepts=true

Schéma de sortie XML

<QueryResults xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Executed></Executed> 
  <BasicQuery></BasicQuery> 
  <AdvancedQuery></AdvancedQuery>
  <ExpandedQuery></ExpandedQuery> 
  <TotalCount></TotalCount> 
  <Time></Time> 
  <Filtered></Filtered> 
  <Optimized></Optimized> 
  <QueryCorrections>
    <QueryCorrection>
      <CorrectedQuery></CorrectedQuery> 
      <WordCorrections>
        <WordCorrection>
          <Position></Position> 
          <OriginalWord></OriginalWord> 
          <CorrectedWord></CorrectedWord> 
        </WordCorrection>
      </WordCorrections>
    </QueryCorrection>
  </QueryCorrections>
  <Results>
    <QueryResult>
      <UniqueId></UniqueId> 
      <Title></Title> 
      <TitleHighlights> 
        <Highlight>
          <Position></Position> 
          <Length></Length> 
        </Highlight>
      </TitleHighlights> 
      <Uri></Uri> 
      <PrintableUri></PrintableUri> 
      <PrintableUriHighlights> 
        <Highlight>
          <Position></Position> 
          <Length></Length> 
        </Highlight>
      </PrintableUriHighlights> 
      <Score></Score> 
      <Size></Size> 
      <IsAttachment></IsAttachment> 
      <ContainsAttachment></ContainsAttachment> 
      <ModifiedDate></ModifiedDate> 
      <IndexedDate></IndexedDate> 
      <Fields>
        <ResultField>
          <Name></Name> 
          <Value xsi:type=""> </Value>
        </ResultField>
      </Fields>
      <IsTopResult></IsTopResult> 
      <Rating></Rating> 
      <IsUserRating></IsUserRating> 
      <LastView></LastView> 
      <NumberOfViews></NumberOfViews> 
      <Excerpt></Excerpt> 
      <ExcerptHighlights>
        <Highlight>
          <Position></Position> 
          <Length></Length> 
        </Highlight>
      </ExcerptHighlights>
      <Summary></Summary> 
      <Concepts>
        <string></string> 
      </Concepts>
      <CachedDocumentUri></CachedDocumentUri> 
    </QueryResult>
  </Results>
</QueryResults>
Élément Type de données Description
QueryResults Aucune Élément racine.
Executed Booléen True s'il y a assez d'informations pour effectuer une recherche.
BasicQuery Chaîne A reçu le contenu du paramètre BasicQuery.
AdvancedQuery Chaîne A reçu le contenu du paramètre AdvancedQuery.
ExpandedQuery Chaîne Requête suggérée par le thésaurus.
TotalCount Entier Nombre total de documents correspondants.
Time Décimale Temps nécessaire au retour des résultats, en secondes.
Filtered Booléen True si les résultats doublés sont filtrés. Contrôlé par le paramètre FilterDuplicates.
Optimized Booléen True si la requête est optimisée. Contrôlé par le paramètre Optimize.
QueryCorrections Aucune Collection d'éléments de QueryCorrection. Représente la fonction Essayez cette orthographe.
QueryCorrection Aucune Contient des éléments de CorrectedQuery et de WordCorrections.
CorrectedQuery Chaîne Requête corrigée comme si tous les éléments de WordCorrections étaient appliqués à BasicQuery.
WordCorrections Aucune Collection des éléments WordCorrection.
WordCorrection Aucune Contient les éléments de Position, OrignalWord et CorrectedWord.
Position Entier Position de OriginalWord dans BasicQuery.
OriginalWord Chaîne Mot qui pourrait avoir besoin d'une correction.
CorrectedWord Chaîne Remplacement suggéré pour OriginalWord.
Results Aucune Collection des éléments QueryResult.
QueryResult Aucune Contient les éléments de UniqueId, Title, TitleHighlights, Uri, PrintableUri, Score, Size, IsAttachment, ContainsAttachment, ModifiedDate, IndexedDate, Fields, IsTopResult, Rating, IsUserRating, LastView, NumberOfViews, Excerpt, et ExcerptHighlights.
UniqueId Entier Identifiant interne unique du document.
Title Chaîne Titre du document.
TitleHighlights Aucune Collection des éléments de Highlight.
Highlight Aucune Contient les éléments de Position et Length.
Position Entier Position de l'expression à mettre en valeur dans Title.
Length Entier Longueur de l'expression à mettre en valeur dans Title.
Uri Chaîne Adresse du document.
PrintableUri Chaîne Adresse qui devrait être affichée pour l'utilisateur.
PrintableUriHighlights Aucune Collection des éléments de Highlight.
Highlight Aucune Contient les éléments de Position et Length.
Position Entier Position de l'expression à mettre en valeur dans PrintableUri.
Length Entier Longueur de l'expression à mettre en valeur dans PrintableUri.
Score Entier Relatif à la qualité du document en ce qui concerne la requête.
Size Entier Taille du fichier en octets.
IsAttachment Booléen True si le fichier se retrouve dans un autre fichier tel qu'un fichier compressé.
ContainsAttachment Booléen True s'il y a d'autres fichiers tels que les zips.
ModifiedDate date/heure Dernière fois que le document a été modifié.
IndexedDate date/heure Dernière fois que le document a été actualisé dans l'index.
Champs Aucune Collection des éléments de ResultField.
ResultField Aucune Contient les éléments de Name et Value.
Nom Chaîne Nom d'un champ.
Value (description) Valeur du champ. Cet élément possède un attribut xsi:type qui dénote le type de données de la valeur.
IsTopResult Booléen True si le document est affiché en tant que Résultat prédéterminé.
Rating Décimale Appréciation du document, en étoiles.
IsUserRating Booléen True si l'élément Rating dénote que l'appréciation a été définie manuellement par l'utilisateur.
LastView date/heure L'heure à laquelle le document a été ouvert pour la dernière fois.
NumberOfViews Entier Nombre d'ouvertures d'un document.
Excerpt Chaîne Extrait de document le plus pertinent.
ExcerptHighlights Aucune Collection des éléments de Highlight.
Highlight Aucune Contient les éléments de Position et Length.
Position Entier Position de l'expression à mettre en valeur dans Excerpt.
Length Entier Longueur de l'expression à mettre en valeur dans Excerpt.
Résumé Chaîne Résumé du document.
Concepts Aucune Collection d'éléments de chaîne.
Chaîne Chaîne L'un des mots ou expressions les plus importants du document.
CachedDocumentUri Chaîne L'adresse où les utilisateurs peuvent voir l'Aperçu rapide du document.