Package com.redis.vl.query

Class HybridQuery.HybridQueryBuilder

java.lang.Object
com.redis.vl.query.HybridQuery.HybridQueryBuilder
Enclosing class:
HybridQuery
public static class HybridQuery.HybridQueryBuilder extends Object
Builder for creating HybridQuery instances with fluent API.

  • Method Details

    • text

      public HybridQuery.HybridQueryBuilder text(String text)
      Set the text query string.
      Parameters:
      text - The text to search for
      Returns:
      This builder for chaining

    • textFieldName

      public HybridQuery.HybridQueryBuilder textFieldName(String textFieldName)
      Set the name of the text field to search.
      Parameters:
      textFieldName - The field name containing text data
      Returns:
      This builder for chaining

    • vector

      public HybridQuery.HybridQueryBuilder vector(float[] vector)
      Set the query vector for similarity search. Makes a defensive copy.
      Parameters:
      vector - The embedding vector to search with
      Returns:
      This builder for chaining

    • vectorFieldName

      public HybridQuery.HybridQueryBuilder vectorFieldName(String vectorFieldName)
      Set the name of the vector field to search.
      Parameters:
      vectorFieldName - The field name containing vector data
      Returns:
      This builder for chaining

    • textScorer

      public HybridQuery.HybridQueryBuilder textScorer(String textScorer)
      Set the scoring algorithm for text search.
      Parameters:
      textScorer - The text scorer (e.g., "BM25", "TFIDF")
      Returns:
      This builder for chaining

    • filterExpression

      public HybridQuery.HybridQueryBuilder filterExpression(Filter filterExpression)
      Set an additional filter expression for the query.
      Parameters:
      filterExpression - The filter to apply
      Returns:
      This builder for chaining

    • alpha

      public HybridQuery.HybridQueryBuilder alpha(float alpha)
      Set the weight for combining text and vector scores.
      Parameters:
      alpha - Weight between 0.0 (vector only) and 1.0 (text only), default 0.7
      Returns:
      This builder for chaining

    • dtype

      public HybridQuery.HybridQueryBuilder dtype(String dtype)
      Set the data type for vector storage.
      Parameters:
      dtype - The data type (e.g., "float32", "float64")
      Returns:
      This builder for chaining

    • numResults

      public HybridQuery.HybridQueryBuilder numResults(int numResults)
      Set the maximum number of results to return.
      Parameters:
      numResults - The result limit
      Returns:
      This builder for chaining

    • returnFields

      public HybridQuery.HybridQueryBuilder returnFields(List<String> returnFields)
      Set the fields to return in results. Makes a defensive copy.
      Parameters:
      returnFields - List of field names to return
      Returns:
      This builder for chaining

    • stopwords

      public HybridQuery.HybridQueryBuilder stopwords(Set<String> stopwords)
      Set custom stopwords for text search. Makes a defensive copy.
      Parameters:
      stopwords - Set of words to exclude from text search
      Returns:
      This builder for chaining

    • dialect

      public HybridQuery.HybridQueryBuilder dialect(int dialect)
      Set the query dialect version.
      Parameters:
      dialect - The dialect version (default 2)
      Returns:
      This builder for chaining

    • build

      public HybridQuery build()
      Build the HybridQuery instance.
      Returns:
      The configured HybridQuery
      Throws:
      IllegalArgumentException - if required fields are missing or invalid