redis.clients.jedis.search.schemafields

Class VectorField.Builder

java.lang.Object

redis.clients.jedis.search.schemafields.VectorField.Builder

Enclosing class:

VectorField

public static class VectorField.Builder
extends java.lang.Object

Builder class for constructing VectorField instances using the builder pattern. Provides a fluent interface for setting vector field properties and attributes.

Example usage:

 VectorField field = VectorField.builder()
     .fieldName("product_embedding")
     .algorithm(VectorAlgorithm.HNSW)
     .addAttribute("TYPE", "FLOAT32")
     .addAttribute("DIM", 768)
     .addAttribute("DISTANCE_METRIC", "COSINE")
     .addAttribute("M", 32)
     .addAttribute("EF_CONSTRUCTION", 200)
     .build();
 

Method Summary

Modifier and Type	Method and Description
VectorField.Builder	addAttribute(java.lang.String name, java.lang.Object value) Adds a single attribute to the vector field configuration.
VectorField.Builder	algorithm(VectorField.VectorAlgorithm algorithm) Sets the vector indexing algorithm to use.
VectorField.Builder	as(java.lang.String attribute) Sets an alias for the field that can be used in queries.
VectorField.Builder	attributes(java.util.Map<java.lang.String,java.lang.Object> attributes) Sets all vector field attributes at once, replacing any previously set attributes.
VectorField	build() Builds and returns a new VectorField instance with the configured properties.
VectorField.Builder	fieldName(FieldName fieldName) Sets the field name using a FieldName object.
VectorField.Builder	fieldName(java.lang.String fieldName) Sets the field name for the vector field.

Methods inherited from class java.lang.Object

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

Method Detail

build

public VectorField build()

Builds and returns a new VectorField instance with the configured properties.

Returns:

a new VectorField instance

Throws:

java.lang.IllegalArgumentException - if required parameters (fieldName, algorithm, or attributes) are not set

fieldName

public VectorField.Builder fieldName(java.lang.String fieldName)

Sets the field name for the vector field.

Parameters:

fieldName - the name of the vector field in the index

Returns:

this Builder instance for method chaining

fieldName

public VectorField.Builder fieldName(FieldName fieldName)

Sets the field name using a FieldName object.

Parameters:

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

Returns:

this Builder instance for method chaining

as

public VectorField.Builder as(java.lang.String attribute)

Sets an alias for the field that can be used in queries.

Parameters:

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

Returns:

this Builder instance for method chaining

algorithm

public VectorField.Builder algorithm(VectorField.VectorAlgorithm algorithm)

Sets the vector indexing algorithm to use.

Parameters:

algorithm - the vector algorithm (FLAT, HNSW, or SVS_VAMANA)

Returns:

this Builder instance for method chaining

attributes

public VectorField.Builder attributes(java.util.Map<java.lang.String,java.lang.Object> attributes)

Sets all vector field attributes at once, replacing any previously set attributes.

Parameters:

attributes - a map of attribute names to values

Returns:

this Builder instance for method chaining

addAttribute

public VectorField.Builder addAttribute(java.lang.String name,
                                        java.lang.Object value)

Adds a single attribute to the vector field configuration. If this is the first attribute added, initializes the attributes map.

Parameters:

name - the attribute name

value - the attribute value

Returns:

this Builder instance for method chaining