Documents - Suggest Get

Service:: Search Service

Version d'API:: 2023-11-01

Suggère des documents dans l’index qui correspondent au texte de requête partiel donné.

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&api-version=2023-11-01

Avec des paramètres facultatifs:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}&api-version=2023-11-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.
search	query	True	string	Texte de recherche à utiliser pour suggérer des documents. Doit comporter au moins 1 caractère et pas plus de 100 caractères.
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 pris en compte pour les suggestions.
$orderby	query		string[]	Liste des expressions OData $orderby par lesquelles trier les résultats. Chaque expression peut être un nom de champ ou un appel aux fonctions geo.distance() ou search.score(). Chaque expression peut être suivie d’asc pour indiquer l’ordre croissant ou desc pour indiquer l’ordre décroissant. La valeur par défaut est l’ordre croissant. Les liens seront rompus par les scores de correspondance des documents. Si aucune $orderby n’est spécifiée, l’ordre de tri par défaut descend par score de correspondance de document. Il peut y avoir au maximum 32 clauses $orderby.
$select	query		string[]	Liste des champs à récupérer. S’il n’est pas spécifié, seul le champ clé est inclus dans les résultats.
$top	query		integer (int32)	Nombre de suggestions à récupérer. La valeur doit être un nombre compris entre 1 et 100. La valeur par défaut est 5.
fuzzy	query		boolean	Valeur indiquant s’il faut utiliser la correspondance approximative pour la requête suggestions. 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 suggestions approximatives 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 suggestions 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 suggestions 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 suggestions 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 à rechercher dans le texte de recherche spécifié. 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	SuggestDocumentsResult	Réponse contenant des documents suggérés qui correspondent à l’entrée partielle.
Other Status Codes	SearchError	Réponse d’erreur.

Exemples

SearchIndexSuggestDocumentsGet

Exemple de requête

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10&api-version=2023-11-01

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "@search.text": "Nice <em>Hotel</em>",
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.text": "Fancy <em>Hotel</em>",
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

Définitions

Nom	Description
SearchError	Décrit une condition d’erreur pour l’API.
SuggestDocumentsResult	Réponse contenant des résultats de requête de suggestion à partir d’un index.
SuggestResult	Résultat contenant un document trouvé par une requête de suggestion, ainsi que des métadonnées associées.

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.

SuggestDocumentsResult

Objet

Réponse contenant des résultats de requête de suggestion à partir d’un index.

Nom	Type	Description
@search.coverage	number (double)	Valeur indiquant le pourcentage de l’index inclus dans la requête ou null si minimumCoverage n’a pas été défini dans la requête.
value	SuggestResult[]	Séquence de résultats retournés par la requête.

SuggestResult

Objet

Résultat contenant un document trouvé par une requête de suggestion, ainsi que des métadonnées associées.

Nom	Type	Description
@search.text	string	Texte du résultat de la suggestion.