Documents - Suggest Post

Référence

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é.

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?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.

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.

Corps de la demande

Nom	Obligatoire	Type	Description
search	True	string	Texte de recherche à utiliser pour suggérer des documents. Doit comprendre 1 caractère au minimum et 100 caractères au maximum.
suggesterName	True	string	Nom du suggesteur tel que spécifié dans la collection de suggesteurs qui fait partie de la définition d’index.
filter		string	Expression OData qui filtre les documents pris en compte pour les suggestions.
fuzzy		boolean	Valeur indiquant s’il faut utiliser la correspondance approximative pour la requête de suggestion. La valeur par défaut est false. Lorsque la valeur est true, la requête trouve des suggestions même s’il y a un caractère remplacé ou manquant dans le texte de recherche. Si cette fonction améliore l'expérience dans certains scénarios, elle a une incidence sur les performances, car les recherches de suggestions approximatives sont plus lentes et consomment davantage de ressources.
highlightPostTag		string	Balise de chaîne qui est ajoutée aux surbrillances d’accès. Doit être défini avec highlightPreTag. En cas d’omission, la mise en surbrillance des suggestions est désactivée.
highlightPreTag		string	Balise de chaîne qui est précédée pour atteindre les surlignages. Doit être défini avec highlightPostTag. En cas d’omission, la mise en surbrillance des suggestions 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 suggestion 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.
orderby		string	Liste séparée par des virgules 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 de desc pour indiquer une valeur décroissante. 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 est décroissant par score de correspondance de document. Il peut y avoir au maximum 32 clauses $orderby.
searchFields		string	Liste de noms de champs séparés par des virgules pour rechercher le texte de recherche spécifié. Les champs cibles doivent être inclus dans le suggesteur spécifié.
select		string	Liste de champs séparés par des virgules à récupérer. S’il n’est pas spécifié, seul le champ clé est inclus dans les résultats.
top		integer	Nombre de suggestions à 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	SuggestDocumentsResult	Réponse contenant des documents suggérés qui correspondent à l’entrée partielle.
Other Status Codes	SearchError	Réponse d’erreur.

Exemples

SearchIndexSuggestDocumentsPost

Exemple de requête

HTTP

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

{
  "filter": "rating gt 4.0",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "rating desc",
  "search": "hote",
  "searchFields": "title",
  "select": "docId,title,description",
  "suggesterName": "sg",
  "top": 10
}

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 les résultats de requête de suggestion d’un index.
SuggestRequest	Paramètres pour le filtrage, le tri, la correspondance approximative et d’autres comportements de requête de suggestions.
SuggestResult	Résultat contenant un document trouvé par une requête de suggestion, plus les métadonnées associées.

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.

SuggestDocumentsResult

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

Nom	Type	Description
@search.coverage	number	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ée par la requête.

SuggestRequest

Paramètres pour le filtrage, le tri, la correspondance approximative et d’autres comportements de requête de suggestions.

Nom	Type	Description
filter	string	Expression OData qui filtre les documents pris en compte pour les suggestions.
fuzzy	boolean	Valeur indiquant s’il faut utiliser la correspondance approximative pour la requête de suggestion. La valeur par défaut est false. Lorsque la valeur est true, la requête trouve des suggestions même s’il y a un caractère remplacé ou manquant dans le texte de recherche. Si cette fonction améliore l'expérience dans certains scénarios, elle a une incidence sur les performances, car les recherches de suggestions approximatives sont plus lentes et consomment davantage de ressources.
highlightPostTag	string	Balise de chaîne qui est ajoutée aux surbrillances d’accès. Doit être défini avec highlightPreTag. En cas d’omission, la mise en surbrillance des suggestions est désactivée.
highlightPreTag	string	Balise de chaîne qui est précédée pour atteindre les surlignages. Doit être défini avec highlightPostTag. En cas d’omission, la mise en surbrillance des suggestions 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 suggestion 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.
orderby	string	Liste séparée par des virgules 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 de desc pour indiquer une valeur décroissante. 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 est décroissant par score de correspondance de document. Il peut y avoir au maximum 32 clauses $orderby.
search	string	Texte de recherche à utiliser pour suggérer des documents. Doit comprendre 1 caractère au minimum et 100 caractères au maximum.
searchFields	string	Liste de noms de champs séparés par des virgules pour rechercher le texte de recherche spécifié. Les champs cibles doivent être inclus dans le suggesteur spécifié.
select	string	Liste de champs séparés par des virgules à récupérer. S’il n’est pas spécifié, seul le champ clé est inclus dans les résultats.
suggesterName	string	Nom du suggesteur tel que spécifié dans la collection de suggesteurs qui fait partie de la définition d’index.
top	integer	Nombre de suggestions à récupérer. Il doit s’agir d’une valeur comprise entre 1 et 100. La valeur par défaut est 5.

SuggestResult

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

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

Partager via