com.lancedb.lance.index.vector

Class VectorIndexParams.Builder

java.lang.Object

com.lancedb.lance.index.vector.VectorIndexParams.Builder

Enclosing class:

VectorIndexParams

public static class VectorIndexParams.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder(IvfBuildParams ivfParams) Create a new builder to create a vector index.

Method Summary

Modifier and Type	Method and Description
VectorIndexParams	build()
VectorIndexParams.Builder	setDistanceType(DistanceType distanceType)
VectorIndexParams.Builder	setHnswParams(HnswBuildParams hnswParams)
VectorIndexParams.Builder	setPqParams(PQBuildParams pqParams)
VectorIndexParams.Builder	setSqParams(SQBuildParams sqParams)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(IvfBuildParams ivfParams)

Create a new builder to create a vector index.

Parameters:

ivfParams - the IVF build parameters

Method Detail

setDistanceType

public VectorIndexParams.Builder setDistanceType(DistanceType distanceType)

Parameters:

distanceType - the distance type for calculating the distance between vectors

Returns:

Builder

setPqParams

public VectorIndexParams.Builder setPqParams(PQBuildParams pqParams)

Parameters:

pqParams - the PQ quantizer build parameters

Returns:

Builder

setHnswParams

public VectorIndexParams.Builder setHnswParams(HnswBuildParams hnswParams)

Parameters:

hnswParams - the HNSW build parameters for building the HNSW graph for each IVF partition

Returns:

Builder

setSqParams

public VectorIndexParams.Builder setSqParams(SQBuildParams sqParams)

Parameters:

sqParams - the sq build params

Returns:

Builder

build

public VectorIndexParams build()