ScalarQuantizationCompression Class

Definition

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

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

Constructors

Name Description
ScalarQuantizationCompression(String)

Initializes a new instance of ScalarQuantizationCompression.

Properties

Name Description
CompressionName

The name to associate with this particular configuration.

(Inherited from VectorSearchCompression)
Parameters

Contains the parameters specific to Scalar Quantization.

RescoringOptions

Contains the options for rescoring.

(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)

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<ScalarQuantizationCompression>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ScalarQuantizationCompression>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<VectorSearchCompression>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

(Inherited from VectorSearchCompression)
IJsonModel<VectorSearchCompression>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from VectorSearchCompression)
IPersistableModel<ScalarQuantizationCompression>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ScalarQuantizationCompression>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ScalarQuantizationCompression>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<VectorSearchCompression>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from VectorSearchCompression)
IPersistableModel<VectorSearchCompression>.GetFormatFromOptions(ModelReaderWriterOptions)

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

(Inherited from VectorSearchCompression)
IPersistableModel<VectorSearchCompression>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from VectorSearchCompression)

Applies to