Skip to content
Closed
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
18 changes: 12 additions & 6 deletions content/develop/ai/redisvl/0.12.0/api/cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,9 @@ Async drop specific entries from the cache by ID or Redis key.
* **Return type:**
None

#### `NOTE`
{{< note >}}
At least one of ids or keys must be provided.
{{< /note >}}

* **Raises:**
**ValueError** – If neither ids nor keys is provided.
Expand All @@ -137,9 +138,10 @@ Asynchronously set or refresh the expiration time for a key in the cache.
* **Return type:**
None

#### `NOTE`
{{< note >}}
If neither the provided TTL nor the default TTL is set (both are None),
this method will have no effect.
{{< /note >}}

#### `async astore(prompt, response, vector=None, metadata=None, filters=None, ttl=None)`

Expand Down Expand Up @@ -268,8 +270,9 @@ Drop specific entries from the cache by ID or Redis key.
* **Return type:**
None

#### `NOTE`
{{< note >}}
At least one of ids or keys must be provided.
{{< /note >}}

* **Raises:**
**ValueError** – If neither ids nor keys is provided.
Expand All @@ -291,9 +294,10 @@ Set or refresh the expiration time for a key in the cache.
* **Return type:**
None

#### `NOTE`
{{< note >}}
If neither the provided TTL nor the default TTL is set (both are None),
this method will have no effect.
{{< /note >}}

#### `set_threshold(distance_threshold)`

Expand Down Expand Up @@ -530,9 +534,10 @@ Asynchronously set or refresh the expiration time for a key in the cache.
* **Return type:**
None

#### `NOTE`
{{< note >}}
If neither the provided TTL nor the default TTL is set (both are None),
this method will have no effect.
{{< /note >}}

#### `async aget(text, model_name)`

Expand Down Expand Up @@ -848,9 +853,10 @@ Set or refresh the expiration time for a key in the cache.
* **Return type:**
None

#### `NOTE`
{{< note >}}
If neither the provided TTL nor the default TTL is set (both are None),
this method will have no effect.
{{< /note >}}

#### `get(text, model_name)`

Expand Down
3 changes: 2 additions & 1 deletion content/develop/ai/redisvl/0.12.0/api/filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,10 @@ v = VectorQuery(
)
```

#### `NOTE`
{{< note >}}
Filter expressions are typically not called directly. Instead they are
built by combining filter statements using the & and | operators.
{{< /note >}}

* **Parameters:**
* **\_filter** (*str* *|* *None*)
Expand Down
27 changes: 18 additions & 9 deletions content/develop/ai/redisvl/0.12.0/api/query.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,9 @@ expression.
* **Raises:**
**TypeError** – If filter_expression is not of type redisvl.query.FilterExpression

#### `NOTE`
{{< note >}}
Learn more about vector queries in Redis: [https://redis.io/docs/latest/develop/ai/search-and-query/vectors/#knn-vector-search](https://redis.io/docs/latest/develop/ai/search-and-query/vectors/#knn-vector-search)
{{< /note >}}

#### `dialect(dialect)`

Expand Down Expand Up @@ -276,10 +277,11 @@ only the FIRST field is used for the Redis SORTBY clause.
>> query.sort_by([("price", "DESC"), ("rating", "ASC")])
```

#### `NOTE`
{{< note >}}
When multiple fields are specified, only the first field is used for sorting
in Redis. Future versions may support multi-field sorting through post-query
sorting in Python.
{{< /note >}}

#### `timeout(timeout)`

Expand Down Expand Up @@ -417,8 +419,9 @@ distance threshold.
* **Raises:**
**TypeError** – If filter_expression is not of type redisvl.query.FilterExpression

