Skip to content

Commit a21e107

Browse files
committed
docs: clarify Redis requirements
1 parent 6331627 commit a21e107

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,34 @@ The project consists of two main components:
1111

1212
## Dependencies
1313

14-
The project requires the following main dependencies:
14+
### Python Dependencies
15+
16+
The project requires the following main Python dependencies:
1517

1618
- `redis>=5.2.1`
1719
- `redisvl>=0.5.1`
1820
- `langgraph-checkpoint>=2.0.24`
1921

22+
### Redis Modules Requirements
23+
24+
**IMPORTANT:** This library requires Redis with the following modules:
25+
26+
- **RedisJSON** - For storing and manipulating JSON data
27+
- **RediSearch** - For search and indexing capabilities
28+
29+
#### Redis 8.0+
30+
31+
If you're using Redis 8.0 or higher, both RedisJSON and RediSearch modules are included by default as part of the core Redis distribution. No additional installation is required.
32+
33+
#### Redis < 8.0
34+
35+
If you're using a Redis version lower than 8.0, you'll need to ensure these modules are installed:
36+
37+
- Use [Redis Stack](https://redis.io/docs/stack/), which bundles Redis with these modules
38+
- Or install the modules separately in your Redis instance
39+
40+
Failure to have these modules available will result in errors during index creation and checkpoint operations.
41+
2042
## Installation
2143

2244
Install the library using pip:
@@ -259,9 +281,16 @@ To run the example notebooks with Docker:
259281

260282
## Implementation Details
261283

284+
### Redis Module Usage
285+
286+
This implementation relies on specific Redis modules:
287+
288+
- **RedisJSON**: Used for storing structured JSON data as native Redis objects
289+
- **RediSearch**: Used for creating and querying indices on JSON data
290+
262291
### Indexing
263292

264-
The Redis implementation creates these main indices:
293+
The Redis implementation creates these main indices using RediSearch:
265294

266295
1. **Checkpoints Index**: Stores checkpoint metadata and versioning
267296
2. **Channel Values Index**: Stores channel-specific data
@@ -323,7 +352,7 @@ The project includes several make commands for development:
323352
- **Redis for Development/Testing**:
324353

325354
```bash
326-
make redis-start # Start Redis in Docker
355+
make redis-start # Start Redis Stack in Docker (includes RedisJSON and RediSearch modules)
327356
make redis-stop # Stop Redis container
328357
```
329358

0 commit comments

Comments
 (0)