Merge branch 'main' into release-rs-gilboa

Author: rrelledge

.github/workflows/redisvl_docs_sync.yaml

@@ -284,6 +284,9 @@ jobs:
             python3 build/version_archiver.py redisvl ${version} --skip-archive
           fi
 
+          # Globally replace unicode quotes to ASCII
+          find content/develop/ai/redisvl/ -type f -exec sed -i 's/[“”]/"/g' {} \;
+
       - name: 'Create pull request if necessary'
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

assets/css/index.css

@@ -259,16 +259,16 @@ select {
 }
 
 .search-item {
-  @apply bg-white rounded-md relative text-redis-ink-900 border border-redis-pen-800;
+  @apply bg-gray-700 rounded-md relative text-gray-300 border border-gray-600;
 }
 
 .search-item[aria-selected] {
-  @apply bg-red-100;
+  @apply bg-gray-600;
 }
 
 .search-item:hover,
 .search-item:not([aria-selected]):focus-within {
-  @apply bg-red-50 text-redis-pen-800;
+  @apply bg-gray-600 text-white;
 }
 
 .search-item > a {

content/develop/ai/langcache/api-examples.md

@@ -34,7 +34,7 @@ For example:
 curl -s -X POST "https://$HOST/v1/caches/$CACHE_ID/entries/search" \
     -H "accept: application/json" \
     -H "Authorization: Bearer $API_KEY" \
-    -d "{ 'prompt': 'What is semantic caching' }"
+    -d '{ "prompt": "What is semantic caching" }'
 {{< /clients-example >}}
 
 This example expects several variables to be set in the shell:

content/develop/ai/redisvl/0.6.0/api/cache.md

@@ -19,7 +19,7 @@ Semantic Cache for Large Language Models.
 
 * **Parameters:**
   * **name** (*str* *,* *optional*) – The name of the semantic cache search index.
-    Defaults to “llmcache”.
+    Defaults to "llmcache".
   * **distance_threshold** (*float* *,* *optional*) – Semantic threshold for the
     cache. Defaults to 0.1.
   * **ttl** (*Optional* *[* *int* *]* *,* *optional*) – The time-to-live for records cached
@@ -416,10 +416,10 @@ Embeddings Cache for storing embedding vectors with exact key matching.
 Initialize an embeddings cache.
 
 * **Parameters:**
-  * **name** (*str*) – The name of the cache. Defaults to “embedcache”.
+  * **name** (*str*) – The name of the cache. Defaults to "embedcache".
   * **ttl** (*Optional* *[* *int* *]*) – The time-to-live for cached embeddings. Defaults to None.
   * **redis_client** (*Optional* *[* *Redis* *]*) – Redis client instance. Defaults to None.
-  * **redis_url** (*str*) – Redis URL for connection. Defaults to “redis://localhost:6379”.
+  * **redis_url** (*str*) – Redis URL for connection. Defaults to "redis://localhost:6379".
   * **connection_kwargs** (*Dict* *[* *str* *,* *Any* *]*) – Redis connection arguments. Defaults to {}.
 * **Raises:**
   **ValueError** – If vector dimensions are invalid

content/develop/ai/redisvl/0.6.0/api/filter.md

@@ -126,7 +126,7 @@ f = Text("job") == "engineer"
 
 #### `__mod__(other)`
 
-Create a Text “LIKE” filter expression. A flexible expression that
+Create a Text "LIKE" filter expression. A flexible expression that
 yields filters that can use a variety of additional operators like
 wildcards (\*), fuzzy matches (%%), or combinatorics (|) of the supplied
 term(s).
@@ -344,9 +344,9 @@ Create a GeoRadius specification (GeoSpec)
   * **longitude** (*float*) – The longitude of the center of the radius.
   * **latitude** (*float*) – The latitude of the center of the radius.
   * **radius** (*int* *,* *optional*) – The radius of the circle. Defaults to 1.
-  * **unit** (*str* *,* *optional*) – The unit of the radius. Defaults to “km”.
+  * **unit** (*str* *,* *optional*) – The unit of the radius. Defaults to "km".
 * **Raises:**
-  **ValueError** – If the unit is not one of “m”, “km”, “mi”, or “ft”.
+  **ValueError** – If the unit is not one of "m", "km", "mi", or "ft".
 
 #### `__init__(longitude, latitude, radius=1, unit='km')`
 
@@ -356,6 +356,6 @@ Create a GeoRadius specification (GeoSpec)
   * **longitude** (*float*) – The longitude of the center of the radius.
   * **latitude** (*float*) – The latitude of the center of the radius.
   * **radius** (*int* *,* *optional*) – The radius of the circle. Defaults to 1.
-  * **unit** (*str* *,* *optional*) – The unit of the radius. Defaults to “km”.
+  * **unit** (*str* *,* *optional*) – The unit of the radius. Defaults to "km".
 * **Raises:**
-  **ValueError** – If the unit is not one of “m”, “km”, “mi”, or “ft”.
+  **ValueError** – If the unit is not one of "m", "km", "mi", or "ft".

content/develop/ai/redisvl/0.6.0/api/query.md

@@ -27,7 +27,7 @@ expression.
   * **filter_expression** (*Union* *[* *str* *,* [*FilterExpression*]({{< relref "filter/#filterexpression" >}}) *]* *,* *optional*) – A filter to apply
     along with the vector search. Defaults to None.
   * **dtype** (*str* *,* *optional*) – The dtype of the vector. Defaults to
-    “float32”.
+    "float32".
   * **num_results** (*int* *,* *optional*) – The top k results to return from the
     vector search. Defaults to 10.
   * **return_score** (*bool* *,* *optional*) – Whether to return the vector
@@ -40,14 +40,14 @@ expression.
     the same order as the terms in the query filter, regardless of
     the offsets between them. Defaults to False.
   * **hybrid_policy** (*Optional* *[* *str* *]*) – Controls how filters are applied during vector search.
-    Options are “BATCHES” (paginates through small batches of nearest neighbors) or
-    “ADHOC_BF” (computes scores for all vectors passing the filter).
-    “BATCHES” mode is typically faster for queries with selective filters.
-    “ADHOC_BF” mode is better when filters match a large portion of the dataset.
+    Options are "BATCHES" (paginates through small batches of nearest neighbors) or
+    "ADHOC_BF" (computes scores for all vectors passing the filter).
+    "BATCHES" mode is typically faster for queries with selective filters.
+    "ADHOC_BF" mode is better when filters match a large portion of the dataset.
     Defaults to None, which lets Redis auto-select the optimal policy.
-  * **batch_size** (*Optional* *[* *int* *]*) – When hybrid_policy is “BATCHES”, controls the number
+  * **batch_size** (*Optional* *[* *int* *]*) – When hybrid_policy is "BATCHES", controls the number
     of vectors to fetch in each batch. Larger values may improve performance
-    at the cost of memory usage. Only applies when hybrid_policy=”BATCHES”.
+    at the cost of memory usage. Only applies when hybrid_policy="BATCHES".
     Defaults to None, which lets Redis auto-select an appropriate batch size.
   * **ef_runtime** (*Optional* *[* *int* *]*) – Controls the size of the dynamic candidate list for HNSW
     algorithm at query time. Higher values improve recall at the expense of
@@ -90,7 +90,7 @@ Add a expander field to the query.
 
 Match only documents where the query terms appear in
 the same order in the document.
-i.e. for the query “hello world”, we do not match “world hello”
+i.e. for the query "hello world", we do not match "world hello"
 
 * **Return type:**
   *Query*
@@ -184,7 +184,7 @@ Default is TFIDF.
 Set the batch size for the query.
 
 * **Parameters:**
-  **batch_size** (*int*) – The batch size to use when hybrid_policy is “BATCHES”.
+  **batch_size** (*int*) – The batch size to use when hybrid_policy is "BATCHES".
 * **Raises:**
   * **TypeError** – If batch_size is not an integer
   * **ValueError** – If batch_size is not positive
@@ -215,8 +215,8 @@ Set the filter expression for the query.
 Set the hybrid policy for the query.
 
 * **Parameters:**
-  **hybrid_policy** (*str*) – The hybrid policy to use. Options are “BATCHES”
-  or “ADHOC_BF”.
+  **hybrid_policy** (*str*) – The hybrid policy to use. Options are "BATCHES"
+  or "ADHOC_BF".
 * **Raises:**
   **ValueError** – If hybrid_policy is not one of the valid options
 
@@ -336,7 +336,7 @@ distance threshold.
   * **filter_expression** (*Union* *[* *str* *,* [*FilterExpression*]({{< relref "filter/#filterexpression" >}}) *]* *,* *optional*) – A filter to apply
     along with the range query. Defaults to None.
   * **dtype** (*str* *,* *optional*) – The dtype of the vector. Defaults to
-    “float32”.
+    "float32".
   * **distance_threshold** (*float*) – The threshold for vector distance.
     A smaller threshold indicates a stricter semantic search.
     Defaults to 0.2.
@@ -357,14 +357,14 @@ distance threshold.
     the same order as the terms in the query filter, regardless of
     the offsets between them. Defaults to False.
   * **hybrid_policy** (*Optional* *[* *str* *]*) – Controls how filters are applied during vector search.
-    Options are “BATCHES” (paginates through small batches of nearest neighbors) or
-    “ADHOC_BF” (computes scores for all vectors passing the filter).
-    “BATCHES” mode is typically faster for queries with selective filters.
-    “ADHOC_BF” mode is better when filters match a large portion of the dataset.
+    Options are "BATCHES" (paginates through small batches of nearest neighbors) or
+    "ADHOC_BF" (computes scores for all vectors passing the filter).
+    "BATCHES" mode is typically faster for queries with selective filters.
+    "ADHOC_BF" mode is better when filters match a large portion of the dataset.
     Defaults to None, which lets Redis auto-select the optimal policy.
-  * **batch_size** (*Optional* *[* *int* *]*) – When hybrid_policy is “BATCHES”, controls the number
+  * **batch_size** (*Optional* *[* *int* *]*) – When hybrid_policy is "BATCHES", controls the number
     of vectors to fetch in each batch. Larger values may improve performance
-    at the cost of memory usage. Only applies when hybrid_policy=”BATCHES”.
+    at the cost of memory usage. Only applies when hybrid_policy="BATCHES".
     Defaults to None, which lets Redis auto-select an appropriate batch size.
   * **normalize_vector_distance** (*bool*) – Redis supports 3 distance metrics: L2 (euclidean),
     IP (inner product), and COSINE. By default, L2 distance returns an unbounded value.
@@ -404,7 +404,7 @@ Add a expander field to the query.
 
 Match only documents where the query terms appear in
 the same order in the document.
-i.e. for the query “hello world”, we do not match “world hello”
+i.e. for the query "hello world", we do not match "world hello"
 
 * **Return type:**
   *Query*
@@ -498,7 +498,7 @@ Default is TFIDF.
 Set the batch size for the query.
 
 * **Parameters:**
-  **batch_size** (*int*) – The batch size to use when hybrid_policy is “BATCHES”.
+  **batch_size** (*int*) – The batch size to use when hybrid_policy is "BATCHES".
 * **Raises:**
   * **TypeError** – If batch_size is not an integer
   * **ValueError** – If batch_size is not positive
@@ -539,8 +539,8 @@ Set the filter expression for the query.
 Set the hybrid policy for the query.
 
 * **Parameters:**
-  **hybrid_policy** (*str*) – The hybrid policy to use. Options are “BATCHES”
-  or “ADHOC_BF”.
+  **hybrid_policy** (*str*) – The hybrid policy to use. Options are "BATCHES"
+  or "ADHOC_BF".
 * **Raises:**
   **ValueError** – If hybrid_policy is not one of the valid options
 
@@ -693,20 +693,20 @@ Instantiates a HybridQuery object.
   * **vector** (*Union* *[* *bytes* *,* *List* *[* *float* *]* *]*) – The vector to perform vector similarity search.
   * **vector_field_name** (*str*) – The vector field name to search in.
   * **text_scorer** (*str* *,* *optional*) – The text scorer to use. Options are {TFIDF, TFIDF.DOCNORM,
-    BM25, DISMAX, DOCSCORE, BM25STD}. Defaults to “BM25STD”.
+    BM25, DISMAX, DOCSCORE, BM25STD}. Defaults to "BM25STD".
   * **filter_expression** (*Optional* *[*[*FilterExpression*]({{< relref "filter/#filterexpression" >}}) *]* *,* *optional*) – The filter expression to use.
     Defaults to None.
   * **alpha** (*float* *,* *optional*) – The weight of the vector similarity. Documents will be scored
     as: hybrid_score = (alpha) \* vector_score + (1-alpha) \* text_score.
     Defaults to 0.7.