#### `NOTE`
{{< note >}}
Learn more about vector range queries: [https://redis.io/docs/interact/search-and-query/search/vectors/#range-query](https://redis.io/docs/interact/search-and-query/search/vectors/#range-query)
{{< /note >}}

#### `dialect(dialect)`

Expand Down Expand Up @@ -638,10 +641,11 @@ only the FIRST field is used for the Redis SORTBY clause.
>> query.sort_by([("price", "DESC"), ("rating", "ASC")])
```

#### `NOTE`
{{< note >}}
When multiple fields are specified, only the first field is used for sorting
in Redis. Future versions may support multi-field sorting through post-query
sorting in Python.
{{< /note >}}

#### `timeout(timeout)`

Expand Down Expand Up @@ -979,10 +983,11 @@ Get the text weights.
* **Return type:**
Dictionary of word

#### `NOTE`
{{< note >}}
The `stopwords` parameter in [HybridQuery](#hybridquery) (and `AggregateHybridQuery`) controls query-time stopword filtering (client-side).
For index-level stopwords configuration (server-side), see `redisvl.schema.IndexInfo.stopwords`.
Using query-time stopwords with index-level `STOPWORDS 0` is counterproductive.
{{< /note >}}

## TextQuery

Expand Down Expand Up @@ -1252,10 +1257,11 @@ only the FIRST field is used for the Redis SORTBY clause.
>> query.sort_by([("price", "DESC"), ("rating", "ASC")])
```

#### `NOTE`
{{< note >}}
When multiple fields are specified, only the first field is used for sorting
in Redis. Future versions may support multi-field sorting through post-query
sorting in Python.
{{< /note >}}

#### `timeout(timeout)`

Expand Down Expand Up @@ -1324,10 +1330,11 @@ Get the text weights.
* **Return type:**
Dictionary of word

#### `NOTE`
{{< note >}}
The `stopwords` parameter in [TextQuery](#textquery) controls query-time stopword filtering (client-side).
For index-level stopwords configuration (server-side), see `redisvl.schema.IndexInfo.stopwords`.
Using query-time stopwords with index-level `STOPWORDS 0` is counterproductive.
{{< /note >}}

## FilterQuery

Expand Down Expand Up @@ -1532,10 +1539,11 @@ only the FIRST field is used for the Redis SORTBY clause.
>> query.sort_by([("price", "DESC"), ("rating", "ASC")])
```

#### `NOTE`
{{< note >}}
When multiple fields are specified, only the first field is used for sorting
in Redis. Future versions may support multi-field sorting through post-query
sorting in Python.
{{< /note >}}

#### `timeout(timeout)`

Expand Down Expand Up @@ -1783,10 +1791,11 @@ only the FIRST field is used for the Redis SORTBY clause.
>> query.sort_by([("price", "DESC"), ("rating", "ASC")])
```

#### `NOTE`
{{< note >}}
When multiple fields are specified, only the first field is used for sorting
in Redis. Future versions may support multi-field sorting through post-query
sorting in Python.
{{< /note >}}

#### `timeout(timeout)`

Expand Down
6 changes: 4 additions & 2 deletions content/develop/ai/redisvl/0.12.0/api/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,10 @@ schema = IndexSchema.from_dict({
})
```

#### `NOTE`
{{< note >}}
The fields attribute in the schema must contain unique field names to ensure
correct and unambiguous field references.
{{< /note >}}

Create a new model by parsing and validating input data from keyword arguments.

Expand Down Expand Up @@ -725,8 +726,9 @@ Configuration for the model, should be a dictionary conforming to [ConfigDict][p
- hnsw: Graph-based approximate search. Fast with high recall (95-99%). Best for general use.
- svs-vamana: SVS-VAMANA (Scalable Vector Search with VAMANA graph algorithm) provides fast approximate nearest neighbor search with optional compression support. This algorithm is optimized for Intel hardware and offers reduced memory usage through vector compression.

#### NOTE
{{< note >}}
For detailed algorithm comparison and selection guidance, see [Vector Algorithm Comparison](#vector-algorithm-comparison).
{{< /note >}}
- datatype: Float precision (bfloat16, float16, float32, float64). Note: SVS-VAMANA only supports float16 and float32.
- distance_metric: Similarity metric (COSINE, L2, IP).
- initial_cap: Initial capacity hint for memory allocation (optional).
Expand Down
6 changes: 4 additions & 2 deletions content/develop/ai/redisvl/0.12.0/api/searchindex.md
Original file line number Diff line number Diff line change
Expand Up @@ -390,10 +390,11 @@ for result_batch in index.paginate(query, page_size=10):
pass
```

#### `NOTE`
{{< note >}}
The page_size parameter controls the number of items each result
batch contains. Adjust this value based on performance
considerations and the expected volume of search results.
{{< /note >}}

#### `query(query)`

Expand Down Expand Up @@ -865,10 +866,11 @@ async for result_batch in index.paginate(query, page_size=10):
pass
```

#### `NOTE`
{{< note >}}
The page_size parameter controls the number of items each result
batch contains. Adjust this value based on performance
considerations and the expected volume of search results.
{{< /note >}}

#### `async query(query)`

Expand Down