Format class and function signatures

Author: paoloredis

content/integrate/redisvl/api/cache.md

@@ -9,7 +9,7 @@ type: integration
 
 <a id="semantic-cache-api"></a>
 
-### *class* SemanticCache(name='llmcache', distance_threshold=0.1, ttl=None, vectorizer=None, filterable_fields=None, redis_client=None, redis_url='redis://localhost:6379', connection_kwargs={}, overwrite=False, \*\*kwargs)
+### `*class* SemanticCache(name='llmcache', distance_threshold=0.1, ttl=None, vectorizer=None, filterable_fields=None, redis_client=None, redis_url='redis://localhost:6379', connection_kwargs={}, overwrite=False, **kwargs)`
 
 Bases: `BaseLLMCache`
 
@@ -41,7 +41,7 @@ Semantic Cache for Large Language Models.
   * **ValueError** – If the threshold is not between 0 and 1.
   * **ValueError** – If existing schema does not match new schema and overwrite is False.
 
-#### *async* acheck(prompt=None, vector=None, num_results=1, return_fields=None, filter_expression=None, distance_threshold=None)
+#### `*async* acheck(prompt=None, vector=None, num_results=1, return_fields=None, filter_expression=None, distance_threshold=None)`
 
 Async check the semantic cache for results similar to the specified prompt
 or vector.
@@ -82,7 +82,7 @@ response = await cache.acheck(
 )
 ```
 
-#### *async* adrop(ids=None, keys=None)
+#### `*async* adrop(ids=None, keys=None)`
 
 Async expire specific entries from the cache by id or specific
 Redis key.
@@ -93,7 +93,7 @@ Redis key.
 * **Return type:**
   None
 
-#### *async* astore(prompt, response, vector=None, metadata=None, filters=None, ttl=None)
+#### `*async* astore(prompt, response, vector=None, metadata=None, filters=None, ttl=None)`
 
 Async stores the specified key-value pair in the cache along with metadata.
 
@@ -126,7 +126,7 @@ key = await cache.astore(
 )
 ```
 
-#### *async* aupdate(key, \*\*kwargs)
+#### `*async* aupdate(key, **kwargs)`
 
 Async update specific fields within an existing cache entry. If no fields
 are passed, then only the document TTL is refreshed.
@@ -147,7 +147,7 @@ await cache.aupdate(
 )
 ```
 
-#### check(prompt=None, vector=None, num_results=1, return_fields=None, filter_expression=None, distance_threshold=None)
+#### `check(prompt=None, vector=None, num_results=1, return_fields=None, filter_expression=None, distance_threshold=None)`
 
 Checks the semantic cache for results similar to the specified prompt
 or vector.
@@ -188,22 +188,22 @@ response = cache.check(
 )
 ```
 
-#### clear()
+#### `clear()`
 
 Clear the cache of all keys while preserving the index.
 
 * **Return type:**
   None
 
-#### delete()
+#### `delete()`
 
 Clear the semantic cache of all keys and remove the underlying search
 index.
 
 * **Return type:**
   None
 
-#### drop(ids=None, keys=None)
+#### `drop(ids=None, keys=None)`
 
 Manually expire specific entries from the cache by id or specific
 Redis key.
@@ -214,7 +214,7 @@ Redis key.
 * **Return type:**
   None
 
-#### set_threshold(distance_threshold)
+#### `set_threshold(distance_threshold)`
 
 Sets the semantic distance threshold for the cache.
 
@@ -226,7 +226,7 @@ Sets the semantic distance threshold for the cache.
 * **Return type:**
   None
 
-#### set_ttl(ttl=None)
+#### `set_ttl(ttl=None)`
 
 Set the default TTL, in seconds, for entries in the cache.
 
@@ -236,7 +236,7 @@ Set the default TTL, in seconds, for entries in the cache.
 * **Raises:**
   **ValueError** – If the time-to-live value is not an integer.
 
-#### store(prompt, response, vector=None, metadata=None, filters=None, ttl=None)
+#### `store(prompt, response, vector=None, metadata=None, filters=None, ttl=None)`
 
 Stores the specified key-value pair in the cache along with metadata.
 