-  * **dtype** (*str* *,* *optional*) – The data type of the vector. Defaults to “float32”.
+  * **dtype** (*str* *,* *optional*) – The data type of the vector. Defaults to "float32".
   * **num_results** (*int* *,* *optional*) – The number of results to return. Defaults to 10.
   * **return_fields** (*Optional* *[* *List* *[* *str* *]* *]* *,* *optional*) – The fields to return. Defaults to None.
   * **stopwords** (*Optional* *[* *Union* *[* *str* *,* *Set* *[* *str* *]* *]* *]* *,* *optional*) – The stopwords to remove from the
-    provided text prior to searchuse. If a string such as “english” “german” is
+    provided text prior to searchuse. If a string such as "english" "german" is
     provided then a default set of stopwords for that language will be used. if a list,
     set, or tuple of strings is provided then those will be used as stopwords.
-    Defaults to “english”. if set to “None” then no stopwords will be removed.
+    Defaults to "english". if set to "None" then no stopwords will be removed.
   * **dialect** (*int* *,* *optional*) – The Redis dialect version. Defaults to 2.
 * **Raises:**
   * **ValueError** – If the text string is empty, or if the text string becomes empty after
@@ -728,7 +728,7 @@ Specify one or more projection expressions to add to each result
 
 - **kwexpr**: One or more key-value pairs for a projection. The key is
   : the alias for the projection, and the value is the projection
