Documents - Autocomplete Post

Service:

Search Service

Version d'API:

2023-10-01-Preview

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=2023-10-01-Preview

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 d’aide pour le débogage.

Corps de la demande

Nom	Obligatoire	Type	Description
search	True	string	Texte de recherche sur lequel baser les résultats de saisie semi-automatique.
suggesterName	True	string	Nom du suggesteur tel que spécifié dans la collection suggesteurs qui fait partie de la définition d’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 lors de la production de termes remplis automatiquement.
filter		string	Expression OData qui filtre les documents utilisés pour produire des 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. Lorsque la valeur est true, la requête est automatiquement saisie des 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 floues sont plus lentes et consomment plus de ressources.
highlightPostTag		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 accès est désactivée.
highlightPreTag		string	Balise de chaîne qui est ajoutée pour atteindre les surbrillances. Doit être défini avec highlightPostTag. En cas d’omission, la mise en surbrillance des accès est désactivée.
minimumCoverage		number	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 un succès. 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		string	Liste séparée par des virgules 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é.
top		integer	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.

Réponses

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

Exemples

SearchIndexAutocompleteDocumentsPost

Exemple de requête

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2023-10-01-Preview

{
  "autocompleteMode": "oneTerm",
  "search": "washington medic",
  "suggesterName": "sg",
  "filter": "search.in(docId,'101,102,105')",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "title,description",
  "top": 10
}

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 pour produire des termes de saisie semi-automatique.
AutocompleteRequest	Paramètres pour la correspondance approximative et autres comportements de requête 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 bardeaux 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 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 ».
oneTermWithContext	string	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 ».
twoTerms	string	La correspondance d’expressions à deux termes dans l’index sera suggérée. Par exemple, si l’entrée est « medic », les termes suggérés peuvent inclure « medicare coverage » et « medical assistant ».

AutocompleteRequest

Paramètres pour la 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 lors de la production de termes remplis automatiquement.
filter	string	Expression OData qui filtre les documents utilisés pour produire des 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. Lorsque la valeur est true, la requête est automatiquement saisie des 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 floues sont plus lentes et consomment plus de ressources.
highlightPostTag	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 accès est désactivée.
highlightPreTag	string	Balise de chaîne qui est ajoutée pour atteindre les surbrillances. Doit être défini avec highlightPostTag. En cas d’omission, la mise en surbrillance des accès est désactivée.
minimumCoverage	number	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 un succès. 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.
search	string	Texte de recherche sur lequel baser les résultats de saisie semi-automatique.
searchFields	string	Liste séparée par des virgules 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é.
suggesterName	string	Nom du suggesteur tel que spécifié dans la collection suggesteurs qui fait partie de la définition d’index.
top	integer	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.

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 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 par l’homme de l’erreur.