Skip to content

Commit 5aeca67

Browse files
committed
Update documentation note on alpha parameter [skip ci]
1 parent 1d753b4 commit 5aeca67

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/api/query.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ AggregateHybridQuery
124124
Using query-time stopwords with index-level ``STOPWORDS 0`` is counterproductive.
125125

126126
.. note::
127-
:class:`HybridQuery` and :class:`AggregateHybridQuery` apply linear combination inconsistently. :class:`HybridQuery` uses ``linear_alpha`` to weight the text score and ``linear_beta`` to weight the vector score. :class:`AggregateHybridQuery` uses ``alpha`` to weight the vector score and ``beta`` to weight the text score.
127+
:class:`HybridQuery` and :class:`AggregateHybridQuery` apply linear combination inconsistently. :class:`HybridQuery` uses ``linear_alpha`` to weight the text score, while :class:`AggregateHybridQuery` uses ``alpha`` to weight the vector score. When switching between the two classes, take care to revise your ``alpha`` setting.
128128

129129
.. note::
130130
**Runtime Parameters for Hybrid Queries**
@@ -139,15 +139,15 @@ AggregateHybridQuery
139139

140140
.. code-block:: python
141141
142-
from redisvl.query.hybrid import HybridQuery
142+
from redisvl.query import HybridQuery
143143
144144
query = HybridQuery(
145145
text="query string",
146146
text_field_name="description",
147147
vector=[0.1, 0.2, 0.3],
148148
vector_field_name="embedding",
149149
vector_search_method="KNN",
150-
knn_k=10,
150+
knn_num_results=10,
151151
knn_ef_runtime=150, # Runtime parameters work with HybridQuery
152152
return_fields=["description"],
153153
num_results=10,

0 commit comments

Comments
 (0)