Package version:

Interface ScalarQuantizationCompression

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

interface ScalarQuantizationCompression {
    compressionName: string;
    kind: "scalarQuantization";
    parameters?: ScalarQuantizationParameters;
    rescoringOptions?: RescoringOptions;
    truncationDimension?: number;
}

Hierarchy (view full)

Properties

compressionName kind parameters? rescoringOptions? truncationDimension?

Properties

compressionName

compressionName: string

The name to associate with this particular configuration.

kind

kind

Polymorphic discriminator, which specifies the different types this object can be

Optionalparameters

parameters?: ScalarQuantizationParameters

Contains the parameters specific to Scalar Quantization.

OptionalrescoringOptions

rescoringOptions?: RescoringOptions

Contains the options for rescoring.

OptionaltruncationDimension

truncationDimension?: number

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.

Settings

Member Visibility