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
@@ -34,7 +34,7 @@ RedisVL provides a powerful Python client library for using Redis as a Vector Da
34
34
35
35
Vector databases have become increasingly popular in recent years due to their ability to store and retrieve vectors efficiently. However, most vector databases are complex to use and require a lot of time and effort to set up. RedisVL aims to solve this problem by providing a simple and intuitive interface for using Redis as a vector database.
36
36
37
-
RedisVL provides a client library that enables you to harness the power of Redis as a vector database. This library simplifies the process of storing, retrieving, and performing semantic searches on vectors in Redis. It also provides a robust index management system that allows you to create, update, and delete indices with ease.
37
+
RedisVL provides a client library that enables you to harness the power and flexibility of Redis as a vector database. This library simplifies the process of storing, retrieving, and performing complex semantic and hybrid searches over vectors in Redis. It also provides a robust index management system that allows you to create, update, and delete indices with ease.
38
38
39
39
40
40
### Capabilities
@@ -43,7 +43,7 @@ RedisVL has a host of powerful features designed to streamline your vector datab
43
43
44
44
1.**Index Management**: RedisVL allows for indices to be created, updated, and deleted with ease. A schema for each index can be defined in yaml or directly in python code and used throughout the lifetime of the index.
45
45
46
-
2.**Embedding Creation**: RedisVL integrates with OpenAIand other text embedding providers to simplify the process of vectorizing unstructured data. *Image support coming soon.*
46
+
2.**Embedding Creation**: RedisVL integrates with OpenAI, HuggingFace, and GCP VertexAI to simplify the process of vectorizing unstructured data. *Image support coming soon. Submit a PR for new vectorizers.*
47
47
48
48
3.**Vector Search**: RedisVL provides robust search capabilities that enable you to query vectors synchronously and asynchronously. Hybrid queries that utilize tag, geographic, numeric, and other filters like full-text search are also supported.
49
49
@@ -55,20 +55,20 @@ RedisVL has a host of powerful features designed to streamline your vector datab
55
55
56
56
Please note that this library is still under heavy development, and while you can quickly try RedisVL and deploy it in a production environment, the API may be subject to change at any time.
57
57
58
-
First, install RedisVL using pip:
58
+
Install `redisvl`using `pip`:
59
59
60
-
```
60
+
```bash
61
61
pip install redisvl
62
62
```
63
63
64
-
Then make sure to have Redis with the Search and Query capability running on Redis Cloud or
65
-
locally in docker by running
64
+
Then make sure to have [Redis](https://redis.io) accessible with Search & Query features enabled on [Redis Cloud](https://redis.com/try-free) or locally in docker with [Redis Stack](https://redis.io/docs/getting-started/install-stack/docker/):
66
65
67
66
```bash
68
-
docker run -d -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
67
+
docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
69
68
```
70
69
71
-
This will also spin up the Redis Insight UI at http://localhost:8001
70
+
This will also spin up the [Redis Insight GUI](https://redis.com/redis-enterprise/redis-insight/) at `http://localhost:8001`.
71
+
72
72
73
73
74
74
## Example Usage
@@ -80,7 +80,6 @@ Indices can be defined through yaml specification that corresponds directly to t
Copy file name to clipboardExpand all lines: docs/index.md
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,6 +31,22 @@ to supercharge your application!
31
31
link: "examples/index"
32
32
```
33
33
34
+
## Installation
35
+
36
+
Install `redisvl` using `pip`:
37
+
38
+
```bash
39
+
pip install redisvl
40
+
```
41
+
42
+
Then make sure to have [Redis](https://redis.io) accessible with Search & Query features enabled on [Redis Cloud](https://redis.com/try-free) or locally in docker with [Redis Stack](https://redis.io/docs/getting-started/install-stack/docker/):
43
+
44
+
```bash
45
+
docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
46
+
```
47
+
48
+
This will also spin up the [Redis Insight GUI](https://redis.com/redis-enterprise/redis-insight/) at `http://localhost:8001`.
0 commit comments