0.0.3 Documentation Update (#48)

Author: Sam Partee

README.md

@@ -115,7 +115,41 @@ query = VectorQuery(
     return_fields=["user", "age", "job", "credit_score"],
     num_results=3,
 )
-results = index.search(query.query, query_params=query.params)
+results = index.query(query)
+
+```
+
+### Flexible Querying
+
+RedisVL supports a variety of filter types, including tag, numeric, geographic, and full text search to create filter expressions. Filter expressions can be used to create hybrid queries which allow you to combine multiple query types (i.e. text and vector search) into a single query.
+
+```python
+from redisvl.index import SearchIndex
+from redisvl.query import VectorQuery
+from redisvl.query.filter import Tag, Num, Geo, GeoRadius, Text
+
+# exact tag match
+is_sam = Tag("user") == "Sam"
+
+# numeric range
+is_over_10 = Num("age") > 10
+
+# geographic radius
+works_in_sf = Geo("location") == GeoRadius(37.7749, -122.4194, 10)
+
+# full text search with fuzzy match
+is_engineer = Text("job") % "enginee*"
+
+filter_expression = is_sam & is_over_10 & works_in_sf & is_engineer
+
+query = VectorQuery(
+    vector=[0.1, 0.1, 0.5],
+    vector_field_name="user_embedding",
+    return_fields=["user", "age", "job", "credit_score"],
+    num_results=3,
+    filter_expression=filter_expression,
+)
+results = index.query(query)
 
 ```
 

docs/_static/gallery-images/RedisOpenAI-QnA.png

@@ -0,0 +1,14 @@
+# Metadata to create our example gallery. This YAML file does two things:
+#
+# 1. Used by `generate_gallery_images.py` to take snapshots of each item and place an image in `gallery`.
+# 2. Used by our Gallery Grid directive to create the grid on our `examples/gallery.md` page.
+#
+# This file should only be modified by maintainer, contributors should add their project
+# to the list of `gallery.md`.
+
+- title: Question and Answer with OpenAI
+  website: https://www.redisvl.com/docs/html/examples/openai_qna.html
+  img-bottom: ../_static/gallery-images/RedisOpenAI-QnA.png
+- title: LLM Recommender for Hotels
+  website: https://github.com/RedisVentures/LLM-Recommender
+  img-bottom: ../_static/gallery-images/hotel-recommender.png

docs/_static/gallery-images/hotel-recommender.png

@@ -4,73 +4,107 @@ Filter
 
 .. _filter_api:
 
-TagFilter
-=========
+FilterExpression
+================
+
+.. currentmodule:: redisvl.query.filter
 
+.. autoclass:: FilterExpression
 
-.. currentmodule:: redisvl.query
+Tag
+===
+
+.. currentmodule:: redisvl.query.filter
 
 .. autosummary::
 
-    TagFilter.__init__
-    TagFilter.to_string
+    Tag.__init__
+    Tag.__eq__
+    Tag.__ne__
+    Tag.__str__
 
 
-.. autoclass:: TagFilter
+.. autoclass:: Tag
     :show-inheritance:
     :members:
+    :special-members:
     :inherited-members:
 
 
 
-TextFilter
-==========
+Text
+====
 
 
-.. currentmodule:: redisvl.query
+.. currentmodule:: redisvl.query.filter
 
 .. autosummary::
 
-    TextFilter.__init__
-    TextFilter.to_string
+    Text.__init__
+    Text.__eq__
+    Text.__ne__
+    Text.__mod__
+    Text.__str__
 
 
-.. autoclass:: TextFilter
+.. autoclass:: Text
     :show-inheritance:
     :members:
-    :inherited-members:
+    :special-members:
 
 
-NumericFilter
-=============
+Num
+===
 
 
-.. currentmodule:: redisvl.query
+.. currentmodule:: redisvl.query.filter
 
 .. autosummary::
 
-    NumericFilter.__init__
-    NumericFilter.to_string
+    Num.__init__
+    Num.__eq__
+    Num.__ne__
+    Num.__lt__
+    Num.__le__
+    Num.__gt__
+    Num.__ge__
+    Num.__str__
 
 
-.. autoclass:: NumericFilter
+.. autoclass:: Num
     :show-inheritance:
     :members:
-    :inherited-members:
+    :special-members:
 
 
-GeoFilter
-=========
+Geo
+===
 
-.. currentmodule:: redisvl.query
+.. currentmodule:: redisvl.query.filter
 
 .. autosummary::
 
-    GeoFilter.__init__
-    GeoFilter.to_string
+    Geo.__init__
+    Geo.__eq__
+    Geo.__ne__
+    Geo.__str__
+
+.. autoclass:: Geo
+    :show-inheritance:
+    :members:
+    :special-members:
+
+
+GeoRadius
+=========
+
+.. currentmodule:: redisvl.query.filter
+
+.. autosummary::
 
+    GeoRadius.__init__
 
-.. autoclass:: GeoFilter
+.. autoclass:: GeoRadius
     :show-inheritance:
     :members:
-    :inherited-members:
+    :special-members:

docs/_static/gallery.yaml

@@ -1,10 +1,10 @@
 
-*****
+**********
 Vectorizer
-*****
+**********
 
 HFTextVectorizer
-===========
+================
 
 .. _hftextvectorizer_api:
 
@@ -23,7 +23,7 @@ HFTextVectorizer
 
 
 OpenAITextVectorizer
-================
+====================
 
 .. _openaitextvectorizer_api:
 

docs/api/filter.rst

@@ -92,7 +92,9 @@
         "alt_text": "RedisVL",
     },
     "use_edit_page_button": True,
-    "show_toc_level": 1,
+    "show_toc_level": 4,
+    "show_nav_level": 3,
+    "navigation_depth": 5,
     "navbar_align": "left",  # [left, content, right] For testing that the navbar items align properly
     "secondary_sidebar_items": ["page-toc", "edit-this-page", "sourcelink"],
     "icon_links": [

docs/api/vectorizer.rst

@@ -5,10 +5,20 @@ myst:
         Examples for RedisVL users
 ---
 
+
 # Examples
 
+```{note}
+If you are using RedisVL, please consider adding your example to this page by
+opening a Pull Request on [GitHub](https://github.com/RedisVentures/RedisVl)
+```
+
+```{gallery-grid} ../_static/gallery.yaml
+:grid-columns: "1 1 2 2"
+```
 
 ```{toctree}
+:hidden:
 
 openai_qna
 

docs/changelog.rst

@@ -31,46 +31,12 @@ to supercharge your application!
   link: "examples/index"
 ```
 
-## Concepts (Coming Soon)
-
-Glossary of AI terminology and concepts related to vector databases.
-
-
-## User Guide
-
-How to use RedisVL
-
-```{toctree}
-:maxdepth: 2
-
-user_guide/index
-```
-
-
-## Examples
-
-Examples of RedisVL
-
-```{toctree}
-:maxdepth: 2
-
-examples/index
-```
-
-
-## API
-
-The redisVL API
+## Table of Contents
 
 ```{toctree}
 :maxdepth: 2
 
+User Guide <user_guide/index>
+Example Gallery <examples/index>
 API <api/index>
 ```
-
-
-```{toctree}
-:hidden:
-
-Changelog <https://github.com/RedisVentures/redisvl/releases>
-```