VLINKS
VLINKS key element [WITHSCORES]
- Available since:
- Redis Open Source 8.0.0
- Time complexity:
- O(1)
- Compatibility:
- Redis Software and Redis Cloud compatibility
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
key
is the name of the key that holds the vector set.
element
is the name of the element whose HNSW neighbors you want to inspect.
Optional arguments
WITHSCORES
includes similarity scores for each neighbor.
Related topics
Redis Software and Redis Cloud compatibility
| Redis Software |
Redis Cloud |
Notes |
|---|---|---|
| ✅ Standard |
✅ Standard |
Return information
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
WITHSCORESoption. - Simple error reply for incorrect syntax.
- Bulk string reply (null bulk string) for unknown keys and/or elements.