Filter

FilterExpression

`class FilterExpression(_filter=None, operator=None, left=None, right=None)`

A FilterExpression is a logical combination of filters in RedisVL.

FilterExpressions can be combined using the & and | operators to create complex expressions that evaluate to the Redis Query language.

This presents an interface by which users can create complex queries without having to know the Redis Query language.

from redisvl.query.filter import Tag, Num

brand_is_nike = Tag("brand") == "nike"
price_is_over_100 = Num("price") < 100
f = brand_is_nike & price_is_over_100

print(str(f))

>> (@brand:{nike} @price:[-inf (100)])

This can be combined with the VectorQuery class to create a query:

from redisvl.query import VectorQuery

v = VectorQuery(
    vector=[0.1, 0.1, 0.5, ...],
    vector_field_name="product_embedding",
    return_fields=["product_id", "brand", "price"],
    filter_expression=f,
)

Note:

Filter expressions are typically not called directly. Instead they are built by combining filter statements using the & and | operators.

Parameters:
- _filter (str | None)
- operator (FilterOperator | None)
- left (FilterExpression | None)
- right (FilterExpression | None)

Tag

`class Tag(field)`

A Tag filter can be applied to Tag fields

Parameters: field (str)

`eq(other)`

Create a Tag equality filter expression.

Parameters: other (Union [ List [ str ] , str ]) – The tag(s) to filter on.
Return type: FilterExpression

from redisvl.query.filter import Tag

f = Tag("brand") == "nike"

`mod(other)`

Create a Tag wildcard filter expression for pattern matching.

This enables wildcard pattern matching on tag fields using the * character. Unlike the equality operator, wildcards are not escaped, allowing patterns with wildcards in any position, such as prefix ("tech*"), suffix ("*tech"), or middle ("*tech*") matches.

Parameters: other (Union [ List [ str ] , str ]) – The tag pattern(s) to filter on. Use * for wildcard matching (e.g., "tech*", "*tech", or "*tech*").
Return type: FilterExpression

from redisvl.query.filter import Tag

f = Tag("category") % "tech*"               # Prefix match
f = Tag("category") % "*tech"               # Suffix match
f = Tag("category") % "*tech*"              # Contains match
f = Tag("category") % "elec*|*soft"         # Multiple wildcard patterns
f = Tag("category") % ["tech*", "*science"] # List of patterns

`ne(other)`

Create a Tag inequality filter expression.

Parameters: other (Union [ List [ str ] , str ]) – The tag(s) to filter on.
Return type: FilterExpression

from redisvl.query.filter import Tag
f = Tag("brand") != "nike"

`str()`

Return the Redis Query string for the Tag filter

Return type: str

Text

`class Text(field)`

A Text is a FilterField representing a text field in a Redis index.

Parameters: field (str)

`eq(other)`

Create a Text equality filter expression. These expressions yield filters that enforce an exact match on the supplied term(s).

Parameters: other (str) – The text value to filter on.
Return type: FilterExpression

from redisvl.query.filter import Text

f = Text("job") == "engineer"

`mod(other)`

Create a Text "LIKE" filter expression. A flexible expression that yields filters that can use a variety of additional operators like wildcards (*), fuzzy matches (%%), or combinatorics (|) of the supplied term(s).

Parameters: other (str) – The text value to filter on.
Return type: FilterExpression

from redisvl.query.filter import Text

f = Text("job") % "engine*"         # suffix wild card match
f = Text("job") % "%%engine%%"      # fuzzy match w/ Levenshtein Distance
f = Text("job") % "engineer|doctor" # contains either term in field
f = Text("job") % "engineer doctor" # contains both terms in field

`ne(other)`

Create a Text inequality filter expression. These expressions yield negated filters on exact matches on the supplied term(s). Opposite of an equality filter expression.

Parameters: other (str) – The text value to filter on.
Return type: FilterExpression

from redisvl.query.filter import Text

f = Text("job") != "engineer"

`str()`

Return the Redis Query string for the Text filter

Return type: str

Num

`class Num(field)`

