Skip to content

DOC-5073 added CLI vector set examples for evaluation #1379

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.

Sign up for GitHub

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 2 commits into from
Apr 8, 2025
Merged

DOC-5073 added CLI vector set examples for evaluation #1379

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c5e684
DOC-5073 added CLI examples for evaluation
andy-stark-redis Apr 8, 2025
36163d2
DOC-5073 added vectorset to list of TYPE return values
andy-stark-redis Apr 8, 2025
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
162 changes: 162 additions & 0 deletions content/develop/data-types/vector-sets/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,165 @@ The following commands are available for vector sets:
- [VREM]({{< relref "/commands/vrem" >}}) - remove an element from a vector set.
- [VSETATTR]({{< relref "/commands/vsetattr" >}}) - set or replace attributes on a vector set element.
- [VSIM]({{< relref "/commands/vsim" >}}) - retrieve elements similar to a given vector or element with optional filtering.

## Examples

The following examples give an overview of how to use vector sets. For clarity,
we will use a set of two-dimensional vectors that represent points in the
Cartesian coordinate plane. However, in real use cases, the vectors will typically
represent *text embeddings* and have hundreds of dimensions. See
[Redis for AI]({{< relref "/develop/ai" >}}) for more information about using text
embeddings.

The points we will use are A: (1.0, 1.0), B: (-1.0, -1.0), C: (-1.0, 1.0), D: (1.0. -1.0), and
E: (1.0, 0), shown in the diagram below.

{{<image filename="images/vecsets/VecSetExamplePoints.drawio.svg" alt="Example points on the coordinate plane." width="400px">}}

### Basic operations

Start by adding the point vectors to a set called `points` using
[`VADD`]({{< relref "/commands/vadd" >}}). This also creates the vector set object.
The [`TYPE`]({{< relref "/commands/type" >}}) command returns a type of `vectorset`
for this object.

```
> VADD points VALUES 2 1.0 1.0 pt:A
(integer) 1
> VADD points VALUES 2 -1.0 -1.0 pt:B
(integer) 1
> VADD points VALUES 2 -1.0 1.0 pt:C
(integer) 1
> VADD points VALUES 2 1.0 -1.0 pt:D
(integer) 1
> VADD points VALUES 2 1.0 0 pt:E
(integer) 1
> TYPE points
vectorset
```

Get the number of elements in the set (also known as the *cardinality* of the set)
using [`VCARD`]({{< relref "/commands/vcard" >}}) and the number of dimensions of
the vectors using [`VDIM`]({{< relref "/commands/vdim" >}}):

```
> VCARD points
(integer) 5
> VDIM points
(integer) 2
```

Get the coordinate values from the elements using [`VEMB`]({{< relref "/commands/vemb" >}}).
Note that the values will not typically be the exact values you supplied when you added
the vector because
[quantization]({{< relref "/develop/data-types/vector-sets/performance#quantization-effects" >}})
is applied to improve performance.

```
> VEMB points pt:A
1) "0.9999999403953552"
2) "0.9999999403953552"
9> VEMB points pt:B
1) "-0.9999999403953552"
2) "-0.9999999403953552"
> VEMB points pt:C
1) "-0.9999999403953552"
2) "0.9999999403953552"
> VEMB points pt:D
1) "0.9999999403953552"
2) "-0.9999999403953552"
> VEMB points pt:E
1) "1"
2) "0"
```

Set and retrieve an element's JSON attribute data using
[`VSETATTR`]({{< relref "/commands/vsetattr" >}})
and [`VGETATTR`]({{< relref "/commands/vgetattr" >}}). You can also pass an empty string
to `VSETATTR` to delete the attribute data:

```
> VSETATTR points pt:A "{\"name\": \"Point A\", \"description\": \"First point added\"}"
(integer) 1
> VGETATTR points pt:A
"{\"name\": \"Point A\", \"description\": \"First point added\"}"
> VSETATTR points pt:A ""
(integer) 1
> VGETATTR points pt:A
(nil)
```

Remove an unwanted element with [`VREM`]({{< relref "/commands/vrem" >}})

```
> VADD points VALUES 2 0 0 pt:F
(integer) 1
127.0.0.1:6379> VCARD points
(integer) 6
127.0.0.1:6379> VREM points pt:F
(integer) 1
127.0.0.1:6379> VCARD points
(integer) 5
```

### Vector similarity search

Use [`VSIM`]({{< relref "/commands/vsim" >}}) to rank the points in order of their vector distance from a sample point:

```
> VSIM points values 2 0.9 0.1
1) "pt:E"
2) "pt:A"
3) "pt:D"
4) "pt:C"
5) "pt:B"
```

Find the four elements that are closest to point A and show their distance "scores":

```
> VSIM points ELE pt:A WITHSCORES COUNT 4
1) "pt:A"
2) "1"
3) "pt:E"
4) "0.8535534143447876"
5) "pt:C"
6) "0.5"
7) "pt:D"
8) "0.5"
```

Add some JSON attributes and use
[filter expressions]({{< relref "/develop/data-types/vector-sets/filtered-search" >}})
to include them in the search:

```
> VSETATTR points pt:A "{\"size\":\"large\",\"price\": 18.99}"
(integer) 1
> VSETATTR points pt:B "{\"size\":\"large\",\"price\": 35.99}"
(integer) 1
> VSETATTR points pt:C "{\"size\":\"large\",\"price\": 25.99}"
(integer) 1
> VSETATTR points pt:D "{\"size\":\"small\",\"price\": 21.00}"
(integer) 1
> VSETATTR points pt:E "{\"size\":\"small\",\"price\": 17.75}"
(integer) 1

# Return elements in order of distance from point A whose
# `size` attribute is `large`.
> VSIM points ELE pt:A FILTER '.size == "large"'
1) "pt:A"
2) "pt:C"
3) "pt:B"

# Return elements in order of distance from point A whose size is
# `large` and whose price is greater than 20.00.
> VSIM points ELE pt:A FILTER '.size == "large" && .price > 20.00'
1) "pt:C"
2) "pt:B"
```

## More information

See the other pages in this section to learn more about the features
and performance parameters of vector sets.
Loading