SearchModelFactory.VectorSearchCompression Method

Definition

Contains configuration options specific to the compression method used during indexing or querying. Please note this is the abstract base class. The derived classes available for instantiation are: ScalarQuantizationCompression and BinaryQuantizationCompression.

public static Azure.Search.Documents.Indexes.Models.VectorSearchCompression VectorSearchCompression(string compressionName = default, Azure.Search.Documents.Indexes.Models.RescoringOptions rescoringOptions = default, int? truncationDimension = default, string kind = default);
static member VectorSearchCompression : string * Azure.Search.Documents.Indexes.Models.RescoringOptions * Nullable<int> * string -> Azure.Search.Documents.Indexes.Models.VectorSearchCompression
Public Shared Function VectorSearchCompression (Optional compressionName As String = Nothing, Optional rescoringOptions As RescoringOptions = Nothing, Optional truncationDimension As Nullable(Of Integer) = Nothing, Optional kind As String = Nothing) As VectorSearchCompression

Parameters

compressionName
String

The name to associate with this particular configuration.

rescoringOptions
RescoringOptions

Contains the options for rescoring.

truncationDimension
Nullable<Int32>

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.

kind
String

Type of VectorSearchCompression.

Returns

A new VectorSearchCompression instance for mocking.

Applies to