@@ -269,7 +269,7 @@ key = cache.store(
 )
 ```
 
-#### update(key, \*\*kwargs)
+#### `update(key, **kwargs)`
 
 Update specific fields within an existing cache entry. If no fields
 are passed, then only the document TTL is refreshed.
@@ -288,7 +288,7 @@ cache.update(key, metadata={"hit_count": 1, "model_name": "Llama-2-7b"})
 )
 ```
 
-#### *property* aindex *: [AsyncSearchIndex]({{< relref "searchindex/#asyncsearchindex" >}}) | None*
+#### `*property* aindex *: [AsyncSearchIndex]({{< relref "searchindex/#asyncsearchindex" >}}) | None*`
 
 The underlying AsyncSearchIndex for the cache.
 
@@ -297,7 +297,7 @@ The underlying AsyncSearchIndex for the cache.
 * **Return type:**
   [AsyncSearchIndex]({{< relref "searchindex/#asyncsearchindex" >}})
 
-#### *property* distance_threshold *: float*
+#### `*property* distance_threshold *: float*`
 
 The semantic distance threshold for the cache.
 
@@ -306,7 +306,7 @@ The semantic distance threshold for the cache.
 * **Return type:**
   float
 
-#### *property* index *: [SearchIndex]({{< relref "searchindex/#searchindex" >}})*
+#### `*property* index *: [SearchIndex]({{< relref "searchindex/#searchindex" >}})*`
 
 The underlying SearchIndex for the cache.
 
@@ -315,6 +315,6 @@ The underlying SearchIndex for the cache.
 * **Return type:**
   [SearchIndex]({{< relref "searchindex/#searchindex" >}})
 
-#### *property* ttl *: int | None*
+#### `*property* ttl *: int | None*`
 
 The default TTL, in seconds, for entries in the cache.

content/integrate/redisvl/api/filter.md

@@ -9,7 +9,7 @@ type: integration
 
 ## FilterExpression
 
-### *class* FilterExpression(\_filter=None, operator=None, left=None, right=None)
+### `*class* FilterExpression(_filter=None, operator=None, left=None, right=None)`
 
 A FilterExpression is a logical combination of filters in RedisVL.
 
@@ -44,7 +44,7 @@ v = VectorQuery(
 )
 ```
 
-#### NOTE
+#### `NOTE`
 Filter expressions are typically not called directly. Instead they are
 built by combining filter statements using the & and | operators.
 
@@ -56,14 +56,14 @@ built by combining filter statements using the & and | operators.
 
 ## Tag
 
-### *class* Tag(field)
+### `*class* Tag(field)`
 
 A Tag filter can be applied to Tag fields
 
 * **Parameters:**
   **field** (*str*)
 
-#### \_\_eq_\_(other)
+#### `__eq__(other)`
 
 Create a Tag equality filter expression.
 
@@ -78,7 +78,7 @@ from redisvl.query.filter import Tag
 f = Tag("brand") == "nike"
 ```
 
-#### \_\_ne_\_(other)
+#### `__ne__(other)`
 
 Create a Tag inequality filter expression.
 
@@ -92,7 +92,7 @@ from redisvl.query.filter import Tag
 f = Tag("brand") != "nike"
 ```
 
-#### \_\_str_\_()
+#### `__str__()`
 
 Return the Redis Query string for the Tag filter
 
@@ -101,14 +101,14 @@ Return the Redis Query string for the Tag filter
 
 ## Text
 
-### *class* Text(field)
+### `*class* Text(field)`
 
 A Text is a FilterField representing a text field in a Redis index.
 
 * **Parameters:**
   **field** (*str*)
 
-#### \_\_eq_\_(other)
+#### `__eq__(other)`
 
 Create a Text equality filter expression. These expressions yield
 filters that enforce an exact match on the supplied term(s).
@@ -124,7 +124,7 @@ from redisvl.query.filter import Text
 f = Text("job") == "engineer"
 ```
 
-#### \_\_mod_\_(other)
+#### `__mod__(other)`
 
 Create a Text “LIKE” filter expression. A flexible expression that
 yields filters that can use a variety of additional operators like
