VSETATTR

Associate a JSON object with an element in a vector set. Use this command to store attributes that can be used in filtered similarity searches with VSIM.

You can also update existing attributes or delete them by setting an empty string.

VSETATTR key element "{\"type\": \"fruit\", \"color\": \"red\"}"

To remove attributes, pass an empty JSON string:

VSETATTR key element ""

Required arguments

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

is the name of the element whose attributes you want to set or remove.

is a valid JSON string. Use an empty string ("") to delete the attributes.

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="vsetattr-return-info" tab1="RESP2" tab2="RESP3" >}}

One of the following:

• Integer reply: 0 if either the key or element does not exist; 1 if the attributes were successfully added to the element.
• Simple error reply for improperly specified attribute string.

-tab-sep-

One of the following:

• Boolean reply: false if either the key or element does not exist; true if the attributes were successfully added to the element.
• Simple error reply for improperly specified attribute string.

{{< /multitabs >}}