VLINKS

Return the neighbors of a specified element in a vector set. The command shows the connections for each layer of the HNSW graph.

VLINKS key element

Use the WITHSCORES option to include similarity scores for each neighbor.

VLINKS key element WITHSCORES

Required arguments

is the name of the key that holds the vector set.

is the name of the element whose HNSW neighbors you want to inspect.

Optional arguments

includes similarity scores for each neighbor.

Related topics

• [Vector sets]({{< relref "/develop/data-types/vector-sets" >}})

Redis Software and Redis Cloud compatibility

| Redis Software | Redis Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> | |:----------------------|:-----------------|:------| | <span title="Supported">✅ Standard</span> <span title="Not supported"><nobr>❌ Active-Active</nobr></span> | <span title="Supported">✅ Standard</span> <span title="Not supported"><nobr>❌ Active-Active</nobr></span> | |

Return information

{{< multitabs id="vlinks-return-info" tab1="RESP2" tab2="RESP3" >}}

One of the following:

• An array of array replies containing the names of adjacent elements as bulk strings; interleaved with scores as bulk strings when used with the WITHSCORES option.
• Simple error reply for incorrect syntax.
• Bulk string reply (null bulk string) for unknown keys and/or elements.

-tab-sep-

One of the following:

• An array of array replies containing the names of adjacent elements as bulk strings when used without the WITHSCORES option.
• An array of map replies containing the names of adjecent elements as bulk strings, together with their scores as doubles when used with the WITHSCORES option.
• Simple error reply for incorrect syntax.
• Null reply for unknown keys and/or elements.

{{< /multitabs >}}