SearchModelFactory.RescoringOptions Method

Definition

Namespace:

Azure.Search.Documents.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.0.0

Source:

SearchModelFactory.cs

Contains the options for rescoring.

public static Azure.Search.Documents.Indexes.Models.RescoringOptions RescoringOptions(bool? enableRescoring = default, double? defaultOversampling = default, Azure.Search.Documents.Indexes.Models.VectorSearchCompressionRescoreStorageMethod? rescoreStorageMethod = default);

static member RescoringOptions : Nullable<bool> * Nullable<double> * Nullable<Azure.Search.Documents.Indexes.Models.VectorSearchCompressionRescoreStorageMethod> -> Azure.Search.Documents.Indexes.Models.RescoringOptions

Public Shared Function RescoringOptions (Optional enableRescoring As Nullable(Of Boolean) = Nothing, Optional defaultOversampling As Nullable(Of Double) = Nothing, Optional rescoreStorageMethod As Nullable(Of VectorSearchCompressionRescoreStorageMethod) = Nothing) As RescoringOptions

Parameters

enableRescoring

Nullable<Boolean>

If set to true, after the initial search on the compressed vectors, the similarity scores are recalculated using the full-precision vectors. This will improve recall at the expense of latency.

defaultOversampling

Nullable<Double>

Default oversampling factor. Oversampling retrieves a greater set of potential documents to offset the resolution loss due to quantization. This increases the set of results that will be rescored on full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when 'enableRescoring' is true. Higher values improve recall at the expense of latency.

rescoreStorageMethod

Nullable<VectorSearchCompressionRescoreStorageMethod>

Controls the storage method for original vectors. This setting is immutable.

Returns

RescoringOptions

A new RescoringOptions instance for mocking.