Skip to content

Refactor query classes #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Sep 6, 2024
Merged

Refactor query classes #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
cd37576
wip
tylerhutcherson Aug 23, 2024
6ad5d16
wip
tylerhutcherson Aug 23, 2024
b0b1895
update query classes and tests
tylerhutcherson Aug 30, 2024
d999853
fix test
tylerhutcherson Aug 30, 2024
02fca2d
add vectorrangequery and update sphinx docs
tylerhutcherson Aug 30, 2024
156a14b
formatting and linting
tylerhutcherson Aug 30, 2024
a2f918f
update query notebook examples
tylerhutcherson Sep 6, 2024
475d424
port the sortby support to session manager internals
tylerhutcherson Sep 6, 2024
42192ae
small formatting updates
tylerhutcherson Sep 6, 2024
4e87c68
update redis url for test
tylerhutcherson Sep 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions docs/api/query.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
Query
*****

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


VectorQuery
Expand All @@ -15,19 +17,22 @@ VectorQuery
.. autoclass:: VectorQuery
:members:
:inherited-members:
:show-inheritance:
:exclude-members: add_filter,get_args,highlight,return_field,summarize


RangeQuery
==========
VectorRangeQuery
================


.. currentmodule:: redisvl.query


.. autoclass:: RangeQuery
.. autoclass:: VectorRangeQuery
:members:
:inherited-members:

:show-inheritance:
:exclude-members: add_filter,get_args,highlight,return_field,summarize

FilterQuery
===========
Expand All @@ -39,6 +44,8 @@ FilterQuery
.. autoclass:: FilterQuery
:members:
:inherited-members:
:show-inheritance:
:exclude-members: add_filter,get_args,highlight,return_field,summarize



Expand All @@ -51,3 +58,5 @@ CountQuery
.. autoclass:: CountQuery
:members:
:inherited-members:
:show-inheritance:
:exclude-members: add_filter,get_args,highlight,return_field,summarize
Loading
Loading