Documents - Autocomplete Post

La 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=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 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 tout en produisant des termes de saisie semi-automatique.

filter

string

Expression OData qui filtre les documents utilisés pour produire des termes terminés pour le résultat de 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. Lorsqu’elle a la valeur true, la requête effectue la saisie semi-automatique 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 saisie semi-automatique approximative 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 de l’accès 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. En cas d’omission, la mise en surbrillance de l’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 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

string

Liste séparée par des virgules des noms de champs à prendre en compte lors de l’interrogation des termes de saisie semi-automatique. Les champs cibles doivent être inclus dans le suggesteur spécifié.

top

integer

Nombre de termes exécutés 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 terminent l’entrée partielle.

Other Status Codes

ErrorResponse

Réponse d’erreur.

Exemples

SearchIndexAutocompleteDocumentsPost

Exemple de requête

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

{
  "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

[
  {
    "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 dans la production de termes de saisie semi-automatique.

AutocompleteRequest

Paramètres de correspondance approximative et autres comportements de requête de saisie semi-automatique.

AutocompleteResult

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

ErrorAdditionalInfo

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

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

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 dans la production de 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

Les expressions à deux termes correspondantes dans l’index sont suggérées. Par exemple, si l’entrée est « medic », les termes suggérés peuvent inclure « assurance-maladie » et « assistant médical ».

AutocompleteRequest

Paramètres de 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 tout en produisant des termes de saisie semi-automatique.

filter

string

Expression OData qui filtre les documents utilisés pour produire des termes terminés pour le résultat de 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. Lorsqu’elle a la valeur true, la requête effectue la saisie semi-automatique 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 saisie semi-automatique approximative 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 de l’accès 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. En cas d’omission, la mise en surbrillance de l’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 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.

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 des termes de saisie semi-automatique. 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 exécutés 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 considéré par la requête de saisie semi-automatique ou null si minimumCoverage n’a pas été spécifié dans la requête.

value

AutocompleteItem[]

Liste des éléments supprimés automatiquement retournés.

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.