Package com.redis.vl.schema

Class VectorField

java.lang.Object

com.redis.vl.schema.BaseField

com.redis.vl.schema.VectorField

public class VectorField
extends BaseField

VectorField represents a vector field in Redis for similarity search. Supports both FLAT and HNSW algorithms with various distance metrics.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VectorField.Algorithm	Vector indexing algorithms
static enum	VectorField.DistanceMetric	Distance metrics for vector similarity
static enum	VectorField.VectorDataType	Vector data types
static class	VectorField.VectorFieldBuilder	Fluent builder for VectorField

Field Summary

Fields inherited from class com.redis.vl.schema.BaseField

alias, indexed, name, sortable

Constructor Summary

Constructors

Constructor	Description
VectorField(String name, int dimensions)	Create a VectorField with name and dimensions (defaults to FLAT algorithm, COSINE distance)

Method Summary

Modifier and Type	Method	Description
static VectorField.VectorFieldBuilder	builder()	Create a VectorField builder (Lombok-style)
VectorField.Algorithm	getAlgorithm()	Get the algorithm as our enum type
int	getDimensions()	Get dimensions
VectorField.DistanceMetric	getDistanceMetric()	Get distance metric
FieldType	getFieldType()	Get the field type.
static VectorField.VectorFieldBuilder	of(String name, int dimensions)	Create a VectorField with fluent API
SchemaField	toJedisSchemaField()	Convert to Jedis SchemaField for index creation.

Methods inherited from class com.redis.vl.schema.BaseField

equals, finalize, hashCode, toJedisFieldName, toJson, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

VectorField

public VectorField(String name,
 int dimensions)

Create a VectorField with name and dimensions (defaults to FLAT algorithm, COSINE distance)

Parameters:

name - Field name

dimensions - Number of dimensions in the vector

Method Details

of

public static VectorField.VectorFieldBuilder of(String name,
 int dimensions)

Create a VectorField with fluent API

Parameters:

name - Field name

dimensions - Number of dimensions in the vector

Returns:

VectorField builder

builder

public static VectorField.VectorFieldBuilder builder()

Create a VectorField builder (Lombok-style)

Returns:

VectorField builder

getAlgorithm

public VectorField.Algorithm getAlgorithm()

Get the algorithm as our enum type

Returns:

Algorithm type

getDimensions

public int getDimensions()

Get dimensions

Returns:

Number of dimensions

getDistanceMetric

public VectorField.DistanceMetric getDistanceMetric()

Get distance metric

Returns:

Distance metric

getFieldType

public FieldType getFieldType()

Description copied from class: BaseField

Get the field type.

Specified by:

getFieldType in class BaseField

Returns:

The field type enumeration

toJedisSchemaField

public SchemaField toJedisSchemaField()

Description copied from class: BaseField

Convert to Jedis SchemaField for index creation.

Specified by:

toJedisSchemaField in class BaseField

Returns:

The Jedis schema field representation