Documents - Suggest Post

  • Référence
Service:
Search Service
Version d'API:
2024-07-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=2024-07-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 comporter au moins 1 caractère et pas plus de 100 caractères.
suggesterName True

string

Nom du suggesteur tel que spécifié dans la collection 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 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 recherches de suggestions approximatives 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. S’il est omis, la mise en surbrillance des suggestions est désactivée.
highlightPreTag

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

number

Nombre compris entre 0 et 100 indiquant le pourcentage de l’index qui doit être couvert par une requête de suggestion 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.
orderby

string

Liste séparée par des virgules d’OData $orderby expressions 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.
searchFields

string

Liste séparée par des virgules des noms de champs à rechercher dans 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

ErrorResponse

Réponse d’erreur.

Exemples

SearchIndexSuggestDocumentsPost

Exemple de requête

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2024-07-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
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
SuggestDocumentsResult

Réponse contenant des résultats de requête de suggestion à partir 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, ainsi que des métadonnées associées.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d’erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

SuggestDocumentsResult

Réponse contenant des résultats de requête de suggestion à partir 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és 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 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 recherches de suggestions approximatives 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. S’il est omis, la mise en surbrillance des suggestions est désactivée.
highlightPreTag

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

number

Nombre compris entre 0 et 100 indiquant le pourcentage de l’index qui doit être couvert par une requête de suggestion 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.
orderby

string

Liste séparée par des virgules d’OData $orderby expressions 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.
search

string

Texte de recherche à utiliser pour suggérer des documents. Doit comporter au moins 1 caractère et pas plus de 100 caractères.
searchFields

string

Liste séparée par des virgules des noms de champs à rechercher dans 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 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, ainsi que des métadonnées associées.

Nom Type Description
@search.text

string

Texte du résultat de la suggestion.