Class AggregateHybridQuery

java.lang.Object
com.redis.vl.query.AggregateHybridQuery

public final class AggregateHybridQuery extends Object
AggregateHybridQuery combines text and vector search in Redis using aggregation.

This is the primary name for hybrid queries in RedisVL, matching the Python implementation. It is a type alias for HybridQuery.

Ported from Python: redisvl/query/aggregate.py:57-315 (AggregateHybridQuery class)

It allows you to perform a hybrid search using both text and vector similarity. It scores documents based on a weighted combination of text and vector similarity.

Python equivalent:

 query = AggregateHybridQuery(
     text="example text",
     text_field_name="text_field",
     vector=[0.1, 0.2, 0.3],
     vector_field_name="vector_field",
     text_scorer="BM25STD",
     filter_expression=None,
     alpha=0.7,
     dtype="float32",
     num_results=10,
     return_fields=["field1", "field2"],
     stopwords="english",
     dialect=2,
 )
 results = index.query(query)
 

Java equivalent:

 HybridQuery query = AggregateHybridQuery.builder()
     .text("example text")
     .textFieldName("text_field")
     .vector(new float[]{0.1f, 0.2f, 0.3f})
     .vectorFieldName("vector_field")
     .textScorer("BM25STD")
     .filterExpression(null)
     .alpha(0.7f)
     .dtype("float32")
     .numResults(10)
     .returnFields(List.of("field1", "field2"))
     .stopwords(HybridQuery.loadDefaultStopwords("english"))
     .dialect(2)
     .build();
 List<Map<String, Object>> results = index.query(query);
 
Since:
0.1.0
  • Method Details

    • builder

      public static HybridQuery.HybridQueryBuilder builder()
      Create a new builder for AggregateHybridQuery (delegates to HybridQuery.builder()).
      Returns:
      A new HybridQuery.HybridQueryBuilder instance
    • loadDefaultStopwords

      public static Set<String> loadDefaultStopwords(String language)
      Load default stopwords for a given language (delegates to HybridQuery.loadDefaultStopwords()).
      Parameters:
      language - the language (e.g., "english", "german")
      Returns:
      set of stopwords