@@ -145,7 +145,7 @@ f = Text("job") % "engineer|doctor" # contains either term in field
 f = Text("job") % "engineer doctor" # contains both terms in field
 ```
 
-#### \_\_ne_\_(other)
+#### `__ne__(other)`
 
 Create a Text inequality filter expression. These expressions yield
 negated filters on exact matches on the supplied term(s). Opposite of an
@@ -162,7 +162,7 @@ from redisvl.query.filter import Text
 f = Text("job") != "engineer"
 ```
 
-#### \_\_str_\_()
+#### `__str__()`
 
 Return the Redis Query string for the Text filter
 
@@ -171,14 +171,14 @@ Return the Redis Query string for the Text filter
 
 ## Num
 
-### *class* Num(field)
+### `*class* Num(field)`
 
 A Num is a FilterField representing a numeric field in a Redis index.
 
 * **Parameters:**
   **field** (*str*)
 
-#### \_\_eq_\_(other)
+#### `__eq__(other)`
 
 Create a Numeric equality filter expression.
 
@@ -192,7 +192,7 @@ from redisvl.query.filter import Num
 f = Num("zipcode") == 90210
 ```
 
-#### \_\_ge_\_(other)
+#### `__ge__(other)`
 
 Create a Numeric greater than or equal to filter expression.
 
@@ -207,7 +207,7 @@ from redisvl.query.filter import Num
 f = Num("age") >= 18
 ```
 
-#### \_\_gt_\_(other)
+#### `__gt__(other)`
 
 Create a Numeric greater than filter expression.
 
@@ -222,7 +222,7 @@ from redisvl.query.filter import Num
 f = Num("age") > 18
 ```
 
-#### \_\_le_\_(other)
+#### `__le__(other)`
 
 Create a Numeric less than or equal to filter expression.
 
@@ -237,7 +237,7 @@ from redisvl.query.filter import Num
 f = Num("age") <= 18
 ```
 
-#### \_\_lt_\_(other)
+#### `__lt__(other)`
 
 Create a Numeric less than filter expression.
 
@@ -252,7 +252,7 @@ from redisvl.query.filter import Num
 f = Num("age") < 18
 ```
 
-#### \_\_ne_\_(other)
+#### `__ne__(other)`
 
 Create a Numeric inequality filter expression.
 
@@ -267,7 +267,7 @@ from redisvl.query.filter import Num
 f = Num("zipcode") != 90210
 ```
 
-#### \_\_str_\_()
+#### `__str__()`
 
 Return the Redis Query string for the Numeric filter
 
@@ -276,15 +276,15 @@ Return the Redis Query string for the Numeric filter
 
 ## Geo
 
-### *class* Geo(field)
+### `*class* Geo(field)`
 
 A Geo is a FilterField representing a geographic (lat/lon) field in a
 Redis index.
 
 * **Parameters:**
   **field** (*str*)
 
-#### \_\_eq_\_(other)
+#### `__eq__(other)`
 
 Create a geographic filter within a specified GeoRadius.
 
@@ -299,7 +299,7 @@ from redisvl.query.filter import Geo, GeoRadius
 f = Geo("location") == GeoRadius(-122.4194, 37.7749, 1, unit="m")
 ```
 
-#### \_\_ne_\_(other)
+#### `__ne__(other)`
 
 Create a geographic filter outside of a specified GeoRadius.
 
@@ -314,7 +314,7 @@ from redisvl.query.filter import Geo, GeoRadius
 f = Geo("location") != GeoRadius(-122.4194, 37.7749, 1, unit="m")
 ```
 
-#### \_\_str_\_()
+#### `__str__()`
 
 Return the Redis Query string for the Geo filter
 
@@ -323,7 +323,7 @@ Return the Redis Query string for the Geo filter
 
 ## GeoRadius
 
-### *class* GeoRadius(longitude, latitude, radius=1, unit='km')
+### `*class* GeoRadius(longitude, latitude, radius=1, unit='km')`
 
 A GeoRadius is a GeoSpec representing a geographic radius.
 
@@ -337,7 +337,7 @@ Create a GeoRadius specification (GeoSpec)
 * **Raises:**
   **ValueError** – If the unit is not one of “m”, “km”, “mi”, or “ft”.
 
-#### \_\_init_\_(longitude, latitude, radius=1, unit='km')
+#### `__init__(longitude, latitude, radius=1, unit='km')`
 
 Create a GeoRadius specification (GeoSpec)