Skip to content

Commit 4175764

Browse files
mich-elle-lunamich-elle-luna
authored
Merge pull request #1770 from redis/DOC-5395
Move redisvl documentation
2 parents b979e97 + 0bba322 commit 4175764

38 files changed

+100
-50
lines changed

‎.github/workflows/redisvl_docs_sync.yaml‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ jobs:
6666
---
6767
linkTitle: ${linkTitle}
6868
title: ${title}
69-
type: integration
7069
EOL
7170
7271
# Inject weight property for index pages to preserve order
@@ -125,7 +124,7 @@ jobs:
125124
sed -E -i 's/^> *//g; s/\x1b\[[0-9;]*m//g' "${markdown_page}"
126125
127126
# Replace https://docs.redisvl.com links
128-
sed -E -i 's#https://docs.redisvl.com/en/latest/.+/([^_]+).+\.html(\#[^)]+)#{{< relref "\1\2" >}}#g; s#https://docs.redisvl.com/en/latest/(.+)\.html#https://redis.io/docs/latest/integrate/redisvl/\1#g' "${markdown_page}"
127+
sed -E -i 's#https://docs.redisvl.com/en/latest/.+/([^_]+).+\.html(\#[^)]+)#{{< relref "\1\2" >}}#g; s#https://docs.redisvl.com/en/latest/(.+)\.html#https://redis.io/docs/latest/develop/ai/redisvl/\1#g' "${markdown_page}"
129128
done
130129
131130
# Fix links in api pages
@@ -236,7 +235,7 @@ jobs:
236235
fi
237236
done
238237
239-
cp -r redis_vl_hugo/* content/integrate/redisvl/
238+
cp -r redis_vl_hugo/* content/develop/ai/redisvl/
240239
241240
- name: 'Create pull request if necessary'
242241
env:
@@ -262,12 +261,12 @@ jobs:
262261
git checkout -b "${branch}"
263262
fi
264263
265-
redisvl_is_different=$(git diff content/integrate/redisvl/)
264+
redisvl_is_different=$(git diff content/develop/ai/redisvl/)
266265
267266
if [[ ! -z $redisvl_is_different ]]; then
268267
redisvl_change=true
269268
270-
git add "content/integrate/redisvl/"
269+
git add "content/develop/ai/redisvl/"
271270
git config user.email "177626021+redisdocsapp[bot]@users.noreply.github.com"
272271
git config user.name "redisdocsapp[bot]"
273272
git commit -m "Update for redisvl ${release}"

‎content/develop/ai/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Redis stores and indexes vector embeddings that semantically represent unstructu
1515

1616
| Vector | RAG | RedisVL |
1717
| :-- | :-- | :-- |
18-
| {{<image filename="images/ai-cube.svg" alt="AI Redis icon.">}}[Redis vector database quick start guide]({{< relref "/develop/get-started/vector-database" >}}) |{{<image filename="images/ai-brain.svg" alt="AI Redis icon.">}} [Retrieval-Augmented Generation quick start guide]({{< relref "/develop/get-started/rag" >}}) | {{<image filename="images/ai-lib.svg" alt="AI Redis icon.">}}[Redis vector Python client library documentation]({{< relref "/integrate/redisvl/" >}}) |
18+
| {{<image filename="images/ai-cube.svg" alt="AI Redis icon.">}}[Redis vector database quick start guide]({{< relref "/develop/get-started/vector-database" >}}) |{{<image filename="images/ai-brain.svg" alt="AI Redis icon.">}} [Retrieval-Augmented Generation quick start guide]({{< relref "/develop/get-started/rag" >}}) | {{<image filename="images/ai-lib.svg" alt="AI Redis icon.">}}[Redis vector Python client library documentation]({{< relref "/develop/ai/redisvl/" >}}) |
1919

2020
#### Overview
2121

‎content/develop/ai/redisvl/_index.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
categories:
3+
- docs
4+
- integrate
5+
- stack
6+
- oss
7+
- rs
8+
- rc
9+
- oss
10+
- clients
11+
description: This is the Redis vector library (RedisVL).
12+
group: library
13+
hidden: false
14+
linkTitle: RedisVL
15+
summary: RedisVL provides a powerful, dedicated Python client library for using Redis
16+
as a vector database. Leverage Redis's speed, reliability, and vector-based semantic
17+
search capabilities to supercharge your application.
18+
title: RedisVL
19+
type: integration
20+
weight: 1
21+
---
22+
RedisVL is a powerful, dedicated Python client library for Redis that enables seamless integration and management of high-dimensional vector data.
23+
Built to support machine learning and artificial intelligence workflows, RedisVL simplifies the process of storing, searching, and analyzing vector embeddings, which are commonly used for tasks like recommendation systems, semantic search, and anomaly detection.
24+
25+
Key features of RedisVL include:
26+
27+
- Vector Similarity Search: Efficiently find nearest neighbors in high-dimensional spaces using algorithms like HNSW (Hierarchical Navigable Small World).
28+
- Integration with AI Frameworks: RedisVL works seamlessly with popular frameworks such as TensorFlow, PyTorch, and Hugging Face, making it easy to deploy AI models.
29+
- Scalable and Fast: Leveraging Redis's in-memory architecture, RedisVL provides low-latency access to vector data, even at scale.
30+
- By bridging the gap between data storage and AI model deployment, RedisVL empowers developers to build intelligent, real-time applications with minimal infrastructure complexity.

content/integrate/redisvl/api/_index.md renamed to content/develop/ai/redisvl/api/_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
22
linkTitle: RedisVL API
33
title: RedisVL API
4-
type: integration
54
weight: 5
65
hideListLinks: true
6+
aliases:
7+
- /integrate/redisvl/api
78
---
89

910

content/integrate/redisvl/api/cache.md renamed to content/develop/ai/redisvl/api/cache.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
linkTitle: LLM cache
33
title: LLM Cache
4-
type: integration
4+
aliases:
5+
- /integrate/redisvl/api/cache
56
---
67

78

content/integrate/redisvl/api/filter.md renamed to content/develop/ai/redisvl/api/filter.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
linkTitle: Filter
33
title: Filter
4-
type: integration
4+
aliases:
5+
- /integrate/redisvl/api/filter
56
---
67

78

content/integrate/redisvl/api/message_history.md renamed to content/develop/ai/redisvl/api/message_history.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
linkTitle: LLM message history
33
title: LLM Message History
4-
type: integration
4+
aliases:
5+
- /integrate/redisvl/api/message_history
56
---
67

78

content/integrate/redisvl/api/query.md renamed to content/develop/ai/redisvl/api/query.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
linkTitle: Query
33
title: Query
4-
type: integration
4+
aliases:
5+
- /integrate/redisvl/api/query
56
---
67

78

content/integrate/redisvl/api/reranker.md renamed to content/develop/ai/redisvl/api/reranker.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
linkTitle: Rerankers
33
title: Rerankers
4-
type: integration
4+
aliases:
5+
- /integrate/redisvl/api/reranker
56
---
67

78

content/integrate/redisvl/api/router.md renamed to content/develop/ai/redisvl/api/router.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
linkTitle: Semantic router
33
title: Semantic Router
4-
type: integration
4+
aliases:
5+
- /integrate/redisvl/api/router
56
---
67

78

0 commit comments

Comments
 (0)