Share via

ScalarQuantizationCompression Class

  • 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:
ScalarQuantizationCompression.cs
Source:
ScalarQuantizationCompression.cs

Contains configuration options specific to the scalar quantization compression method used during indexing and querying.

public class ScalarQuantizationCompression : Azure.Search.Documents.Indexes.Models.VectorSearchCompression
type ScalarQuantizationCompression = class
    inherit VectorSearchCompression
Public Class ScalarQuantizationCompression
Inherits VectorSearchCompression
Inheritance
Object
VectorSearchCompression
ScalarQuantizationCompression

Constructors

ScalarQuantizationCompression(String)

Initializes a new instance of ScalarQuantizationCompression.

Properties

CompressionName

The name to associate with this particular configuration.

(Inherited from VectorSearchCompression)
DefaultOversampling

Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency.

(Inherited from VectorSearchCompression)
Parameters

Contains the parameters specific to Scalar Quantization.
RerankWithOriginalVectors

If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency.

(Inherited from VectorSearchCompression)
TruncationDimension

The number of dimensions to truncate the vectors to. Truncating the vectors reduces the size of the vectors and the amount of data that needs to be transferred during search. This can save storage cost and improve search performance at the expense of recall. It should be only used for embeddings trained with Matryoshka Representation Learning (MRL) such as OpenAI text-embedding-3-large (small). The default value is null, which means no truncation.

(Inherited from VectorSearchCompression)

Applies to