Package com.redis.vl.query

Class VectorRangeQuery.Builder

java.lang.Object
com.redis.vl.query.VectorRangeQuery.Builder
Enclosing class:
VectorRangeQuery
public static class VectorRangeQuery.Builder extends Object
Builder for creating VectorRangeQuery instances.

  • Method Details

    • vector

      public VectorRangeQuery.Builder vector(float[] vector)
      Set the query vector.
      Parameters:
      vector - Query vector for similarity search
      Returns:
      This builder

    • field

      public VectorRangeQuery.Builder field(String field)
      Set the vector field name to search.
      Parameters:
      field - Name of the vector field
      Returns:
      This builder

    • returnFields

      public VectorRangeQuery.Builder returnFields(String... fields)
      Set the fields to return in results (varargs).
      Parameters:
      fields - Field names to return
      Returns:
      This builder

    • returnFields

      public VectorRangeQuery.Builder returnFields(List<String> fields)
      Set the fields to return in results (list).
      Parameters:
      fields - List of field names to return
      Returns:
      This builder

    • distanceThreshold

      public VectorRangeQuery.Builder distanceThreshold(double threshold)
      Set the distance threshold for range filtering.
      Parameters:
      threshold - Maximum distance from query vector
      Returns:
      This builder

    • numResults

      public VectorRangeQuery.Builder numResults(int numResults)
      Set the maximum number of results to return.
      Parameters:
      numResults - Maximum number of results
      Returns:
      This builder

    • k

      @Deprecated public VectorRangeQuery.Builder k(int k)
      Deprecated.
      Use numResults() instead
      Set the maximum number of results (deprecated alias).
      Parameters:
      k - Maximum number of results
      Returns:
      This builder

    • returnScore

      public VectorRangeQuery.Builder returnScore(boolean returnScore)
      Set whether to return scores with results.
      Parameters:
      returnScore - True to return similarity scores
      Returns:
      This builder

    • normalizeVectorDistance

      public VectorRangeQuery.Builder normalizeVectorDistance(boolean normalize)
      Set whether to normalize vector distances.
      Parameters:
      normalize - True to normalize distances to [0, 1]
      Returns:
      This builder

    • epsilon

      public VectorRangeQuery.Builder epsilon(double epsilon)
      Set the epsilon value for approximate HNSW search.
      Parameters:
      epsilon - Epsilon parameter for search precision
      Returns:
      This builder

    • sortBy

      public VectorRangeQuery.Builder sortBy(String sortBy)
      Set the field name to sort results by.
      Parameters:
      sortBy - Field name for sorting
      Returns:
      This builder

    • sortDescending

      public VectorRangeQuery.Builder sortDescending(boolean descending)
      Set whether to sort results in descending order.
      Parameters:
      descending - True for descending sort
      Returns:
      This builder

    • inOrder

      public VectorRangeQuery.Builder inOrder(boolean inOrder)
      Set whether query terms must appear in order.
      Parameters:
      inOrder - True to enforce term order
      Returns:
      This builder

    • build

      public VectorRangeQuery build()
      Build the VectorRangeQuery instance.
      Returns:
      Configured VectorRangeQuery
      Throws:
      IllegalArgumentException - if vector or field is null