Type de ressource searchRequest

Espace de noms: microsoft.graph

Important

Les API sous la /beta version de 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 de 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.

Le 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 champs demandés et la requête de recherche réelle. Voir des exemples de demandes de recherche sur différentes ressources.

Notes

N’ignorez pas les 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. Facultatif.
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. Facultatif.
Créez ce filtre en fonction d’une recherche préalable qui agrège par le même champ. À partir de la réponse de la recherche précédente, identifiez l’ensemble searchBucket qui filtre les résultats selon la valeur spécifique du champ, utilisez la chaîne dans sa propriété aggregationFilterToken et créez 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 dans sa propriété aggregationFilterToken et créez 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 renvoie un objet searchBucket pour le type docx de fichier dans la réponse. Vous pouvez facilement utiliser l’objet aggregationFilterToken renvoyé pour cet objet searchBucket docx dans une requête de recherche ultérieure et le filtre correspond aux éléments de lecteur du type de fichier. Les exemples 1 et 2 montrent les demandes et réponses réelles.
contentSources String collection Contient la connexion à cibler.
Respecte le format suivant : /external/connections/connectionid où se trouve connectionid le ConnectionId défini dans l’administration des connecteurs.
Remarque : contentSource est applicable uniquement lorsque entityType=externalItem. Facultatif.
enableTopResults Boolean Cela déclenche le tri hybride pour les messages : les 3 premiers messages sont les plus pertinents. Cette propriété s’applique uniquement à entityType=message. Facultatif.
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. Consultez les limitations connues pour les combinaisons de deux ou plusieurs types d’entités pris en charge dans la même demande de recherche. Obligatoire.
fields String collection Contient les champs à retourner pour chaque objet ressource spécifié dans entityTypes, ce qui permet la personnalisation des champs renvoyés par défaut dans le cas contraire, 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 en tant que titre, vous pouvez la récupérer à l’aide de la syntaxe suivante : label_title.
Facultatif.
de Int32 Spécifie le décalage des résultats de la recherche. Le décalage 0 renvoie le tout premier résultat. Facultatif.
requête searchQuery Contient les termes de la requête. Obligatoire.
queryAlterationOptions searchAlterationOptions Fournit des options d’altération de requête formatées en tant qu’objet blob JSON qui contient deux indicateurs facultatifs liés à la correction orthographique. Facultatif.
resultTemplateOptions collection resultTemplateOption Fournit les options des modèles de résultats de recherche pour les résultats de recherche des connecteurs de rendu.
size Int32 Taille de la page à récupérer. Facultatif.
sortProperties collection sortProperty Contient la collection triée de champs et la direction pour trier les résultats. Il peut y avoir au maximum 5 propriétés de tri dans la collection. Facultatif.
trimDuplicates Boolean Indique s’il faut découper les fichiers SharePoint des résultats de la recherche. La valeur par défaut est false. Facultatif.
stored_fields (supprimé) String collection Il est maintenant remplacé 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"},
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "size": 1024,
  "sortProperties": [{"@odata.type": "microsoft.graph.sortProperty"}],
  "trimDuplicates": false
}

Voir aussi