Partager via

BaseSearchRequestOptions interface

Paquet:
@azure/search-documents

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

Propriétés

facets

Liste des expressions de facette à 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 name :value.
filter

L’expression OData $filter à appliquer à la requête de recherche.
highlightFields

Liste séparée par des virgules 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

Balise de chaîne 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 de mises en surbrillance. 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. 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 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 100.
orderBy

Liste des expressions OData $orderby 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.
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. Les valeurs possibles sont les suivantes : 'simple', 'full', 'semantic'
scoringParameters

Liste des valeurs de paramètre à utiliser dans les fonctions de scoring (par exemple, referencePointParameter) à l’aide des valeurs de nom de format. 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 d’un profil de scoring pour évaluer les scores de correspondance pour les documents correspondants afin de trier les résultats.
scoringStatistics

Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence inférieure. Les valeurs possibles sont les suivantes : « Local », « Global »
searchFields

Liste séparée par des virgules des noms de champs auxquels étendre la recherche en texte intégral. Lors de l’utilisation de la recherche fielded (fieldName :searchExpression) dans une requête Lucene complète, les noms de champs de chaque expression de recherche fielded sont prioritaires sur tous les noms de champs répertoriés dans ce paramètre.
searchMode

Valeur qui spécifie si l’un ou l’ensemble des termes de recherche doivent être mis en correspondance pour compter le document comme correspondance. Les valeurs possibles sont les suivantes : 'any', 'all'
select

Liste des champs à récupérer. S’il n’est pas spécifié, tous les champs marqués comme récupérables dans le schéma sont inclus.
sessionId

Valeur à utiliser pour créer une session sticky, qui peut aider à obtenir des résultats plus cohérents. Tant que le même id de session est utilisé, une tentative optimale sera effectuée pour cibler le même jeu de réplicas. Soyez prudent que la réutilisation des mêmes valeurs sessionID peut interférer à plusieurs reprises avec l’équilibrage de charge des requêtes entre les réplicas et affecter négativement les performances du service de recherche. La valeur utilisée en tant que sessionId ne peut pas commencer par un caractère '_'.
skip

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 la séquence, mais que vous ne pouvez pas l’utiliser en raison de cette limitation, envisagez d’utiliser orderby sur une clé totalement ordonnée et filtrer avec une requête de plage à la place.
top

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 suivante des résultats.
vectorSearchOptions

Définit des options pour les requêtes de recherche vectorielle

Détails de la propriété

facets

Liste des expressions de facette à 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 name :value.

facets?: string[]

Valeur de propriété

string[]

filter

L’expression OData $filter à appliquer à la requête de recherche.

filter?: string

Valeur de propriété

string

highlightFields

Liste séparée par des virgules 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.

highlightFields?: string

Valeur de propriété

string

highlightPostTag

Balise de chaîne ajoutée aux surbrillances d’accès. Doit être défini avec highlightPreTag. La valeur par défaut est </em>.

highlightPostTag?: string

Valeur de propriété

string

highlightPreTag

Balise de chaîne qui est précédée de mises en surbrillance. Doit être défini avec highlightPostTag. La valeur par défaut est <em>.

highlightPreTag?: string

Valeur de propriété

string

includeTotalCount

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.

includeTotalCount?: boolean

Valeur de propriété

boolean

minimumCoverage

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

minimumCoverage?: number

Valeur de propriété

number

orderBy

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

orderBy?: string[]

Valeur de propriété

string[]

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. Les valeurs possibles sont les suivantes : 'simple', 'full', 'semantic'

queryType?: QueryType

Valeur de propriété

QueryType

scoringParameters

Liste des valeurs de paramètre à utiliser dans les fonctions de scoring (par exemple, referencePointParameter) à l’aide des valeurs de nom de format. 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).

scoringParameters?: string[]

Valeur de propriété

string[]

scoringProfile

Nom d’un profil de scoring pour évaluer les scores de correspondance pour les documents correspondants afin de trier les résultats.

scoringProfile?: string

Valeur de propriété

string

scoringStatistics

Valeur qui spécifie si nous voulons calculer des statistiques de scoring (telles que la fréquence du document) globalement pour un scoring plus cohérent, ou localement, pour une latence inférieure. Les valeurs possibles sont les suivantes : « Local », « Global »

scoringStatistics?: ScoringStatistics

Valeur de propriété

ScoringStatistics

searchFields

Liste séparée par des virgules des noms de champs auxquels étendre la recherche en texte intégral. Lors de l’utilisation de la recherche fielded (fieldName :searchExpression) dans une requête Lucene complète, les noms de champs de chaque expression de recherche fielded sont prioritaires sur tous les noms de champs répertoriés dans ce paramètre.

searchFields?: SearchFieldArray<TModel>

Valeur de propriété

SearchFieldArray<TModel>

searchMode

Valeur qui spécifie si l’un ou l’ensemble des termes de recherche doivent être mis en correspondance pour compter le document comme correspondance. Les valeurs possibles sont les suivantes : 'any', 'all'

searchMode?: SearchMode

Valeur de propriété

SearchMode

select

Liste des champs à récupérer. S’il n’est pas spécifié, tous les champs marqués comme récupérables dans le schéma sont inclus.

select?: SelectArray<TFields>

Valeur de propriété

SelectArray<TFields>

sessionId

Valeur à utiliser pour créer une session sticky, qui peut aider à obtenir des résultats plus cohérents. Tant que le même id de session est utilisé, une tentative optimale sera effectuée pour cibler le même jeu de réplicas. Soyez prudent que la réutilisation des mêmes valeurs sessionID peut interférer à plusieurs reprises avec l’équilibrage de charge des requêtes entre les réplicas et affecter négativement les performances du service de recherche. La valeur utilisée en tant que sessionId ne peut pas commencer par un caractère '_'.

sessionId?: string

Valeur de propriété

string

skip

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 la séquence, mais que vous ne pouvez pas l’utiliser en raison de cette limitation, envisagez d’utiliser orderby sur une clé totalement ordonnée et filtrer avec une requête de plage à la place.

skip?: number

Valeur de propriété

number

top

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 suivante des résultats.

top?: number

Valeur de propriété

number

vectorSearchOptions

Définit des options pour les requêtes de recherche vectorielle

vectorSearchOptions?: VectorSearchOptions<TModel>

Valeur de propriété

VectorSearchOptions<TModel>