Skip to content

Commit 32a5444

Browse files
rbs333tylerhutcherson
authored andcommittedApr 4, 2025·
Update documentation and version for release (#308)
Co-authored-by: Tyler Hutcherson <[email protected]>
1 parent 52cfe75 commit 32a5444

File tree

16 files changed

+955
-54
lines changed

16 files changed

+955
-54
lines changed
 

Diff for: ‎.github/workflows/test.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ jobs:
170170
if [[ "${{ matrix.python-version }}" > "3.9" ]]; then
171171
make test-notebooks
172172
else
173-
poetry run test-notebooks --ignore ./docs/user_guide/09_threshold_optimization.ipynb
173+
poetry run test-notebooks --ignore ./docs/user_guide/09_threshold_optimization.ipynb --ignore ./docs/user_guide/release_guide/0_5_0_release.ipynb
174174
fi
175175
176176
docs:

Diff for: ‎docs/api/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ reranker
2222
cache
2323
session_manager
2424
router
25+
threshold_optimizer
2526
```
2627

Diff for: ‎docs/api/query.rst

+28
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,34 @@ VectorRangeQuery
3434
:show-inheritance:
3535
:exclude-members: add_filter,get_args,highlight,return_field,summarize
3636

37+
HybridQuery
38+
================
39+
40+
41+
.. currentmodule:: redisvl.query
42+
43+
44+
.. autoclass:: HybridQuery
45+
:members:
46+
:inherited-members:
47+
:show-inheritance:
48+
:exclude-members: add_filter,get_args,highlight,return_field,summarize
49+
50+
51+
TextQuery
52+
================
53+
54+
55+
.. currentmodule:: redisvl.query
56+
57+
58+
.. autoclass:: TextQuery
59+
:members:
60+
:inherited-members:
61+
:show-inheritance:
62+
:exclude-members: add_filter,get_args,highlight,return_field,summarize
63+
64+
3765
FilterQuery
3866
===========
3967

Diff for: ‎docs/api/session_manager.rst

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
LLM Session Manager
33
*******************
44

5-
65
SemanticSessionManager
76
======================
87

Diff for: ‎docs/api/threshold_optimizer.rst

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
********************
2+
Threshold Optimizers
3+
********************
4+
5+
CacheThresholdOptimizer
6+
=======================
7+
8+
.. _cachethresholdoptimizer_api:
9+
10+
.. currentmodule:: redisvl.utils.optimize.cache
11+
12+
.. autoclass:: CacheThresholdOptimizer
13+
:show-inheritance:
14+
:members:
15+
16+
17+
RouterThresholdOptimizer
18+
========================
19+
20+
.. _routerthresholdoptimizer_api:
21+
22+
.. currentmodule:: redisvl.utils.optimize.router
23+
24+
.. autoclass:: RouterThresholdOptimizer
25+
:show-inheritance:
26+
:members:

Diff for: ‎docs/user_guide/index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
myst:
33
html_meta:
44
"description lang=en": |
5-
User Guides for RedisVL
5+
User guides for RedisVL
66
---
77

88
# User Guides
@@ -20,4 +20,6 @@ User guides provide helpful resources for using RedisVL and its different compon
2020
06_rerankers
2121
07_session_manager
2222
08_semantic_router
23+
09_threshold_optimization
24+
release_guide/index
2325
```

0 commit comments

Comments
 (0)