Skip to content

Update documentation and versions for release #308

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.

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 9 commits into from
Apr 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ jobs:
if [[ "${{ matrix.python-version }}" > "3.9" ]]; then
make test-notebooks
else
poetry run test-notebooks --ignore ./docs/user_guide/09_threshold_optimization.ipynb
poetry run test-notebooks --ignore ./docs/user_guide/09_threshold_optimization.ipynb --ignore ./docs/user_guide/release_guide/0_5_0_release.ipynb
fi

docs:
Expand Down
1 change: 1 addition & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,6 @@ reranker
cache
session_manager
router
threshold_optimizer
```

28 changes: 28 additions & 0 deletions docs/api/query.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,34 @@ VectorRangeQuery
:show-inheritance:
:exclude-members: add_filter,get_args,highlight,return_field,summarize

HybridQuery
================


.. currentmodule:: redisvl.query


.. autoclass:: HybridQuery
:members:
:inherited-members:
:show-inheritance:
:exclude-members: add_filter,get_args,highlight,return_field,summarize


TextQuery
================


.. currentmodule:: redisvl.query


.. autoclass:: TextQuery
:members:
:inherited-members:
:show-inheritance:
:exclude-members: add_filter,get_args,highlight,return_field,summarize


FilterQuery
===========

Expand Down
1 change: 0 additions & 1 deletion docs/api/session_manager.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
LLM Session Manager
*******************


SemanticSessionManager
======================

Expand Down
26 changes: 26 additions & 0 deletions docs/api/threshold_optimizer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
********************
Threshold Optimizers
********************

CacheThresholdOptimizer
=======================

.. _cachethresholdoptimizer_api:

.. currentmodule:: redisvl.utils.optimize.cache

.. autoclass:: CacheThresholdOptimizer
:show-inheritance:
:members:


RouterThresholdOptimizer
========================

.. _routerthresholdoptimizer_api:

.. currentmodule:: redisvl.utils.optimize.router

.. autoclass:: RouterThresholdOptimizer
:show-inheritance:
:members:
4 changes: 3 additions & 1 deletion docs/user_guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
myst:
html_meta:
"description lang=en": |
User Guides for RedisVL
User guides for RedisVL
---

# User Guides
Expand All @@ -20,4 +20,6 @@ User guides provide helpful resources for using RedisVL and its different compon
06_rerankers
07_session_manager
08_semantic_router
09_threshold_optimization
release_guide/index
```
Loading