Combined queries
Combine query expressions
A combined query is a combination of several query types, such as:
You can use logical query operators to combine query expressions for numeric, tag, and text fields. For vector fields, you can combine a KNN query with a pre-filter.
Note:
The operators are interpreted slightly differently depending on the query dialect used. The default dialect is
DIALECT 1
; see
this article for information on how to change the dialect version. This article uses the second version of the query dialect,
DIALECT 2
, and uses additional brackets (
(...)
) to help clarify the examples. Further details can be found in the
query syntax documentation .
The examples in this article use the following schema:
Field name
Field type
description
TEXT
condition
TAG
price
NUMERIC
vector
VECTOR
AND
The binary operator
(space) is used to intersect the results of two or more expressions.
FT.SEARCH index "(expr1) (expr2)"
If you want to perform an intersection based on multiple values within a specific text field, then you should use the following simplified notion:
FT.SEARCH index "@text_field:( value1 value2 ... )"
The following example shows you a query that finds bicycles in new condition and in a price range from 500 USD to 1000 USD:
>_ Redis CLI
FT.SEARCH idx:bicycle "@price:[500 1000] @condition:{new}"
Copied!
Python
import json
import numpy as np
import redis
import warnings
from redis.commands.json.path import Path
from redis.commands.search.field import NumericField , TagField , TextField , VectorField
from redis.commands.search.indexDefinition import IndexDefinition , IndexType
from redis.commands.search.query import Query
from sentence_transformers import SentenceTransformer
def embed_text ( model , text ):
return np . array ( model . encode ( text )) . astype ( np . float32 ) . tobytes ()
warnings . filterwarnings ( "ignore" , category = FutureWarning , message = r ".*clean_up_tokenization_spaces.*" )
model = SentenceTransformer ( 'sentence-transformers/all-MiniLM-L6-v2' )
query = "Bike for small kids"
query_vector = embed_text ( model , query )
r = redis . Redis ( decode_responses = True )
# create index
schema = (
TextField ( "$.description" , no_stem = True , as_name = "model" ),
TagField ( "$.condition" , as_name = "condition" ),
NumericField ( "$.price" , as_name = "price" ),
VectorField (
"$.description_embeddings" ,
"FLAT" ,
{
"TYPE" : "FLOAT32" ,
"DIM" : 384 ,
"DISTANCE_METRIC" : "COSINE" ,
},
as_name = "vector" ,
),
)
index = r . ft ( "idx:bicycle" )
index . create_index (
schema ,
definition = IndexDefinition ( prefix = [ "bicycle:" ], index_type = IndexType . JSON ),
)
# load data
with open ( "data/query_vector.json" ) as f :
bicycles = json . load ( f )
pipeline = r . pipeline ( transaction = False )
for bid , bicycle in enumerate ( bicycles ):
pipeline . json () . set ( f 'bicycle: { bid } ' , Path . root_path (), bicycle )
pipeline . execute ()
q = Query ( "@price:[500 1000] @condition: {new} " )
res = index . search ( q )
print ( res . total ) # >>> 1
q = Query ( "kids @price:[500 1000] @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 1
q = Query ( "(kids | small) @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 2
q = Query ( "@description:(kids | small) @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 0
q = Query ( "@description:(kids | small) @condition:{new | used}" )
res = index . search ( q )
print ( res . total ) # >>> 0
q = Query ( "@price:[500 1000] -@condition: {new} " )
res = index . search ( q )
print ( res . total ) # >>> 2
q = Query ( "(@price:[500 1000] -@condition: {new} )=>[KNN 3 @vector $query_vector]" ) . dialect ( 2 )
# put query string here
res = index . search ( q ,{ 'query_vector' : query_vector })
print ( res . total ) # >>> 2
Copied!
You might also be interested in bicycles for kids. The query below shows you how to combine a full-text search with the criteria from the previous query:
>_ Redis CLI
FT.SEARCH idx:bicycle "kids (@price:[500 1000] @condition:{used})"
Copied!
Python
import json
import numpy as np
import redis
import warnings
from redis.commands.json.path import Path
from redis.commands.search.field import NumericField , TagField , TextField , VectorField
from redis.commands.search.indexDefinition import IndexDefinition , IndexType
from redis.commands.search.query import Query
from sentence_transformers import SentenceTransformer
def embed_text ( model , text ):
return np . array ( model . encode ( text )) . astype ( np . float32 ) . tobytes ()
warnings . filterwarnings ( "ignore" , category = FutureWarning , message = r ".*clean_up_tokenization_spaces.*" )
model = SentenceTransformer ( 'sentence-transformers/all-MiniLM-L6-v2' )
query = "Bike for small kids"
query_vector = embed_text ( model , query )
r = redis . Redis ( decode_responses = True )
# create index
schema = (
TextField ( "$.description" , no_stem = True , as_name = "model" ),
TagField ( "$.condition" , as_name = "condition" ),
NumericField ( "$.price" , as_name = "price" ),
VectorField (
"$.description_embeddings" ,
"FLAT" ,
{
"TYPE" : "FLOAT32" ,
"DIM" : 384 ,
"DISTANCE_METRIC" : "COSINE" ,
},
as_name = "vector" ,
),
)
index = r . ft ( "idx:bicycle" )
index . create_index (
schema ,
definition = IndexDefinition ( prefix = [ "bicycle:" ], index_type = IndexType . JSON ),
)
# load data
with open ( "data/query_vector.json" ) as f :
bicycles = json . load ( f )
pipeline = r . pipeline ( transaction = False )
for bid , bicycle in enumerate ( bicycles ):
pipeline . json () . set ( f 'bicycle: { bid } ' , Path . root_path (), bicycle )
pipeline . execute ()
q = Query ( "@price:[500 1000] @condition: {new} " )
res = index . search ( q )
print ( res . total ) # >>> 1
q = Query ( "kids @price:[500 1000] @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 1
q = Query ( "(kids | small) @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 2
q = Query ( "@description:(kids | small) @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 0
q = Query ( "@description:(kids | small) @condition:{new | used}" )
res = index . search ( q )
print ( res . total ) # >>> 0
q = Query ( "@price:[500 1000] -@condition: {new} " )
res = index . search ( q )
print ( res . total ) # >>> 2
q = Query ( "(@price:[500 1000] -@condition: {new} )=>[KNN 3 @vector $query_vector]" ) . dialect ( 2 )
# put query string here
res = index . search ( q ,{ 'query_vector' : query_vector })
print ( res . total ) # >>> 2
Copied!
OR
You can use the binary operator |
(vertical bar) to perform a union.
FT.SEARCH index "(expr1) | (expr2)"
Note:
The logical
AND
takes precedence over
OR
when using dialect version two. The expression
expr1 expr2 | expr3 expr4
means
(expr1 expr2) | (expr3 expr4)
. Version one of the query dialect behaves differently. Using parentheses in query strings is advised to ensure the order is clear.
If you want to perform the union based on multiple values within a single tag or text field, then you should use the following simplified notion:
FT.SEARCH index "@text_field:( value1 | value2 | ... )"
FT.SEARCH index "@tag_field:{ value1 | value2 | ... }"
The following query shows you how to find used bicycles that contain either the word 'kids' or 'small':
>_ Redis CLI
FT.SEARCH idx:bicycle "(kids | small) @condition:{used}"
Copied!
Python
import json
import numpy as np
import redis
import warnings
from redis.commands.json.path import Path
from redis.commands.search.field import NumericField , TagField , TextField , VectorField
from redis.commands.search.indexDefinition import IndexDefinition , IndexType
from redis.commands.search.query import Query
from sentence_transformers import SentenceTransformer
def embed_text ( model , text ):
return np . array ( model . encode ( text )) . astype ( np . float32 ) . tobytes ()
warnings . filterwarnings ( "ignore" , category = FutureWarning , message = r ".*clean_up_tokenization_spaces.*" )
model = SentenceTransformer ( 'sentence-transformers/all-MiniLM-L6-v2' )
query = "Bike for small kids"
query_vector = embed_text ( model , query )
r = redis . Redis ( decode_responses = True )
# create index
schema = (
TextField ( "$.description" , no_stem = True , as_name = "model" ),
TagField ( "$.condition" , as_name = "condition" ),
NumericField ( "$.price" , as_name = "price" ),
VectorField (
"$.description_embeddings" ,
"FLAT" ,
{
"TYPE" : "FLOAT32" ,
"DIM" : 384 ,
"DISTANCE_METRIC" : "COSINE" ,
},
as_name = "vector" ,
),
)
index = r . ft ( "idx:bicycle" )
index . create_index (
schema ,
definition = IndexDefinition ( prefix = [ "bicycle:" ], index_type = IndexType . JSON ),
)
# load data
with open ( "data/query_vector.json" ) as f :
bicycles = json . load ( f )
pipeline = r . pipeline ( transaction = False )
for bid , bicycle in enumerate ( bicycles ):
pipeline . json () . set ( f 'bicycle: { bid } ' , Path . root_path (), bicycle )
pipeline . execute ()
q = Query ( "@price:[500 1000] @condition: {new} " )
res = index . search ( q )
print ( res . total ) # >>> 1
q = Query ( "kids @price:[500 1000] @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 1
q = Query ( "(kids | small) @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 2
q = Query ( "@description:(kids | small) @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 0
q = Query ( "@description:(kids | small) @condition:{new | used}" )
res = index . search ( q )
print ( res . total ) # >>> 0
q = Query ( "@price:[500 1000] -@condition: {new} " )
res = index . search ( q )
print ( res . total ) # >>> 2
q = Query ( "(@price:[500 1000] -@condition: {new} )=>[KNN 3 @vector $query_vector]" ) . dialect ( 2 )
# put query string here
res = index . search ( q ,{ 'query_vector' : query_vector })
print ( res . total ) # >>> 2
Copied!
The previous query searches across all text fields. The following example shows you how to limit the search to the description field:
>_ Redis CLI
FT.SEARCH idx:bicycle "@description:(kids | small) @condition:{used}"
Copied!
Python
import json
import numpy as np
import redis
import warnings
from redis.commands.json.path import Path
from redis.commands.search.field import NumericField , TagField , TextField , VectorField
from redis.commands.search.indexDefinition import IndexDefinition , IndexType
from redis.commands.search.query import Query
from sentence_transformers import SentenceTransformer
def embed_text ( model , text ):
return np . array ( model . encode ( text )) . astype ( np . float32 ) . tobytes ()
warnings . filterwarnings ( "ignore" , category = FutureWarning , message = r ".*clean_up_tokenization_spaces.*" )
model = SentenceTransformer ( 'sentence-transformers/all-MiniLM-L6-v2' )
query = "Bike for small kids"
query_vector = embed_text ( model , query )
r = redis . Redis ( decode_responses = True )
# create index
schema = (
TextField ( "$.description" , no_stem = True , as_name = "model" ),
TagField ( "$.condition" , as_name = "condition" ),
NumericField ( "$.price" , as_name = "price" ),
VectorField (
"$.description_embeddings" ,
"FLAT" ,
{
"TYPE" : "FLOAT32" ,
"DIM" : 384 ,
"DISTANCE_METRIC" : "COSINE" ,
},
as_name = "vector" ,
),
)
index = r . ft ( "idx:bicycle" )
index . create_index (
schema ,
definition = IndexDefinition ( prefix = [ "bicycle:" ], index_type = IndexType . JSON ),
)
# load data
with open ( "data/query_vector.json" ) as f :
bicycles = json . load ( f )
pipeline = r . pipeline ( transaction = False )
for bid , bicycle in enumerate ( bicycles ):
pipeline . json () . set ( f 'bicycle: { bid } ' , Path . root_path (), bicycle )
pipeline . execute ()
q = Query ( "@price:[500 1000] @condition: {new} " )
res = index . search ( q )
print ( res . total ) # >>> 1
q = Query ( "kids @price:[500 1000] @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 1
q = Query ( "(kids | small) @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 2
q = Query ( "@description:(kids | small) @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 0
q = Query ( "@description:(kids | small) @condition:{new | used}" )
res = index . search ( q )
print ( res . total ) # >>> 0
q = Query ( "@price:[500 1000] -@condition: {new} " )
res = index . search ( q )
print ( res . total ) # >>> 2
q = Query ( "(@price:[500 1000] -@condition: {new} )=>[KNN 3 @vector $query_vector]" ) . dialect ( 2 )
# put query string here
res = index . search ( q ,{ 'query_vector' : query_vector })
print ( res . total ) # >>> 2
Copied!
If you want to extend the search to new bicycles, then the below example shows you how to do that:
>_ Redis CLI
FT.SEARCH idx:bicycle "@description:(kids | small) @condition:{new | used}"
Copied!
Python
import json
import numpy as np
import redis
import warnings
from redis.commands.json.path import Path
from redis.commands.search.field import NumericField , TagField , TextField , VectorField
from redis.commands.search.indexDefinition import IndexDefinition , IndexType
from redis.commands.search.query import Query
from sentence_transformers import SentenceTransformer
def embed_text ( model , text ):
return np . array ( model . encode ( text )) . astype ( np . float32 ) . tobytes ()
warnings . filterwarnings ( "ignore" , category = FutureWarning , message = r ".*clean_up_tokenization_spaces.*" )
model = SentenceTransformer ( 'sentence-transformers/all-MiniLM-L6-v2' )
query = "Bike for small kids"
query_vector = embed_text ( model , query )
r = redis . Redis ( decode_responses = True )
# create index
schema = (
TextField ( "$.description" , no_stem = True , as_name = "model" ),
TagField ( "$.condition" , as_name = "condition" ),
NumericField ( "$.price" , as_name = "price" ),
VectorField (
"$.description_embeddings" ,
"FLAT" ,
{
"TYPE" : "FLOAT32" ,
"DIM" : 384 ,
"DISTANCE_METRIC" : "COSINE" ,
},
as_name = "vector" ,
),
)
index = r . ft ( "idx:bicycle" )
index . create_index (
schema ,
definition = IndexDefinition ( prefix = [ "bicycle:" ], index_type = IndexType . JSON ),
)
# load data
with open ( "data/query_vector.json" ) as f :
bicycles = json . load ( f )
pipeline = r . pipeline ( transaction = False )
for bid , bicycle in enumerate ( bicycles ):
pipeline . json () . set ( f 'bicycle: { bid } ' , Path . root_path (), bicycle )
pipeline . execute ()
q = Query ( "@price:[500 1000] @condition: {new} " )
res = index . search ( q )
print ( res . total ) # >>> 1
q = Query ( "kids @price:[500 1000] @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 1
q = Query ( "(kids | small) @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 2
q = Query ( "@description:(kids | small) @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 0
q = Query ( "@description:(kids | small) @condition:{new | used}" )
res = index . search ( q )
print ( res . total ) # >>> 0
q = Query ( "@price:[500 1000] -@condition: {new} " )
res = index . search ( q )
print ( res . total ) # >>> 2
q = Query ( "(@price:[500 1000] -@condition: {new} )=>[KNN 3 @vector $query_vector]" ) . dialect ( 2 )
# put query string here
res = index . search ( q ,{ 'query_vector' : query_vector })
print ( res . total ) # >>> 2
Copied!
NOT
A minus (-
) in front of a query expression negates the expression.
FT.SEARCH index "-(expr)"
If you want to exclude new bicycles from the search within the previous price range, you can use this query:
>_ Redis CLI
FT.SEARCH idx:bicycle "@price:[500 1000] -@condition:{new}"
Copied!
Python
import json
import numpy as np
import redis
import warnings
from redis.commands.json.path import Path
from redis.commands.search.field import NumericField , TagField , TextField , VectorField
from redis.commands.search.indexDefinition import IndexDefinition , IndexType
from redis.commands.search.query import Query
from sentence_transformers import SentenceTransformer
def embed_text ( model , text ):
return np . array ( model . encode ( text )) . astype ( np . float32 ) . tobytes ()
warnings . filterwarnings ( "ignore" , category = FutureWarning , message = r ".*clean_up_tokenization_spaces.*" )
model = SentenceTransformer ( 'sentence-transformers/all-MiniLM-L6-v2' )
query = "Bike for small kids"
query_vector = embed_text ( model , query )
r = redis . Redis ( decode_responses = True )
# create index
schema = (
TextField ( "$.description" , no_stem = True , as_name = "model" ),
TagField ( "$.condition" , as_name = "condition" ),
NumericField ( "$.price" , as_name = "price" ),
VectorField (
"$.description_embeddings" ,
"FLAT" ,
{
"TYPE" : "FLOAT32" ,
"DIM" : 384 ,
"DISTANCE_METRIC" : "COSINE" ,
},
as_name = "vector" ,
),
)
index = r . ft ( "idx:bicycle" )
index . create_index (
schema ,
definition = IndexDefinition ( prefix = [ "bicycle:" ], index_type = IndexType . JSON ),
)
# load data
with open ( "data/query_vector.json" ) as f :
bicycles = json . load ( f )
pipeline = r . pipeline ( transaction = False )
for bid , bicycle in enumerate ( bicycles ):
pipeline . json () . set ( f 'bicycle: { bid } ' , Path . root_path (), bicycle )
pipeline . execute ()
q = Query ( "@price:[500 1000] @condition: {new} " )
res = index . search ( q )
print ( res . total ) # >>> 1
q = Query ( "kids @price:[500 1000] @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 1
q = Query ( "(kids | small) @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 2
q = Query ( "@description:(kids | small) @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 0
q = Query ( "@description:(kids | small) @condition:{new | used}" )
res = index . search ( q )
print ( res . total ) # >>> 0
q = Query ( "@price:[500 1000] -@condition: {new} " )
res = index . search ( q )
print ( res . total ) # >>> 2
q = Query ( "(@price:[500 1000] -@condition: {new} )=>[KNN 3 @vector $query_vector]" ) . dialect ( 2 )
# put query string here
res = index . search ( q ,{ 'query_vector' : query_vector })
print ( res . total ) # >>> 2
Copied!
Numeric filter
The FT.SEARCH command allows you to combine any query expression with a numeric filter.
FT.SEARCH index "expr" FILTER numeric_field start end
Please see the range query article to learn more about numeric range queries and such filters.
Pre-filter for a KNN vector query
You can use a simple or more complex query expression with logical operators as a pre-filter in a KNN vector query.
FT.SEARCH index "(filter_expr)=>[KNN num_neighbours @field $vector]" PARAMS 2 vector "binary_data" DIALECT 2
Here is an example:
>_ Redis CLI
FT.SEARCH idx:bikes_vss "(@price:[500 1000] @condition:{new})=>[KNN 3 @vector $query_vector]" PARAMS 2 "query_vector" "Z\xf8\x15:\xf23\xa1\xbfZ\x1dI>\r\xca9..." DIALECT 2
Copied!
Python
import json
import numpy as np
import redis
import warnings
from redis.commands.json.path import Path
from redis.commands.search.field import NumericField , TagField , TextField , VectorField
from redis.commands.search.indexDefinition import IndexDefinition , IndexType
from redis.commands.search.query import Query
from sentence_transformers import SentenceTransformer
def embed_text ( model , text ):
return np . array ( model . encode ( text )) . astype ( np . float32 ) . tobytes ()
warnings . filterwarnings ( "ignore" , category = FutureWarning , message = r ".*clean_up_tokenization_spaces.*" )
model = SentenceTransformer ( 'sentence-transformers/all-MiniLM-L6-v2' )
query = "Bike for small kids"
query_vector = embed_text ( model , query )
r = redis . Redis ( decode_responses = True )
# create index
schema = (
TextField ( "$.description" , no_stem = True , as_name = "model" ),
TagField ( "$.condition" , as_name = "condition" ),
NumericField ( "$.price" , as_name = "price" ),
VectorField (
"$.description_embeddings" ,
"FLAT" ,
{
"TYPE" : "FLOAT32" ,
"DIM" : 384 ,
"DISTANCE_METRIC" : "COSINE" ,
},
as_name = "vector" ,
),
)
index = r . ft ( "idx:bicycle" )
index . create_index (
schema ,
definition = IndexDefinition ( prefix = [ "bicycle:" ], index_type = IndexType . JSON ),
)
# load data
with open ( "data/query_vector.json" ) as f :
bicycles = json . load ( f )
pipeline = r . pipeline ( transaction = False )
for bid , bicycle in enumerate ( bicycles ):
pipeline . json () . set ( f 'bicycle: { bid } ' , Path . root_path (), bicycle )
pipeline . execute ()
q = Query ( "@price:[500 1000] @condition: {new} " )
res = index . search ( q )
print ( res . total ) # >>> 1
q = Query ( "kids @price:[500 1000] @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 1
q = Query ( "(kids | small) @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 2
q = Query ( "@description:(kids | small) @condition: {used} " )
res = index . search ( q )
print ( res . total ) # >>> 0
q = Query ( "@description:(kids | small) @condition:{new | used}" )
res = index . search ( q )
print ( res . total ) # >>> 0
q = Query ( "@price:[500 1000] -@condition: {new} " )
res = index . search ( q )
print ( res . total ) # >>> 2
q = Query ( "(@price:[500 1000] -@condition: {new} )=>[KNN 3 @vector $query_vector]" ) . dialect ( 2 )
# put query string here
res = index . search ( q ,{ 'query_vector' : query_vector })
print ( res . total ) # >>> 2
Copied!
The vector search article provides further details about vector queries in general.