-    expression itself, for example apply(square_root=”sqrt(@foo)”)
+    expression itself, for example apply(square_root="sqrt(@foo)")
 
 * **Return type:**
   *AggregateRequest*
@@ -986,7 +986,7 @@ Add a expander field to the query.
 
 Match only documents where the query terms appear in
 the same order in the document.
-i.e. for the query “hello world”, we do not match “world hello”
+i.e. for the query "hello world", we do not match "world hello"
 
 * **Return type:**
   *Query*
@@ -1198,7 +1198,7 @@ Add a expander field to the query.
 
 Match only documents where the query terms appear in
 the same order in the document.
-i.e. for the query “hello world”, we do not match “world hello”
+i.e. for the query "hello world", we do not match "world hello"
 
 * **Return type:**
   *Query*
@@ -1415,7 +1415,7 @@ Add a expander field to the query.
 
 Match only documents where the query terms appear in
 the same order in the document.
-i.e. for the query “hello world”, we do not match “world hello”
+i.e. for the query "hello world", we do not match "world hello"
 
 * **Return type:**
   *Query*

content/develop/ai/redisvl/0.6.0/api/vectorizer.md

@@ -671,7 +671,7 @@ Initialize the VoyageAI vectorizer.
 Visit [https://docs.voyageai.com/docs/embeddings](https://docs.voyageai.com/docs/embeddings) to learn about embeddings and check the available models.
 
 * **Parameters:**
-  * **model** (*str*) – Model to use for embedding. Defaults to “voyage-large-2”.
+  * **model** (*str*) – Model to use for embedding. Defaults to "voyage-large-2".
   * **api_config** (*Optional* *[* *Dict* *]* *,* *optional*) – Dictionary containing the API key.
     Defaults to None.
   * **dtype** (*str*) – the default datatype to use when embedding text as byte arrays.

content/develop/ai/redisvl/0.7.0/api/cache.md

@@ -19,7 +19,7 @@ Semantic Cache for Large Language Models.
 
 * **Parameters:**
   * **name** (*str* *,* *optional*) – The name of the semantic cache search index.
-    Defaults to “llmcache”.
+    Defaults to "llmcache".
   * **distance_threshold** (*float* *,* *optional*) – Semantic threshold for the
     cache. Defaults to 0.1.
   * **ttl** (*Optional* *[* *int* *]* *,* *optional*) – The time-to-live for records cached
@@ -416,10 +416,10 @@ Embeddings Cache for storing embedding vectors with exact key matching.
 Initialize an embeddings cache.
 
 * **Parameters:**
-  * **name** (*str*) – The name of the cache. Defaults to “embedcache”.
+  * **name** (*str*) – The name of the cache. Defaults to "embedcache".
   * **ttl** (*Optional* *[* *int* *]*) – The time-to-live for cached embeddings. Defaults to None.
   * **redis_client** (*Optional* *[* *SyncRedisClient* *]*) – Redis client instance. Defaults to None.
-  * **redis_url** (*str*) – Redis URL for connection. Defaults to “redis://localhost:6379”.
+  * **redis_url** (*str*) – Redis URL for connection. Defaults to "redis://localhost:6379".
   * **connection_kwargs** (*Dict* *[* *str* *,* *Any* *]*) – Redis connection arguments. Defaults to {}.
   * **async_redis_client** (*Redis* *|* *RedisCluster* *|* *None*)
 * **Raises:**

content/develop/ai/redisvl/0.7.0/api/filter.md

@@ -126,7 +126,7 @@ f = Text("job") == "engineer"
 
 #### `__mod__(other)`
 
-Create a Text “LIKE” filter expression. A flexible expression that
+Create a Text "LIKE" filter expression. A flexible expression that
 yields filters that can use a variety of additional operators like
 wildcards (\*), fuzzy matches (%%), or combinatorics (|) of the supplied
 term(s).
@@ -344,9 +344,9 @@ Create a GeoRadius specification (GeoSpec)
   * **longitude** (*float*) – The longitude of the center of the radius.
   * **latitude** (*float*) – The latitude of the center of the radius.
   * **radius** (*int* *,* *optional*) – The radius of the circle. Defaults to 1.
-  * **unit** (*str* *,* *optional*) – The unit of the radius. Defaults to “km”.
+  * **unit** (*str* *,* *optional*) – The unit of the radius. Defaults to "km".
 * **Raises:**
-  **ValueError** – If the unit is not one of “m”, “km”, “mi”, or “ft”.
+  **ValueError** – If the unit is not one of "m", "km", "mi", or "ft".
 
 #### `__init__(longitude, latitude, radius=1, unit='km')`
 
@@ -356,6 +356,6 @@ Create a GeoRadius specification (GeoSpec)
   * **longitude** (*float*) – The longitude of the center of the radius.
   * **latitude** (*float*) – The latitude of the center of the radius.
   * **radius** (*int* *,* *optional*) – The radius of the circle. Defaults to 1.
-  * **unit** (*str* *,* *optional*) – The unit of the radius. Defaults to “km”.
+  * **unit** (*str* *,* *optional*) – The unit of the radius. Defaults to "km".
 * **Raises:**
-  **ValueError** – If the unit is not one of “m”, “km”, “mi”, or “ft”.
+  **ValueError** – If the unit is not one of "m", "km", "mi", or "ft".