Vector set embeddings

A Redis [vector set]({{< relref "/develop/data-types/vector-sets" >}}) lets you store a set of unique keys, each with its own associated vector. You can then retrieve keys from the set according to the similarity between their stored vectors and a query vector that you specify.

You can use vector sets to store any type of numeric vector but they are particularly optimized to work with text embedding vectors (see [Redis for AI]({{< relref "/develop/ai" >}}) to learn more about text embeddings). The example below shows how to use the @xenova/transformers library to generate vector embeddings and then store and retrieve them using a vector set with node-redis.

Initialize

Start by [installing]({{< relref "/develop/clients/nodejs#install" >}}) node-redis if you haven't already done so. Also, install @xenova/transformers:

npm install @xenova/transformers

In your JavaScript source file, import the required classes:

{{< clients-example set="home_vecsets" step="import" lang_filter="Node.js" description="Foundational: Import Redis client and transformer modules for vector set operations" difficulty="beginner" >}} {{< /clients-example >}}

The first of these imports is the @xenova/transformers class, which generates an embedding from a section of text. This example uses transformers.pipeline with the all-MiniLM-L6-v2 model for the embeddings. This model generates vectors with 384 dimensions, regardless of the length of the input text, but note that the input is truncated to 256 tokens (see Word piece tokenization at the Hugging Face docs to learn more about the way tokens are related to the original text).

The output from transformers.pipeline is a function (called pipe in the examples) that you can call to generate embeddings. The pipeOptions object is a parameter for pipe that specifies how to generate sentence embeddings from token embeddings (see the all-MiniLM-L6-v2 documentation for details).

{{< clients-example set="home_vecsets" step="model" lang_filter="Node.js" description="Foundational: Configure a transformer pipeline to generate text embeddings for vector set operations" difficulty="beginner" >}} {{< /clients-example >}}

Create the data

The example data is contained in an object with some brief descriptions of famous people:

{{< clients-example set="home_vecsets" step="data" lang_filter="Node.js" description="Foundational: Define sample data structures with descriptions for vector set examples" difficulty="beginner" >}} {{< /clients-example >}}

Add the data to a vector set

The next step is to connect to Redis and add the data to a new vector set.

The code below iterates through all the key-value pairs in the peopleData object and adds corresponding elements to a vector set called famousPeople.

Use the pipe() function created above to generate the embedding and then use Array.from() to convert the embedding to an array of float32 values that you can pass to the [vAdd()]({{< relref "/commands/vadd" >}}) command to set the embedding.

The call to vAdd() also adds the born and died values from the peopleData object as attribute data. You can access this during a query or by using the [vGetAttr()]({{< relref "/commands/vgetattr" >}}) method.

{{< clients-example set="home_vecsets" step="add_data" lang_filter="Node.js" description="Practical pattern: Generate embeddings and add elements to a vector set with vAdd() and attribute metadata" difficulty="intermediate" >}} {{< /clients-example >}}

Query the vector set

You can now query the data in the set. The basic approach is to use the pipe() function to generate another embedding vector for the query text. (This is the same method used to add the elements to the set.) Then, pass the query vector to [vSim()]({{< relref "/commands/vsim" >}}) to return elements of the set, ranked in order of similarity to the query.

Start with a simple query for "actors":

{{< clients-example set="home_vecsets" step="basic_query" lang_filter="Node.js" description="Vector set query: Execute a basic vector similarity search using vSim() to find semantically similar elements" difficulty="intermediate" >}} {{< /clients-example >}}

This returns the following list of elements (formatted slightly for clarity):

'actors': ["Masako Natsume","Chaim Topol","Linus Pauling",
    "Marie Fredriksson","Maryam Mirzakhani","Freddie Mercury",
    "Marie Curie","Paul Erdos"]

The first two people in the list are the two actors, as expected, but none of the people from Linus Pauling onward was especially well-known for acting (and there certainly isn't any information about that in the short description text). As it stands, the search attempts to rank all the elements in the set, based on the information contained in the embedding model. You can use the COUNT parameter of vSim() to limit the list of elements to just the most relevant few items:

{{< clients-example set="home_vecsets" step="limited_query" lang_filter="Node.js" description="Restrict results: Limit vector search results using the COUNT parameter to return only the most relevant matches" difficulty="intermediate" >}} {{< /clients-example >}}

The reason for using text embeddings rather than simple text search is that the embeddings represent semantic information. This allows a query to find elements with a similar meaning even if the text is different. For example, the word "entertainer" doesn't appear in any of the descriptions but if you use it as a query, the actors and musicians are ranked highest in the results list:

{{< clients-example set="home_vecsets" step="entertainer_query" lang_filter="Node.js" description="Semantic search: Find elements with similar meaning despite different text" difficulty="intermediate" >}} {{< /clients-example >}}

Similarly, if you use "science" as a query, you get the following results:

'science': ["Linus Pauling","Marie Curie","Maryam Mirzakhani","Paul Erdos",
"Marie Fredriksson","Masako Natsume","Freddie Mercury","Chaim Topol"]

The scientists are ranked highest but they are then followed by the mathematicians. This seems reasonable given the connection between mathematics and science.

You can also use [filter expressions]({{< relref "/develop/data-types/vector-sets/filtered-search" >}}) with vSim() to restrict the search further. For example, repeat the "science" query, but this time limit the results to people who died before the year 2000:

{{< clients-example set="home_vecsets" step="filtered_query" lang_filter="Node.js" description="Pre-filtering: Combine vector similarity search with filter expressions to restrict results based on attribute metadata" difficulty="advanced" >}} {{< /clients-example >}}

Note that the boolean filter expression is applied to items in the list before the vector distance calculation is performed. Items that don't pass the filter test are removed from the results completely, rather than just reduced in rank. This can help to improve the performance of the search because there is no need to calculate the vector distance for elements that have already been filtered out of the search.

More information

See the [vector sets]({{< relref "/develop/data-types/vector-sets" >}}) docs for more information and code examples. See the [Redis for AI]({{< relref "/develop/ai" >}}) section for more details about text embeddings and other AI techniques you can use with Redis.

You may also be interested in [vector search]({{< relref "/develop/clients/nodejs/vecsearch" >}}). This is a feature of [Redis Search]({{< relref "/develop/ai/search-and-query" >}}) that lets you retrieve [JSON]({{< relref "/develop/data-types/json" >}}) and [hash]({{< relref "/develop/data-types/hashes" >}}) documents based on vector data stored in their fields.