Type de ressource searchRequest

  • Article

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Attention

Les ressources utilisées dans une demande et une réponse de l’API de recherche Microsoft ont été renommées ou supprimées, ou deviennent obsolètes. En savoir plus sur l’obsolescence. En conséquence, mettez à jour les requêtes de l’API de recherche dans les applications antérieures.

Demande de recherche mise en forme dans un objet blob JSON.

L’objet blob JSON contient les types de ressources attendus dans la réponse, les sources sous-jacentes, les paramètres de pagination, les options de tri, les agrégations et les champs demandés, ainsi que la requête de recherche réelle. Consultez des exemples de demandes de recherche sur diverses ressources.

Remarque

Tenez compte des limitations connues concernant la recherche de combinaisons spécifiques de types d’entités et le tri ou l’agrégation des résultats de recherche.

Propriétés

Propriété Type Description
aggregations collection aggregationOption Spécifie les agrégations (également appelées affinements) à retourner avec les résultats de la recherche. Optional.
aggregationFilters String collection Contient un ou plusieurs filtres pour obtenir des résultats de recherche agrégés et filtrés sur une valeur spécifique d’un champ. Optional.
Créez ce filtre en fonction d’une recherche précédente qui agrège par le même champ. À partir de la réponse de la recherche précédente, identifiez le searchBucket qui filtre les résultats sur la valeur spécifique du champ, utilisez la chaîne dans sa propriété aggregationFilterToken et générez une chaîne de filtre d’agrégation au format « {field} :\"{aggregationFilterToken}\ » ».
Si plusieurs valeurs pour le même champ doivent être fournies, utilisez les chaînes de sa propriété aggregationFilterToken et générez une chaîne de filtre d’agrégation au format « {field} :or(\"{aggregationFilterToken1}\ »,\"{aggregationFilterToken2}\ ») ».
Par exemple, la recherche et l’agrégation d’éléments de lecteur par type de fichier retournent un searchBucket pour le type docx de fichier dans la réponse. Vous pouvez facilement utiliser l’agrégationFilterToken retournée pour ce searchBucket dans une requête de recherche ultérieure et filtrer les correspondances vers le docx bas pour les éléments du type de fichier. Les exemples 1 et 2 montrent les demandes et réponses réelles.
collapseProperties collection collapseProperty Contient la collection ordonnée de champs et limite pour réduire les résultats. Optional.
contentSources String collection Contient la connexion à cibler.
Respecte le format suivant : /external/connections/connectionid où connectionid est le ConnectionId défini dans l’administration des connecteurs.
Remarque : contentSource s’applique uniquement lorsque entityType=externalItem. Optional.
enableTopResults Valeur booléenne Cela déclenche un tri hybride pour les messages : les 3 premiers messages sont les plus pertinents. Cette propriété s’applique uniquement à entityType=message. Optional.
entityTypes collection entityType Un ou plusieurs types de ressources attendus dans la réponse. Les valeurs possibles sont les suivantes : list, site, listItem, message, event, drive, driveItem, person, externalItem, acronym, bookmark et chatMessage. Pour plus d’informations sur les combinaisons de deux types d’entités ou plus pris en charge dans la même demande de recherche, consultez Limitations connues. Obligatoire.
fields Collection de chaînes Contient les champs à renvoyer pour chaque objet de ressource spécifié dans entityTypes, ce qui permet de personnaliser les champs retournés par défaut, y compris les champs supplémentaires tels que les propriétés gérées personnalisées de SharePoint et OneDrive, ou les champs personnalisés dans externalItem à partir du contenu que les connecteurs Microsoft Graph apportent.
La propriété fields peut utiliser les étiquettes sémantiques appliquées aux propriétés. Par exemple, si une propriété est étiquetée comme titre, vous pouvez la récupérer à l’aide de la syntaxe suivante : label_title.
Optional.
de Int32 Spécifie le décalage pour les résultats de la recherche. Offset 0 retourne le tout premier résultat. Optional.
requête searchQuery Contient les termes de la requête. Obligatoire.
queryAlterationOptions searchAlterationOptions Fournit des options de modification de requête au format d’un objet blob JSON qui contient deux indicateurs facultatifs liés à la correction orthographique. Optional.
Région chaîne Obligatoire pour les recherches qui utilisent des autorisations d’application. Représente l’emplacement géographique de la recherche. Pour plus d’informations, consultez Obtenir la valeur de la région.
resultTemplateOptions collection resultTemplateOption Fournit les options de modèles de résultats de recherche pour le rendu des résultats de recherche des connecteurs.
sharePointOneDriveOptions sharePointOneDriveOptions Indique le type de contenu à rechercher lorsqu’une recherche est effectuée à l’aide d’autorisations d’application. Optional.
size Int32 Taille de la page à récupérer. La valeur maximale est 500. Optional.
sortProperties collection sortProperty Contient la collection ordonnée de champs et de direction pour trier les résultats. La collection peut comporter au maximum 5 propriétés de tri. Optional.
trimDuplicates Valeur booléenne Indique s’il faut supprimer les fichiers SharePoint en double des résultats de recherche. La valeur par défaut est false. Optional.
stored_fields (déconseillé) String collection Cette propriété est maintenant remplacée par la propriété fields .

Représentation JSON

Voici une représentation JSON de la ressource.

{
  "aggregationFilters": ["String"],
  "aggregations": [{"@odata.type": "microsoft.graph.aggregationOption"}],
  "contentSources": ["String"],
  "enableTopResults": true,
  "entityTypes": ["String"],
  "fields": ["String"],
  "from": 1024,
  "query": {"@odata.type": "microsoft.graph.searchQuery"},
  "queryAlterationOptions": {"@odata.type": "microsoft.graph.searchAlterationOptions"},
  "region": "63128164-cbbf-4db4-896c-a7038417019c",
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "sharePointOneDriveOptions": {"@odata.type": "microsoft.graph.sharePointOneDriveOptions"},
  "size": 1024,
  "sortProperties": [{"@odata.type": "microsoft.graph.sortProperty"}],
  "collapseProperties": [{"@odata.type": "microsoft.graph.collapseProperty"}],
  "trimDuplicates": false
}

Contenu connexe