Documents - Autocomplete Get

Service:: Search Service

Version d'API:: 2023-11-01

La 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=2023-11-01&search={search}&suggesterName={suggesterName}

Avec des paramètres facultatifs:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-11-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	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.
search	query	True	string	Terme incomplet qui doit être terminé 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 des termes terminés pour le résultat de saisie semi-automatique.
$top	query		integer (int32)	Nombre de termes exécuté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 de saisie semi-automatique.
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. Lorsque la valeur est true, la requête trouve des termes même s’il existe un caractère substitué ou manquant dans le texte de recherche. Bien que cela offre une meilleure expérience dans certains scénarios, il s’agit d’un coût de performances, car les requêtes de saisie semi-automatique approximative 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 de l’accès 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 de l’accès 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 afin que la requête soit signalée comme une réussite. 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 des termes de saisie semi-automatique. Les champs cibles doivent être inclus dans le suggesteur spécifié.

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 faciliter le débogage.

Réponses

Nom	Type	Description
200 OK	AutocompleteResult	Réponse contenant des termes de requête suggérés qui terminent l’entrée partielle.
Other Status Codes	SearchError	Réponse d’erreur.

Exemples

SearchIndexAutocompleteDocumentsGet

Exemple de requête

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2023-11-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
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.
SearchError	Décrit une condition d’erreur pour l’API.

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 a 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	Les expressions à deux termes correspondantes dans l’index sont suggérées. Par exemple, si l’entrée est « medic », les termes suggérés peuvent inclure « assurance-maladie » et « assistant médical ».
oneTermWithContext	Termine 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.

SearchError

Objet

Décrit une condition d’erreur pour l’API.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	SearchError[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
message	string	Représentation lisible par l’homme de l’erreur.