Récupération des suggestions de requête à l'aide du service de recherche REST
Découvrez comment utiliser le service de recherche REST à partir de vos applications clients et mobiles pour récupérer des suggestions de requête à partir de la recherche dans SharePoint. Suggestions de requête, également connu sous le nom des suggestions de recherche, sont des expressions que les utilisateurs ont déjà recherchés et qui sont affichées ou « suggestions » leur qu'ils tapent leurs requêtes. Vous pouvez faire usage de la recherche dans SharePoint pour activer les suggestions avant et après la requête. Ces suggestions apparaissent dans une liste en dessous de la zone de recherche lorsque l'utilisateur saisit une requête. Pour plus d’informations sur les suggestions de requête et leur activation, voir Gérer les suggestions de requête dans SharePoint.
Suggérer un point de terminaison dans le service de recherche REST
Le service REST de recherche inclut un point de terminaison Suggest que vous pouvez utiliser dans toute technologie prenant en charge les requêtes de web REST permet de récupérer des suggestions de requête générée par le système de recherche pour une requête à partir des clients ou des applications mobiles.
L'URI pour les demandes de GET au point de terminaison du service REST de recherche Suggest est la suivante :
/_api/search/suggest
Les paramètres de suggestion de requête sont spécifiés dans l'URL. Vous pouvez construire l'URL de la demande de deux manières :
http://server/_api/search/suggest?parameter=value&parameter=value
http://server/_api/search/suggest(parameter=value&parameter=value)
Remarque
Le service REST de recherche ne prennent en charge les requêtes anonymes Suggest au point de terminaison.
Paramètres des suggestions de requête
Les sections suivantes décrivent les paramètres que vous pouvez utiliser pour le point de terminaison Suggest.
QueryText
Chaîne contenant le texte pour la requête de recherche.
Exemple de requête GET
http:// server/_api/search/suggest?querytext = « sharepoint »
iNumberOfQuerySuggestions
Le nombre de suggestions de requête à récupérer. Doit être supérieure à zéro (0). La valeur par défaut est 5.
Exemple de requête GET
http:// server/_api/search/suggest ?querytext='sharepoint'&inumberofquerysuggestions=3
iNumberOfResultSuggestions
Le nombre de résultats personnels à récupérer. Doit être supérieure à zéro (0). La valeur par défaut est 5.
Exemple de requête GET
http:// server/_api/search/suggest ?querytext='sharepoint'&inumberofresultsuggestions=4
fPreQuerySuggestions
Une valeur de type Boolean qui indique si vous souhaitez récupérer des suggestions de requêtes avant ou après. true pour renvoyer des suggestions de requête préliminaire ; dans le cas contraire, false. La valeur par défaut est false.
Exemple de requête GET
http:// server/_api/search/suggest ?querytext='sharepoint'&fprequerysuggestions=true
fHitHighlighting
Valeur booléenne qui spécifie s’il faut mettre en surbrillance ou mettre en gras les suggestions de requête. true pour mettre en forme en gras les termes des suggestions de requête retournées qui correspondent aux termes de la requête spécifiée ; sinon, false. La valeur par défaut est true.
Exemple de requête GET
http:// server/_api/search/suggest ?querytext='sharepoint'&fhithighlighting=false
fCapitalizeFirstLetters
Une valeur de type Boolean qui indique s'il faut mettre en majuscule la première lettre dans chaque terme dans les suggestions de requête retournée. true à mettre en majuscule la première lettre de chaque terme ; dans le cas contraire, false. La valeur par défaut est false.
Exemple de requête GET
http:// server/_api/search/suggest ?querytext='sharepoint'&fcapitalizefirstletters=false
Culture
ID de paramètres régionaux (LCID) pour la requête (voir ID de paramètres régionaux attribués par Microsoft).
Exemple de requête GET
http:// server/_api/search/suggest ?querytext='sharepoint'&culture=1044
EnableStemming
Valeur booléenne indiquant si la recherche de radical est activée. true pour activer la recherche de radical ; dans le cas contraire, false. La valeur par défaut est true.
Exemple de requête GET
http:// server/_api/search/suggest ?querytext='sharepoint'&enablestemming=false
ShowPeopleNameSuggestions
Une valeur de type Boolean qui indique s'il faut inclure des noms de personnes dans les suggestions de requête retournée. true pour inclure les noms de personnes dans les suggestions de requête retournée ; dans le cas contraire, false. La valeur par défaut est true.
Exemple de requête GET
http:// server/_api/search/suggest ?querytext='sharepoint'&showpeoplenamesuggestions=false
EnableQueryRules
Une valeur de type Boolean qui indique s'il faut activer des règles de requête pour cette requête. true pour activer les règles de requête ; dans le cas contraire, false. La valeur par défaut est true.
Exemple de requête GET
http:// server/_api/search/suggest ?querytext='sharepoint'&enablequeryrules=false
fPrefixMatchAllTerms
Une valeur de type Boolean qui indique s'il faut renvoyer les suggestions de requête pour le préfixe correspond à. true pour renvoyer des suggestions de requête en fonction de préfixe correspond à, dans le cas contraire, false lorsque les suggestions de requête doivent correspondre au mot de requête complète.
Exemple de requête GET
http:// server/_api/search/suggest ?querytext='sharepoint'&fprefixmatchallterms=false