VectorSearchCompression Class

Definition

Namespace:
Azure.Search.Documents.Indexes.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Package:
Azure.Search.Documents v11.8.0-beta.1
Source:
VectorSearchCompression.cs
Source:
VectorSearchCompression.cs

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.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Indexes.Models.UnknownVectorSearchCompression))]
public abstract class VectorSearchCompression : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.VectorSearchCompression>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.VectorSearchCompression>
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Models.UnknownVectorSearchCompression))]
public abstract class VectorSearchCompression : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.VectorSearchCompression>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.VectorSearchCompression>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Indexes.Models.UnknownVectorSearchCompression))>]
type VectorSearchCompression = class
    interface IJsonModel<VectorSearchCompression>
    interface IPersistableModel<VectorSearchCompression>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Models.UnknownVectorSearchCompression))>]
type VectorSearchCompression = class
    interface IJsonModel<VectorSearchCompression>
    interface IPersistableModel<VectorSearchCompression>
Public MustInherit Class VectorSearchCompression
Implements IJsonModel(Of VectorSearchCompression), IPersistableModel(Of VectorSearchCompression)
Inheritance
Object
VectorSearchCompression
Derived
Attributes
PersistableModelProxyAttribute
Implements
IJsonModel<VectorSearchCompression> IPersistableModel<VectorSearchCompression> IPersistableModel<T>

Constructors

Name Description
VectorSearchCompression(String)

Initializes a new instance of VectorSearchCompression.

Properties

Name Description
CompressionName

The name to associate with this particular configuration.
RescoringOptions

Contains the options for rescoring.
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.

Methods

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

Explicit Interface Implementations

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

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<VectorSearchCompression>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<VectorSearchCompression>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<VectorSearchCompression>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<VectorSearchCompression>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to