SearchIndex.Similarity Property

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
SearchIndex.cs
Source:
SearchIndex.cs

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.

public Azure.Search.Documents.Indexes.Models.SimilarityAlgorithm Similarity { get; set; }
member this.Similarity : Azure.Search.Documents.Indexes.Models.SimilarityAlgorithm with get, set
Public Property Similarity As SimilarityAlgorithm

Property Value

SimilarityAlgorithm

Applies to