Partager via


SearchOptions Classe

Définition

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

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

Constructeurs

SearchOptions()

Initialise une nouvelle instance de SearchOptions.

Propriétés

Debug

Active un outil de débogage qui peut être utilisé pour explorer plus en détail vos résultats de recherche sémantique.

Facets

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

L’expression OData $filter à appliquer à la requête de recherche. Vous pouvez utiliser Create(FormattableString) pour aider à construire l’expression de filtre.

HighlightFields

Liste des noms de champs à utiliser pour les surlignages. Seuls les champs pouvant faire l’objet d’une recherche peuvent être utilisés pour la mise en surbrillance des correspondances.

HighlightPostTag

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 </em>.

HighlightPreTag

Balise de chaîne qui est précédée pour atteindre les surlignages. Doit être défini avec highlightPostTag. La valeur par défaut est <em>.

IncludeTotalCount

Valeur qui spécifie s’il faut extraire le nombre total de résultats en tant que TotalCount propriété . 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

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 une seule réplica. La valeur par défaut est 100.

OrderBy

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

QueryAnswer

Valeur qui spécifie si Answers doit être retourné dans le cadre de la réponse de recherche.

QueryAnswerCount

Valeur qui spécifie le nombre de Answers qui doivent être retournés dans le cadre de la réponse de recherche.

QueryAnswerThreshold

Valeur qui spécifie le seuil de Answers qui doit être retourné dans le cadre de la réponse de recherche.

QueryCaption

Valeur qui spécifie si Captions doit être retourné dans le cadre de la réponse de recherche.

La valeur par défaut est None.

QueryCaptionHighlightEnabled

Si QueryCaption a la valeur Extractive, la définition de true cette valeur permet la mise en surbrillance des légendes retournées. Il remplit Highlights.

La valeur par défaut est true.

QueryLanguage

Valeur qui spécifie la langue de la requête de recherche.

QuerySpeller

Valeur qui spécifie le type de l’orthographe à utiliser pour corriger l’orthographe des termes de requête de recherche individuels.

QueryType

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.

ScoringParameters

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

Nom du profil de calcul de score utilisé pour évaluer les scores de correspondance des documents correspondants afin de trier les résultats.

ScoringStatistics

Valeur qui spécifie si nous voulons calculer les statistiques de scoring (telles que la fréquence des documents) globalement pour un scoring plus cohérent, ou localement, pour une latence plus faible. La valeur par défaut est « local ». Utilisez « global » pour agréger les statistiques de scoring à l’échelle mondiale avant le scoring. L’utilisation de statistiques de scoring globales peut augmenter la latence des requêtes de recherche.

SearchFields

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 champs de chaque expression de recherche avec champ sont prioritaires sur les noms de champs répertoriés dans ce paramètre.

SearchMode

Valeur qui spécifie si tout ou partie des termes de recherche doivent être mis en correspondance pour compter le document en tant que correspondance.

Select

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.

SemanticConfigurationName

Nom d’une configuration sémantique qui sera utilisée lors du traitement de documents pour des requêtes de type sémantique.

SemanticErrorHandling

Permet à l’utilisateur de choisir si un appel sémantique doit échouer complètement ou de retourner des résultats partiels (par défaut).

SemanticFields

Liste des noms de champs utilisés pour la recherche sémantique.

SemanticMaxWaitInMilliseconds

Permet à l’utilisateur de définir une limite supérieure sur le temps nécessaire à l’enrichissement sémantique pour terminer le traitement avant l’échec de la requête.

SemanticQuery

Permet de définir une requête de recherche distincte qui sera utilisée uniquement pour la reclassement sémantique, les légendes sémantiques et les réponses sémantiques. Est utile pour les scénarios où il est nécessaire d’utiliser différentes requêtes entre la phase de récupération et de classement de base et la phase sémantique L2.

SessionId

Valeur à utiliser pour créer une session collante, qui peut vous aider à obtenir des résultats plus cohérents. Tant que le même sessionId est utilisé, une tentative de la meilleure façon est effectuée pour cibler le même réplica défini. Veillez à ce que la réutilisation répétée des mêmes valeurs sessionID puisse interférer avec l’équilibrage de charge des requêtes entre les réplicas et nuire aux performances du service de recherche. La valeur utilisée comme sessionId ne peut pas commencer par un caractère « _ ».

Size

Nombre de résultats de recherche à récupérer. Ceci peut être utilisé conjointement avec Skip pour implémenter la pagination côté client des résultats de la 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.

Skip

Nombre de résultats de recherche à ignorer. Cette valeur ne peut pas être supérieure à 100 000. Si vous devez 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é totalement ordonnée et de filtrer avec une requête de plage à la place.

VectorFilterMode

Détermine si les filtres sont appliqués avant ou après l’exécution de la recherche vectorielle. La valeur par défaut est « preFilter ».

VectorQueries

Paramètres de requête pour les requêtes de recherche multi-vecteurs.

S’applique à