Skip to content

Commit 5ecf8e2

Browse files
committed
Removed unsupported ft.Aggregate parameters, update notebooks and documentation.
1 parent 9c2b353 commit 5ecf8e2

File tree

4 files changed

+489
-294
lines changed

4 files changed

+489
-294
lines changed

docs/api/query.rst

Lines changed: 5 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -128,19 +128,13 @@ HybridQuery
128128

129129
AggregateHybridQuery (and the deprecated HybridQuery) support runtime parameters for the vector search component.
130130

131-
**Note:** The ``epsilon`` parameter is only supported for range queries (VectorRangeQuery), not for KNN queries used in hybrid search.
131+
**Note:** AggregateHybridQuery uses FT.AGGREGATE commands which only support the ``ef_runtime`` parameter for HNSW indexes. SVS-VAMANA runtime parameters (``search_window_size``, ``use_search_history``, ``search_buffer_capacity``) are NOT supported in FT.AGGREGATE commands. For full runtime parameter support including SVS-VAMANA, use VectorQuery or VectorRangeQuery which use FT.SEARCH commands.
132132

133-
**HNSW Parameters:**
134-
135-
- ``ef_runtime``: Controls search accuracy for the vector component
133+
**Supported Runtime Parameter:**
136134

137-
**SVS-VAMANA Parameters:**
138-
139-
- ``search_window_size``: Size of search window for KNN searches
140-
- ``use_search_history``: Whether to use search buffer (OFF/ON/AUTO)
141-
- ``search_buffer_capacity``: Tuning parameter for 2-level compression
135+
- ``ef_runtime``: Controls search accuracy for HNSW indexes (higher = better recall, slower search)
142136

143-
Example with HNSW:
137+
Example:
144138

145139
.. code-block:: python
146140
@@ -152,22 +146,7 @@ HybridQuery
152146
vector=[0.1, 0.2, 0.3],
153147
vector_field_name="embedding",
154148
alpha=0.7,
155-
ef_runtime=150 # HNSW parameter
156-
)
157-
158-
Example with SVS-VAMANA:
159-
160-
.. code-block:: python
161-
162-
query = AggregateHybridQuery(
163-
text="search query",
164-
text_field_name="description",
165-
vector=[0.1, 0.2, 0.3],
166-
vector_field_name="embedding",
167-
alpha=0.7,
168-
search_window_size=20, # SVS-VAMANA
169-
use_search_history='ON', # SVS-VAMANA
170-
search_buffer_capacity=30 # SVS-VAMANA
149+
ef_runtime=150 # Only HNSW ef_runtime is supported
171150
)
172151
173152

0 commit comments

Comments
 (0)