Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/redisvl_docs_sync.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,9 @@ jobs:
fi
done

# Globally replace unicode quotes to ASCII
find content/develop/ai/redisvl/ -type f -exec sed -i 's/[“”]/"/g' {} \;

if [ ${isLatest} = true ]; then
cp -r redis_vl_hugo/* content/develop/ai/redisvl/
else
Expand Down
6 changes: 3 additions & 3 deletions content/develop/ai/redisvl/0.6.0/api/cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions content/develop/ai/redisvl/0.6.0/api/filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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')`

Expand All @@ -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".
60 changes: 30 additions & 30 deletions content/develop/ai/redisvl/0.6.0/api/query.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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*
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -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*
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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*
Expand Down Expand Up @@ -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*
Expand Down Expand Up @@ -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*
Expand Down Expand Up @@ -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*
Expand Down
2 changes: 1 addition & 1 deletion content/develop/ai/redisvl/0.6.0/api/vectorizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions content/develop/ai/redisvl/0.7.0/api/cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:**
Expand Down
10 changes: 5 additions & 5 deletions content/develop/ai/redisvl/0.7.0/api/filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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')`

Expand All @@ -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".
Loading