SearchIndex Class

Definition

Namespace:

Azure.Search.Documents.Indexes.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.6.0

Source:

SearchIndex.cs

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

Object

SearchIndex

Constructors

SearchIndex(String, IEnumerable<SearchField>)	Initializes a new instance of the SearchIndex class.
SearchIndex(String)	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. Once you have encrypted your data, it will always remain encrypted. The search service 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.
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. Please note SimilarityAlgorithm is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include BM25Similarity and ClassicSimilarity.
Suggesters	Gets the suggesters for the index.
TokenFilters	Gets the token filters for the index.
Tokenizers	Gets the tokenizers for the index.
VectorSearch	Contains configuration options related to vector search.