SearchIndex Class

Definition

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

public class SearchIndex
type SearchIndex = class
Public Class SearchIndex
Inheritance
SearchIndex

Constructors

SearchIndex(String)

Initializes a new instance of the SearchIndex class.

SearchIndex(String, IEnumerable<SearchField>)

Initializes a new instance of the SearchIndex class.

Properties

Analyzers

Gets the analyzers for the index.

CharFilters

Gets 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 SearchIndex.

Fields

Gets or sets the fields in the index. Use FieldBuilder to define fields based on a model class, or SimpleField, SearchableField, and ComplexField to manually define fields. Index fields have many constraints that are not validated with SearchField until the index is created on the server.

Name

Gets the name of the index.

ScoringProfiles

Gets the scoring profiles for the index.

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

Gets the suggesters for the index.

TokenFilters

Gets the token filters for the index.

Tokenizers

Gets the tokenizers for the index.

Applies to