redis.clients.jedis.search.schemafields

Class VectorField

java.lang.Object

redis.clients.jedis.search.schemafields.SchemaField

redis.clients.jedis.search.schemafields.VectorField

All Implemented Interfaces:

IParams

public class VectorField
extends SchemaField

Represents a vector field in a Redis search index schema for performing semantic vector searches. Vector fields enable high-performance similarity searches over vector embeddings using various algorithms and distance metrics.

See Also:

Redis Vector Search Documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VectorField.Builder Builder class for constructing VectorField instances using the builder pattern.
static class	VectorField.VectorAlgorithm Enumeration of supported vector indexing algorithms in Redis.

Field Summary

Fields inherited from class redis.clients.jedis.search.schemafields.SchemaField

fieldName

Constructor Summary

Constructors

Constructor and Description
VectorField(FieldName fieldName, VectorField.VectorAlgorithm algorithm, java.util.Map<java.lang.String,java.lang.Object> attributes) Creates a new VectorField with the specified field name, algorithm, and attributes.
VectorField(java.lang.String fieldName, VectorField.VectorAlgorithm algorithm, java.util.Map<java.lang.String,java.lang.Object> attributes) Creates a new VectorField with the specified field name, algorithm, and attributes.

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args) Adds the vector field parameters to the Redis command arguments.
VectorField	as(java.lang.String attribute) Sets an alias for this field that can be used in queries instead of the field name.
static VectorField.Builder	builder() Creates a new Builder instance for constructing VectorField objects using the builder pattern.
VectorField	indexMissing() Configures the field to handle missing values during indexing.

Methods inherited from class redis.clients.jedis.search.schemafields.SchemaField

getFieldName, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

VectorField

public VectorField(java.lang.String fieldName,
                   VectorField.VectorAlgorithm algorithm,
                   java.util.Map<java.lang.String,java.lang.Object> attributes)

Creates a new VectorField with the specified field name, algorithm, and attributes.

Parameters:

fieldName - the name of the vector field in the index

algorithm - the vector indexing algorithm to use

attributes - the algorithm-specific configuration attributes

Throws:

java.lang.IllegalArgumentException - if required attributes are missing or invalid

VectorField

public VectorField(FieldName fieldName,
                   VectorField.VectorAlgorithm algorithm,
                   java.util.Map<java.lang.String,java.lang.Object> attributes)

Creates a new VectorField with the specified field name, algorithm, and attributes.

Parameters:

fieldName - the field name object containing the field name and optional alias

algorithm - the vector indexing algorithm to use

attributes - the algorithm-specific configuration attributes

Throws:

java.lang.IllegalArgumentException - if required attributes are missing or invalid

See Also:

for detailed attribute documentation

Method Detail

as

public VectorField as(java.lang.String attribute)

Sets an alias for this field that can be used in queries instead of the field name. This is useful when the field name contains special characters or when you want to use a shorter name in queries.

Overrides:

as in class SchemaField

Parameters:

attribute - the alias name to use for this field in queries

Returns:

this VectorField instance for method chaining

indexMissing

public VectorField indexMissing()

Configures the field to handle missing values during indexing. When enabled, documents that don't contain this vector field will still be indexed, but won't participate in vector searches.

This is useful when not all documents in your dataset contain vector embeddings, but you still want to index them for other types of searches.

Returns:

this VectorField instance for method chaining

addParams

public void addParams(CommandArguments args)

Adds the vector field parameters to the Redis command arguments. This method is used internally when creating the search index.

Parameters:

args - the command arguments to add parameters to

builder

public static VectorField.Builder builder()

Creates a new Builder instance for constructing VectorField objects using the builder pattern. The builder pattern provides a fluent interface for setting field properties and is especially useful when dealing with complex vector field configurations.

Returns:

a new Builder instance