documentation updates

redis · Jan 31, 2024 · 713e3d2 · 713e3d2
1 parent 23f1c50
commit 713e3d2
Show file tree

Hide file tree

Showing 15 changed files with 349 additions and 287 deletions.
diff --git a/docs/_static/gallery.yaml b/docs/_static/gallery.yaml
@@ -1,6 +1,6 @@
 
 - title: Arxiv Paper Search
-  website: https://docsearch.redisventures.com
+  website: https://docsearch.redisvl.com
   img-bottom: ../_static/gallery-images/arxiv-search.png
 - title: Real-Time Embeddings with Redis and Bytewax
   website: https://github.com/awmatheson/real-time-embeddings

diff --git a/docs/_static/js/sidebar.js b/docs/_static/js/sidebar.js
@@ -2,19 +2,18 @@ const toc = [
     { header: "Overview", toc: [
         { title: "RedisVL", path: "/index.html" },
         { title: "Install", path: "/overview/installation.html" },
-        { title: "CLI", path: "/user_guide/cli.html" },
+        { title: "CLI", path: "/overview/cli.html" },
     ]},
     { header: "User Guides", toc: [
         { title: "Getting Started", path: "/user_guide/getting_started_01.html" },
         { title: "Query and Filter", path: "/user_guide/hybrid_queries_02.html" },
         { title: "JSON vs Hash Storage", path: "/user_guide/hash_vs_json_05.html" },
         { title: "Vectorizers", path: "/user_guide/vectorizers_04.html" },
         { title: "Semantic Caching", path: "/user_guide/llmcache_03.html" },
-
     ]},
     { header: "API", toc: [
-        { title: "Schema", path: "/api/indexschema.html"},
-        { title: "Index", path: "/api/searchindex.html" },
+        { title: "Schema", path: "/api/schema.html"},
+        { title: "Search Index", path: "/api/searchindex.html" },
         { title: "Query", path: "/api/query.html" },
         { title: "Filter", path: "/api/filter.html" },
         { title: "Vectorizers", path: "/api/vectorizer.html" },

diff --git a/docs/api/index.md b/docs/api/index.md
@@ -11,7 +11,7 @@ myst:
 :caption: RedisVL
 :maxdepth: 2
 
-indexschema
+schema
 searchindex
 query
 filter

diff --git a/docs/api/indexschema.rst → docs/api/schema.rst b/docs/api/indexschema.rst → docs/api/schema.rst
diff --git a/docs/api/searchindex.rst b/docs/api/searchindex.rst
@@ -1,6 +1,17 @@
-***********
-SearchIndex
-***********
+********************
+Search Index Classes
+********************
+
+.. list-table::
+   :widths: 25 75
+   :header-rows: 1
+
+   * - Class
+     - Description
+   * - `SearchIndex <#searchindex_api>`_
+     - Primary class to write, read, and search across data structures in Redis.
+   * - `AsyncSearchIndex <#asyncsearchindex_api>`_
+     - Async version of the SearchIndex to write, read, and search across data structures in Redis.
 
 SearchIndex
 ===========
@@ -9,36 +20,19 @@ SearchIndex
 
 .. currentmodule:: redisvl.index
 
-.. autosummary::
-
-    SearchIndex.from_yaml
-    SearchIndex.from_dict
-    SearchIndex.client
-    SearchIndex.name
-    SearchIndex.prefix
-    SearchIndex.key_separator
-    SearchIndex.storage_type
-    SearchIndex.connect
-    SearchIndex.disconnect
-    SearchIndex.set_client
-    SearchIndex.create
-    SearchIndex.acreate
-    SearchIndex.exists
-    SearchIndex.aexists
-    SearchIndex.load
-    SearchIndex.aload
-    SearchIndex.search
-    SearchIndex.asearch
-    SearchIndex.query
-    SearchIndex.aquery
-    SearchIndex.query_batch
-    SearchIndex.aquery_batch
-    SearchIndex.delete
-    SearchIndex.adelete
-    SearchIndex.info
-    SearchIndex.ainfo
-
 .. autoclass:: SearchIndex
    :show-inheritance:
    :inherited-members:
    :members:
+
+AsyncSearchIndex
+================
+
+.. _asyncsearchindex_api:
+
+.. currentmodule:: redisvl.index
+
+.. autoclass:: AsyncSearchIndex
+   :show-inheritance:
+   :inherited-members:
+   :members: