SearchModelFactory.SearchIndexResponse Method
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 static Azure.Search.Documents.Indexes.Models.SearchIndexResponse SearchIndexResponse(string name = default, string description = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.SearchField> fields = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.ScoringProfile> scoringProfiles = default, string defaultScoringProfile = default, Azure.Search.Documents.Indexes.Models.CorsOptions corsOptions = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.SearchSuggester> suggesters = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.LexicalAnalyzer> analyzers = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.LexicalTokenizer> tokenizers = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.TokenFilter> tokenFilters = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.CharFilter> charFilters = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.LexicalNormalizer> normalizers = default, Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey encryptionKey = default, Azure.Search.Documents.Indexes.Models.SimilarityAlgorithm similarity = default, Azure.Search.Documents.Indexes.Models.SemanticSearch semanticSearch = default, Azure.Search.Documents.Indexes.Models.VectorSearch vectorSearch = default, Azure.ETag? eTag = default);static member SearchIndexResponse : string * string * seq<Azure.Search.Documents.Indexes.Models.SearchField> * seq<Azure.Search.Documents.Indexes.Models.ScoringProfile> * string * Azure.Search.Documents.Indexes.Models.CorsOptions * seq<Azure.Search.Documents.Indexes.Models.SearchSuggester> * seq<Azure.Search.Documents.Indexes.Models.LexicalAnalyzer> * seq<Azure.Search.Documents.Indexes.Models.LexicalTokenizer> * seq<Azure.Search.Documents.Indexes.Models.TokenFilter> * seq<Azure.Search.Documents.Indexes.Models.CharFilter> * seq<Azure.Search.Documents.Indexes.Models.LexicalNormalizer> * Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey * Azure.Search.Documents.Indexes.Models.SimilarityAlgorithm * Azure.Search.Documents.Indexes.Models.SemanticSearch * Azure.Search.Documents.Indexes.Models.VectorSearch * Nullable<Azure.ETag> -> Azure.Search.Documents.Indexes.Models.SearchIndexResponsePublic Shared Function SearchIndexResponse (Optional name As String = Nothing, Optional description As String = Nothing, Optional fields As IEnumerable(Of SearchField) = Nothing, Optional scoringProfiles As IEnumerable(Of ScoringProfile) = Nothing, Optional defaultScoringProfile As String = Nothing, Optional corsOptions As CorsOptions = Nothing, Optional suggesters As IEnumerable(Of SearchSuggester) = Nothing, Optional analyzers As IEnumerable(Of LexicalAnalyzer) = Nothing, Optional tokenizers As IEnumerable(Of LexicalTokenizer) = Nothing, Optional tokenFilters As IEnumerable(Of TokenFilter) = Nothing, Optional charFilters As IEnumerable(Of CharFilter) = Nothing, Optional normalizers As IEnumerable(Of LexicalNormalizer) = Nothing, Optional encryptionKey As SearchResourceEncryptionKey = Nothing, Optional similarity As SimilarityAlgorithm = Nothing, Optional semanticSearch As SemanticSearch = Nothing, Optional vectorSearch As VectorSearch = Nothing, Optional eTag As Nullable(Of ETag) = Nothing) As SearchIndexResponseParameters
- name
- String
The name of the index.
- description
- String
The description of the index.
- fields
- IEnumerable<SearchField>
The fields of the index.
- scoringProfiles
- IEnumerable<ScoringProfile>
The scoring profiles for the index.
- defaultScoringProfile
- String
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.
- corsOptions
- CorsOptions
Options to control Cross-Origin Resource Sharing (CORS) for the index.
- suggesters
- IEnumerable<SearchSuggester>
The suggesters for the index.
- analyzers
- IEnumerable<LexicalAnalyzer>
The analyzers for the index.
- tokenizers
- IEnumerable<LexicalTokenizer>
The tokenizers for the index.
- tokenFilters
- IEnumerable<TokenFilter>
The token filters for the index.
- charFilters
- IEnumerable<CharFilter>
The character filters for the index.
- normalizers
- IEnumerable<LexicalNormalizer>
The normalizers for the index.
- encryptionKey
- SearchResourceEncryptionKey
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.
- similarity
- SimilarityAlgorithm
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.
- semanticSearch
- SemanticSearch
Defines parameters for a search index that influence semantic capabilities.
- vectorSearch
- VectorSearch
Contains configuration options related to vector search.
Returns
A new SearchIndexResponse instance for mocking.