A Num is a FilterField representing a numeric field in a Redis index.

Parameters: field (str)

`eq(other)`

Create a Numeric equality filter expression.

Parameters: other (Union [ int , float ]) – The value to filter on.
Return type: FilterExpression

from redisvl.query.filter import Num
f = Num("zipcode") == 90210

`ge(other)`

Create a Numeric greater than or equal to filter expression.

Parameters: other (Union [ int , float ]) – The value to filter on.
Return type: FilterExpression

from redisvl.query.filter import Num

f = Num("age") >= 18

`gt(other)`

Create a Numeric greater than filter expression.

Parameters: other (Union [ int , float ]) – The value to filter on.
Return type: FilterExpression

from redisvl.query.filter import Num

f = Num("age") > 18

`le(other)`

Create a Numeric less than or equal to filter expression.

Parameters: other (Union [ int , float ]) – The value to filter on.
Return type: FilterExpression

from redisvl.query.filter import Num

f = Num("age") <= 18

`lt(other)`

Create a Numeric less than filter expression.

Parameters: other (Union [ int , float ]) – The value to filter on.
Return type: FilterExpression

from redisvl.query.filter import Num

f = Num("age") < 18

`ne(other)`

Create a Numeric inequality filter expression.

Parameters: other (Union [ int , float ]) – The value to filter on.
Return type: FilterExpression

from redisvl.query.filter import Num

f = Num("zipcode") != 90210

`str()`

Return the Redis Query string for the Numeric filter

Return type: str

`between(start, end, inclusive='both')`

Operator for searching values between two numeric values.

Parameters:
- start (int)
- end (int)
- inclusive (str)
Return type: FilterExpression

Geo

`class Geo(field)`

A Geo is a FilterField representing a geographic (lat/lon) field in a Redis index.

Parameters: field (str)

`eq(other)`

Create a geographic filter within a specified GeoRadius.

Parameters: other (GeoRadius) – The geographic spec to filter on.
Return type: FilterExpression

from redisvl.query.filter import Geo, GeoRadius

f = Geo("location") == GeoRadius(-122.4194, 37.7749, 1, unit="m")

`ne(other)`

Create a geographic filter outside of a specified GeoRadius.

Parameters: other (GeoRadius) – The geographic spec to filter on.
Return type: FilterExpression

from redisvl.query.filter import Geo, GeoRadius

f = Geo("location") != GeoRadius(-122.4194, 37.7749, 1, unit="m")

`str()`

Return the Redis Query string for the Geo filter

Return type: str

GeoRadius

`class GeoRadius(longitude, latitude, radius=1, unit='km')`

A GeoRadius is a GeoSpec representing a geographic radius.

Create a GeoRadius specification (GeoSpec)

Parameters:
- longitude (float) – The longitude of the center of the radius.
- latitude (float) – The latitude of the center of the radius.
- radius (int , optional) – The radius of the circle. Defaults to 1.
- unit (str , optional) – The unit of the radius. Defaults to "km".
Raises: ValueError – If the unit is not one of "m", "km", "mi", or "ft".

`init(longitude, latitude, radius=1, unit='km')`

Create a GeoRadius specification (GeoSpec)

Parameters:
- longitude (float) – The longitude of the center of the radius.
- latitude (float) – The latitude of the center of the radius.
- radius (int , optional) – The radius of the circle. Defaults to 1.
- unit (str , optional) – The unit of the radius. Defaults to "km".
Raises: ValueError – If the unit is not one of "m", "km", "mi", or "ft".

Timestamp

`class Timestamp(field)`

A timestamp filter for querying date/time fields in Redis.

This filter can handle various date and time formats, including:

datetime objects (with or without timezone)
date objects
ISO-8601 formatted strings
Unix timestamps (as integers or floats)

All timestamps are converted to Unix timestamps in UTC for consistency. Bare date values and date-only ISO strings are anchored to the UTC calendar day, not the host’s local day, and naive datetimes are read as UTC.

Parameters: field (str)

`eq(other)`

