SuggestRequest interface

Paquet:

@azure/search-documents

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

Propriétés

filter	Expression OData qui filtre les documents pris en compte pour les suggestions.
highlightPostTag	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 suggestions est désactivée.
highlightPreTag	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 suggestions est désactivée.
minimumCoverage	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 en tant que 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	Liste des expressions OData $orderby selon 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 la 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	Liste séparée par des virgules des noms de champs pour rechercher le texte de recherche spécifié. Les champs cibles doivent être inclus dans le suggesteur spécifié.
select	Liste des champs à récupérer. S’il n’est pas spécifié, seul le champ clé est inclus dans les résultats.
top	/** Nombre de suggestions à récupérer. Il doit s’agir d’une valeur comprise entre 1 et 100. La valeur par défaut est
useFuzzyMatching	Valeur indiquant s’il faut utiliser la correspondance approximative pour la requête de suggestion. La valeur par défaut est false. Lorsqu’elle est définie sur true, la requête trouve des suggestions même s’il existe 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.

Détails de la propriété

filter

Expression OData qui filtre les documents pris en compte pour les suggestions.

filter?: string

Valeur de propriété

string

highlightPostTag

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 suggestions est désactivée.

highlightPostTag?: string

Valeur de propriété

string

highlightPreTag

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 suggestions est désactivée.

highlightPreTag?: string

Valeur de propriété

string

minimumCoverage

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 en tant que 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.

minimumCoverage?: number

Valeur de propriété

number

orderBy

Liste des expressions OData $orderby selon 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 la 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.

orderBy?: string[]

Valeur de propriété

string[]

searchFields

Liste séparée par des virgules des noms de champs pour rechercher le texte de recherche spécifié. Les champs cibles doivent être inclus dans le suggesteur spécifié.

searchFields?: SearchFieldArray<TModel>

Valeur de propriété

SearchFieldArray<TModel>

select

Liste des champs à récupérer. S’il n’est pas spécifié, seul le champ clé est inclus dans les résultats.

select?: SelectArray<TFields>

Valeur de propriété

SelectArray<TFields>

top

/**

• Nombre de suggestions à récupérer. Il doit s’agir d’une valeur comprise entre 1 et 100. La valeur par défaut est

top?: number

Valeur de propriété

number

useFuzzyMatching

Valeur indiquant s’il faut utiliser la correspondance approximative pour la requête de suggestion. La valeur par défaut est false. Lorsqu’elle est définie sur true, la requête trouve des suggestions même s’il existe 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.

useFuzzyMatching?: boolean

Valeur de propriété

boolean