From 155619a890102ff570cfa6c74e501ee136409941 Mon Sep 17 00:00:00 2001 From: "redisdocsapp[bot]" <177626021+redisdocsapp[bot]@users.noreply.github.com> Date: Fri, 5 Jun 2026 13:25:05 +0000 Subject: [PATCH] Update for redisvl 0.12.0 --- .../develop/ai/redisvl/0.12.0/api/cache.md | 18 ++++++++----- .../develop/ai/redisvl/0.12.0/api/filter.md | 3 ++- .../develop/ai/redisvl/0.12.0/api/query.md | 27 ++++++++++++------- .../develop/ai/redisvl/0.12.0/api/schema.md | 6 +++-- .../ai/redisvl/0.12.0/api/searchindex.md | 6 +++-- 5 files changed, 40 insertions(+), 20 deletions(-) diff --git a/content/develop/ai/redisvl/0.12.0/api/cache.md b/content/develop/ai/redisvl/0.12.0/api/cache.md index aab125e68b..98956dc533 100644 --- a/content/develop/ai/redisvl/0.12.0/api/cache.md +++ b/content/develop/ai/redisvl/0.12.0/api/cache.md @@ -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. @@ -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)` @@ -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. @@ -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)` @@ -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)` @@ -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)` diff --git a/content/develop/ai/redisvl/0.12.0/api/filter.md b/content/develop/ai/redisvl/0.12.0/api/filter.md index f38e655400..24050266a4 100644 --- a/content/develop/ai/redisvl/0.12.0/api/filter.md +++ b/content/develop/ai/redisvl/0.12.0/api/filter.md @@ -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*) diff --git a/content/develop/ai/redisvl/0.12.0/api/query.md b/content/develop/ai/redisvl/0.12.0/api/query.md index 5136f74105..76693059c9 100644 --- a/content/develop/ai/redisvl/0.12.0/api/query.md +++ b/content/develop/ai/redisvl/0.12.0/api/query.md @@ -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)` @@ -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)` @@ -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)` @@ -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)` @@ -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 @@ -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)` @@ -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 @@ -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)` @@ -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)` diff --git a/content/develop/ai/redisvl/0.12.0/api/schema.md b/content/develop/ai/redisvl/0.12.0/api/schema.md index 9cc3eb5fb5..83d909c207 100644 --- a/content/develop/ai/redisvl/0.12.0/api/schema.md +++ b/content/develop/ai/redisvl/0.12.0/api/schema.md @@ -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. @@ -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). diff --git a/content/develop/ai/redisvl/0.12.0/api/searchindex.md b/content/develop/ai/redisvl/0.12.0/api/searchindex.md index 75c6b86fb7..23ad1ce571 100644 --- a/content/develop/ai/redisvl/0.12.0/api/searchindex.md +++ b/content/develop/ai/redisvl/0.12.0/api/searchindex.md @@ -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)` @@ -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)`