Improve redisvl module structure (#106)

In order to position RedisVL for growth and adhere to some best
practices, this PR moves around a few submodules and packages things in
a better way overall:

```
redisvl
├── __init__.py
├── cli
│   ├── __init__.py
│   ├── index.py
│   ├── main.py
│   ├── runner.py
│   ├── stats.py
│   ├── utils.py
│   └── version.py
├── extensions
│   ├── __init__.py
│   └── llmcache
│       ├── __init__.py
│       ├── base.py
│       └── semantic.py
├── index
│   ├── __init__.py
│   ├── index.py
│   └── storage.py
├── query
│   ├── __init__.py
│   ├── filter.py
│   └── query.py
├── redis
│   ├── __init__.py
│   ├── connection.py
│   ├── constants.py
│   └── utils.py
├── schema
│   ├── __init__.py
│   ├── fields.py
│   └── schema.py
├── utils
│   ├── __init__.py
│   ├── log.py
│   ├── token_escaper.py
│   └── vectorize
│       ├── __init__.py
│       ├── base.py
│       └── text
│           ├── __init__.py
│           ├── cohere.py
│           ├── huggingface.py
│           ├── openai.py
│           └── vertexai.py
└── version.py
```

- Move vectorizers under utils (since its a useful tool)
- Create an extensions module and add llmcache. Others will be added
there too.

Author: tylerhutcherson

docs/examples/openai_qna.ipynb

@@ -574,7 +574,7 @@
     "import os\n",
     "import getpass\n",
     "\n",
-    "from redisvl.vectorize.text import OpenAITextVectorizer\n",
+    "from redisvl.utils.vectorize import OpenAITextVectorizer\n",
     "\n",
     "api_key = os.getenv(\"OPENAI_API_KEY\") or getpass.getpass(\"Enter your OpenAI API key: \")\n",
     "oaip = OpenAITextVectorizer(EMBEDDINGS_MODEL, api_config={\"api_key\": api_key})\n",
@@ -859,7 +859,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from redisvl.llmcache import SemanticCache\n",
+    "from redisvl.extensions.llmcache import SemanticCache\n",
     "\n",
     "cache = SemanticCache(redis_url=\"redis://localhost:6379\", distance_threshold=0.2)"
    ]

docs/user_guide/getting_started_01.ipynb

