SearchIndexResponse Class

Definition

Namespace:

Azure.Search.Documents.Indexes.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.0.0

Source:

SearchIndexResponse.cs

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

public class SearchIndexResponse : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.SearchIndexResponse>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.SearchIndexResponse>

type SearchIndexResponse = class
    interface IJsonModel<SearchIndexResponse>
    interface IPersistableModel<SearchIndexResponse>

Public Class SearchIndexResponse
Implements IJsonModel(Of SearchIndexResponse), IPersistableModel(Of SearchIndexResponse)

Inheritance

Object

SearchIndexResponse

Implements

IJsonModel<SearchIndexResponse> IPersistableModel<SearchIndexResponse> IPersistableModel<T>

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 index.
Fields	The fields of the index.
Name	The name of the index.
Normalizers	The normalizers for 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.

Methods

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
IJsonModel<SearchIndexResponse>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<SearchIndexResponse>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<SearchIndexResponse>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<SearchIndexResponse>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<SearchIndexResponse>.Write(ModelReaderWriterOptions)