Package org.redisson.api.search.index

Class HNSWVectorIndexParams

java.lang.Object

org.redisson.api.search.index.HNSWVectorIndexParams

All Implemented Interfaces:

FieldIndex, HNSWVectorIndex, HNSWVectorOptionalArgs, VectorDimParam<HNSWVectorOptionalArgs>, VectorDistParam<HNSWVectorOptionalArgs>, VectorTypeParam<HNSWVectorOptionalArgs>

public final class HNSWVectorIndexParams
extends Object
implements HNSWVectorIndex, VectorDimParam<HNSWVectorOptionalArgs>, VectorDistParam<HNSWVectorOptionalArgs>, HNSWVectorOptionalArgs

Author:

Nikita Koksharov

Nested Class Summary

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
HNSWVectorIndexParams	as(String as)	Defines the attribute associated to the field name
VectorDistParam<HNSWVectorOptionalArgs>	dim(int value)	Defines vector dimension parameter
HNSWVectorOptionalArgs	distance(VectorDistParam.DistanceMetric metric)	Defines distance metric parameter
HNSWVectorOptionalArgs	efConstruction(int value)	Defines number of maximum allowed potential outgoing edges candidates for each node.
HNSWVectorOptionalArgs	efRuntime(int value)	Defines number of maximum top candidates to hold during the KNN search.
HNSWVectorOptionalArgs	epsilon(double value)	Defines relative factor that sets the boundaries in which a range query may search for candidates
String	getAs()
int	getCount()
int	getDim()
VectorDistParam.DistanceMetric	getDistanceMetric()
Integer	getEfConstruction()
Integer	getEfRuntime()
Double	getEpsilon()
String	getFieldName()
Integer	getInitialCap()
Integer	getM()
VectorTypeParam.Type	getType()
HNSWVectorOptionalArgs	initialCapacity(int value)	Defines initial vector capacity.
HNSWVectorOptionalArgs	m(int value)	Defines number of maximum allowed outgoing edges for each node.
VectorDimParam<HNSWVectorOptionalArgs>	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 HNSWVectorIndexParams as(String as)

Description copied from interface: HNSWVectorIndex

Defines the attribute associated to the field name

Specified by:

as in interface HNSWVectorIndex

Parameters:

as - the associated attribute

Returns:

options object

type

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

Description copied from interface: VectorTypeParam

Defines vector type parameter

Specified by:

type in interface VectorTypeParam<HNSWVectorOptionalArgs>

Parameters:

type - vector type parameter

Returns:

vector options

dim

public VectorDistParam<HNSWVectorOptionalArgs> dim(int value)

Description copied from interface: VectorDimParam

Defines vector dimension parameter

Specified by:

dim in interface VectorDimParam<HNSWVectorOptionalArgs>

Parameters:

value - vector dimension

Returns:

vector options

distance

public HNSWVectorOptionalArgs distance(VectorDistParam.DistanceMetric metric)

Description copied from interface: VectorDistParam

Defines distance metric parameter

Specified by:

distance in interface VectorDistParam<HNSWVectorOptionalArgs>

Parameters:

metric - distance metric

Returns:

vector options

initialCapacity

public HNSWVectorOptionalArgs initialCapacity(int value)

Description copied from interface: HNSWVectorOptionalArgs

Defines initial vector capacity.

Specified by:

initialCapacity in interface HNSWVectorOptionalArgs

Parameters:

value - initial vector capacity

Returns:

vector options

m

public HNSWVectorOptionalArgs m(int value)

Description copied from interface: HNSWVectorOptionalArgs

Defines number of maximum allowed outgoing edges for each node.

Specified by:

m in interface HNSWVectorOptionalArgs

Parameters:

value - number of maximum allowed outgoing edges

Returns:

vector options

efConstruction

public HNSWVectorOptionalArgs efConstruction(int value)

Description copied from interface: HNSWVectorOptionalArgs

Defines number of maximum allowed potential outgoing edges candidates for each node.

Specified by:

efConstruction in interface HNSWVectorOptionalArgs

Parameters:

value - number of maximum allowed potential outgoing edges

Returns:

vector options

efRuntime

public HNSWVectorOptionalArgs efRuntime(int value)

Description copied from interface: HNSWVectorOptionalArgs

Defines number of maximum top candidates to hold during the KNN search.

Specified by:

efRuntime in interface HNSWVectorOptionalArgs

Parameters:

value - number of maximum top candidates

Returns:

vector options

epsilon

public HNSWVectorOptionalArgs epsilon(double value)

Description copied from interface: HNSWVectorOptionalArgs

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

Specified by:

epsilon in interface HNSWVectorOptionalArgs

Parameters:

value - relative factor

Returns:

getFieldName

public String getFieldName()

getType

public VectorTypeParam.Type getType()

getDim

public int getDim()

getDistanceMetric

public VectorDistParam.DistanceMetric getDistanceMetric()

getInitialCap

public Integer getInitialCap()

getM

public Integer getM()

getEfConstruction

public Integer getEfConstruction()

getEfRuntime

public Integer getEfRuntime()

getEpsilon

public Double getEpsilon()

getCount

public int getCount()

getAs

public String getAs()