Documents - Autocomplete Get

Service:: Search Service

Version d'API:: 2026-04-01

Saisie semi-automatique des termes de requête incomplets en fonction du texte d’entrée et des termes correspondants dans l’index.

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

Avec des paramètres facultatifs:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2026-04-01&search={search}&suggesterName={suggesterName}&autocompleteMode={autocompleteMode}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&searchFields={searchFields}&$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	Le terme incomplet qui doit être complété automatiquement.
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 utilisés pour produire les termes terminés pour le résultat de la saisie semi-automatique.
$top	query		integer (int32)	Nombre de termes complétés automatiquement à récupérer. Il doit s’agir d’une valeur comprise entre 1 et 100. La valeur par défaut est 5.
autocompleteMode	query		AutocompleteMode	Spécifie le mode de saisie semi-automatique. La valeur par défaut est 'oneTerm'. Utilisez 'twoTerms' pour obtenir des bardeaux et 'oneTermWithContext' pour utiliser le contexte actuel tout en produisant des termes complétés automatiquement.
fuzzy	query		boolean	Valeur indiquant s’il faut utiliser la correspondance approximative pour la requête de saisie semi-automatique. 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 saisie semi-automatique floue 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. S’il est omis, la mise en surbrillance des appuis 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. S’il est omis, la mise en surbrillance des appuis 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 saisie semi-automatique pour que la requête soit signalé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 à prendre en compte lors de l’interrogation de termes auto-complétés. 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	AutocompleteResult	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

SearchIndexAutocompleteDocumentsGet

Exemple de requête

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2026-04-01&search=washington medic&suggesterName=sg&autocompleteMode=oneTerm&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&searchFields=title,description

Exemple de réponse

Code d’état:: 200

[
  {
    "text": "medicaid",
    "queryPlusText": "washington medicaid"
  },
  {
    "text": "medicare",
    "queryPlusText": "washington medicare"
  },
  {
    "text": "medicine",
    "queryPlusText": "washington medicine"
  }
]

Définitions

Nom	Description
Accept	L’en-tête Accept.
AutocompleteItem	Résultat des demandes de saisie semi-automatique.
AutocompleteMode	Spécifie le mode de saisie semi-automatique. La valeur par défaut est 'oneTerm'. Utilisez 'twoTerms' pour obtenir des bardeaux et 'oneTermWithContext' pour utiliser le contexte actuel dans la production de termes de saisie semi-automatique.
AutocompleteResult	Résultat de la requête de saisie semi-automatique.
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.).

Accept

Énumération

L’en-tête Accept.

Valeur	Description
application/json;odata.metadata=none

AutocompleteItem

Objet

Résultat des demandes de saisie semi-automatique.

Nom	Type	Description
queryPlusText	string	Requête avec le terme terminé.
text	string	Terme terminé.

AutocompleteMode

Énumération

Spécifie le mode de saisie semi-automatique. La valeur par défaut est 'oneTerm'. Utilisez 'twoTerms' pour obtenir des bardeaux et 'oneTermWithContext' pour utiliser le contexte actuel dans la production de termes de saisie semi-automatique.

Valeur	Description
oneTerm	Un seul terme est suggéré. Si la requête comporte deux termes, seul le dernier terme est terminé. Par exemple, si l’entrée est « washington medic », les termes suggérés peuvent inclure « medicaid », « medicare » et « medicine ».
twoTerms	Il sera suggéré de faire correspondre les phrases à deux termes dans l’index. Par exemple, si l’entrée est « medic », les termes suggérés peuvent inclure « couverture medicare » et « assistant médical ».
oneTermWithContext	Complète le dernier terme d’une requête avec deux termes ou plus, où les deux derniers termes sont une expression qui existe dans l’index. Par exemple, si l’entrée est « washington medic », les termes suggérés peuvent inclure « washington medicaid » et « washington medical ».

AutocompleteResult

Objet

Résultat de la requête de saisie semi-automatique.

Nom	Type	Description
@search.coverage	number (double)	Valeur indiquant le pourcentage de l’index considéré par la requête de saisie semi-automatique ou null si minimumCoverage n’a pas été spécifié dans la requête.
value	AutocompleteItem[]	Liste des éléments supprimés automatiquement retournés.

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.