SearchIndex Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a search index definition, which describes the fields and search behavior of an index.
public class SearchIndex : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.SearchIndex>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.SearchIndex>type SearchIndex = class
interface IJsonModel<SearchIndex>
interface IPersistableModel<SearchIndex>Public Class SearchIndex
Implements IJsonModel(Of SearchIndex), IPersistableModel(Of SearchIndex)- Inheritance
-
SearchIndex
- Implements
Constructors
| Name | Description |
|---|---|
| SearchIndex(String, IEnumerable<SearchField>) |
Initializes a new instance of the SearchIndex class. |
| SearchIndex(String) |
Initializes a new instance of the SearchIndex class. |
Properties
| Name | Description |
|---|---|
| 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. |
| Description |
The description of the index. |
| 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 |
The name of the index. |
| Normalizers |
The normalizers for the index. |
| PermissionFilterOption |
A value indicating whether permission filtering is enabled for the index. |
| PurviewEnabled |
A value indicating whether the index is leveraging Purview-specific features. This property defaults to false and cannot be changed after index creation. |
| 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. |
Methods
Operators
| Name | Description |
|---|---|
| Explicit(Response to SearchIndex) | |
| Implicit(SearchIndex to RequestContent) | |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<SearchIndex>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<SearchIndex>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<SearchIndex>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<SearchIndex>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<SearchIndex>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
