Documents - Autocomplete Post

Service:: Search Service

Version d'API:: 2025-09-01

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2025-09-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	URL du point de terminaison du service de recherche.
indexName	path	True	string	Nom de l’index.
api-version	query	True	string	Version de l’API cliente.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string (uuid)	ID de suivi envoyé avec la demande pour aider au débogage.

Corps de la demande

Nom	Obligatoire	Type	Description
search	True	string	Le texte de recherche sur lequel baser les résultats de la saisie semi-automatique.
suggesterName	True	string	Nom du suggesteur tel qu’il est spécifié dans la collection de suggesteurs qui fait partie de la définition de l’index.
autocompleteMode		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.
filter		string	Expression OData qui filtre les documents utilisés pour produire les termes terminés pour le résultat de la saisie semi-automatique.
fuzzy		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 complète automatiquement les 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		string	Une balise de chaîne qui est ajoutée aux points forts des hits. Doit être défini avec highlightPreTag. S’il est omis, la mise en surbrillance des appuis est désactivée.
highlightPreTag		string	Une balise de chaîne qui est ajoutée pour frapper les points forts. Doit être défini avec highlightPostTag. S’il est omis, la mise en surbrillance des appuis est désactivée.
minimumCoverage		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 ne comportant qu’un seul réplica. La valeur par défaut est 80.
searchFields		string	Liste des noms de champs séparés par des virgules à prendre en compte lors de l’interrogation de termes auto-complétés. Les champs cibles doivent être inclus dans le suggesteur spécifié.
top		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.

Réponses

Nom	Type	Description
200 OK	AutocompleteResult	Réponse contenant des termes de requête suggérés qui complètent la saisie partielle.
Other Status Codes	ErrorResponse	Réponse d’erreur.

Exemples

SearchIndexAutocompleteDocumentsPost

Exemple de requête

HTTP

POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.autocomplete?api-version=2025-09-01


{
  "search": "p",
  "autocompleteMode": "oneTerm",
  "filter": "ownerId ne '1'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "category, ownerId",
  "suggesterName": "sg",
  "top": 10
}

Exemple de réponse

Code d’état:: 200

{
  "@search.coverage": 100,
  "value": [
    {
      "text": "purple",
      "queryPlusText": "<em>purple</em>"
    },
    {
      "text": "pink",
      "queryPlusText": "<em>pink</em>"
    }
  ]
}

Définitions

Nom	Description
AutocompleteItem	Le 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.
AutocompleteRequest	Paramètres de correspondance approximative et autres comportements de requête 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 d’erreur

AutocompleteItem

Object

Le résultat des demandes de saisie semi-automatique.

Nom	Type	Description
queryPlusText	string	La requête avec la durée terminée.
text	string	Le 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 ».

AutocompleteRequest

Object

Paramètres de correspondance approximative et autres comportements de requête de saisie semi-automatique.

Nom	Type	Description
autocompleteMode	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.
filter	string	Expression OData qui filtre les documents utilisés pour produire les termes terminés pour le résultat de la saisie semi-automatique.
fuzzy	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 complète automatiquement les 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	string	Une balise de chaîne qui est ajoutée aux points forts des hits. Doit être défini avec highlightPreTag. S’il est omis, la mise en surbrillance des appuis est désactivée.
highlightPreTag	string	Une balise de chaîne qui est ajoutée pour frapper les points forts. Doit être défini avec highlightPostTag. S’il est omis, la mise en surbrillance des appuis est désactivée.
minimumCoverage	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 ne comportant qu’un seul réplica. La valeur par défaut est 80.
search	string	Le texte de recherche sur lequel baser les résultats de la saisie semi-automatique.
searchFields	string	Liste des noms de champs séparés par des virgules à prendre en compte lors de l’interrogation de termes auto-complétés. Les champs cibles doivent être inclus dans le suggesteur spécifié.
suggesterName	string	Nom du suggesteur tel qu’il est spécifié dans la collection de suggesteurs qui fait partie de la définition de l’index.
top	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.

AutocompleteResult

Object

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

Nom	Type	Description
@search.coverage	number (double)	Valeur indiquant le pourcentage de l’index qui a été pris en compte par la demande de saisie semi-automatique, ou null si minimumCoverage n’a pas été spécifié dans la demande.
value	AutocompleteItem[]	La liste des éléments renvoyés avec saisie semi-automatique.

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

Partager via

Documents - Autocomplete Post

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Exemples

SearchIndexAutocompleteDocumentsPost

Exemple de requête

Exemple de réponse

Définitions

AutocompleteItem

AutocompleteMode

AutocompleteRequest

AutocompleteResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse