Documents - Autocomplete Get

Référence

Service:: Search Service

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

With optional parameters:

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 rempli automatiquement.
suggesterName	query	True	string	Nom du suggesteur tel que spécifié dans la collection de 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 la saisie semi-automatique.
$top	query		integer int32	Nombre de termes remplis 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 shingles et « oneTermWithContext » pour utiliser le contexte actuel lors de la production de termes remplis automatiquement.
fuzzy	query		boolean	Valeur indiquant s’il faut utiliser une correspondance approximative pour la requête d’autocomplétion. La valeur par défaut est false. Lorsque la valeur est true, la requête trouve les termes même s’il existe un caractère remplacé ou manquant dans le texte de recherche. Bien que cela offre une meilleure expérience dans certains scénarios, cela a un coût de performances, car les requêtes de saisie semi-automatique approximatives sont plus lentes et consomment plus de ressources.
highlightPostTag	query		string	Balise de chaîne qui est ajoutée aux surbrillances d’accès. Doit être défini avec highlightPreTag. S’il est omis, la mise en surbrillance des correspondances est désactivée.
highlightPreTag	query		string	Balise de chaîne qui est précédée pour atteindre les surlignages. Doit être défini avec highlightPostTag. S’il est omis, la mise en surbrillance des correspondances 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 une réussite. Ce paramètre peut être utile pour garantir la disponibilité de la recherche, même pour les services avec une seule 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 remplis automatiquement. 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

Sample Request

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

Sample Response

Status code:: 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 shingles et « oneTermWithContext » pour utiliser le contexte actuel pour produire des 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

Résultat des demandes de saisie semi-automatique.

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

AutocompleteMode

Spécifie le mode de saisie semi-automatique. La valeur par défaut est « oneTerm ». Utilisez « twoTerms » pour obtenir des shingles et « oneTermWithContext » pour utiliser le contexte actuel pour produire des termes de saisie semi-automatique.

Nom	Type	Description
oneTerm	string	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 ».
oneTermWithContext	string	Termine le dernier terme d’une requête avec au moins deux termes, 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 ».
twoTerms	string	La mise en correspondance d’expressions à deux termes dans l’index est suggérée. Par exemple, si l’entrée est « medic », les termes suggérés peuvent inclure « assurance-maladie » et « assistant médicales ».

AutocompleteResult

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

Nom	Type	Description
@search.coverage	number	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[]	Liste des éléments supprimés automatiquement retournés.

SearchError

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

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

Partager via