Update redisvl docs for redisvl 0.4.1

Author: paoloredis

content/integrate/redisvl/api/searchindex.md

@@ -14,7 +14,7 @@ type: integration
 
 ## SearchIndex
 
-### `class SearchIndex(schema, redis_client=None, redis_url=None, connection_args={}, **kwargs)`
+### `class SearchIndex(schema, redis_client=None, redis_url=None, connection_kwargs=None, **kwargs)`
 
 A search index class for interacting with Redis as a vector database.
 
@@ -26,8 +26,7 @@ settings and field configurations.
 from redisvl.index import SearchIndex
 
 # initialize the index object with schema from file
-index = SearchIndex.from_yaml("schemas/schema.yaml")
-index.connect(redis_url="redis://localhost:6379")
+index = SearchIndex.from_yaml("schemas/schema.yaml", redis_url="redis://localhost:6379")
 
 # create the index
 index.create(overwrite=True)
@@ -49,7 +48,7 @@ kwargs.
     instantiated redis client.
   * **redis_url** (*Optional* *[* *str* *]*) – The URL of the Redis server to
     connect to.
-  * **connection_args** (*Dict* *[* *str* *,* *Any* *]* *,* *optional*) – Redis client connection
+  * **connection_kwargs** (*Dict* *[* *str* *,* *Any* *]* *,* *optional*) – Redis client connection
     args.
 
 #### `aggregate(*args, **kwargs)`
@@ -85,13 +84,13 @@ extra options specific to the Redis connection.
 
 * **Parameters:**
   **redis_url** (*Optional* *[* *str* *]* *,* *optional*) – The URL of the Redis server to
-  connect to. If not provided, the method defaults to using the
-  REDIS_URL environment variable.
+  connect to.
 * **Raises:**
   * **redis.exceptions.ConnectionError** – If the connection to the Redis
         server fails.
   * **ValueError** – If the Redis URL is not provided nor accessible
         through the REDIS_URL environment variable.
