Skip to content

Move redisvl documentation #1770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 1, 2025
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
9 changes: 4 additions & 5 deletions .github/workflows/redisvl_docs_sync.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ jobs:
---
linkTitle: ${linkTitle}
title: ${title}
type: integration
EOL

# Inject weight property for index pages to preserve order
Expand Down Expand Up @@ -125,7 +124,7 @@ jobs:
sed -E -i 's/^> *//g; s/\x1b\[[0-9;]*m//g' "${markdown_page}"

# Replace https://docs.redisvl.com links
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}"
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}"
done

# Fix links in api pages
Expand Down Expand Up @@ -236,7 +235,7 @@ jobs:
fi
done

cp -r redis_vl_hugo/* content/integrate/redisvl/
cp -r redis_vl_hugo/* content/develop/ai/redisvl/

- name: 'Create pull request if necessary'
env:
Expand All @@ -262,12 +261,12 @@ jobs:
git checkout -b "${branch}"
fi

redisvl_is_different=$(git diff content/integrate/redisvl/)
redisvl_is_different=$(git diff content/develop/ai/redisvl/)

if [[ ! -z $redisvl_is_different ]]; then
redisvl_change=true

git add "content/integrate/redisvl/"
git add "content/develop/ai/redisvl/"
git config user.email "177626021+redisdocsapp[bot]@users.noreply.github.com"
git config user.name "redisdocsapp[bot]"
git commit -m "Update for redisvl ${release}"
Expand Down
2 changes: 1 addition & 1 deletion content/develop/ai/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Redis stores and indexes vector embeddings that semantically represent unstructu

| Vector | RAG | RedisVL |
| :-- | :-- | :-- |
| {{<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/" >}}) |
| {{<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/" >}}) |

#### Overview

Expand Down
30 changes: 30 additions & 0 deletions content/develop/ai/redisvl/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
categories:
- docs
- integrate
- stack
- oss
- rs
- rc
- oss
- clients
description: This is the Redis vector library (RedisVL).
group: library
hidden: false
linkTitle: RedisVL
summary: RedisVL provides a powerful, dedicated Python client library for using Redis
as a vector database. Leverage Redis's speed, reliability, and vector-based semantic
search capabilities to supercharge your application.
title: RedisVL
type: integration
weight: 1
---
RedisVL is a powerful, dedicated Python client library for Redis that enables seamless integration and management of high-dimensional vector data.
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.

Key features of RedisVL include:

- Vector Similarity Search: Efficiently find nearest neighbors in high-dimensional spaces using algorithms like HNSW (Hierarchical Navigable Small World).
- Integration with AI Frameworks: RedisVL works seamlessly with popular frameworks such as TensorFlow, PyTorch, and Hugging Face, making it easy to deploy AI models.
- Scalable and Fast: Leveraging Redis's in-memory architecture, RedisVL provides low-latency access to vector data, even at scale.
- By bridging the gap between data storage and AI model deployment, RedisVL empowers developers to build intelligent, real-time applications with minimal infrastructure complexity.
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
linkTitle: RedisVL API
title: RedisVL API
type: integration
weight: 5
hideListLinks: true
aliases:
- /integrate/redisvl/api
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
linkTitle: LLM cache
title: LLM Cache
type: integration
aliases:
- /integrate/redisvl/api/cache
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
linkTitle: Filter
title: Filter
type: integration
aliases:
- /integrate/redisvl/api/filter
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
linkTitle: LLM message history
title: LLM Message History
type: integration
aliases:
- /integrate/redisvl/api/message_history
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
linkTitle: Query
title: Query
type: integration
aliases:
- /integrate/redisvl/api/query
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
linkTitle: Rerankers
title: Rerankers
type: integration
aliases:
- /integrate/redisvl/api/reranker
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
linkTitle: Semantic router
title: Semantic Router
type: integration
aliases:
- /integrate/redisvl/api/router
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
linkTitle: Schema
title: Schema
type: integration
aliases:
- /integrate/redisvl/api/schema
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
linkTitle: Search index classes
title: Search Index Classes
type: integration
aliases:
- /integrate/redisvl/api/searchindex
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
linkTitle: LLM session manager
title: LLM Session Manager
type: integration
aliases:
- /integrate/redisvl/api/session_manager
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
linkTitle: Threshold optimizers
title: Threshold Optimizers
type: integration
aliases:
- /integrate/redisvl/api/threshold_optimizer
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
linkTitle: Vectorizers
title: Vectorizers
type: integration
aliases:
- /integrate/redisvl/api/vectorizer
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
aliases:
- /integrate/redisvl/overview/install
description: Install RedisVL
linkTitle: Install
title: Install
type: integration
weight: 2
aliases:
- /integrate/redisvl/install
---
## Installation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
linkTitle: Overview
title: Overview
type: integration
weight: 3
hideListLinks: true
aliases:
- /integrate/redisvl/overview
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
linkTitle: The RedisVL CLI
title: The RedisVL CLI
type: integration
aliases:
- /integrate/redisvl/overview/cli
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
linkTitle: Install RedisVL
title: Install RedisVL
type: integration
aliases:
- /integrate/redisvl/overview/installation
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
linkTitle: User guides
title: User Guides
type: integration
weight: 4
hideListLinks: true
aliases:
- /integrate/redisvl/user_guide
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
linkTitle: Caching embeddings
title: Caching Embeddings
type: integration
weight: 10
aliases:
- /integrate/redisvl/user_guide/embeddings_cache
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
linkTitle: Getting started with RedisVL
title: Getting Started with RedisVL
type: integration
weight: 01
aliases:
- /integrate/redisvl/user_guide/getting_started
---

`redisvl` is a versatile Python library with an integrated CLI, designed to enhance AI applications using Redis. This guide will walk you through the following steps:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
linkTitle: Hash vs JSON storage
title: Hash vs JSON Storage
type: integration
weight: 05
aliases:
- /integrate/redisvl/user_guide/hash_vs_json
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
linkTitle: Querying with RedisVL
title: Querying with RedisVL
type: integration
weight: 02
aliases:
- /integrate/redisvl/user_guide/hybrid_queries
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
linkTitle: Semantic caching for LLMs
title: Semantic Caching for LLMs
type: integration
weight: 03
aliases:
- /integrate/redisvl/user_guide/llmcache
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
linkTitle: LLM message history
title: LLM Message History
type: integration
weight: 07
aliases:
- /integrate/redisvl/user_guide/message_history
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
linkTitle: 0.5.1 feature overview
title: 0.5.1 Feature Overview
type: integration
aliases:
- /integrate/redisvl/user_guide/release_guide/0_5_0_release
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
linkTitle: Release guides
title: Release Guides
type: integration
hideListLinks: true
aliases:
- /integrate/redisvl/user_guide/release_guide
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
linkTitle: Rerankers
title: Rerankers
type: integration
weight: 06
aliases:
- /integrate/redisvl/user_guide/rerankers
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
linkTitle: Semantic routing
title: Semantic Routing
type: integration
weight: 08
aliases:
- /integrate/redisvl/user_guide/semantic_router
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
linkTitle: LLM session memory
title: LLM Session Memory
type: integration
weight: 07
aliases:
- /integrate/redisvl/user_guide/session_manager
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
linkTitle: Threshold optimization
title: Threshold Optimization
type: integration
weight: 09
aliases:
- /integrate/redisvl/user_guide/threshold_optimization
---


Expand Down
Loading