update doc strings for Hybrid and Text

Author: rbs333

docs/api/query.rst

@@ -34,6 +34,34 @@ VectorRangeQuery
    :show-inheritance:
    :exclude-members: add_filter,get_args,highlight,return_field,summarize
 
+HybridQuery
+================
+
+
+.. currentmodule:: redisvl.query
+
+
+.. autoclass:: HybridQuery
+   :members:
+   :inherited-members:
+   :show-inheritance:
+   :exclude-members: add_filter,get_args,highlight,return_field,summarize
+
+
+TextQuery
+================
+
+
+.. currentmodule:: redisvl.query
+
+
+.. autoclass:: TextQuery
+   :members:
+   :inherited-members:
+   :show-inheritance:
+   :exclude-members: add_filter,get_args,highlight,return_field,summarize
+
+
 FilterQuery
 ===========
 

redisvl/query/aggregate.py

@@ -23,6 +23,31 @@ class HybridQuery(AggregationQuery):
     HybridQuery combines text and vector search in Redis.
     It allows you to perform a hybrid search using both text and vector similarity.
     It scores documents based on a weighted combination of text and vector similarity.
+
+     .. code-block:: python
+
+        from redisvl.query import HybridQuery
+        from redisvl.index import SearchIndex
+
+        index = SearchIndex.from_yaml("path/to/index.yaml")
+
+        query = HybridQuery(
+            text="example text",
+            text_field_name="text_field",
+            vector=[0.1, 0.2, 0.3],
+            vector_field_name="vector_field",
+            text_scorer="BM25STD",
+            filter_expression=None,
+            alpha=0.7,
+            dtype="float32",
+            num_results=10,
+            return_fields=["field1", "field2"],
+            stopwords="english",
+            dialect=2,
+        )
+
+        results = index.query(query)
+
     """
 
     DISTANCE_ID: str = "vector_distance"
@@ -72,29 +97,6 @@ def __init__(
             ValueError: If the text string is empty, or if the text string becomes empty after
                 stopwords are removed.
             TypeError: If the stopwords are not a set, list, or tuple of strings.
-
-        .. code-block:: python
-            from redisvl.query import HybridQuery
-            from redisvl.index import SearchIndex
-
-            index = SearchIndex.from_yaml("path/to/index.yaml")
-
-            query = HybridQuery(
-                text="example text",
-                text_field_name="text_field",
-                vector=[0.1, 0.2, 0.3],
-                vector_field_name="vector_field",
-                text_scorer="BM25STD",
-                filter_expression=None,
-                alpha=0.7,
-                dtype="float32",
-                num_results=10,
-                return_fields=["field1", "field2"],
-                stopwords="english",
-                dialect=2,
-            )
-
-            results = index.query(query)
         """
 
         if not text.strip():

redisvl/query/query.py

@@ -690,6 +690,30 @@ class RangeQuery(VectorRangeQuery):
 
 
 class TextQuery(BaseQuery):
+    """
+    TextQuery is a query for running a full text search, along with an optional filter expression.
+
+    .. code-block:: python
+
+        from redisvl.query import TextQuery
+        from redisvl.index import SearchIndex
+
+        index = SearchIndex.from_yaml(index.yaml)
+
+        query = TextQuery(
+            text="example text",
+            text_field_name="text_field",
+            text_scorer="BM25STD",
+            filter_expression=None,
+            num_results=10,
+            return_fields=["field1", "field2"],
+            stopwords="english",
+            dialect=2,
+        )
+
+        results = index.query(query)
+    """
+
     def __init__(
         self,
         text: str,
@@ -739,25 +763,6 @@ def __init__(
         Raises:
             ValueError: if stopwords language string cannot be loaded.
             TypeError: If stopwords is not a valid iterable set of strings.
-
-        .. code-block:: python
-            from redisvl.query import TextQuery
-            from redisvl.index import SearchIndex
-
-            index = SearchIndex.from_yaml(index.yaml)
-
-            query = TextQuery(
-                text="example text",
-                text_field_name="text_field",
-                text_scorer="BM25STD",
-                filter_expression=None,
-                num_results=10,
-                return_fields=["field1", "field2"],
-                stopwords="english",
-                dialect=2,
-            )
-
-            results = index.query(query)
         """
         self._text = text
         self._text_field = text_field_name