SearchIndex interface

Package:

@azure/search-documents

Represents a search index definition, which describes the fields and search behavior of an index.

Properties

analyzers	The analyzers for the index.
charFilters	The character filters for the index.
corsOptions	Options to control Cross-Origin Resource Sharing (CORS) for the index.
defaultScoringProfile	The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used.
encryptionKey	A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.
etag	The ETag of the index.
fields	The fields of the index.
name	The name of the index.
scoringProfiles	The scoring profiles for the index.
semanticSearch	Defines parameters for a search index that influence semantic capabilities.
similarity	The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.
suggesters	The suggesters for the index.
tokenFilters	The token filters for the index.
tokenizers	The tokenizers for the index.
vectorSearch	Contains configuration options related to vector search.

Property Details

analyzers

The analyzers for the index.

analyzers?: LexicalAnalyzer[]

Property Value

LexicalAnalyzer[]

charFilters

The character filters for the index.

charFilters?: CharFilter[]

Property Value

CharFilter[]

corsOptions

Options to control Cross-Origin Resource Sharing (CORS) for the index.

corsOptions?: CorsOptions

Property Value

CorsOptions

defaultScoringProfile

The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used.

defaultScoringProfile?: string

Property Value

string

encryptionKey

A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.

encryptionKey?: SearchResourceEncryptionKey

Property Value

SearchResourceEncryptionKey

etag

The ETag of the index.

etag?: string

Property Value

string

fields

The fields of the index.

fields: SearchField[]

Property Value

SearchField[]

name

The name of the index.

name: string

Property Value

string

scoringProfiles

The scoring profiles for the index.

scoringProfiles?: ScoringProfile[]

Property Value

ScoringProfile[]

semanticSearch

Defines parameters for a search index that influence semantic capabilities.

semanticSearch?: SemanticSearch

Property Value

SemanticSearch

similarity

The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.

similarity?: SimilarityAlgorithm

Property Value

SimilarityAlgorithm

suggesters

The suggesters for the index.

suggesters?: SearchSuggester[]

Property Value

SearchSuggester[]

tokenFilters

The token filters for the index.

tokenFilters?: TokenFilter[]

Property Value

TokenFilter[]

tokenizers

The tokenizers for the index.

tokenizers?: LexicalTokenizer[]

Property Value

LexicalTokenizer[]

vectorSearch

Contains configuration options related to vector search.

vectorSearch?: VectorSearch

Property Value

VectorSearch