Package com.redis.vl.schema

Class VectorField.VectorFieldBuilder

java.lang.Object
com.redis.vl.schema.VectorField.VectorFieldBuilder
Enclosing class:
VectorField
public static class VectorField.VectorFieldBuilder extends Object
Fluent builder for VectorField

  • Method Details

    • name

      public VectorField.VectorFieldBuilder name(String name)
      Set the field name
      Parameters:
      name - Field name
      Returns:
      This builder

    • alias

      public VectorField.VectorFieldBuilder alias(String alias)
      Set the field alias
      Parameters:
      alias - Field alias
      Returns:
      This builder

    • withAlias

      public VectorField.VectorFieldBuilder withAlias(String alias)
      Set the field alias (alternative method)
      Parameters:
      alias - Field alias
      Returns:
      This builder

    • indexed

      public VectorField.VectorFieldBuilder indexed(boolean indexed)
      Set whether the field is indexed
      Parameters:
      indexed - True if indexed
      Returns:
      This builder

    • sortable

      public VectorField.VectorFieldBuilder sortable(boolean sortable)
      Set whether the field is sortable
      Parameters:
      sortable - True if sortable
      Returns:
      This builder

    • dimensions

      public VectorField.VectorFieldBuilder dimensions(int dimensions)
      Set the number of dimensions
      Parameters:
      dimensions - Number of dimensions in the vector
      Returns:
      This builder

    • algorithm

      public VectorField.VectorFieldBuilder algorithm(VectorField.VectorAlgorithm algorithm)
      Set the vector indexing algorithm
      Parameters:
      algorithm - Vector algorithm (FLAT or HNSW)
      Returns:
      This builder

    • withAlgorithm

      public VectorField.VectorFieldBuilder withAlgorithm(VectorField.VectorAlgorithm algorithm)
      Set the vector indexing algorithm (alternative method)
      Parameters:
      algorithm - Vector algorithm (FLAT or HNSW)
      Returns:
      This builder

    • distanceMetric

      public VectorField.VectorFieldBuilder distanceMetric(VectorField.DistanceMetric distanceMetric)
      Set the distance metric
      Parameters:
      distanceMetric - Distance metric (L2, IP, or COSINE)
      Returns:
      This builder

    • withDistanceMetric

      public VectorField.VectorFieldBuilder withDistanceMetric(VectorField.DistanceMetric distanceMetric)
      Set the distance metric (alternative method)
      Parameters:
      distanceMetric - Distance metric (L2, IP, or COSINE)
      Returns:
      This builder

    • dataType

      public VectorField.VectorFieldBuilder dataType(VectorField.VectorDataType dataType)
      Set the data type
      Parameters:
      dataType - Data type (FLOAT32 or FLOAT64)
      Returns:
      This builder

    • initialCapacity

      public VectorField.VectorFieldBuilder initialCapacity(int initialCapacity)
      Set the initial capacity for FLAT algorithm
      Parameters:
      initialCapacity - Initial capacity
      Returns:
      This builder

    • blockSize

      public VectorField.VectorFieldBuilder blockSize(int blockSize)
      Set the block size for FLAT algorithm
      Parameters:
      blockSize - Block size
      Returns:
      This builder

    • hnswM

      public VectorField.VectorFieldBuilder hnswM(int m)
      Set the M parameter for HNSW algorithm
      Parameters:
      m - M parameter
      Returns:
      This builder

    • withHnswM

      public VectorField.VectorFieldBuilder withHnswM(int m)
      Set the M parameter for HNSW algorithm (alternative method)
      Parameters:
      m - M parameter
      Returns:
      This builder

    • hnswEfConstruction

      public VectorField.VectorFieldBuilder hnswEfConstruction(int efConstruction)
      Set the EF_CONSTRUCTION parameter for HNSW algorithm
      Parameters:
      efConstruction - EF_CONSTRUCTION parameter
      Returns:
      This builder

    • withHnswEfConstruction

      public VectorField.VectorFieldBuilder withHnswEfConstruction(int efConstruction)
      Set the EF_CONSTRUCTION parameter for HNSW algorithm (alternative method)
      Parameters:
      efConstruction - EF_CONSTRUCTION parameter
      Returns:
      This builder

    • hnswEfRuntime

      public VectorField.VectorFieldBuilder hnswEfRuntime(int efRuntime)
      Set the EF_RUNTIME parameter for HNSW algorithm
      Parameters:
      efRuntime - EF_RUNTIME parameter
      Returns:
      This builder

    • epsilon

      public VectorField.VectorFieldBuilder epsilon(double epsilon)
      Set the epsilon parameter for HNSW algorithm
      Parameters:
      epsilon - Epsilon parameter
      Returns:
      This builder

    • build

      public VectorField build()
      Build the VectorField
      Returns:
      VectorField instance