@@ -379,7 +379,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    ">By default, `load` will create a unique Redis \"key\" as a combination of the index key `prefix` and a UUID. You can also customize the key by providing direct keys or pointing to a specified `key_field` on load."
+    ">By default, `load` will create a unique Redis \"key\" as a combination of the index key `prefix` and a UUID. You can also customize the key by providing direct keys or pointing to a specified `id_field` on load."
    ]
   },
   {

docs/user_guide/llmcache_03.ipynb

@@ -79,7 +79,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from redisvl.llmcache import SemanticCache\n",
+    "from redisvl.extensions.llmcache import SemanticCache\n",
     "\n",
     "llmcache = SemanticCache(\n",
     "    name=\"llmcache\",                     # underlying search index name\n",

docs/user_guide/vectorizers_04.ipynb

@@ -107,7 +107,7 @@
     }
    ],
    "source": [
-    "from redisvl.vectorize.text import OpenAITextVectorizer\n",
+    "from redisvl.utils.vectorize import OpenAITextVectorizer\n",
     "\n",
     "# create a vectorizer\n",
     "oai = OpenAITextVectorizer(\n",
@@ -224,7 +224,7 @@
    ],
    "source": [
     "os.environ[\"TOKENIZERS_PARALLELISM\"] = \"false\"\n",
-    "from redisvl.vectorize.text import HFTextVectorizer\n",
+    "from redisvl.utils.vectorize import HFTextVectorizer\n",
     "\n",
     "\n",
     "# create a vectorizer\n",
@@ -297,7 +297,7 @@
     }
    ],
    "source": [
-    "from redisvl.vectorize.text import VertexAITextVectorizer\n",
+    "from redisvl.utils.vectorize import VertexAITextVectorizer\n",
     "\n",
     "\n",
     "# create a vectorizer\n",
@@ -363,7 +363,7 @@
     }
    ],
    "source": [
-    "from redisvl.vectorize.text import CohereTextVectorizer\n",
+    "from redisvl.utils.vectorize import CohereTextVectorizer\n",
     "\n",
     "# create a vectorizer\n",
     "co = CohereTextVectorizer(\n",

redisvl/vectorize/__init__.py renamed to redisvl/extensions/__init__.py

@@ -0,0 +1,3 @@
+from redisvl.extensions.llmcache.semantic import SemanticCache
+
+__all__ = ["SemanticCache"]

redisvl/extensions/llmcache/__init__.py

@@ -2,13 +2,12 @@
 
 from redis import Redis
 
+from redisvl.extensions.llmcache.base import BaseLLMCache
 from redisvl.index import SearchIndex
-from redisvl.llmcache.base import BaseLLMCache
 from redisvl.query import RangeQuery
 from redisvl.redis.utils import array_to_buffer
 from redisvl.schema.schema import IndexSchema
-from redisvl.vectorize.base import BaseVectorizer
-from redisvl.vectorize.text import HFTextVectorizer
+from redisvl.utils.vectorize import BaseVectorizer, HFTextVectorizer
 
 
 class SemanticCache(BaseLLMCache):
@@ -331,5 +330,5 @@ def store(
             payload[self.metadata_field_name] = self.serialize(metadata)
 
         # Load LLMCache entry with TTL
-        keys = self._index.load(data=[payload], ttl=self._ttl, key_field=id_field)
+        keys = self._index.load(data=[payload], ttl=self._ttl, id_field=id_field)
         return keys[0]

redisvl/llmcache/base.py renamed to redisvl/extensions/llmcache/base.py

@@ -0,0 +1,3 @@
+from redisvl.index.index import AsyncSearchIndex, SearchIndex
+
+__all__ = ["SearchIndex", "AsyncSearchIndex"]

redisvl/llmcache/semantic.py renamed to redisvl/extensions/llmcache/semantic.py

@@ -22,11 +22,11 @@
 import redis.asyncio as aredis
 from redis.commands.search.indexDefinition import IndexDefinition
 
+from redisvl.index.storage import HashStorage, JsonStorage
 from redisvl.query.query import BaseQuery, CountQuery, FilterQuery
 from redisvl.redis.connection import RedisConnectionFactory
 from redisvl.redis.utils import convert_bytes
 from redisvl.schema import IndexSchema, StorageType
-from redisvl.storage import HashStorage, JsonStorage
 from redisvl.utils.log import get_logger
 
 logger = get_logger(__name__)
@@ -454,7 +454,7 @@ def delete(self, drop: bool = True):
     def load(
         self,
         data: Iterable[Any],
-        key_field: Optional[str] = None,
+        id_field: Optional[str] = None,
         keys: Optional[Iterable[str]] = None,
         ttl: Optional[int] = None,
         preprocess: Optional[Callable] = None,
@@ -465,7 +465,8 @@ def load(
 
         Args:
             data (Iterable[Any]): An iterable of objects to store.
-            key_field (Optional[str], optional): Field used as the key for each
+            id_field (Optional[str], optional): Specified field used as the id
+                portion of the redis key (after the prefix) for each
                 object. Defaults to None.
             keys (Optional[Iterable[str]], optional): Optional iterable of keys.
                 Must match the length of objects if provided. Defaults to None.
@@ -492,7 +493,7 @@ def load(
             return self._storage.write(
                 self._redis_client,  # type: ignore
                 objects=data,
-                key_field=key_field,
+                id_field=id_field,
                 keys=keys,
                 ttl=ttl,
                 preprocess=preprocess,
@@ -792,7 +793,7 @@ async def delete(self, drop: bool = True):
     async def load(
         self,
         data: Iterable[Any],
-        key_field: Optional[str] = None,
+        id_field: Optional[str] = None,
         keys: Optional[Iterable[str]] = None,
         ttl: Optional[int] = None,
         preprocess: Optional[Callable] = None,
@@ -803,7 +804,8 @@ async def load(
 
         Args:
             data (Iterable[Any]): An iterable of objects to store.
-            key_field (Optional[str], optional): Field used as the key for each
+            id_field (Optional[str], optional): Specified field used as the id
+                portion of the redis key (after the prefix) for each
                 object. Defaults to None.
             keys (Optional[Iterable[str]], optional): Optional iterable of keys.
                 Must match the length of objects if provided. Defaults to None.
@@ -831,7 +833,7 @@ async def load(
             return await self._storage.awrite(
                 self._redis_client,  # type: ignore
                 objects=data,
-                key_field=key_field,
+                id_field=id_field,
                 keys=keys,
                 ttl=ttl,
                 preprocess=preprocess,