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 TypeMethodDescriptionDefines the attribute associated to the field namedim
(int value) Defines vector dimension parameterDefines distance metric parameterefConstruction
(int value) Defines number of maximum allowed potential outgoing edges candidates for each node.efRuntime
(int value) Defines number of maximum top candidates to hold during the KNN search.epsilon
(double value) Defines relative factor that sets the boundaries in which a range query may search for candidatesgetAs()
int
getCount()
int
getDim()
getM()
getType()
initialCapacity
(int value) Defines initial vector capacity.m
(int value) Defines number of maximum allowed outgoing edges for each node.type
(VectorTypeParam.Type type) Defines vector type parameter
-
Method Details
-
as
Description copied from interface:HNSWVectorIndex
Defines the attribute associated to the field name- Specified by:
as
in interfaceHNSWVectorIndex
- Parameters:
as
- the associated attribute- Returns:
- options object
-
type
Description copied from interface:VectorTypeParam
Defines vector type parameter- Specified by:
type
in interfaceVectorTypeParam<HNSWVectorOptionalArgs>
- Parameters:
type
- vector type parameter- Returns:
- vector options
-
dim
Description copied from interface:VectorDimParam
Defines vector dimension parameter- Specified by:
dim
in interfaceVectorDimParam<HNSWVectorOptionalArgs>
- Parameters:
value
- vector dimension- Returns:
- vector options
-
distance
Description copied from interface:VectorDistParam
Defines distance metric parameter- Specified by:
distance
in interfaceVectorDistParam<HNSWVectorOptionalArgs>
- Parameters:
metric
- distance metric- Returns:
- vector options
-
initialCapacity
Description copied from interface:HNSWVectorOptionalArgs
Defines initial vector capacity.- Specified by:
initialCapacity
in interfaceHNSWVectorOptionalArgs
- Parameters:
value
- initial vector capacity- Returns:
- vector options
-
m
Description copied from interface:HNSWVectorOptionalArgs
Defines number of maximum allowed outgoing edges for each node.- Specified by:
m
in interfaceHNSWVectorOptionalArgs
- Parameters:
value
- number of maximum allowed outgoing edges- Returns:
- vector options
-
efConstruction
Description copied from interface:HNSWVectorOptionalArgs
Defines number of maximum allowed potential outgoing edges candidates for each node.- Specified by:
efConstruction
in interfaceHNSWVectorOptionalArgs
- Parameters:
value
- number of maximum allowed potential outgoing edges- Returns:
- vector options
-
efRuntime
Description copied from interface:HNSWVectorOptionalArgs
Defines number of maximum top candidates to hold during the KNN search.- Specified by:
efRuntime
in interfaceHNSWVectorOptionalArgs
- Parameters:
value
- number of maximum top candidates- Returns:
- vector options
-
epsilon
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 interfaceHNSWVectorOptionalArgs
- Parameters:
value
- relative factor- Returns:
-
getFieldName
-
getType
-
getDim
public int getDim() -
getDistanceMetric
-
getInitialCap
-
getM
-
getEfConstruction
-
getEfRuntime
-
getEpsilon
-
getCount
public int getCount() -
getAs
-