Skip to content

Commit b33287c

Browse files
committed
Fix relrefs
1 parent c81a295 commit b33287c

File tree

6 files changed

+54
-54
lines changed

6 files changed

+54
-54
lines changed

content/integrate/redisvl/api/cache.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ LLM responses.
6161
* **return_fields** (*Optional* *[**List* *[**str* *]* *]* *,* *optional*) – The fields to include
6262
in each returned result. If None, defaults to all available
6363
fields in the cached entry.
64-
* **filter_expression** (*Optional* *[*[*FilterExpression*](filter.md#redisvl.query.filter.FilterExpression) *]*) – Optional filter expression
64+
* **filter_expression** (*Optional* *[*[*FilterExpression*]({{< relref "filter/#filterexpression" >}}) *]*) – Optional filter expression
6565
that can be used to filter cache results. Defaults to None and
6666
the full cache will be searched.
6767
* **distance_threshold** (*Optional* *[**float* *]*) – The threshold for semantic
@@ -167,7 +167,7 @@ LLM responses.
167167
* **return_fields** (*Optional* *[**List* *[**str* *]* *]* *,* *optional*) – The fields to include
168168
in each returned result. If None, defaults to all available
169169
fields in the cached entry.
170-
* **filter_expression** (*Optional* *[*[*FilterExpression*](filter.md#redisvl.query.filter.FilterExpression) *]*) – Optional filter expression
170+
* **filter_expression** (*Optional* *[*[*FilterExpression*]({{< relref "filter/#filterexpression" >}}) *]*) – Optional filter expression
171171
that can be used to filter cache results. Defaults to None and
172172
the full cache will be searched.
173173
* **distance_threshold** (*Optional* *[**float* *]*) – The threshold for semantic
@@ -288,14 +288,14 @@ cache.update(key, metadata={"hit_count": 1, "model_name": "Llama-2-7b"})
288288
)
289289
```
290290

291-
#### *property* aindex *: [AsyncSearchIndex](searchindex.md#redisvl.index.AsyncSearchIndex) | None*
291+
#### *property* aindex *: [AsyncSearchIndex]({{< relref "searchindex/#asyncsearchindex" >}}) | None*
292292

293293
The underlying AsyncSearchIndex for the cache.
294294

295295
* **Returns:**
296296
The async search index.
297297
* **Return type:**
298-
[AsyncSearchIndex](searchindex.md#redisvl.index.AsyncSearchIndex)
298+
[AsyncSearchIndex]({{< relref "searchindex/#asyncsearchindex" >}})
299299

300300
#### *property* distance_threshold *: float*
301301

@@ -306,14 +306,14 @@ The semantic distance threshold for the cache.
306306
* **Return type:**
307307
float
308308

309-
#### *property* index *: [SearchIndex](searchindex.md#redisvl.index.SearchIndex)*
309+
#### *property* index *: [SearchIndex]({{< relref "searchindex/#searchindex" >}})*
310310

311311
The underlying SearchIndex for the cache.
312312

313313
* **Returns:**
314314
The search index.
315315
* **Return type:**
316-
[SearchIndex](searchindex.md#redisvl.index.SearchIndex)
316+
[SearchIndex]({{< relref "searchindex/#searchindex" >}})
317317

318318
#### *property* ttl *: int | None*
319319

content/integrate/redisvl/api/filter.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ built by combining filter statements using the & and | operators.
5151
* **Parameters:**
5252
* **\_filter** (*str* *|* *None*)
5353
* **operator** (*FilterOperator* *|* *None*)
54-
* **left** ([*FilterExpression*](#redisvl.query.filter.FilterExpression) *|* *None*)
55-
* **right** ([*FilterExpression*](#redisvl.query.filter.FilterExpression) *|* *None*)
54+
* **left** ([*FilterExpression*](#filterexpression) *|* *None*)
55+
* **right** ([*FilterExpression*](#filterexpression) *|* *None*)
5656

5757
## Tag
5858

@@ -70,7 +70,7 @@ Create a Tag equality filter expression.
7070
* **Parameters:**
7171
**other** (*Union* *[**List* *[**str* *]* *,* *str* *]*) – The tag(s) to filter on.
7272
* **Return type:**
73-
[*FilterExpression*](#redisvl.query.filter.FilterExpression)
73+
[*FilterExpression*](#filterexpression)
7474

7575
```python
7676
from redisvl.query.filter import Tag
@@ -85,7 +85,7 @@ Create a Tag inequality filter expression.
8585
* **Parameters:**
8686
**other** (*Union* *[**List* *[**str* *]* *,* *str* *]*) – The tag(s) to filter on.
8787
* **Return type:**
88-
[*FilterExpression*](#redisvl.query.filter.FilterExpression)
88+
[*FilterExpression*](#filterexpression)
8989

9090
```python
9191
from redisvl.query.filter import Tag
@@ -116,7 +116,7 @@ filters that enforce an exact match on the supplied term(s).
116116
* **Parameters:**
117117
**other** (*str*) – The text value to filter on.
118118
* **Return type:**
119-
[*FilterExpression*](#redisvl.query.filter.FilterExpression)
119+
[*FilterExpression*](#filterexpression)
120120

121121
```python
122122
from redisvl.query.filter import Text
@@ -134,7 +134,7 @@ term(s).
134134
* **Parameters:**
135135
**other** (*str*) – The text value to filter on.
136136
* **Return type:**
137-
[*FilterExpression*](#redisvl.query.filter.FilterExpression)
137+
[*FilterExpression*](#filterexpression)
138138

139139
```python
140140
from redisvl.query.filter import Text
@@ -154,7 +154,7 @@ equality filter expression.
154154
* **Parameters:**
155155
**other** (*str*) – The text value to filter on.
156156
* **Return type:**
157-
[*FilterExpression*](#redisvl.query.filter.FilterExpression)
157+
[*FilterExpression*](#filterexpression)
158158

159159
```python
160160
from redisvl.query.filter import Text
@@ -185,7 +185,7 @@ Create a Numeric equality filter expression.
185185
* **Parameters:**
186186
**other** (*int*) – The value to filter on.
187187
* **Return type:**
188-
[*FilterExpression*](#redisvl.query.filter.FilterExpression)
188+
[*FilterExpression*](#filterexpression)
189189

190190
```python
191191
from redisvl.query.filter import Num
@@ -199,7 +199,7 @@ Create a Numeric greater than or equal to filter expression.
199199
* **Parameters:**
200200
**other** (*int*) – The value to filter on.
201201
* **Return type:**
202-
[*FilterExpression*](#redisvl.query.filter.FilterExpression)
202+
[*FilterExpression*](#filterexpression)
203203

204204
```python
205205
from redisvl.query.filter import Num
@@ -214,7 +214,7 @@ Create a Numeric greater than filter expression.
214214
* **Parameters:**
215215
**other** (*int*) – The value to filter on.
216216
* **Return type:**
217-
[*FilterExpression*](#redisvl.query.filter.FilterExpression)
217+
[*FilterExpression*](#filterexpression)
218218

219219
```python
220220
from redisvl.query.filter import Num
@@ -229,7 +229,7 @@ Create a Numeric less than or equal to filter expression.
229229
* **Parameters:**
230230
**other** (*int*) – The value to filter on.
231231
* **Return type:**
232-
[*FilterExpression*](#redisvl.query.filter.FilterExpression)
232+
[*FilterExpression*](#filterexpression)
233233

234234
```python
235235
from redisvl.query.filter import Num
@@ -244,7 +244,7 @@ Create a Numeric less than filter expression.
244244
* **Parameters:**
245245
**other** (*int*) – The value to filter on.
246246
* **Return type:**
247-
[*FilterExpression*](#redisvl.query.filter.FilterExpression)
247+
[*FilterExpression*](#filterexpression)
248248

249249
```python
250250
from redisvl.query.filter import Num
@@ -259,7 +259,7 @@ Create a Numeric inequality filter expression.
259259
* **Parameters:**
260260
**other** (*int*) – The value to filter on.
261261
* **Return type:**
262-
[*FilterExpression*](#redisvl.query.filter.FilterExpression)
262+
[*FilterExpression*](#filterexpression)
263263

264264
```python
265265
from redisvl.query.filter import Num
@@ -289,9 +289,9 @@ Redis index.
289289
Create a geographic filter within a specified GeoRadius.
290290

291291
* **Parameters:**
292-
**other** ([*GeoRadius*](#redisvl.query.filter.GeoRadius)) – The geographic spec to filter on.
292+
**other** ([*GeoRadius*](#georadius)) – The geographic spec to filter on.
293293
* **Return type:**
294-
[*FilterExpression*](#redisvl.query.filter.FilterExpression)
294+
[*FilterExpression*](#filterexpression)
295295

296296
```python
297297
from redisvl.query.filter import Geo, GeoRadius
@@ -304,9 +304,9 @@ f = Geo("location") == GeoRadius(-122.4194, 37.7749, 1, unit="m")
304304
Create a geographic filter outside of a specified GeoRadius.
305305

306306
* **Parameters:**
307-
**other** ([*GeoRadius*](#redisvl.query.filter.GeoRadius)) – The geographic spec to filter on.
307+
**other** ([*GeoRadius*](#georadius)) – The geographic spec to filter on.
308308
* **Return type:**
309-
[*FilterExpression*](#redisvl.query.filter.FilterExpression)
309+
[*FilterExpression*](#filterexpression)
310310

311311
```python
312312
from redisvl.query.filter import Geo, GeoRadius

content/integrate/redisvl/api/query.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ expression.
2424
against in the database.
2525
* **return_fields** (*List* *[**str* *]*) – The declared fields to return with search
2626
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
2828
along with the vector search. Defaults to None.
2929
* **dtype** (*str* *,* *optional*) – The dtype of the vector. Defaults to
3030
“float32”.
@@ -165,7 +165,7 @@ Default is TFIDF.
165165
Set the filter expression for the query.
166166

167167
* **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
169169
expression or query string to use on the query.
170170
* **Raises:**
171171
**TypeError** – If filter_expression is not a valid FilterExpression or string.
@@ -224,7 +224,7 @@ Ask the engine to return document search scores.
224224
* **Return type:**
225225
*Query*
226226

227-
#### *property* filter *: str | [FilterExpression](filter.md#redisvl.query.filter.FilterExpression)*
227+
#### *property* filter *: str | [FilterExpression]({{< relref "filter/#filterexpression" >}})*
228228

229229
The filter expression for the query.
230230

@@ -256,7 +256,7 @@ distance threshold.
256256
against in the database.
257257
* **return_fields** (*List* *[**str* *]*) – The declared fields to return with search
258258
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
260260
along with the range query. Defaults to None.
261261
* **dtype** (*str* *,* *optional*) – The dtype of the vector. Defaults to
262262
“float32”.
@@ -407,7 +407,7 @@ Set the distance threshold for the query.
407407
Set the filter expression for the query.
408408

409409
* **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
411411
expression or query string to use on the query.
412412
* **Raises:**
413413
**TypeError** – If filter_expression is not a valid FilterExpression or string.
@@ -475,7 +475,7 @@ Return the distance threshold for the query.
475475
* **Return type:**
476476
float
477477

478-
#### *property* filter *: str | [FilterExpression](filter.md#redisvl.query.filter.FilterExpression)*
478+
#### *property* filter *: str | [FilterExpression]({{< relref "filter/#filterexpression" >}})*
479479

480480
The filter expression for the query.
481481

@@ -501,7 +501,7 @@ Bases: `BaseQuery`
501501
A query for running a filtered search with a filter expression.
502502

503503
* **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
505505
expression to query with. Defaults to ‘\*’.
506506
* **return_fields** (*Optional* *[**List* *[**str* *]* *]* *,* *optional*) – The fields to return.
507507
* **num_results** (*Optional* *[**int* *]* *,* *optional*) – The number of results to return. Defaults to 10.
@@ -632,7 +632,7 @@ Default is TFIDF.
632632
Set the filter expression for the query.
633633

634634
* **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
636636
expression or query string to use on the query.
637637
* **Raises:**
638638
**TypeError** – If filter_expression is not a valid FilterExpression or string.
@@ -691,7 +691,7 @@ Ask the engine to return document search scores.
691691
* **Return type:**
692692
*Query*
693693

694-
#### *property* filter *: str | [FilterExpression](filter.md#redisvl.query.filter.FilterExpression)*
694+
#### *property* filter *: str | [FilterExpression]({{< relref "filter/#filterexpression" >}})*
695695

696696
The filter expression for the query.
697697

@@ -712,7 +712,7 @@ Bases: `BaseQuery`
712712
A query for a simple count operation provided some filter expression.
713713

714714
* **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.
716716
* **params** (*Optional* *[**Dict* *[**str* *,* *Any* *]* *]* *,* *optional*) – The parameters for the query. Defaults to None.
717717
* **dialect** (*int*)
718718
* **Raises:**
@@ -848,7 +848,7 @@ Default is TFIDF.
848848
Set the filter expression for the query.
849849

850850
* **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
852852
expression or query string to use on the query.
853853
* **Raises:**
854854
**TypeError** – If filter_expression is not a valid FilterExpression or string.
@@ -907,7 +907,7 @@ Ask the engine to return document search scores.
907907
* **Return type:**
908908
*Query*
909909

910-
#### *property* filter *: str | [FilterExpression](filter.md#redisvl.query.filter.FilterExpression)*
910+
#### *property* filter *: str | [FilterExpression]({{< relref "filter/#filterexpression" >}})*
911911

912912
The filter expression for the query.
913913

content/integrate/redisvl/api/router.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ Initialize the SemanticRouter.
1717

1818
* **Parameters:**
1919
* **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.
2121
* **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.
2323
* **redis_client** (*Optional* *[**Redis* *]* *,* *optional*) – Redis client for connection. Defaults to None.
2424
* **redis_url** (*str* *,* *optional*) – The redis url. Defaults to redis://localhost:6379.
2525
* **overwrite** (*bool* *,* *optional*) – Whether to overwrite existing index. Defaults to False.
@@ -49,7 +49,7 @@ Create a SemanticRouter from a dictionary.
4949
* **Returns:**
5050
The semantic router instance.
5151
* **Return type:**
52-
[SemanticRouter](#redisvl.extensions.router.SemanticRouter)
52+
[SemanticRouter](#semanticrouter)
5353
* **Raises:**
5454
**ValueError** – If required data is missing or invalid.
5555

@@ -72,7 +72,7 @@ Create a SemanticRouter from a YAML file.
7272
* **Returns:**
7373
The semantic router instance.
7474
* **Return type:**
75-
[SemanticRouter](#redisvl.extensions.router.SemanticRouter)
75+
[SemanticRouter](#semanticrouter)
7676
* **Raises:**
7777
* **ValueError** – If the file path is invalid.
7878
* **FileNotFoundError** – If the file does not exist.
@@ -91,7 +91,7 @@ Get a route by its name.
9191
* **Returns:**
9292
The selected Route object or None if not found.
9393
* **Return type:**
94-
Optional[[Route](#redisvl.extensions.router.Route)]
94+
Optional[[Route](#route)]
9595

9696
#### model_post_init(context, /)
9797

@@ -123,11 +123,11 @@ Query the semantic router with a given statement or vector for multiple matches.
123123
* **vector** (*Optional* *[**List* *[**float* *]* *]*) – The input vector to be queried.
124124
* **max_k** (*Optional* *[**int* *]*) – The maximum number of top matches to return.
125125
* **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.
127127
* **Returns:**
128128
The matching routes and their details.
129129
* **Return type:**
130-
List[[RouteMatch](#redisvl.extensions.router.schema.RouteMatch)]
130+
List[[RouteMatch](#routematch)]
131131

132132
#### to_dict()
133133

@@ -171,7 +171,7 @@ router.to_yaml("router.yaml")
171171
Update the routing configuration.
172172

173173
* **Parameters:**
174-
**routing_config** ([*RoutingConfig*](#redisvl.extensions.router.RoutingConfig)) – The new routing configuration.
174+
**routing_config** ([*RoutingConfig*](#routingconfig)) – The new routing configuration.
175175

176176
#### model_config *: ClassVar[ConfigDict]* *= {'arbitrary_types_allowed': True}*
177177

@@ -199,11 +199,11 @@ Get the distance thresholds for each route.
199199
* **Return type:**
200200
Dict[str, float]
201201

202-
#### routes *: List[[Route](#redisvl.extensions.router.Route)]*
202+
#### routes *: List[[Route](#route)]*
203203

204204
List of Route objects.
205205

206-
#### routing_config *: [RoutingConfig](#redisvl.extensions.router.RoutingConfig)*
206+
#### routing_config *: [RoutingConfig](#routingconfig)*
207207

208208
Configuration for routing behavior.
209209

@@ -226,7 +226,7 @@ self is explicitly positional-only to allow self as a field name.
226226

227227
* **Parameters:**
228228
* **max_k** (*Annotated* *[**int* *,* *FieldInfo* *(**annotation=NoneType* *,* *required=False* *,* *default=1* *,* *metadata=* *[**Strict* *(**strict=True* *)* *,* *Gt* *(**gt=0* *)* *]* *)* *]*)
229-
* **aggregation_method** ([*DistanceAggregationMethod*](#redisvl.extensions.router.schema.DistanceAggregationMethod))
229+
* **aggregation_method** ([*DistanceAggregationMethod*](#distanceaggregationmethod))
230230

231231
#### max_k *: Annotated[int, FieldInfo(annotation=NoneType, required=False, default=1, metadata=[Strict(strict=True), Gt(gt=0)])]*
232232

content/integrate/redisvl/api/schema.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ Create an IndexSchema from a dictionary.
173173
* **Returns:**
174174
The index schema.
175175
* **Return type:**
176-
[IndexSchema](#redisvl.schema.IndexSchema)
176+
[IndexSchema](#indexschema)
177177

178178
```python
179179
from redisvl.schema import IndexSchema
@@ -210,7 +210,7 @@ Create an IndexSchema from a YAML file.
210210
* **Returns:**
211211
The index schema.
212212
* **Return type:**
213-
[IndexSchema](#redisvl.schema.IndexSchema)
213+
[IndexSchema](#indexschema)
214214

215215
```python
216216
from redisvl.schema import IndexSchema

0 commit comments

Comments
 (0)