The RedisVL CLI#

RedisVL is a Python library with a dedicated CLI to help load and create vector search indices within Redis.

This notebook will walk through how to use the Redis Vector Library CLI (rvl).

Before running this notebook, be sure to

Have installed redisvl and have that environment active for this notebook.
Have a running Redis instance with the Search and Query capability

# First, see if the rvl tool is installed
!rvl version

16:19:10 [RedisVL] INFO   RedisVL version 0.4.0

Commands#

Here’s a table of all the rvl commands and options. We’ll go into each one in detail below.

Command	Options	Description
`rvl version`		display the redisvl library version
`rvl index`	`create --schema` or `-s <schema.yaml>`	create a redis index from the specified schema file
`rvl index`	`listall`	list all the existing search indices
`rvl index`	`info --index` or `-i <index_name>`	display the index definition in tabular format
`rvl index`	`delete --index` or `-i <index_name>`	remove the specified index, leaving the data still in Redis
`rvl index`	`destroy --index` or `-i <index_name>`	remove the specified index, as well as the associated data
`rvl stats`	`--index` or `-i <index_name>`	display the index statistics, including number of docs, average bytes per record, indexing time, etc
`rvl stats`	`--schema` or `-s <schema.yaml>`	display the index statistics of a schema defined in <schema.yaml>. The index must have already been created within Redis

Index#

The rvl index command can be used for a number of tasks related to creating and managing indices. Whether you are working in Python or another language, this cli tool can still be useful for managing and inspecting your indices.

First, we will create an index from a yaml schema that looks like the following:

%%writefile schema.yaml

version: '0.1.0'

index:
    name: vectorizers
    prefix: doc
    storage_type: hash

fields:
    - name: sentence
      type: text
    - name: embedding
      type: vector
      attrs:
        dims: 768
        algorithm: flat
        distance_metric: cosine

Overwriting schema.yaml

# Create an index from a yaml schema
!rvl index create -s schema.yaml

18:12:32 [RedisVL] INFO   Using Redis address from environment variable, REDIS_URL
18:12:32 [RedisVL] INFO   Index created successfully

# list the indices that are available
!rvl index listall

12:35 [RedisVL] INFO   Using Redis address from environment variable, REDIS_URL
12:35 [RedisVL] INFO   Indices:
12:35 [RedisVL] INFO   1. vectorizers

# inspect the index fields
!rvl index info -i vectorizers

18:12:37 [RedisVL] INFO   Using Redis address from environment variable, REDIS_URL


Index Information:
╭──────────────┬────────────────┬────────────┬─────────────────┬────────────╮
│ Index Name   │ Storage Type   │ Prefixes   │ Index Options   │   Indexing │
├──────────────┼────────────────┼────────────┼─────────────────┼────────────┤
│ vectorizers  │ HASH           │ ['doc']    │ []              │          0 │
╰──────────────┴────────────────┴────────────┴─────────────────┴────────────╯
Index Fields:
╭───────────┬─────────────┬────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬─────────────────┬────────────────╮
│ Name      │ Attribute   │ Type   │ Field Option   │ Option Value   │ Field Option   │ Option Value   │ Field Option   │   Option Value │ Field Option    │ Option Value   │
├───────────┼─────────────┼────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼─────────────────┼────────────────┤
│ sentence  │ sentence    │ TEXT   │ WEIGHT         │ 1              │                │                │                │                │                 │                │
│ embedding │ embedding   │ VECTOR │ algorithm      │ FLAT           │ data_type      │ FLOAT32        │ dim            │            768 │ distance_metric │ COSINE         │
╰───────────┴─────────────┴────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴─────────────────┴────────────────╯

# delete an index without deleting the data within it
!rvl index delete -i vectorizers

18:12:40 [RedisVL] INFO   Using Redis address from environment variable, REDIS_URL
18:12:40 [RedisVL] INFO   Index deleted successfully

# see the indices that still exist
!rvl index listall

18:12:43 [RedisVL] INFO   Using Redis address from environment variable, REDIS_URL
18:12:43 [RedisVL] INFO   Indices:

Stats#

The rvl stats command will return some basic information about the index. This is useful for checking the status of an index, or for getting information about the index to use in other commands.

# create a new index with the same schema
# recreating the index will reindex the documents
!rvl index create -s schema.yaml

13:21 [RedisVL] INFO   Using Redis address from environment variable, REDIS_URL
13:21 redisvl.index.index INFO   Index already exists, not overwriting.
13:21 [RedisVL] INFO   Index created successfully

# list the indices that are available
!rvl index listall

13:25 [RedisVL] INFO   Using Redis address from environment variable, REDIS_URL
13:25 [RedisVL] INFO   Indices:
13:25 [RedisVL] INFO   1. vectorizers

# see all the stats for the index
!rvl stats -i vectorizers

18:13:31 [RedisVL] INFO   Using Redis address from environment variable, REDIS_URL

Statistics:
╭─────────────────────────────┬─────────╮
│ Stat Key                    │ Value   │
├─────────────────────────────┼─────────┤
│ num_docs                    │ 0       │
│ num_terms                   │ 0       │
│ max_doc_id                  │ 0       │
│ num_records                 │ 0       │
│ percent_indexed             │ 1       │
│ hash_indexing_failures      │ 3       │
│ number_of_uses              │ 2       │
│ bytes_per_record_avg        │ nan     │
│ doc_table_size_mb           │ 0       │
│ inverted_sz_mb              │ 0       │
│ key_table_size_mb           │ 0       │
│ offset_bits_per_record_avg  │ nan     │
│ offset_vectors_sz_mb        │ 0       │
│ offsets_per_term_avg        │ nan     │
│ records_per_doc_avg         │ nan     │
│ sortable_values_size_mb     │ 0       │
│ total_indexing_time         │ 0.02    │
│ total_inverted_index_blocks │ 0       │
│ vector_index_sz_mb          │ 0       │
╰─────────────────────────────┴─────────╯

Optional arguments#

You can modify these commands with the below optional arguments

Argument	Description	Default
`-u --url`	The full Redis URL to connec to	`redis://localhost:6379`
`--host`	Redis host to connect to	`localhost`
`-p --port`	Redis port to connect to. Must be an integer	`6379`
`--user`	Redis username, if one is required	`default`
`--ssl`	Boolean flag indicating if ssl is required. If set the Redis base url changes to `rediss://`	None
`-a --password`	Redis password, if one is required	`""`

Choosing your Redis instance#

By default rvl first checks if you have REDIS_URL environment variable defined and tries to connect to that. If not, it then falls back to localhost:6379, unless you pass the --host or --port arguments

# specify your Redis instance to connect to
!rvl index listall --host localhost --port 6379

13:36 [RedisVL] INFO   Using Redis address from environment variable, REDIS_URL
13:36 [RedisVL] INFO   Indices:
13:36 [RedisVL] INFO   1. vectorizers

Using SSL encription#

If your Redis instance is configured to use SSL encription then set the --ssl flag. You can similarly specify the username and password to construct the full Redis URL

# connect to rediss://jane_doe:password123@localhost:6379
!rvl index listall --user jane_doe -a password123 --ssl

!rvl index destroy -i vectorizers