Filter for timestamps equal to the specified value. For date objects (without time), this matches the entire UTC calendar day, from 00:00:00 to 23:59:59.999999 UTC.

Parameters: other (datetime | date | str | int | float) – A datetime, date, ISO string, or Unix timestamp
Returns: The filter object for method chaining
Return type: self

`ge(other)`

Filter for timestamps greater than or equal to the specified value.

For a bare date (or date-only ISO string), this means from the start of that UTC day, so the day itself is included.

Parameters: other – A datetime, date, ISO string, or Unix timestamp
Returns: The filter object for method chaining
Return type: self

`gt(other)`

Filter for timestamps greater than the specified value.

For a bare date (or date-only ISO string), this means after the end of that UTC day, so the day itself is excluded.

Parameters: other – A datetime, date, ISO string, or Unix timestamp
Returns: The filter object for method chaining
Return type: self

`le(other)`

Filter for timestamps less than or equal to the specified value.

For a bare date (or date-only ISO string), this means through the end of that UTC day, so the day itself is included.

Parameters: other – A datetime, date, ISO string, or Unix timestamp
Returns: The filter object for method chaining
Return type: self

`lt(other)`

Filter for timestamps less than the specified value.

For a bare date (or date-only ISO string), this means before the start of that UTC day, so the day itself is excluded.

Parameters: other – A datetime, date, ISO string, or Unix timestamp
Returns: The filter object for method chaining
Return type: self

`ne(other)`

Filter for timestamps not equal to the specified value. For date objects (without time), this excludes the entire UTC calendar day, from 00:00:00 to 23:59:59.999999 UTC.

Parameters: other (datetime | date | str | int | float) – A datetime, date, ISO string, or Unix timestamp
Returns: The filter object for method chaining
Return type: self

`between(start, end, inclusive='both')`

Filter for timestamps between start and end (inclusive).

Bare dates (and date-only ISO strings) span whole UTC calendar days: start anchors to 00:00:00 of its day and end to 23:59:59.999999 of its day, so both endpoint days are covered in full.

Parameters:
- start – A datetime, date, ISO string, or Unix timestamp
- end – A datetime, date, ISO string, or Unix timestamp
- inclusive (str) – Which endpoints to include – "both" (default), "left", "right", or "neither".
Returns: The filter object for method chaining
Return type: self

Filter

FilterExpression

class FilterExpression(_filter=None, operator=None, left=None, right=None)

Tag

class Tag(field)

__eq__(other)

__mod__(other)

__ne__(other)

__str__()

Text

class Text(field)

__eq__(other)

__mod__(other)

__ne__(other)

__str__()

Num

class Num(field)

__eq__(other)

__ge__(other)

__gt__(other)

__le__(other)

__lt__(other)

__ne__(other)

__str__()

between(start, end, inclusive='both')

Geo

class Geo(field)

__eq__(other)

__ne__(other)

__str__()

GeoRadius

class GeoRadius(longitude, latitude, radius=1, unit='km')

__init__(longitude, latitude, radius=1, unit='km')

Timestamp

class Timestamp(field)

__eq__(other)

__ge__(other)

__gt__(other)

__le__(other)

__lt__(other)

__ne__(other)

between(start, end, inclusive='both')

On this page

`class FilterExpression(_filter=None, operator=None, left=None, right=None)`

`class Tag(field)`

`eq(other)`

`mod(other)`

`ne(other)`

`str()`

`class Text(field)`

`eq(other)`

`mod(other)`

`ne(other)`

`str()`

`class Num(field)`

`eq(other)`

`ge(other)`

`gt(other)`

`le(other)`

`lt(other)`

`ne(other)`

`str()`

`between(start, end, inclusive='both')`

`class Geo(field)`

`eq(other)`

`ne(other)`

`str()`

`class GeoRadius(longitude, latitude, radius=1, unit='km')`

`init(longitude, latitude, radius=1, unit='km')`

`class Timestamp(field)`

`eq(other)`

`ge(other)`

`gt(other)`

`le(other)`

`lt(other)`

`ne(other)`

`between(start, end, inclusive='both')`