couchbase-lite-ee/kotbase/VectorIndexConfiguration

VectorIndexConfiguration

actual class VectorIndexConfiguration(expression: String, dimensions: Long, centroids: Long) : IndexConfiguration(source)

expect class VectorIndexConfiguration(expression: String, dimensions: Long, centroids: Long) : IndexConfiguration(source)

Configuration for creating vector indexes.

Parameters

expression

The SQL++ expression returning a vector which is an array of numbers.

dimensions

The number of dimensions of the vectors to be indexed. The vectors that do not have the same dimensions specified in the config will not be indexed. The dimensions must be between 2 and 4096 inclusively.

centroids

The number of centroids which is the number buckets to partition the vectors in the index. The number of centroids will be based on the expected number of vectors to be indexed; one suggested rule is to use the square root of the number of vectors. The centroids must be between 1 and 64000 inclusively.

actual class VectorIndexConfiguration(expression: String, dimensions: Long, centroids: Long) : IndexConfiguration(source)

actual class VectorIndexConfiguration(val expression: String, val dimensions: Long, val centroids: Long) : IndexConfiguration(source)

Constructors

VectorIndexConfiguration

actual constructor(expression: String, dimensions: Long, centroids: Long)

expect constructor(expression: String, dimensions: Long, centroids: Long)

VectorIndexConfiguration Constructor.

actual constructor(expression: String, dimensions: Long, centroids: Long)

Types

DistanceMetric

actual enum DistanceMetric : Enum<VectorIndexConfiguration.DistanceMetric>

expect enum DistanceMetric : Enum<VectorIndexConfiguration.DistanceMetric>

Distance metric to be used in the vector indexes.

actual enum DistanceMetric : Enum<VectorIndexConfiguration.DistanceMetric>

Properties

centroids

actual val centroids: Long

expect val centroids: Long

The number of centroids which is the number buckets into which to partition the vectors in the index.

actual val centroids: Long

dimensions

actual val dimensions: Long

expect val dimensions: Long

The number of vector dimensions.

actual val dimensions: Long

encoding

actual var encoding: VectorEncoding

expect var encoding: VectorEncoding

Vector encoding type.

actual var encoding: VectorEncoding

expression

actual val expression: String

expect val expression: String

The SQL++ expression returning a vector which is an array of 32-bits floating-point numbers or a Base64 string representing an array of 32-bits floating-point numbers in little-endian format.

actual val expression: String

expressions

actual val expressions: List<String>

expect val expressions: List<String>

actual val expressions: List<String>

isLazy

actual var isLazy: Boolean

expect var isLazy: Boolean

The boolean flag indicating that index is lazy or not. The default value is false.

actual var isLazy: Boolean

maxTrainingSize

actual var maxTrainingSize: Long

expect var maxTrainingSize: Long

The maximum number of vectors used for training the index. The default value is zero, meaning that the maxTrainingSize will be automatically calulated by the index based on the number of centroids specified, encoding types, and the encoding parameters.

actual var maxTrainingSize: Long

metric

actual var metric: VectorIndexConfiguration.DistanceMetric

expect var metric: VectorIndexConfiguration.DistanceMetric

Distance Metric type

actual var metric: VectorIndexConfiguration.DistanceMetric

minTrainingSize

actual var minTrainingSize: Long

expect var minTrainingSize: Long

The minimum number of vectors for training the index. The default value is zero, meaning that minTrainingSize will be automatically calculated by the index based on the number of centroids specified, encoding types, and the encoding parameters.

actual var minTrainingSize: Long

numProbes

actual var numProbes: Long

expect var numProbes: Long

The number of centroids that will be scanned during a query. The default value is zero, meaning that the numProbes will be automatically calulated by the index based on the number of centroids specified

actual var numProbes: Long