Package org.redisson.api.search.index

Class SVSVamanaVectorIndexParams

java.lang.Object

org.redisson.api.search.index.SVSVamanaVectorIndexParams

All Implemented Interfaces:

FieldIndex, SVSVamanaVectorIndex, SVSVamanaVectorOptionalArgs, VectorDimParam<SVSVamanaVectorOptionalArgs>, VectorDistParam<SVSVamanaVectorOptionalArgs>, VectorTypeParam<SVSVamanaVectorOptionalArgs>

public class SVSVamanaVectorIndexParams
extends Object
implements SVSVamanaVectorIndex, VectorDimParam<SVSVamanaVectorOptionalArgs>, VectorDistParam<SVSVamanaVectorOptionalArgs>, SVSVamanaVectorOptionalArgs

Author:

seakider

Nested Class Summary

Nested classes/interfaces inherited from interface org.redisson.api.search.index.SVSVamanaVectorOptionalArgs

SVSVamanaVectorOptionalArgs.CompressionAlgorithm

Nested classes/interfaces inherited from interface org.redisson.api.search.index.VectorDistParam

VectorDistParam.DistanceMetric

Nested classes/interfaces inherited from interface org.redisson.api.search.index.VectorTypeParam

VectorTypeParam.Type

Method Summary

Modifier and Type	Method	Description
SVSVamanaVectorIndexParams	as(String as)	Defines the attribute associated to the field name
SVSVamanaVectorOptionalArgs	compression(SVSVamanaVectorOptionalArgs.CompressionAlgorithm algorithm)	Defines compression algorithm
SVSVamanaVectorOptionalArgs	constructionWindowSize(int value)	Defines number of the search window size to during graph construction
VectorDistParam<SVSVamanaVectorOptionalArgs>	dim(int value)	Defines vector dimension parameter
SVSVamanaVectorOptionalArgs	distance(VectorDistParam.DistanceMetric metric)	Defines distance metric parameter
SVSVamanaVectorOptionalArgs	epsilon(double value)	Defines relative factor that sets the boundaries in which a range query may search for candidates
String	getAs()
SVSVamanaVectorOptionalArgs.CompressionAlgorithm	getCompressionAlgorithm()
Integer	getConstructionWindowSize()
int	getCount()
int	getDim()
VectorDistParam.DistanceMetric	getDistanceMetric()
Double	getEpsilon()
String	getFieldName()
Integer	getGraphMaxDegree()
Integer	getLeanVecDim()
Integer	getSearchWindowSize()
Integer	getTrainingThreshold()
VectorTypeParam.Type	getType()
SVSVamanaVectorOptionalArgs	graphMaxDegree(int value)	Defines the maximum number of edges per node
SVSVamanaVectorOptionalArgs	leanVecDim(int value)	Defines the dimension used when using LeanVec4x8 or LeanVec8x8
SVSVamanaVectorOptionalArgs	searchWindowSize(int value)	Defines the size of the search window
SVSVamanaVectorOptionalArgs	trainingThreshold(int value)	Defines number of vectors needed to learn compression parameters.
VectorDimParam<SVSVamanaVectorOptionalArgs>	type(VectorTypeParam.Type type)	Defines vector type parameter

Methods inherited from class java.lang.Object

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

Method Details

as

public SVSVamanaVectorIndexParams as(String as)

Description copied from interface: SVSVamanaVectorIndex

Defines the attribute associated to the field name

Specified by:

as in interface SVSVamanaVectorIndex

Parameters:

as - the associated attribute

Returns:

options object

dim

public VectorDistParam<SVSVamanaVectorOptionalArgs> dim(int value)

Description copied from interface: VectorDimParam

Defines vector dimension parameter

Specified by:

dim in interface VectorDimParam<SVSVamanaVectorOptionalArgs>

Parameters:

value - vector dimension

Returns:

vector options

distance

public SVSVamanaVectorOptionalArgs distance(VectorDistParam.DistanceMetric metric)

Description copied from interface: VectorDistParam

Defines distance metric parameter

Specified by:

distance in interface VectorDistParam<SVSVamanaVectorOptionalArgs>

Parameters:

metric - distance metric

Returns:

vector options

type

public VectorDimParam<SVSVamanaVectorOptionalArgs> type(VectorTypeParam.Type type)

Description copied from interface: VectorTypeParam

Defines vector type parameter

Specified by:

type in interface VectorTypeParam<SVSVamanaVectorOptionalArgs>

Parameters:

type - vector type parameter

Returns:

vector options

compression

public SVSVamanaVectorOptionalArgs compression(SVSVamanaVectorOptionalArgs.CompressionAlgorithm algorithm)

Description copied from interface: SVSVamanaVectorOptionalArgs

Defines compression algorithm

Specified by:

compression in interface SVSVamanaVectorOptionalArgs

Parameters:

algorithm - compression algorithm

Returns:

vector options

constructionWindowSize

public SVSVamanaVectorOptionalArgs constructionWindowSize(int value)

Description copied from interface: SVSVamanaVectorOptionalArgs

Defines number of the search window size to during graph construction

Specified by:

constructionWindowSize in interface SVSVamanaVectorOptionalArgs

Parameters:

value - number of search window size

Returns:

vector options

graphMaxDegree

public SVSVamanaVectorOptionalArgs graphMaxDegree(int value)

Description copied from interface: SVSVamanaVectorOptionalArgs

Defines the maximum number of edges per node

Specified by:

graphMaxDegree in interface SVSVamanaVectorOptionalArgs

Parameters:

value - the maximum number of edges

Returns:

vector options

searchWindowSize

public SVSVamanaVectorOptionalArgs searchWindowSize(int value)

Description copied from interface: SVSVamanaVectorOptionalArgs

Defines the size of the search window

Specified by:

searchWindowSize in interface SVSVamanaVectorOptionalArgs

Parameters:

value - size of the search window

Returns:

vector options

epsilon

public SVSVamanaVectorOptionalArgs epsilon(double value)

Description copied from interface: SVSVamanaVectorOptionalArgs

Defines relative factor that sets the boundaries in which a range query may search for candidates

Specified by:

epsilon in interface SVSVamanaVectorOptionalArgs

Parameters:

value - relative factor

Returns:

vector options

trainingThreshold

public SVSVamanaVectorOptionalArgs trainingThreshold(int value)

Description copied from interface: SVSVamanaVectorOptionalArgs

Defines number of vectors needed to learn compression parameters.

Specified by:

trainingThreshold in interface SVSVamanaVectorOptionalArgs

Parameters:

value - number of vectors

Returns:

leanVecDim

public SVSVamanaVectorOptionalArgs leanVecDim(int value)

Description copied from interface: SVSVamanaVectorOptionalArgs

Defines the dimension used when using LeanVec4x8 or LeanVec8x8

Specified by:

leanVecDim in interface SVSVamanaVectorOptionalArgs

Parameters:

value - the dimension

Returns:

getFieldName

public String getFieldName()

getType

public VectorTypeParam.Type getType()

getDim

public int getDim()

getDistanceMetric

public VectorDistParam.DistanceMetric getDistanceMetric()

getCount

public int getCount()

getAs

public String getAs()

getCompressionAlgorithm

public SVSVamanaVectorOptionalArgs.CompressionAlgorithm getCompressionAlgorithm()

getConstructionWindowSize

public Integer getConstructionWindowSize()

getGraphMaxDegree

public Integer getGraphMaxDegree()

getSearchWindowSize

public Integer getSearchWindowSize()

getEpsilon

public Double getEpsilon()

getTrainingThreshold

public Integer getTrainingThreshold()

getLeanVecDim

public Integer getLeanVecDim()