Skip to content

Commit 5f1e046

Browse files
Refactor query classes (#211)
In order to support more advanced query params/settings of the Redis query engine, we needed a more flexible and customizable way to build RedisVL queries. This PR introduces a simple refactor to inherit all redis-py Query module capabilities for each query type. Source: https://github.com/redis/redis-py/blob/master/redis/commands/search/query.py
1 parent ffd153b commit 5f1e046

File tree

11 files changed

+452
-401
lines changed

11 files changed

+452
-401
lines changed

docs/api/query.rst

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
Query
44
*****
55

6-
.. _query_api:
6+
Query classes in RedisVL provide a structured way to define simple or complex
7+
queries for different use cases. Each query class wraps the ``redis-py`` Query module
8+
https://github.com/redis/redis-py/blob/master/redis/commands/search/query.py with extended functionality for ease-of-use.
79

810

911
VectorQuery
@@ -15,19 +17,22 @@ VectorQuery
1517
.. autoclass:: VectorQuery
1618
:members:
1719
:inherited-members:
20+
:show-inheritance:
21+
:exclude-members: add_filter,get_args,highlight,return_field,summarize
1822

1923

20-
RangeQuery
21-
==========
24+
VectorRangeQuery
25+
================
2226

2327

2428
.. currentmodule:: redisvl.query
2529

2630

27-
.. autoclass:: RangeQuery
31+
.. autoclass:: VectorRangeQuery
2832
:members:
2933
:inherited-members:
30-
34+
:show-inheritance:
35+
:exclude-members: add_filter,get_args,highlight,return_field,summarize
3136

3237
FilterQuery
3338
===========
@@ -39,6 +44,8 @@ FilterQuery
3944
.. autoclass:: FilterQuery
4045
:members:
4146
:inherited-members:
47+
:show-inheritance:
48+
:exclude-members: add_filter,get_args,highlight,return_field,summarize
4249

4350

4451

@@ -51,3 +58,5 @@ CountQuery
5158
.. autoclass:: CountQuery
5259
:members:
5360
:inherited-members:
61+
:show-inheritance:
62+
:exclude-members: add_filter,get_args,highlight,return_field,summarize

0 commit comments

Comments
 (0)