SearchIndex interface

Paquet:

@azure/search-documents

Représente une définition d’index de recherche, qui décrit les champs et le comportement de recherche d’un index.

Propriétés

analyzers	Analyseurs pour l’index.
charFilters	Filtres de caractères pour l’index.
corsOptions	Options permettant de contrôler le partage de ressources entre les origines (CORS) pour l’index.
defaultScoringProfile	Nom du profil de scoring à utiliser si aucun n’est spécifié dans la requête. Si cette propriété n’est pas définie et qu’aucun profil de scoring n’est spécifié dans la requête, le scoring par défaut (tf-idf) est utilisé.
encryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé est utilisée pour fournir un niveau supplémentaire de chiffrement au repos pour vos données lorsque vous souhaitez avoir l’assurance complète que personne, pas même Microsoft, ne peut déchiffrer vos données dans Recherche cognitive Azure. Une fois que vous avez chiffré vos données, elles restent toujours chiffrées. Recherche cognitive Azure ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si nécessaire si vous souhaitez faire pivoter votre clé de chiffrement ; Vos données ne seront pas affectées. Le chiffrement avec des clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
etag	ETag de l’index.
fields	Champs de l’index.
name	Nom de l’index.
scoringProfiles	Profils de scoring pour l’index.
semanticSearch	Définit les paramètres d’un index de recherche qui influencent les fonctionnalités sémantiques.
similarity	Type d’algorithme de similarité à utiliser lors du scoring et du classement des documents correspondant à une requête de recherche. L’algorithme de similarité ne peut être défini qu’au moment de la création de l’index et ne peut pas être modifié sur des index existants. Si la valeur est null, l’algorithme ClassicSimilarity est utilisé.
suggesters	Les suggesteurs pour l’index.
tokenFilters	Le jeton filtre pour l’index.
tokenizers	Les générateurs de jetons pour l’index.
vectorSearch	Contient des options de configuration liées à la recherche vectorielle.

Détails de la propriété

analyzers

Analyseurs pour l’index.

analyzers?: LexicalAnalyzer[]

Valeur de propriété

LexicalAnalyzer[]

charFilters

Filtres de caractères pour l’index.

charFilters?: CharFilter[]

Valeur de propriété

CharFilter[]

corsOptions

Options permettant de contrôler le partage de ressources entre les origines (CORS) pour l’index.

corsOptions?: CorsOptions

Valeur de propriété

CorsOptions

defaultScoringProfile

Nom du profil de scoring à utiliser si aucun n’est spécifié dans la requête. Si cette propriété n’est pas définie et qu’aucun profil de scoring n’est spécifié dans la requête, le scoring par défaut (tf-idf) est utilisé.

defaultScoringProfile?: string

Valeur de propriété

string

encryptionKey

Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé est utilisée pour fournir un niveau supplémentaire de chiffrement au repos pour vos données lorsque vous souhaitez avoir l’assurance complète que personne, pas même Microsoft, ne peut déchiffrer vos données dans Recherche cognitive Azure. Une fois que vous avez chiffré vos données, elles restent toujours chiffrées. Recherche cognitive Azure ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si nécessaire si vous souhaitez faire pivoter votre clé de chiffrement ; Vos données ne seront pas affectées. Le chiffrement avec des clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.

encryptionKey?: SearchResourceEncryptionKey

Valeur de propriété

SearchResourceEncryptionKey

etag

ETag de l’index.

etag?: string

Valeur de propriété

string

fields

Champs de l’index.

fields: SearchField[]

Valeur de propriété

SearchField[]

name

Nom de l’index.

name: string

Valeur de propriété

string

scoringProfiles

Profils de scoring pour l’index.

scoringProfiles?: ScoringProfile[]

Valeur de propriété

ScoringProfile[]

semanticSearch

Définit les paramètres d’un index de recherche qui influencent les fonctionnalités sémantiques.

semanticSearch?: SemanticSearch

Valeur de propriété

SemanticSearch

similarity

Type d’algorithme de similarité à utiliser lors du scoring et du classement des documents correspondant à une requête de recherche. L’algorithme de similarité ne peut être défini qu’au moment de la création de l’index et ne peut pas être modifié sur des index existants. Si la valeur est null, l’algorithme ClassicSimilarity est utilisé.

similarity?: SimilarityAlgorithm

Valeur de propriété

SimilarityAlgorithm

suggesters

Les suggesteurs pour l’index.

suggesters?: SearchSuggester[]

Valeur de propriété

SearchSuggester[]

tokenFilters

Le jeton filtre pour l’index.

tokenFilters?: TokenFilter[]

Valeur de propriété

TokenFilter[]

tokenizers

Les générateurs de jetons pour l’index.

tokenizers?: LexicalTokenizer[]

Valeur de propriété

LexicalTokenizer[]

vectorSearch

Contient des options de configuration liées à la recherche vectorielle.

vectorSearch?: VectorSearch

Valeur de propriété

VectorSearch