Share via

VectorSearchCompression 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

Contains configuration options specific to the compression method used during indexing or querying. Please note VectorSearchCompression 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 BinaryQuantizationCompression and ScalarQuantizationCompression.

public abstract class VectorSearchCompression
type VectorSearchCompression = class
Public MustInherit Class VectorSearchCompression
Inheritance
Object
VectorSearchCompression
Derived

Constructors

VectorSearchCompression(String)

Initializes a new instance of VectorSearchCompression.

Properties

CompressionName

The name to associate with this particular configuration.
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.
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.
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.

Applies to