From efda34b38e9b576b9524d784e286807ef7143d8a Mon Sep 17 00:00:00 2001 From: Tyler Hutcherson Date: Thu, 31 Oct 2024 12:00:29 -0400 Subject: [PATCH] Release 0.3.6 (#240) --- docs/_static/version_names.json | 9 +++++++-- docs/overview/cli.ipynb | 2 +- pyproject.toml | 2 +- redisvl/index/index.py | 20 ++++++++++++++++++++ redisvl/version.py | 2 +- 5 files changed, 30 insertions(+), 5 deletions(-) diff --git a/docs/_static/version_names.json b/docs/_static/version_names.json index 6194ec72..9553271b 100644 --- a/docs/_static/version_names.json +++ b/docs/_static/version_names.json @@ -1,10 +1,15 @@ [ { - "name": "0.3.5 (stable)", - "version": "0.3.5", + "name": "0.3.6 (stable)", + "version": "0.3.6", "url": "/", "preferred": true }, + { + "name": "0.3.5", + "version": "0.3.5", + "url": "/0.3.5/" + }, { "name": "0.3.4", "version": "0.3.4", diff --git a/docs/overview/cli.ipynb b/docs/overview/cli.ipynb index 20b958e2..7ec5e684 100644 --- a/docs/overview/cli.ipynb +++ b/docs/overview/cli.ipynb @@ -24,7 +24,7 @@ "name": "stdout", "output_type": "stream", "text": [ - "\u001b[32m15:46:57\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m RedisVL version 0.3.5\n" + "\u001b[32m11:14:08\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m RedisVL version 0.3.6\n" ] } ], diff --git a/pyproject.toml b/pyproject.toml index 1f4c2c28..08f3d8e2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "redisvl" -version = "0.3.5" +version = "0.3.6" description = "Python client library and CLI for using Redis as a vector database" authors = ["Redis Inc. "] license = "MIT" diff --git a/redisvl/index/index.py b/redisvl/index/index.py index 025d6ce9..8914b4c9 100644 --- a/redisvl/index/index.py +++ b/redisvl/index/index.py @@ -314,6 +314,16 @@ def from_existing( redis_url: Optional[str] = None, **kwargs, ): + """ + Initialize from an existing search index in Redis by index name. + + Args: + name (str): Name of the search index in Redis. + redis_client(Optional[redis.Redis]): An + instantiated redis client. + redis_url (Optional[str]): The URL of the Redis server to + connect to. + """ # Handle redis instance if redis_url: redis_client = RedisConnectionFactory.connect( @@ -844,6 +854,16 @@ async def from_existing( redis_url: Optional[str] = None, **kwargs, ): + """ + Initialize from an existing search index in Redis by index name. + + Args: + name (str): Name of the search index in Redis. + redis_client(Optional[redis.Redis]): An + instantiated redis client. + redis_url (Optional[str]): The URL of the Redis server to + connect to. + """ if redis_url: redis_client = RedisConnectionFactory.connect( redis_url=redis_url, use_async=True, **kwargs diff --git a/redisvl/version.py b/redisvl/version.py index a8d4557d..d7b30e12 100644 --- a/redisvl/version.py +++ b/redisvl/version.py @@ -1 +1 @@ -__version__ = "0.3.5" +__version__ = "0.3.6"