Refactor Redis Storage and add JSON support

docs/_extension/gallery_directive.py

@@ -1,12 +1,12 @@
 """A directive to generate a gallery of images from structured data.
 
-Generating a gallery of images that are all the same size is a common
-pattern in documentation, and this can be cumbersome if the gallery is
-generated programmatically. This directive wraps this particular use-case
-in a helper-directive to generate it with a single YAML configuration file.
+Generating a gallery of images that are all the same size is a common pattern in
+documentation, and this can be cumbersome if the gallery is generated
+programmatically. This directive wraps this particular use-case in a helper-
+directive to generate it with a single YAML configuration file.
 
-It currently exists for maintainers of the pydata-sphinx-theme,
-but might be abstracted into a standalone package if it proves useful.
+It currently exists for maintainers of the pydata-sphinx-theme, but might be
+abstracted into a standalone package if it proves useful.
 """
 from pathlib import Path
 from typing import Any, Dict, List

docs/api/searchindex.rst

@@ -13,18 +13,23 @@ SearchIndex
 .. autosummary::
 
     SearchIndex.__init__
+    SearchIndex.client
+    SearchIndex.name
+    SearchIndex.prefix
+    SearchIndex.key_separator
+    SearchIndex.storage
+    SearchIndex.storage_type
     SearchIndex.from_yaml
     SearchIndex.from_dict
     SearchIndex.from_existing
+    SearchIndex.connect
+    SearchIndex.create
+    SearchIndex.load
     SearchIndex.search
     SearchIndex.query
-    SearchIndex.create
     SearchIndex.delete
-    SearchIndex.load
-    SearchIndex.client
-    SearchIndex.connect
-    SearchIndex.disconnect
     SearchIndex.info
+    SearchIndex.disconnect
 
 
 
@@ -44,17 +49,23 @@ AsyncSearchIndex
 .. autosummary::
 
     AsyncSearchIndex.__init__
+    AsyncSearchIndex.client
+    AsyncSearchIndex.name
+    AsyncSearchIndex.prefix
+    AsyncSearchIndex.key_separator
+    AsyncSearchIndex.storage
+    AsyncSearchIndex.storage_type
     AsyncSearchIndex.from_yaml
     AsyncSearchIndex.from_dict
     AsyncSearchIndex.from_existing
+    AsyncSearchIndex.connect
+    AsyncSearchIndex.create
+    AsyncSearchIndex.load
     AsyncSearchIndex.search
     AsyncSearchIndex.query
-    AsyncSearchIndex.create
     AsyncSearchIndex.delete
-    AsyncSearchIndex.load
-    AsyncSearchIndex.connect
-    AsyncSearchIndex.disconnect
     AsyncSearchIndex.info
+    AsyncSearchIndex.disconnect
 
 
 

docs/examples/openai_qna.ipynb

@@ -46,7 +46,7 @@
    "source": [
     "# first we need to install a few things\n",
     "\n",
-    "!pip install pandas wget tenacity tiktoken openai"
+    "!pip install pandas wget tenacity tiktoken openai==0.28.1"
    ]
   },
   {

docs/user_guide/getting_started_01.ipynb

@@ -127,6 +127,8 @@
     "index:\n",
     "  name: user_index\n",
     "  prefix: user\n",
+    "  storage_type: hash\n",
+    "  key_separator: ':'\n",
     "\n",
     "fields:\n",
     "    # define tag fields\n",
@@ -162,6 +164,8 @@
     "    \"index\": {\n",
     "        \"name\": \"user_index\",\n",
     "        \"prefix\": \"user\",\n",
+    "        \"storage_type\": \"hash\",\n",
+    "        \"key_separator\": \":\"\n",
     "    },\n",
     "    \"fields\": {\n",
     "        \"tag\": [{\"name\": \"credit_score\"}],\n",
@@ -465,7 +469,7 @@
    ],
    "source": [
     "# create a new SearchIndex instance from an existing index\n",
-    "existing_index = SearchIndex.from_existing(\"user_index\", \"redis://localhost:6379\")\n",
+    "existing_index = SearchIndex.from_existing(name=\"user_index\", redis_url=\"redis://localhost:6379\")\n",
     "\n",
     "# run the same query\n",
     "results = existing_index.query(query)\n",