Documents - Suggest Get

Service:: Search Service

Version d'API:: 2026-04-01

Suggère des documents dans l’index qui correspondent au texte de requête partiel donné.

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2026-04-01&search={search}&suggesterName={suggesterName}

Avec des paramètres facultatifs:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2026-04-01&search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	URL du point de terminaison du service de recherche.
indexName	path	True	string	Nom de l’index.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
search	query	True	string	Texte de recherche à utiliser pour suggérer des documents. Doit comporter au moins 1 caractère et pas plus de 100 caractères.
suggesterName	query	True	string	Nom du suggesteur tel que spécifié dans la collection suggesteurs qui fait partie de la définition d’index.
$filter	query		string	Expression OData qui filtre les documents pris en compte pour les suggestions.
$orderby	query		string[]	Liste des expressions OData $orderby par lesquelles trier les résultats. Chaque expression peut être un nom de champ ou un appel aux fonctions geo.distance() ou search.score(). Chaque expression peut être suivie d’asc pour indiquer l’ordre croissant ou desc pour indiquer l’ordre décroissant. La valeur par défaut est l’ordre croissant. Les liens seront rompus par les scores de correspondance des documents. Si aucune $orderby n’est spécifiée, l’ordre de tri par défaut descend par score de correspondance de document. Il peut y avoir au maximum 32 clauses $orderby.
$select	query		string[]	Liste des champs à récupérer. S’il n’est pas spécifié, seul le champ clé sera inclus dans les résultats.
$top	query		integer (int32)	Le nombre de suggestions à récupérer. La valeur doit être un nombre compris entre 1 et 100. La valeur par défaut est 5.
fuzzy	query		boolean	Valeur indiquant s’il faut utiliser la correspondance approximative pour la requête de suggestions. La valeur par défaut est false. Lorsqu’elle est définie sur true, la requête trouvera des termes même s’il y a un caractère substitué ou manquant dans le texte de recherche. Bien que cela offre une meilleure expérience dans certains scénarios, cela a un coût en termes de performances, car les requêtes de suggestions floues sont plus lentes et consomment plus de ressources.
highlightPostTag	query		string	Balise de chaîne ajoutée aux surbrillances d’accès. Doit être défini avec highlightPreTag. En cas d’omission, la mise en surbrillance des suggestions est désactivée.
highlightPreTag	query		string	Balise de chaîne qui est précédée de mises en surbrillance. Doit être défini avec highlightPostTag. En cas d’omission, la mise en surbrillance des suggestions est désactivée.
minimumCoverage	query		number (double)	Nombre compris entre 0 et 100 indiquant le pourcentage de l’index qui doit être couvert par une requête de suggestions pour que la requête soit déclarée comme réussie. Ce paramètre peut être utile pour garantir la disponibilité de la recherche même pour les services avec un seul réplica. La valeur par défaut est 80.
searchFields	query		string[]	Liste des noms de champs à rechercher pour le texte de recherche spécifié. Les champs cibles doivent être inclus dans le suggesteur spécifié.

En-tête de la demande

Nom	Obligatoire	Type	Description
Accept		Accept	L’en-tête Accept.
x-ms-client-request-id		string (uuid)	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Réponses

Nom	Type	Description
200 OK	SuggestDocumentsResult	La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

api-key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

Nom	Description
https://search.azure.com/.default

Exemples

SearchIndexSuggestDocumentsGet

Exemple de requête

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?api-version=2026-04-01&search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "@search.text": "Nice <em>Hotel</em>",
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.text": "Fancy <em>Hotel</em>",
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

Définitions

Nom	Description
Accept	L’en-tête Accept.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).
SuggestDocumentsResult	Réponse contenant des résultats de requête de suggestion à partir d’un index.
SuggestResult	Résultat contenant un document trouvé par une requête de suggestion, ainsi que des métadonnées associées.

Accept

Énumération

L’en-tête Accept.

Valeur	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info		Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

SuggestDocumentsResult

Objet

Réponse contenant des résultats de requête de suggestion à partir d’un index.

Nom	Type	Description
@search.coverage	number (double)	Valeur indiquant le pourcentage de l’index inclus dans la requête, ou null si minimumCoverage n’a pas été défini dans la demande.
value	SuggestResult[]	Séquence de résultats retournés par la requête.

SuggestResult

Objet

Résultat contenant un document trouvé par une requête de suggestion, ainsi que des métadonnées associées.

Nom	Type	Description
@search.text	string	Le texte du résultat de la suggestion.