Use Advanced Query Types
This guide covers advanced query types available in RedisVL:
TextQuery: Full text search with advanced scoringAggregateHybridQueryandHybridQuery: Combines text and vector search for hybrid retrievalMultiVectorQuery: Search over multiple vector fields simultaneously
These query types enable sophisticated search applications that go beyond simple vector similarity search.
Prerequisites
Before you begin, ensure you have:
- Installed RedisVL:
pip install redisvl - A running Redis instance (Redis 8+ or Redis Cloud)
- For
HybridQuery: Redis >= 8.4.0 and redis-py >= 7.1.0
What You'll Learn
By the end of this guide, you will be able to:
- Perform full-text search with
TextQueryand advanced scoring options - Combine text and vector search using
HybridQueryandAggregateHybridQuery - Search across multiple vector fields with
MultiVectorQuery - Configure custom stopwords for text search
Setup and Data Preparation
First, let's create a schema and prepare sample data that includes text fields, numeric fields, and vector fields.
import numpy as np
from jupyterutils import result_print
# Sample data with text descriptions, categories, and vectors
data = [
{
'product_id': 'prod_1',
'brief_description': 'comfortable running shoes for athletes',
'full_description': 'Engineered with a dual-layer EVA foam midsole and FlexWeave breathable mesh upper, these running shoes deliver responsive cushioning for long-distance runs. The anatomical footbed adapts to your stride while the carbon rubber outsole provides superior traction on varied terrain.',
'category': 'footwear',
'price': 89.99,
'rating': 4.5,
'text_embedding': np.array([0.1, 0.2, 0.1], dtype=np.float32).tobytes(),
'image_embedding': np.array([0.8, 0.1], dtype=np.float32).tobytes(),
},
{
'product_id': 'prod_2',
'brief_description': 'lightweight running jacket with water resistance',
'full_description': 'Stay protected with this ultralight 2.5-layer DWR-coated shell featuring laser-cut ventilation zones and reflective piping for low-light visibility. Packs into its own chest pocket and weighs just 4.2 oz, making it ideal for unpredictable weather conditions.',
'category': 'outerwear',
'price': 129.99,
'rating': 4.8,
'text_embedding': np.array([0.2, 0.3, 0.2], dtype=np.float32).tobytes(),
'image_embedding': np.array([0.7, 0.2], dtype=np.float32).tobytes(),
},
{
'product_id': 'prod_3',
'brief_description': 'professional tennis racket for competitive players',
'full_description': 'Competition-grade racket featuring a 98 sq in head size, 16x19 string pattern, and aerospace-grade graphite frame that delivers explosive power with pinpoint control. Tournament-approved specs include 315g weight and 68 RA stiffness rating for advanced baseline play.',
'category': 'equipment',
'price': 199.99,
'rating': 4.9,
'text_embedding': np.array([0.9, 0.1, 0.05], dtype=np.float32).tobytes(),
'image_embedding': np.array([0.1, 0.9], dtype=np.float32).tobytes(),
},
{
'product_id': 'prod_4',
'brief_description': 'yoga mat with extra cushioning for comfort',
'full_description': 'Premium 8mm thick TPE yoga mat with dual-texture surface - smooth side for hot yoga flow and textured side for maximum grip during balancing poses. Closed-cell technology prevents moisture absorption while alignment markers guide proper positioning in asanas.',
'category': 'accessories',
'price': 39.99,
'rating': 4.3,
'text_embedding': np.array([0.15, 0.25, 0.15], dtype=np.float32).tobytes(),
'image_embedding': np.array([0.5, 0.5], dtype=np.float32).tobytes(),
},
{
'product_id': 'prod_5',
'brief_description': 'basketball shoes with excellent ankle support',
'full_description': 'High-top basketball sneakers with Zoom Air units in forefoot and heel, reinforced lateral sidewalls for explosive cuts, and herringbone traction pattern optimized for hardwood courts. The internal bootie construction and extended ankle collar provide lockdown support during aggressive drives.',
'category': 'footwear',
'price': 139.99,
'rating': 4.7,
'text_embedding': np.array([0.12, 0.18, 0.12], dtype=np.float32).tobytes(),
'image_embedding': np.array([0.75, 0.15], dtype=np.float32).tobytes(),
},
{
'product_id': 'prod_6',
'brief_description': 'swimming goggles with anti-fog coating',
'full_description': 'Low-profile competition goggles with curved polycarbonate lenses offering 180-degree peripheral vision and UV protection. Hydrophobic anti-fog coating lasts 10x longer than standard treatments, while the split silicone strap and interchangeable nose bridges ensure a watertight, custom fit.',
'category': 'accessories',
'price': 24.99,
'rating': 4.4,
'text_embedding': np.array([0.3, 0.1, 0.2], dtype=np.float32).tobytes(),
'image_embedding': np.array([0.2, 0.8], dtype=np.float32).tobytes(),
},
]
Define the Schema
Our schema includes:
- Tag fields:
product_id,category - Text fields:
brief_descriptionandfull_descriptionfor full-text search - Numeric fields:
price,rating - Vector fields:
text_embedding(3 dimensions) andimage_embedding(2 dimensions) for semantic search
schema = {
"index": {
"name": "advanced_queries",
"prefix": "products",
"storage_type": "hash",
},
"fields": [
{"name": "product_id", "type": "tag"},
{"name": "category", "type": "tag"},
{"name": "brief_description", "type": "text"},
{"name": "full_description", "type": "text"},
{"name": "price", "type": "numeric"},
{"name": "rating", "type": "numeric"},
{
"name": "text_embedding",
"type": "vector",
"attrs": {
"dims": 3,
"distance_metric": "cosine",
"algorithm": "flat",
"datatype": "float32"
}
},
{
"name": "image_embedding",
"type": "vector",
"attrs": {
"dims": 2,
"distance_metric": "cosine",
"algorithm": "flat",
"datatype": "float32"
}
}
],
}
Create Index and Load Data
from redisvl.index import SearchIndex
# Create the search index
index = SearchIndex.from_dict(schema, redis_url="redis://localhost:6379")
# Create the index and load data
index.create(overwrite=True)
keys = index.load(data)
print(f"Loaded {len(keys)} products into the index")
Loaded 6 products into the index
1. TextQuery: Full Text Search
The TextQuery class enables full text search with advanced scoring algorithms. It's ideal for keyword-based search with relevance ranking.
Basic Text Search
Let's search for products related to "running shoes":
from redisvl.query import TextQuery
# Create a text query
text_query = TextQuery(
text="running shoes",
text_field_name="brief_description",
return_fields=["product_id", "brief_description", "category", "price"],
num_results=5
)
results = index.query(text_query)
result_print(results)
| score | product_id | brief_description | category | price |
|---|---|---|---|---|
| 5.953989333038773 | prod_1 | comfortable running shoes for athletes | footwear | 89.99 |
| 2.085315593627535 | prod_5 | basketball shoes with excellent ankle support | footwear | 139.99 |
| 2.0410082774474088 | prod_2 | lightweight running jacket with water resistance | outerwear | 129.99 |
Text Search with Different Scoring Algorithms
RedisVL supports multiple text scoring algorithms. Let's compare BM25STD and TFIDF:
# BM25 standard scoring (default)
bm25_query = TextQuery(
text="comfortable shoes",
text_field_name="brief_description",
text_scorer="BM25STD",
return_fields=["product_id", "brief_description", "price"],
num_results=3
)
print("Results with BM25 scoring:")
results = index.query(bm25_query)
result_print(results)
Results with BM25 scoring:
| score | product_id | brief_description | price |
|---|---|---|---|
| 6.031534703977659 | prod_1 | comfortable running shoes for athletes | 89.99 |
| 2.085315593627535 | prod_5 | basketball shoes with excellent ankle support | 139.99 |
| 1.5268074873573214 | prod_4 | yoga mat with extra cushioning for comfort | 39.99 |
# TFIDF scoring
tfidf_query = TextQuery(
text="comfortable shoes",
text_field_name="brief_description",
text_scorer="TFIDF",
return_fields=["product_id", "brief_description", "price"],
num_results=3
)
print("Results with TFIDF scoring:")
results = index.query(tfidf_query)
result_print(results)
Results with TFIDF scoring:
| score | product_id | brief_description | price |
|---|---|---|---|
| 2.3333333333333335 | prod_1 | comfortable running shoes for athletes | 89.99 |
| 2.0 | prod_5 | basketball shoes with excellent ankle support | 139.99 |
| 1.0 | prod_4 | yoga mat with extra cushioning for comfort | 39.99 |
Text Search with Filters
Combine text search with filters to narrow results:
from redisvl.query.filter import Tag, Num
# Search for "shoes" only in the footwear category
filtered_text_query = TextQuery(
text="shoes",
text_field_name="brief_description",
filter_expression=Tag("category") == "footwear",
return_fields=["product_id", "brief_description", "category", "price"],
num_results=5
)
results = index.query(filtered_text_query)
result_print(results)
| score | product_id | brief_description | category | price |
|---|---|---|---|---|
| 3.9314935770863046 | prod_1 | comfortable running shoes for athletes | footwear | 89.99 |
| 3.1279733904413027 | prod_5 | basketball shoes with excellent ankle support | footwear | 139.99 |
# Search for products under $100
price_filtered_query = TextQuery(
text="comfortable",
text_field_name="brief_description",
filter_expression=Num("price") < 100,
return_fields=["product_id", "brief_description", "price"],
num_results=5
)
results = index.query(price_filtered_query)
result_print(results)
| score | product_id | brief_description | price |
|---|---|---|---|
| 3.1541404034996914 | prod_1 | comfortable running shoes for athletes | 89.99 |
| 1.5268074873573214 | prod_4 | yoga mat with extra cushioning for comfort | 39.99 |
Text Search with Multiple Fields and Weights
You can search across multiple text fields with different weights to prioritize certain fields.
Here we'll prioritize the brief_description field and make text similarity in that field twice as important as text similarity in full_description:
weighted_query = TextQuery(
text="shoes",
text_field_name={"brief_description": 1.0, "full_description": 0.5},
return_fields=["product_id", "brief_description"],
num_results=3
)
results = index.query(weighted_query)
result_print(results)
| score | product_id | brief_description |
|---|---|---|
| 5.035440025836444 | prod_1 | comfortable running shoes for athletes |
| 2.085315593627535 | prod_5 | basketball shoes with excellent ankle support |
Text Search with Custom Stopwords
Stopwords are common words that are filtered out before processing the query. You can specify which language's default stopwords should be filtered out, like english, french, or german. You can also define your own list of stopwords:
# Use English stopwords (default)
query_with_stopwords = TextQuery(
text="the best shoes for running",
text_field_name="brief_description",
stopwords="english", # Common words like "the", "for" will be removed
return_fields=["product_id", "brief_description"],
num_results=3
)
results = index.query(query_with_stopwords)
result_print(results)
| score | product_id | brief_description |
|---|---|---|
| 5.953989333038773 | prod_1 | comfortable running shoes for athletes |
| 2.085315593627535 | prod_5 | basketball shoes with excellent ankle support |
| 2.0410082774474088 | prod_2 | lightweight running jacket with water resistance |
# Use custom stopwords
custom_stopwords_query = TextQuery(
text="professional equipment for athletes",
text_field_name="brief_description",
stopwords=["for", "with"], # Only these words will be filtered
return_fields=["product_id", "brief_description"],
num_results=3
)
results = index.query(custom_stopwords_query)
result_print(results)
| score | product_id | brief_description |
|---|---|---|
| 3.1541404034996914 | prod_1 | comfortable running shoes for athletes |
| 3.0864038416103 | prod_3 | professional tennis racket for competitive players |
# No stopwords
no_stopwords_query = TextQuery(
text="the best shoes for running",
text_field_name="brief_description",
stopwords=None, # All words will be included
return_fields=["product_id", "brief_description"],
num_results=3
)
results = index.query(no_stopwords_query)
result_print(results)
| score | product_id | brief_description |
|---|---|---|
| 5.953989333038773 | prod_1 | comfortable running shoes for athletes |
| 2.085315593627535 | prod_5 | basketball shoes with excellent ankle support |
| 2.0410082774474088 | prod_2 | lightweight running jacket with water resistance |
2. Hybrid Queries: Combining Text and Vector Search
Hybrid queries combine text search and vector similarity to provide the best of both worlds:
- Text search: Finds exact keyword matches
- Vector search: Captures semantic similarity
As of Redis 8.4.0, Redis natively supports a FT.HYBRID search command. RedisVL provides a HybridQuery class that makes it easy to construct and execute hybrid queries. For earlier versions of Redis, RedisVL provides an AggregateHybridQuery class that uses Redis aggregation to achieve similar results.
from packaging.version import Version
from redis import __version__ as _redis_py_version
redis_py_version = Version(_redis_py_version)
redis_version = Version(index.client.info()["redis_version"])
HYBRID_SEARCH_AVAILABLE = redis_version >= Version("8.4.0") and redis_py_version >= Version("7.1.0")
print(HYBRID_SEARCH_AVAILABLE)
True
Index-Level Stopwords Configuration
The previous example showed query-time stopwords using TextQuery.stopwords, which filters words from the query before searching. RedisVL also supports index-level stopwords configuration, which determines which words are indexed in the first place.
Key Difference:
- Query-time stopwords (
TextQuery.stopwords): Filters words from your search query (client-side) - Index-level stopwords (
IndexInfo.stopwords): Controls which words get indexed in Redis (server-side)
Three Configuration Modes:
None(default): Use Redis's default stopwords list[](empty list): Disable stopwords completely (STOPWORDS 0in FT.CREATE)["the", "a", "an"]: Use a custom stopwords list
When to use STOPWORDS 0:
- When you need to search for common words like "of", "at", "the"
- For entity names containing stopwords (e.g., "Bank of Glasberliner", "University of Glasberliner")
- When working with structured data where every word matters
# Create a schema with index-level stopwords disabled
from redisvl.index import SearchIndex
stopwords_schema = {
"index": {
"name": "company_index",
"prefix": "company:",
"storage_type": "hash",
"stopwords": [] # STOPWORDS 0 - disable stopwords completely
},
"fields": [
{"name": "company_name", "type": "text"},
{"name": "description", "type": "text"}
]
}
# Create index using from_dict (handles schema creation internally)
company_index = SearchIndex.from_dict(stopwords_schema, redis_url="redis://localhost:6379")
company_index.create(overwrite=True, drop=True)
print(f"Index created with STOPWORDS 0: {company_index}")
Index created with STOPWORDS 0: <redisvl.index.index.SearchIndex object at 0x130e98410>
# Load sample data with company names containing common stopwords
companies = [
{"company_name": "Bank of Glasberliner", "description": "Major financial institution"},
{"company_name": "University of Glasberliner", "description": "Public university system"},
{"company_name": "Department of Glasberliner Affairs", "description": "A government agency"},
{"company_name": "Glasberliner FC", "description": "Football Club"},
{"company_name": "The Home Market", "description": "Home improvement retailer"},
]
for i, company in enumerate(companies):
company_index.load([company], keys=[f"company:{i}"])
print(f"✓ Loaded {len(companies)} companies")
✓ Loaded 5 companies
# Search for "Bank of Glasberliner" - with STOPWORDS 0, "of" is indexed and searchable
from redisvl.query import FilterQuery
query = FilterQuery(
filter_expression='@company_name:(Bank of Glasberliner)',
return_fields=["company_name", "description"],
)
results = company_index.search(query.query, query_params=query.params)
print(f"Found {len(results.docs)} results for 'Bank of Glasberliner':")
for doc in results.docs:
print(f" - {doc.company_name}: {doc.description}")
Found 1 results for 'Bank of Glasberliner':
- Bank of Glasberliner: Major financial institution
Comparison: With vs Without Stopwords
If we had used the default stopwords (not specifying stopwords in the schema), the word "of" would be filtered out during indexing. This means:
- ❌ Searching for
"Bank of Glasberliner"might not find exact matches - ❌ The phrase would be indexed as
"Bank Berlin"(without "of") - ✅ With
STOPWORDS 0, all words including "of" are indexed
Custom Stopwords Example:
You can also provide a custom list of stopwords:
# Example: Create index with custom stopwords
custom_stopwords_schema = {
"index": {
"name": "custom_stopwords_index",
"prefix": "custom:",
"stopwords": ["inc", "llc", "corp"] # Filter out legal entity suffixes
},
"fields": [
{"name": "name", "type": "text"}
]
}
# This would create an index where "inc", "llc", "corp" are not indexed
print("Custom stopwords:", custom_stopwords_schema["index"]["stopwords"])
Custom stopwords: ['inc', 'llc', 'corp']
YAML Format:
You can also define stopwords in YAML schema files:
version: '0.1.0'
index:
name: company_index
prefix: company:
storage_type: hash
stopwords: [] # Disable stopwords (STOPWORDS 0)
fields:
- name: company_name
type: text
- name: description
type: text
Or with custom stopwords:
index:
stopwords:
- the
- a
- an
# Cleanup
company_index.delete(drop=True)
print("✓ Cleaned up company_index")
✓ Cleaned up company_index
Basic Hybrid Query
NOTE: HybridQuery requires Redis >= 8.4.0 and redis-py >= 7.1.0.
Let's search for "running" with both text and semantic search, combining the results' scores using a linear combination:
if HYBRID_SEARCH_AVAILABLE:
from redisvl.query import HybridQuery
# Create a hybrid query
hybrid_query = HybridQuery(
text="running shoes",
text_field_name="brief_description",
vector=[0.1, 0.2, 0.1], # Query vector
vector_field_name="text_embedding",
return_fields=["product_id", "brief_description", "category", "price"],
num_results=5,
yield_text_score_as="text_score",
yield_vsim_score_as="vector_similarity",
combination_method="LINEAR",
yield_combined_score_as="hybrid_score",
)
results = index.query(hybrid_query)
result_print(results)
else:
print("Hybrid search is not available in this version of Redis/redis-py.")
/Users/tyler.hutcherson/Documents/AppliedAI/redis-vl-python/redisvl/query/hybrid.py:136: UserWarning: HybridPostProcessingConfig is an experimental and may change or be removed in future versions.
self.postprocessing_config = HybridPostProcessingConfig()
/Users/tyler.hutcherson/Documents/AppliedAI/redis-vl-python/redisvl/query/hybrid.py:247: UserWarning: HybridSearchQuery is an experimental and may change or be removed in future versions.
search_query = HybridSearchQuery(
/Users/tyler.hutcherson/Documents/AppliedAI/redis-vl-python/redisvl/query/hybrid.py:288: UserWarning: HybridVsimQuery is an experimental and may change or be removed in future versions.
vsim_query = HybridVsimQuery(
/Users/tyler.hutcherson/Documents/AppliedAI/redis-vl-python/redisvl/query/hybrid.py:363: UserWarning: CombineResultsMethod is an experimental and may change or be removed in future versions.
return CombineResultsMethod(
| text_score | product_id | brief_description | category | price | vector_similarity | hybrid_score |
|---|---|---|---|---|---|---|
| 5.95398933304 | prod_1 | comfortable running shoes for athletes | footwear | 89.99 | 0.999999970198 | 2.48619677905 |
| 2.08531559363 | prod_5 | basketball shoes with excellent ankle support | footwear | 139.99 | 0.995073735714 | 1.32214629309 |
| 2.04100827745 | prod_2 | lightweight running jacket with water resistance | outerwear | 129.99 | 0.995073735714 | 1.30885409823 |
| 0 | prod_4 | yoga mat with extra cushioning for comfort | accessories | 39.99 | 0.998058259487 | 0.698640781641 |
| 0 | prod_6 | swimming goggles with anti-fog coating | accessories | 24.99 | 0.881881296635 | 0.617316907644 |
For earlier versions of Redis, you can use AggregateHybridQuery instead:
from redisvl.query import AggregateHybridQuery
agg_hybrid_query = AggregateHybridQuery(
text="running shoes",
text_field_name="brief_description",
vector=[0.1, 0.2, 0.1], # Query vector
vector_field_name="text_embedding",
return_fields=["product_id", "brief_description", "category", "price"],
num_results=5
)
results = index.query(agg_hybrid_query)
result_print(results)
| vector_distance | product_id | brief_description | category | price | vector_similarity | text_score | hybrid_score |
|---|---|---|---|---|---|---|---|
| 5.96046447754e-08 | prod_1 | comfortable running shoes for athletes | footwear | 89.99 | 0.999999970198 | 5.95398933304 | 2.48619677905 |
| 0.00985252857208 | prod_5 | basketball shoes with excellent ankle support | footwear | 139.99 | 0.995073735714 | 2.08531559363 | 1.32214629309 |
| 0.00985252857208 | prod_2 | lightweight running jacket with water resistance | outerwear | 129.99 | 0.995073735714 | 2.04100827745 | 1.30885409823 |
| 0.0038834810257 | prod_4 | yoga mat with extra cushioning for comfort | accessories | 39.99 | 0.998058259487 | 0 | 0.698640781641 |
| 0.236237406731 | prod_6 | swimming goggles with anti-fog coating | accessories | 24.99 | 0.881881296635 | 0 | 0.617316907644 |
Adjusting the Alpha Parameter
Results are scored using a weighted combination:
hybrid_score = (alpha) * text_score + (1 - alpha) * vector_score
Where alpha controls the balance between text and vector search (default: 0.3 for HybridQuery and 0.7 for AggregateHybridQuery). Note that AggregateHybridQuery reverses the definition of alpha to be the weight of the vector score.
The alpha parameter controls the weight between text and vector search:
alpha=1.0: Pure text search (or pure vector search forAggregateHybridQuery)alpha=0.0: Pure vector search (or pure text search forAggregateHybridQuery)alpha=0.3(default -HybridQuery): 30% text, 70% vector
if HYBRID_SEARCH_AVAILABLE:
vector_heavy_query = HybridQuery(
text="comfortable",
text_field_name="brief_description",
vector=[0.15, 0.25, 0.15],
vector_field_name="text_embedding",
combination_method="LINEAR",
linear_alpha=0.1, # 10% text, 90% vector
return_fields=["product_id", "brief_description"],
num_results=3,
yield_text_score_as="text_score",
yield_vsim_score_as="vector_similarity",
yield_combined_score_as="hybrid_score",
)
print("Results with alpha=0.1 (vector-heavy):")
results = index.query(vector_heavy_query)
result_print(results)
else:
print("Hybrid search is not available in this version of Redis/redis-py.")
Results with alpha=0.1 (vector-heavy):
| text_score | product_id | brief_description | vector_similarity | hybrid_score |
|---|---|---|---|---|
| 3.1541404035 | prod_1 | comfortable running shoes for athletes | 0.998058259487 | 1.21366647389 |
| 1.52680748736 | prod_4 | yoga mat with extra cushioning for comfort | 1.0000000596 | 1.05268080238 |
| 0 | prod_2 | lightweight running jacket with water resistance | 0.999315559864 | 0.899384003878 |
# More emphasis on vector search (alpha=0.9)
vector_heavy_query = AggregateHybridQuery(
text="comfortable",
text_field_name="brief_description",
vector=[0.15, 0.25, 0.15],
vector_field_name="text_embedding",
alpha=0.9, # 90% vector, 10% text
return_fields=["product_id", "brief_description"],
num_results=3
)
print("Results with alpha=0.9 (vector-heavy):")
results = index.query(vector_heavy_query)
result_print(results)
Results with alpha=0.9 (vector-heavy):
| vector_distance | product_id | brief_description | vector_similarity | text_score | hybrid_score |
|---|---|---|---|---|---|
| -1.19209289551e-07 | prod_4 | yoga mat with extra cushioning for comfort | 1.0000000596 | 1.52680748736 | 1.05268080238 |
| 0.00136888027191 | prod_5 | basketball shoes with excellent ankle support | 0.999315559864 | 0 | 0.899384003878 |
| 0.00136888027191 | prod_2 | lightweight running jacket with water resistance | 0.999315559864 | 0 | 0.899384003878 |
Reciprocal Rank Fusion (RRF)
In addition to combining scores using a linear combination, HybridQuery also supports reciprocal rank fusion (RRF) for combining scores. This method is useful when you want to combine scores giving more weight to the top results from each query.
HybridQuery allows for the following parameters to be specified for RRF:
rrf_window: The window size to use for the RRF combination method. Limits the fusion scope.rrf_constant: The constant to use for the RRF combination method. Controls the decay of rank influence.
AggregateHybridQuery does not support RRF, and only supports a linear combination of scores.
if HYBRID_SEARCH_AVAILABLE:
rrf_query = HybridQuery(
text="comfortable",
text_field_name="brief_description",
vector=[0.15, 0.25, 0.15],
vector_field_name="text_embedding",
combination_method="RRF",
return_fields=["product_id", "brief_description"],
num_results=3,
yield_text_score_as="text_score",
yield_vsim_score_as="vector_similarity",
yield_combined_score_as="hybrid_score",
)
results = index.query(rrf_query)
result_print(results)
else:
print("Hybrid search is not available in this version of Redis/redis-py.")
| text_score | product_id | brief_description | vector_similarity | hybrid_score |
|---|---|---|---|---|
| 1.52680748736 | prod_4 | yoga mat with extra cushioning for comfort | 1.0000000596 | 0.032522474881 |
| 3.1541404035 | prod_1 | comfortable running shoes for athletes | 0.998058259487 | 0.032018442623 |
| 0 | prod_2 | lightweight running jacket with water resistance | 0.999315559864 | 0.0320020481311 |
Hybrid Query with Filters
You can also combine hybrid search with filters:
if HYBRID_SEARCH_AVAILABLE:
# Hybrid search with a price filter
filtered_hybrid_query = HybridQuery(
text="professional equipment",
text_field_name="brief_description",
vector=[0.9, 0.1, 0.05],
vector_field_name="text_embedding",
filter_expression=Num("price") > 100,
return_fields=["product_id", "brief_description", "category", "price"],
num_results=5,
combination_method="LINEAR",
yield_text_score_as="text_score",
yield_vsim_score_as="vector_similarity",
yield_combined_score_as="hybrid_score",
)
results = index.query(filtered_hybrid_query)
result_print(results)
else:
print("Hybrid search is not available in this version of Redis/redis-py.")
| text_score | product_id | brief_description | category | price | vector_similarity | hybrid_score |
|---|---|---|---|---|---|---|
| 3.08640384161 | prod_3 | professional tennis racket for competitive players | equipment | 199.99 | 1.0000000596 | 1.62592119421 |
| 0 | prod_2 | lightweight running jacket with water resistance | outerwear | 129.99 | 0.794171273708 | 0.555919891596 |
| 0 | prod_5 | basketball shoes with excellent ankle support | footwear | 139.99 | 0.794171273708 | 0.555919891596 |
# Hybrid search with a price filter
filtered_hybrid_query = AggregateHybridQuery(
text="professional equipment",
text_field_name="brief_description",
vector=[0.9, 0.1, 0.05],
vector_field_name="text_embedding",
filter_expression=Num("price") > 100,
return_fields=["product_id", "brief_description", "category", "price"],
num_results=5
)
results = index.query(filtered_hybrid_query)
result_print(results)
| vector_distance | product_id | brief_description | category | price | vector_similarity | text_score | hybrid_score |
|---|---|---|---|---|---|---|---|
| -1.19209289551e-07 | prod_3 | professional tennis racket for competitive players | equipment | 199.99 | 1.0000000596 | 3.08640384161 | 1.62592119421 |
| 0.411657452583 | prod_5 | basketball shoes with excellent ankle support | footwear | 139.99 | 0.794171273708 | 0 | 0.555919891596 |
| 0.411657452583 | prod_2 | lightweight running jacket with water resistance | outerwear | 129.99 | 0.794171273708 | 0 | 0.555919891596 |
Using Different Text Scorers
Hybrid queries support the same text scoring algorithms as TextQuery:
if HYBRID_SEARCH_AVAILABLE:
# Aggregate Hybrid query with TFIDF scorer
hybrid_tfidf = HybridQuery(
text="shoes support",
text_field_name="brief_description",
vector=[0.12, 0.18, 0.12],
vector_field_name="text_embedding",
text_scorer="TFIDF",
return_fields=["product_id", "brief_description"],
num_results=3,
combination_method="LINEAR",
yield_text_score_as="text_score",
yield_vsim_score_as="vector_similarity",
yield_combined_score_as="hybrid_score",
)
results = index.query(hybrid_tfidf)
result_print(results)
else:
print("Hybrid search is not available in this version of Redis/redis-py.")
| text_score | product_id | brief_description | vector_similarity | hybrid_score |
|---|---|---|---|---|
| 2.66666666667 | prod_1 | comfortable running shoes for athletes | 0.995073735714 | 1.496551615 |
| 1.66666666667 | prod_5 | basketball shoes with excellent ankle support | 1 | 1.2 |
| 0 | prod_2 | lightweight running jacket with water resistance | 1 | 0.7 |
# Aggregate Hybrid query with TFIDF scorer
hybrid_tfidf = AggregateHybridQuery(
text="shoes support",
text_field_name="brief_description",
vector=[0.12, 0.18, 0.12],
vector_field_name="text_embedding",
text_scorer="TFIDF",
return_fields=["product_id", "brief_description"],
num_results=3
)
results = index.query(hybrid_tfidf)
result_print(results)
| vector_distance | product_id | brief_description | vector_similarity | text_score | hybrid_score |
|---|---|---|---|---|---|
| 0 | prod_5 | basketball shoes with excellent ankle support | 1 | 5 | 2.2 |
| 0 | prod_2 | lightweight running jacket with water resistance | 1 | 0 | 0.7 |
| 0.00136888027191 | prod_4 | yoga mat with extra cushioning for comfort | 0.999315559864 | 0 | 0.699520891905 |
Runtime Parameters for Vector Search Tuning
Important: AggregateHybridQuery uses FT.AGGREGATE commands which do NOT support runtime parameters.
Runtime parameters (such as ef_runtime for HNSW indexes or search_window_size for SVS-VAMANA indexes) are only supported with FT.SEARCH (and partially FT.HYBRID) commands.
For runtime parameter support, use HybridQuery, VectorQuery, or VectorRangeQuery instead:
HybridQuery: Supportsef_runtimefor HNSW indexesVectorQuery: Supports all runtime parameters (HNSW and SVS-VAMANA)VectorRangeQuery: Supports all runtime parameters (HNSW and SVS-VAMANA)AggregateHybridQuery: Does NOT support runtime parameters (uses FT.AGGREGATE)
See the Runtime Parameters section earlier in this notebook for examples of using runtime parameters with VectorQuery.
3. MultiVectorQuery: Multi-Vector Search
The MultiVectorQuery allows you to search over multiple vector fields simultaneously. This is useful when you have different types of embeddings (e.g., text and image embeddings) and want to find results that match across multiple modalities.
The final score is calculated as a weighted combination:
combined_score = w_1 * score_1 + w_2 * score_2 + w_3 * score_3 + ...
Basic Multi-Vector Query
First, we need to import the Vector class to define our query vectors:
from redisvl.query import MultiVectorQuery, Vector
# Define multiple vectors for the query
text_vector = Vector(
vector=[0.1, 0.2, 0.1],
field_name="text_embedding",
dtype="float32",
weight=0.7 # 70% weight for text embedding
)
image_vector = Vector(
vector=[0.8, 0.1],
field_name="image_embedding",
dtype="float32",
weight=0.3 # 30% weight for image embedding
)
# Create a multi-vector query
multi_vector_query = MultiVectorQuery(
vectors=[text_vector, image_vector],
return_fields=["product_id", "brief_description", "category"],
num_results=5
)
results = index.query(multi_vector_query)
result_print(results)
| distance_0 | distance_1 | product_id | brief_description | category | score_0 | score_1 | combined_score |
|---|---|---|---|---|---|---|---|
| 5.96046447754e-08 | 5.96046447754e-08 | prod_1 | comfortable running shoes for athletes | footwear | 0.999999970198 | 0.999999970198 | 0.999999970198 |
| 0.00985252857208 | 0.00266629457474 | prod_5 | basketball shoes with excellent ankle support | footwear | 0.995073735714 | 0.998666852713 | 0.996151670814 |
| 0.00985252857208 | 0.0118260979652 | prod_2 | lightweight running jacket with water resistance | outerwear | 0.995073735714 | 0.994086951017 | 0.994777700305 |
| 0.0038834810257 | 0.210647821426 | prod_4 | yoga mat with extra cushioning for comfort | accessories | 0.998058259487 | 0.894676089287 | 0.967043608427 |
| 0.236237406731 | 0.639005899429 | prod_6 | swimming goggles with anti-fog coating | accessories | 0.881881296635 | 0.680497050285 | 0.82146602273 |
Adjusting Vector Weights
You can adjust the weights to prioritize different vector fields:
# More emphasis on image similarity
text_vec = Vector(
vector=[0.9, 0.1, 0.05],
field_name="text_embedding",
dtype="float32",
weight=0.2 # 20% weight
)
image_vec = Vector(
vector=[0.1, 0.9],
field_name="image_embedding",
dtype="float32",
weight=0.8 # 80% weight
)
image_heavy_query = MultiVectorQuery(
vectors=[text_vec, image_vec],
return_fields=["product_id", "brief_description", "category"],
num_results=3
)
print("Results with emphasis on image similarity:")
results = index.query(image_heavy_query)
result_print(results)
Results with emphasis on image similarity:
| distance_0 | distance_1 | product_id | brief_description | category | score_0 | score_1 | combined_score |
|---|---|---|---|---|---|---|---|
| -1.19209289551e-07 | 0 | prod_3 | professional tennis racket for competitive players | equipment | 1.0000000596 | 1 | 1.00000001192 |
| 0.14539372921 | 0.00900757312775 | prod_6 | swimming goggles with anti-fog coating | accessories | 0.927303135395 | 0.995496213436 | 0.981857597828 |
| 0.436696171761 | 0.219131231308 | prod_4 | yoga mat with extra cushioning for comfort | accessories | 0.78165191412 | 0.890434384346 | 0.868677890301 |
Multi-Vector Query with Filters
Combine multi-vector search with filters to narrow results:
# Multi-vector search with category filter
text_vec = Vector(
vector=[0.1, 0.2, 0.1],
field_name="text_embedding",
dtype="float32",
weight=0.6
)
image_vec = Vector(
vector=[0.8, 0.1],
field_name="image_embedding",
dtype="float32",
weight=0.4
)
filtered_multi_query = MultiVectorQuery(
vectors=[text_vec, image_vec],
filter_expression=Tag("category") == "footwear",
return_fields=["product_id", "brief_description", "category", "price"],
num_results=5
)
results = index.query(filtered_multi_query)
result_print(results)
| distance_0 | distance_1 | product_id | brief_description | category | price | score_0 | score_1 | combined_score |
|---|---|---|---|---|---|---|---|---|
| 5.96046447754e-08 | 5.96046447754e-08 | prod_1 | comfortable running shoes for athletes | footwear | 89.99 | 0.999999970198 | 0.999999970198 | 0.999999970198 |
| 0.00985252857208 | 0.00266629457474 | prod_5 | basketball shoes with excellent ankle support | footwear | 139.99 | 0.995073735714 | 0.998666852713 | 0.996510982513 |
Comparing Query Types
Let's compare the three query types side by side:
# TextQuery - keyword-based search
text_q = TextQuery(
text="shoes",
text_field_name="brief_description",
return_fields=["product_id", "brief_description"],
num_results=3
)
print("TextQuery Results (keyword-based):")
result_print(index.query(text_q))
print()
TextQuery Results (keyword-based):
| score | product_id | brief_description |
|---|---|---|
| 2.8773943004779676 | prod_1 | comfortable running shoes for athletes |
| 2.085315593627535 | prod_5 | basketball shoes with excellent ankle support |
if HYBRID_SEARCH_AVAILABLE:
# HybridQuery - combines text and vector search
hybrid_q = HybridQuery(
text="shoes",
text_field_name="brief_description",
vector=[0.1, 0.2, 0.1],
vector_field_name="text_embedding",
return_fields=["product_id", "brief_description"],
num_results=3,
combination_method="LINEAR",
yield_text_score_as="text_score",
yield_vsim_score_as="vector_similarity",
yield_combined_score_as="hybrid_score",
)
results = index.query(hybrid_q)
else:
hybrid_q = AggregateHybridQuery(
text="shoes",
text_field_name="brief_description",
vector=[0.1, 0.2, 0.1],
vector_field_name="text_embedding",
return_fields=["product_id", "brief_description"],
num_results=3,
)
results = index.query(hybrid_q)
print(f"{hybrid_q.__class__.__name__} Results (text + vector):")
result_print(results)
print()
HybridQuery Results (text + vector):
| text_score | product_id | brief_description | vector_similarity | hybrid_score |
|---|---|---|---|---|
| 2.87739430048 | prod_1 | comfortable running shoes for athletes | 0.999999970198 | 1.56321826928 |
| 2.08531559363 | prod_5 | basketball shoes with excellent ankle support | 0.995073735714 | 1.32214629309 |
| 0 | prod_4 | yoga mat with extra cushioning for comfort | 0.998058259487 | 0.698640781641 |
# MultiVectorQuery - searches multiple vector fields
mv_text = Vector(
vector=[0.1, 0.2, 0.1],
field_name="text_embedding",
dtype="float32",
weight=0.5
)
mv_image = Vector(
vector=[0.8, 0.1],
field_name="image_embedding",
dtype="float32",
weight=0.5
)
multi_q = MultiVectorQuery(
vectors=[mv_text, mv_image],
return_fields=["product_id", "brief_description"],
num_results=3
)
print("MultiVectorQuery Results (multiple vectors):")
result_print(index.query(multi_q))
MultiVectorQuery Results (multiple vectors):
| distance_0 | distance_1 | product_id | brief_description | score_0 | score_1 | combined_score |
|---|---|---|---|---|---|---|
| 5.96046447754e-08 | 5.96046447754e-08 | prod_1 | comfortable running shoes for athletes | 0.999999970198 | 0.999999970198 | 0.999999970198 |
| 0.00985252857208 | 0.00266629457474 | prod_5 | basketball shoes with excellent ankle support | 0.995073735714 | 0.998666852713 | 0.996870294213 |
| 0.00985252857208 | 0.0118260979652 | prod_2 | lightweight running jacket with water resistance | 0.995073735714 | 0.994086951017 | 0.994580343366 |
Best Practices
When to Use Each Query Type:
-
TextQuery:- When you need precise keyword matching
- For traditional search engine functionality
- When text relevance scoring is important
- Example: Product search, document retrieval
-
HybridQuery:- When you want to combine keyword and semantic search
- For improved search quality over pure text or vector search
- When you have both text and vector representations of your data
- Example: E-commerce search, content recommendation
-
MultiVectorQuery:- When you have multiple types of embeddings (text, image, audio, etc.)
- For multi-modal search applications
- When you want to balance multiple semantic signals
- Example: Image-text search, cross-modal retrieval
Next Steps
Now that you understand advanced query types, explore these related guides:
- Query and Filter Data - Apply filters to narrow down search results
- Write SQL Queries for Redis - Use SQL-like syntax for Redis queries
- Improve Search Quality with Rerankers - Rerank results for better relevance
Cleanup
# Cleanup
index.delete()