Package version
The analyzers for the index. The analyzers for the index.
The character filters for the index. The character filters for the index.
Options to control Cross-Origin Resource Sharing (CORS) for the index. Options to control Cross-Origin Resource Sharing (CORS) for the index.
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. 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.
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. 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.
The ETag of the index. The ETag of the index.
The fields of the index. The fields of the index.
The name of the index. The name of the index.
The normalizers for the index. The normalizers for the index.
The scoring profiles for the index. The scoring profiles for the index.
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. 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.
The suggesters for the index. The suggesters for the index.
The token filters for the index. The token filters for the index.
The tokenizers for the index. The tokenizers for the index.
Generated using TypeDoc
Represents a search index definition, which describes the fields and search behavior of an index. Represents a search index definition, which describes the fields and search behavior of an index.