Package org.redisson.api.search.index

Class FlatVectorIndexParams

java.lang.Object

org.redisson.api.search.index.FlatVectorIndexParams

All Implemented Interfaces:

FieldIndex, FlatVectorIndex, FlatVectorOptionalArgs, VectorDimParam<FlatVectorOptionalArgs>, VectorDistParam<FlatVectorOptionalArgs>, VectorTypeParam<FlatVectorOptionalArgs>

public final class FlatVectorIndexParams
extends Object
implements FlatVectorIndex, VectorDimParam<FlatVectorOptionalArgs>, VectorDistParam<FlatVectorOptionalArgs>, FlatVectorOptionalArgs

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
FlatVectorIndexParams	as(String as)	Defines the attribute associated to the field name
FlatVectorOptionalArgs	blockSize(int value)	Defines amount of vectors in a contiguous array.
VectorDistParam<FlatVectorOptionalArgs>	dim(int value)	Defines vector dimension parameter
FlatVectorOptionalArgs	distance(VectorDistParam.DistanceMetric metric)	Defines distance metric parameter
String	getAs()
Integer	getBlockSize()
int	getCount()
int	getDim()
VectorDistParam.DistanceMetric	getDistanceMetric()
String	getFieldName()
Integer	getInitialCapacity()
VectorTypeParam.Type	getType()
FlatVectorOptionalArgs	initialCapacity(int value)	Defines initial vector capacity.
VectorDimParam<FlatVectorOptionalArgs>	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 FlatVectorIndexParams as(String as)

Description copied from interface: FlatVectorIndex

Defines the attribute associated to the field name

Specified by:

as in interface FlatVectorIndex

Parameters:

as - the associated attribute

Returns:

options object

type

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

Description copied from interface: VectorTypeParam

Defines vector type parameter

Specified by:

type in interface VectorTypeParam<FlatVectorOptionalArgs>

Parameters:

type - vector type parameter

Returns:

vector options

dim

public VectorDistParam<FlatVectorOptionalArgs> dim(int value)

Description copied from interface: VectorDimParam

Defines vector dimension parameter

Specified by:

dim in interface VectorDimParam<FlatVectorOptionalArgs>

Parameters:

value - vector dimension

Returns:

vector options

distance

public FlatVectorOptionalArgs distance(VectorDistParam.DistanceMetric metric)

Description copied from interface: VectorDistParam

Defines distance metric parameter

Specified by:

distance in interface VectorDistParam<FlatVectorOptionalArgs>

Parameters:

metric - distance metric

Returns:

vector options

initialCapacity

public FlatVectorOptionalArgs initialCapacity(int value)

Description copied from interface: FlatVectorOptionalArgs

Defines initial vector capacity.

Specified by:

initialCapacity in interface FlatVectorOptionalArgs

Parameters:

value - initial vector capacity

Returns:

vector options

blockSize

public FlatVectorOptionalArgs blockSize(int value)

Description copied from interface: FlatVectorOptionalArgs

Defines amount of vectors in a contiguous array.

Specified by:

blockSize in interface FlatVectorOptionalArgs

Parameters:

value - amount of vectors

Returns:

vector options

getFieldName

public String getFieldName()

getType

public VectorTypeParam.Type getType()

getDim

public int getDim()

getDistanceMetric

public VectorDistParam.DistanceMetric getDistanceMetric()

getInitialCapacity

public Integer getInitialCapacity()

getBlockSize

public Integer getBlockSize()

getCount

public int getCount()

getAs

public String getAs()