+  * **ModuleNotFoundError** – If required Redis modules are not installed.
 
 ```python
 index.connect(redis_url="redis://localhost:6379")
@@ -158,6 +157,16 @@ Check if the index exists in Redis.
 * **Return type:**
   bool
 
+#### `expire_keys(keys, ttl)`
+
+Set the expiration time for a specific entry or entries in Redis.
+
+* **Parameters:**
+  * **keys** (*Union* *[* *str* *,* *List* *[* *str* *]* *]*) – The entry ID or IDs to set the expiration for.
+  * **ttl** (*int*) – The time-to-live in seconds.
+* **Return type:**
+  int | *List*[int]
+
 #### `fetch(id)`
 
 Fetch an object from Redis by id.
@@ -210,6 +219,9 @@ Initialize from an existing search index in Redis by index name.
     instantiated redis client.
   * **redis_url** (*Optional* *[* *str* *]*) – The URL of the Redis server to
     connect to.
+* **Raises:**
+  * **ValueError** – If redis_url or redis_client is not provided.
+  * **RedisModuleVersionError** – If required Redis modules are not installed.
 
 #### `classmethod from_yaml(schema_path, **kwargs)`
 
@@ -438,7 +450,7 @@ hash or json.
 
 ## AsyncSearchIndex
 
-### `class AsyncSearchIndex(schema, **kwargs)`
+### `class AsyncSearchIndex(schema, *, redis_url=None, redis_client=None, connection_kwargs=None, **kwargs)`
 
 A search index class for interacting with Redis as a vector database in
 async-mode.
@@ -451,8 +463,10 @@ various settings and field configurations.
 from redisvl.index import AsyncSearchIndex
 
 # initialize the index object with schema from file
-index = AsyncSearchIndex.from_yaml("schemas/schema.yaml")
-await index.connect(redis_url="redis://localhost:6379")
+index = AsyncSearchIndex.from_yaml(
+    "schemas/schema.yaml",
+    redis_url="redis://localhost:6379"
+)
 
 # create the index
 await index.create(overwrite=True)
@@ -468,7 +482,11 @@ Initialize the RedisVL async search index with a schema.
 
 * **Parameters:**
   * **schema** ([*IndexSchema*]({{< relref "schema/#indexschema" >}})) – Index schema object.
-  * **connection_args** (*Dict* *[* *str* *,* *Any* *]* *,* *optional*) – Redis client connection
+  * **redis_url** (*Optional* *[* *str* *]* *,* *optional*) – The URL of the Redis server to
+    connect to.
+  * **redis_client** (*Optional* *[* *aredis.Redis* *]*) – An
+    instantiated redis client.
+  * **connection_kwargs** (*Optional* *[* *Dict* *[* *str* *,* *Any* *]* *]*) – Redis client connection
     args.
 
 #### `async aggregate(*args, **kwargs)`
@@ -494,27 +512,12 @@ available and in-place for future insertions or updates.
 * **Return type:**
   int
 
-#### `async connect(redis_url=None, **kwargs)`
-
-Connect to a Redis instance using the provided redis_url, falling
-back to the REDIS_URL environment variable (if available).
+#### `connect(redis_url=None, **kwargs)`
 
-Note: Additional keyword arguments (\*\*kwargs) can be used to provide
-extra options specific to the Redis connection.
+[DEPRECATED] Connect to a Redis instance. Use connection parameters in \_\_init_\_.
 
 * **Parameters:**
-  **redis_url** (*Optional* *[* *str* *]* *,* *optional*) – The URL of the Redis server to
-  connect to. If not provided, the method defaults to using the
-  REDIS_URL environment variable.
-* **Raises:**
-  * **redis.exceptions.ConnectionError** – If the connection to the Redis
-        server fails.
-  * **ValueError** – If the Redis URL is not provided nor accessible
-        through the REDIS_URL environment variable.
-
-```python
-index.connect(redis_url="redis://localhost:6379")
-```
+  **redis_url** (*str* *|* *None*)
 
 #### `async create(overwrite=False, drop=False)`
 
@@ -553,9 +556,9 @@ Delete the search index.
 * **Raises:**
   **redis.exceptions.ResponseError** – If the index does not exist.
 
-#### `disconnect()`
+#### `async disconnect()`
 
-Disconnect and cleanup the underlying async redis connection.
+Disconnect from the Redis database.
 
 #### `async drop_keys(keys)`
 
@@ -577,6 +580,16 @@ Check if the index exists in Redis.
 * **Return type:**
   bool
 
+#### `async expire_keys(keys, ttl)`
+
+Set the expiration time for a specific entry or entries in Redis.
+
+* **Parameters:**
+  * **keys** (*Union* *[* *str* *,* *List* *[* *str* *]* *]*) – The entry ID or IDs to set the expiration for.
+  * **ttl** (*int*) – The time-to-live in seconds.
+* **Return type:**
+  int | *List*[int]
+
 #### `async fetch(id)`
 
 Asynchronously etch an object from Redis by id. The id is typically
@@ -805,29 +818,13 @@ to the redis-py ft.search() method.
 * **Return type:**
   Result
 
-#### `async set_client(redis_client)`
+#### `set_client(redis_client)`
 
-Manually set the Redis client to use with the search index.
-
-This method configures the search index to use a specific
-Async Redis client. It is useful for cases where an external,
-custom-configured client is preferred instead of creating a new one.
+[DEPRECATED] Manually set the Redis client to use with the search index.
+This method is deprecated; please provide connection parameters in \_\_init_\_.
 
 * **Parameters:**
-  **redis_client** (*aredis.Redis*) – An Async Redis
-  client instance to be used for the connection.
-* **Raises:**
-  **TypeError** – If the provided client is not valid.
-
-```python
-import redis.asyncio as aredis
-from redisvl.index import AsyncSearchIndex
-
-# async Redis client and index
-client = aredis.Redis.from_url("redis://localhost:6379")
-index = AsyncSearchIndex.from_yaml("schemas/schema.yaml")
-await index.set_client(client)
-```
+  **redis_client** (*Redis* *|* *Redis*)
 
 #### `property client: Redis | None`
 

content/integrate/redisvl/overview/cli.md

@@ -19,7 +19,7 @@ Before running this notebook, be sure to
 !rvl version
 ```
 
-    18:12:25 [RedisVL] INFO   RedisVL version 0.3.9
+    16:19:10 [RedisVL] INFO   RedisVL version 0.4.0
 
 
 ## Commands

content/integrate/redisvl/user_guide/getting_started.md

@@ -148,7 +148,7 @@ index = SearchIndex.from_dict(schema)
 Now we also need to facilitate a Redis connection. There are a few ways to do this:
 
 - Create & manage your own client connection (recommended)
-- Provide a simple Redis URL and let RedisVL connect on your behalf
+- Provide a Redis URL and let RedisVL connect on your behalf (by default, it will connect to "redis://localhost:6379")
 
 ### Bring your own Redis connection instance
 
@@ -159,9 +159,14 @@ This is ideal in scenarios where you have custom settings on the connection inst
 from redis import Redis
 
 client = Redis.from_url("redis://localhost:6379")
+index = SearchIndex.from_dict(schema, redis_client=client)
+
+# alternatively, provide an async Redis client object to enable async index operations
+# from redis.asyncio import Redis
+# from redisvl.index import AsyncSearchIndex
+# client = Redis.from_url("redis://localhost:6379")
+# index = AsyncSearchIndex.from_dict(schema, redis_client=client)
 
-index.set_client(client)
-# optionally provide an async Redis client object to enable async index operations
 ```
 
 
@@ -177,8 +182,10 @@ This is ideal for simple cases:
 
 
 ```python
