io.lettuce.core.search.arguments

Class VectorFieldArgs

java.lang.Object

io.lettuce.core.search.arguments.FieldArgs

io.lettuce.core.search.arguments.VectorFieldArgs

public class VectorFieldArgs
extends FieldArgs

Field arguments for VECTOR fields in a RediSearch index.

Vector fields are floating-point vectors that are typically generated by external machine learning models. These vectors represent unstructured data such as text, images, or other complex features. Redis allows you to search for similar vectors using vector search algorithms like cosine similarity, Euclidean distance, and inner product.

Since:

6.8

Author:

Tihomir Mateev

See Also:

Vector Fields

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VectorFieldArgs.Algorithm Vector similarity index algorithms.
static class	VectorFieldArgs.Builder Builder for VectorFieldArgs.
static class	VectorFieldArgs.DistanceMetric Distance metrics for vector similarity.
static class	VectorFieldArgs.VectorType Vector data types.

Field Summary

Fields inherited from class io.lettuce.core.search.arguments.FieldArgs

as, indexEmpty, indexMissing, name, noIndex, sortable, unNormalizedForm

Constructor Summary

Constructors

Constructor and Description
VectorFieldArgs()

Method Summary

Modifier and Type	Method and Description
static VectorFieldArgs.Builder	builder() Create a new VectorFieldArgs using the builder pattern.
protected void	buildTypeSpecificArgs(CommandArgs<?,?> args) Add type-specific arguments to the command.
Optional<VectorFieldArgs.Algorithm>	getAlgorithm() Get the vector algorithm.
Map<String,Object>	getAttributes() Get the vector attributes.
String	getFieldType() Returns the field type.

Methods inherited from class io.lettuce.core.search.arguments.FieldArgs

build, getAs, getName, isIndexEmpty, isIndexMissing, isNoIndex, isSortable, isUnNormalizedForm

Methods inherited from class java.lang.Object

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

Constructor Detail

VectorFieldArgs

public VectorFieldArgs()

Method Detail

builder

public static VectorFieldArgs.Builder builder()

Create a new VectorFieldArgs using the builder pattern.

Returns:

a new VectorFieldArgs.Builder

getFieldType

public String getFieldType()

Description copied from class: FieldArgs

Returns the field type. Subclasses must implement this method.

Specified by:

getFieldType in class FieldArgs

Returns:

the field type

getAlgorithm

public Optional<VectorFieldArgs.Algorithm> getAlgorithm()

Get the vector algorithm.

Returns:

the algorithm

getAttributes

public Map<String,Object> getAttributes()

Get the vector attributes.

Returns:

the attributes

buildTypeSpecificArgs

protected void buildTypeSpecificArgs(CommandArgs<?,?> args)

Description copied from class: FieldArgs

Add type-specific arguments to the command. Subclasses should override this method to add their specific arguments.

Specified by:

buildTypeSpecificArgs in class FieldArgs

Parameters:

args - the command arguments to modify