Partager via


SearchParameters Classe

Définition

Paramètres de filtrage, de tri, de facettes, de pagination et d’autres comportements de requête de recherche.

public class SearchParameters
type SearchParameters = class
Public Class SearchParameters
Héritage
SearchParameters

Constructeurs

SearchParameters()

Initialise une nouvelle instance de la classe SearchParameters.

SearchParameters(Boolean, IList<String>, String, IList<String>, String, String, Nullable<Double>, IList<String>, QueryType, IList<ScoringParameter>, String, IList<String>, SearchMode, IList<String>, Nullable<Int32>, Nullable<Int32>)

Initialise une nouvelle instance de la classe SearchParameters.

Propriétés

Facets

Obtient ou définit la liste des expressions de facettes à appliquer à la requête de recherche. Chaque expression de facette contient un nom de champ, éventuellement suivi d’une liste séparée par des virgules de paires nom:valeur.

Filter

Obtient ou définit l’expression OData $filter à appliquer à la requête de recherche.

HighlightFields

Obtient ou définit la liste des noms de champs à utiliser pour les surbrillances d’accès. Seuls les champs pouvant faire l’objet d’une recherche peuvent être utilisés pour la mise en surbrillance des accès.

HighlightPostTag

Obtient ou définit une balise de chaîne qui est ajoutée aux surbrillances d’accès. Doit être défini avec highlightPreTag. La valeur par défaut est &amp;lt;/em&amp;gt;.

HighlightPreTag

Obtient ou définit une balise de chaîne qui est précédée d’atteindre les surbrillances. Doit être défini avec highlightPostTag. La valeur par défaut est &amp;lt;em&amp;gt;.

IncludeTotalResultCount

Obtient ou définit une valeur qui spécifie s’il faut extraire le nombre total de résultats. La valeur par défaut est false. La définition de cette valeur sur true peut avoir un impact sur les performances. Notez que le nombre retourné est une approximation.

MinimumCoverage

Obtient ou définit un nombre compris entre 0 et 100 indiquant le pourcentage de l’index qui doit être couvert par une requête de recherche 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 un seul réplica. La valeur par défaut est 100.

OrderBy

Obtient ou définit la 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 la montée et 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 aucun OrderBy n’est spécifié, 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.

QueryType

Obtient ou définit une valeur qui spécifie la syntaxe de la requête de recherche. La valeur par défaut est « simple ». Utilisez « full » si votre requête utilise la syntaxe de requête Lucene. Les valeurs possibles sont les suivantes : 'simple', 'full'

ScoringParameters

Obtient ou définit la liste des valeurs de paramètres à utiliser dans les fonctions de scoring (par exemple, referencePointParameter) à l’aide du format name-values. Par exemple, si le profil de scoring définit une fonction avec un paramètre appelé « mylocation », la chaîne de paramètre est « mylocation--122.2,44.8 » (sans les guillemets).

ScoringProfile

Obtient ou définit le nom d’un profil de scoring pour évaluer les scores de correspondance pour les documents correspondants afin de trier les résultats.

SearchFields

Obtient ou définit la liste des noms de champs auxquels étendre la recherche en texte intégral. Lorsque vous utilisez la recherche sur champ (fieldName:searchExpression) dans une requête Lucene complète, les noms de champ de chaque expression de recherche avec champ sont prioritaires sur les noms de champs répertoriés dans ce paramètre.

SearchMode

Obtient ou définit une valeur qui spécifie si tout ou partie des termes de recherche doivent être mis en correspondance pour compter le document comme une correspondance. Les valeurs possibles sont les suivantes : 'any', 'all'

Select

Obtient ou définit la liste des champs à récupérer. Si aucune valeur n'est spécifiée, tous les champs marqués comme récupérables dans le schéma sont inclus.

Skip

Obtient ou définit le nombre de résultats de recherche à ignorer. Cette valeur ne peut pas être supérieure à 100 000. Si vous avez besoin d’analyser des documents dans l’ordre, mais que vous ne pouvez pas utiliser $skip en raison de cette limitation, envisagez d’utiliser $orderby sur une clé entièrement ordonnée et $filter avec une requête de plage à la place.

Top

Obtient ou définit le nombre de résultats de recherche à récupérer. Cela peut être utilisé conjointement avec $skip pour implémenter la pagination côté client des résultats de recherche. Si les résultats sont tronqués en raison de la pagination côté serveur, la réponse inclut un jeton de continuation qui peut être utilisé pour émettre une autre demande de recherche pour la page de résultats suivante.

S’applique à