Skip to content

Commit 8bdb4b3

Browse files
author
Sam Partee
authored
Introduce SearchIndex.query (#30)
Add convience method for ``SearchIndex.query`` that allows the ``redisvl.query.VectorQuery`` object to be passed directly.
1 parent 4c84ed4 commit 8bdb4b3

File tree

9 files changed

+576
-90
lines changed

9 files changed

+576
-90
lines changed

docs/api/searchindex.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,12 @@ SearchIndex
1616
SearchIndex.from_yaml
1717
SearchIndex.from_dict
1818
SearchIndex.from_existing
19+
SearchIndex.search
20+
SearchIndex.query
1921
SearchIndex.create
2022
SearchIndex.delete
2123
SearchIndex.load
24+
SearchIndex.client
2225
SearchIndex.connect
2326
SearchIndex.disconnect
2427
SearchIndex.info
@@ -27,6 +30,7 @@ SearchIndex
2730

2831
.. autoclass:: SearchIndex
2932
:show-inheritance:
33+
:inherited-members:
3034
:members:
3135

3236

@@ -43,6 +47,8 @@ AsyncSearchIndex
4347
AsyncSearchIndex.from_yaml
4448
AsyncSearchIndex.from_dict
4549
AsyncSearchIndex.from_existing
50+
AsyncSearchIndex.search
51+
AsyncSearchIndex.query
4652
AsyncSearchIndex.create
4753
AsyncSearchIndex.delete
4854
AsyncSearchIndex.load
@@ -54,6 +60,7 @@ AsyncSearchIndex
5460

5561
.. autoclass:: AsyncSearchIndex
5662
:show-inheritance:
63+
:inherited-members:
5764
:members:
5865

5966

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383

8484
# This allows us to use ::: to denote directives, useful for admonitions
8585
myst_enable_extensions = ["colon_fence"]
86-
myst_heading_anchors = 2
86+
myst_heading_anchors = 3
8787

8888
html_theme_options = {
8989
"logo": {

0 commit comments

Comments
 (0)