You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-3Lines changed: 32 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,12 +11,34 @@ The project consists of two main components:
11
11
12
12
## Dependencies
13
13
14
-
The project requires the following main dependencies:
14
+
### Python Dependencies
15
+
16
+
The project requires the following main Python dependencies:
15
17
16
18
-`redis>=5.2.1`
17
19
-`redisvl>=0.5.1`
18
20
-`langgraph-checkpoint>=2.0.24`
19
21
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
+
20
42
## Installation
21
43
22
44
Install the library using pip:
@@ -259,9 +281,16 @@ To run the example notebooks with Docker:
259
281
260
282
## Implementation Details
261
283
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
+
262
291
### Indexing
263
292
264
-
The Redis implementation creates these main indices:
293
+
The Redis implementation creates these main indices using RediSearch:
265
294
266
295
1.**Checkpoints Index**: Stores checkpoint metadata and versioning
267
296
2.**Channel Values Index**: Stores channel-specific data
@@ -323,7 +352,7 @@ The project includes several make commands for development:
323
352
-**Redis for Development/Testing**:
324
353
325
354
```bash
326
-
make redis-start # Start Redis in Docker
355
+
make redis-start # Start Redis Stack in Docker (includes RedisJSON and RediSearch modules)
0 commit comments