Share via


RescoringOptions Class

Definition

Contains the options for rescoring.

public class RescoringOptions : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.RescoringOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.RescoringOptions>
type RescoringOptions = class
    interface IJsonModel<RescoringOptions>
    interface IPersistableModel<RescoringOptions>
Public Class RescoringOptions
Implements IJsonModel(Of RescoringOptions), IPersistableModel(Of RescoringOptions)
Inheritance
RescoringOptions
Implements

Constructors

RescoringOptions()

Initializes a new instance of RescoringOptions.

Properties

DefaultOversampling

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.

EnableRescoring

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.

RescoreStorageMethod

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<RescoringOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<RescoringOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<RescoringOptions>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<RescoringOptions>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<RescoringOptions>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to