-index.connect("redis://localhost:6379")
-# optionally use an async client by passing use_async=True
+index = SearchIndex.from_dict(schema, redis_url="redis://localhost:6379")
+
+# If you don't specify a client or Redis URL, the index will attempt to
+# connect to Redis at the default address ("redis://localhost:6379").
 ```
 
 
@@ -299,8 +306,11 @@ results = index.query(query)
 result_print(results)
 ```
 
+    *=>[KNN 3 @user_embedding $vector AS vector_distance] RETURN 6 user age job credit_score vector_distance vector_distance SORTBY vector_distance ASC DIALECT 2 LIMIT 0 3
 
-<table><tr><th>vector_distance</th><th>user</th><th>age</th><th>job</th><th>credit_score</th></tr><tr><td>0</td><td>john</td><td>1</td><td>engineer</td><td>high</td></tr><tr><td>0</td><td>mary</td><td>2</td><td>doctor</td><td>low</td></tr><tr><td>0.0566299557686</td><td>tyler</td><td>9</td><td>engineer</td><td>high</td></tr></table>
+
+
+table><tr><th>vector_distance</th><th>user</th><th>age</th><th>job</th><th>credit_score</th></tr><tr><td>0</td><td>john</td><td>1</td><td>engineer</td><td>high</td></tr><tr><td>0</td><td>mary</td><td>2</td><td>doctor</td><td>low</td></tr><tr><td>0.0566299557686</td><td>tyler</td><td>9</td><td>engineer</td><td>high</td></tr></table>
 
 
 ## Using an Asynchronous Redis Client
@@ -337,8 +347,7 @@ from redis.asyncio import Redis
 
 client = Redis.from_url("redis://localhost:6379")
 
-index = AsyncSearchIndex.from_dict(schema)
-await index.set_client(client)
+index = AsyncSearchIndex.from_dict(schema, redis_client=client)
 ```
 
 
@@ -393,7 +402,7 @@ index.schema.add_fields([
 await index.create(overwrite=True, drop=False)
 ```
 
-    11:53:25 redisvl.index.index INFO   Index already exists, overwriting.
+    11:28:32 redisvl.index.index INFO   Index already exists, overwriting.
 
 
 
@@ -404,7 +413,7 @@ result_print(results)
 ```
 
 
-<table><tr><th>vector_distance</th><th>user</th><th>age</th><th>job</th><th>credit_score</th></tr><tr><td>0</td><td>john</td><td>1</td><td>engineer</td><td>high</td></tr><tr><td>0</td><td>mary</td><td>2</td><td>doctor</td><td>low</td></tr><tr><td>0.0566299557686</td><td>tyler</td><td>9</td><td>engineer</td><td>high</td></tr></table>
+<table><tr><th>vector_distance</th><th>user</th><th>age</th><th>job</th><th>credit_score</th></tr><tr><td>0</td><td>mary</td><td>2</td><td>doctor</td><td>low</td></tr><tr><td>0</td><td>john</td><td>1</td><td>engineer</td><td>high</td></tr><tr><td>0.0566299557686</td><td>tyler</td><td>9</td><td>engineer</td><td>high</td></tr></table>
 
 
 ## Check Index Stats
@@ -426,19 +435,19 @@ Use the `rvl` CLI to check the stats for the index:
     │ num_records                 │ 22          │
     │ percent_indexed             │ 1           │
     │ hash_indexing_failures      │ 0           │
-    │ number_of_uses              │ 5           │
-    │ bytes_per_record_avg        │ 50.9091     │
+    │ number_of_uses              │ 2           │
+    │ bytes_per_record_avg        │ 47.8        │
     │ doc_table_size_mb           │ 0.000423431 │
-    │ inverted_sz_mb              │ 0.00106812  │
+    │ inverted_sz_mb              │ 0.000911713 │
     │ key_table_size_mb           │ 0.000165939 │
-    │ offset_bits_per_record_avg  │ 8           │
-    │ offset_vectors_sz_mb        │ 5.72205e-06 │
-    │ offsets_per_term_avg        │ 0.272727    │
-    │ records_per_doc_avg         │ 5.5         │
+    │ offset_bits_per_record_avg  │ nan         │
+    │ offset_vectors_sz_mb        │ 0           │
+    │ offsets_per_term_avg        │ 0           │
+    │ records_per_doc_avg         │ 5           │
     │ sortable_values_size_mb     │ 0           │
-    │ total_indexing_time         │ 0.197       │
-    │ total_inverted_index_blocks │ 12          │
-    │ vector_index_sz_mb          │ 0.0201416   │
+    │ total_indexing_time         │ 0.239       │
+    │ total_inverted_index_blocks │ 11          │
+    │ vector_index_sz_mb          │ 0.235603    │
     ╰─────────────────────────────┴─────────────╯