You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/integrate/redisvl/api/query.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ expression.
24
24
against in the database.
25
25
***return_fields** (*List**[**str**]*) – The declared fields to return with search
26
26
results.
27
-
***filter_expression** (*Union**[**str**,*[*FilterExpression*](filter.md#redisvl.query.filter.FilterExpression)*]**,**optional*) – A filter to apply
27
+
***filter_expression** (*Union**[**str**,*[*FilterExpression*]({{< relref "filter/#filterexpression" >}}) *]**,**optional*) – A filter to apply
28
28
along with the vector search. Defaults to None.
29
29
***dtype** (*str**,**optional*) – The dtype of the vector. Defaults to
30
30
“float32”.
@@ -165,7 +165,7 @@ Default is TFIDF.
165
165
Set the filter expression for the query.
166
166
167
167
***Parameters:**
168
-
**filter_expression** (*Optional**[**Union**[**str**,*[*FilterExpression*](filter.md#redisvl.query.filter.FilterExpression)*]**]**,**optional*) – The filter
168
+
**filter_expression** (*Optional**[**Union**[**str**,*[*FilterExpression*]({{< relref "filter/#filterexpression" >}}) *]**]**,**optional*) – The filter
169
169
expression or query string to use on the query.
170
170
***Raises:**
171
171
**TypeError** – If filter_expression is not a valid FilterExpression or string.
@@ -224,7 +224,7 @@ Ask the engine to return document search scores.
***return_fields** (*List**[**str**]*) – The declared fields to return with search
258
258
results.
259
-
***filter_expression** (*Union**[**str**,*[*FilterExpression*](filter.md#redisvl.query.filter.FilterExpression)*]**,**optional*) – A filter to apply
259
+
***filter_expression** (*Union**[**str**,*[*FilterExpression*]({{< relref "filter/#filterexpression" >}}) *]**,**optional*) – A filter to apply
260
260
along with the range query. Defaults to None.
261
261
***dtype** (*str**,**optional*) – The dtype of the vector. Defaults to
262
262
“float32”.
@@ -407,7 +407,7 @@ Set the distance threshold for the query.
407
407
Set the filter expression for the query.
408
408
409
409
***Parameters:**
410
-
**filter_expression** (*Optional**[**Union**[**str**,*[*FilterExpression*](filter.md#redisvl.query.filter.FilterExpression)*]**]**,**optional*) – The filter
410
+
**filter_expression** (*Optional**[**Union**[**str**,*[*FilterExpression*]({{< relref "filter/#filterexpression" >}}) *]**]**,**optional*) – The filter
411
411
expression or query string to use on the query.
412
412
***Raises:**
413
413
**TypeError** – If filter_expression is not a valid FilterExpression or string.
@@ -475,7 +475,7 @@ Return the distance threshold for the query.
A query for running a filtered search with a filter expression.
502
502
503
503
***Parameters:**
504
-
***filter_expression** (*Optional**[**Union**[**str**,*[*FilterExpression*](filter.md#redisvl.query.filter.FilterExpression)*]**]*) – The optional filter
504
+
***filter_expression** (*Optional**[**Union**[**str**,*[*FilterExpression*]({{< relref "filter/#filterexpression" >}}) *]**]*) – The optional filter
505
505
expression to query with. Defaults to ‘\*’.
506
506
***return_fields** (*Optional**[**List**[**str**]**]**,**optional*) – The fields to return.
507
507
***num_results** (*Optional**[**int**]**,**optional*) – The number of results to return. Defaults to 10.
@@ -632,7 +632,7 @@ Default is TFIDF.
632
632
Set the filter expression for the query.
633
633
634
634
***Parameters:**
635
-
**filter_expression** (*Optional**[**Union**[**str**,*[*FilterExpression*](filter.md#redisvl.query.filter.FilterExpression)*]**]**,**optional*) – The filter
635
+
**filter_expression** (*Optional**[**Union**[**str**,*[*FilterExpression*]({{< relref "filter/#filterexpression" >}}) *]**]**,**optional*) – The filter
636
636
expression or query string to use on the query.
637
637
***Raises:**
638
638
**TypeError** – If filter_expression is not a valid FilterExpression or string.
@@ -691,7 +691,7 @@ Ask the engine to return document search scores.
A query for a simple count operation provided some filter expression.
713
713
714
714
***Parameters:**
715
-
***filter_expression** (*Optional**[**Union**[**str**,*[*FilterExpression*](filter.md#redisvl.query.filter.FilterExpression)*]**]*) – The filter expression to query with. Defaults to None.
715
+
***filter_expression** (*Optional**[**Union**[**str**,*[*FilterExpression*]({{< relref "filter/#filterexpression" >}}) *]**]*) – The filter expression to query with. Defaults to None.
716
716
***params** (*Optional**[**Dict**[**str**,**Any**]**]**,**optional*) – The parameters for the query. Defaults to None.
717
717
***dialect** (*int*)
718
718
***Raises:**
@@ -848,7 +848,7 @@ Default is TFIDF.
848
848
Set the filter expression for the query.
849
849
850
850
***Parameters:**
851
-
**filter_expression** (*Optional**[**Union**[**str**,*[*FilterExpression*](filter.md#redisvl.query.filter.FilterExpression)*]**]**,**optional*) – The filter
851
+
**filter_expression** (*Optional**[**Union**[**str**,*[*FilterExpression*]({{< relref "filter/#filterexpression" >}}) *]**]**,**optional*) – The filter
852
852
expression or query string to use on the query.
853
853
***Raises:**
854
854
**TypeError** – If filter_expression is not a valid FilterExpression or string.
@@ -907,7 +907,7 @@ Ask the engine to return document search scores.
Copy file name to clipboardExpand all lines: content/integrate/redisvl/api/router.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,9 +17,9 @@ Initialize the SemanticRouter.
17
17
18
18
***Parameters:**
19
19
***name** (*str*) – The name of the semantic router.
20
-
***routes** (*List**[*[*Route*](#redisvl.extensions.router.Route)*]*) – List of Route objects.
20
+
***routes** (*List**[*[*Route*](#route)*]*) – List of Route objects.
21
21
***vectorizer** (*BaseVectorizer**,**optional*) – The vectorizer used to embed route references. Defaults to default HFTextVectorizer.
22
-
***routing_config** ([*RoutingConfig*](#redisvl.extensions.router.RoutingConfig)*,**optional*) – Configuration for routing behavior. Defaults to the default RoutingConfig.
22
+
***routing_config** ([*RoutingConfig*](#routingconfig)*,**optional*) – Configuration for routing behavior. Defaults to the default RoutingConfig.
23
23
***redis_client** (*Optional**[**Redis**]**,**optional*) – Redis client for connection. Defaults to None.
24
24
***redis_url** (*str**,**optional*) – The redis url. Defaults to redis://localhost:6379.
25
25
***overwrite** (*bool**,**optional*) – Whether to overwrite existing index. Defaults to False.
@@ -49,7 +49,7 @@ Create a SemanticRouter from a dictionary.
@@ -123,11 +123,11 @@ Query the semantic router with a given statement or vector for multiple matches.
123
123
***vector** (*Optional**[**List**[**float**]**]*) – The input vector to be queried.
124
124
***max_k** (*Optional**[**int**]*) – The maximum number of top matches to return.
125
125
***distance_threshold** (*Optional**[**float**]*) – The threshold for semantic distance.
126
-
***aggregation_method** (*Optional**[*[*DistanceAggregationMethod*](#redisvl.extensions.router.schema.DistanceAggregationMethod)*]*) – The aggregation method used for vector distances.
126
+
***aggregation_method** (*Optional**[*[*DistanceAggregationMethod*](#distanceaggregationmethod)*]*) – The aggregation method used for vector distances.
0 commit comments