update:

* the type of vector attribute: string -> VectorAttributeMarshaller
* Add a new API VRemAttr
* mark the APIs are experimental

Signed-off-by: fukua95 <[email protected]>

Author: cxljs

command.go

@@ -5621,51 +5621,46 @@ func (cmd *MonitorCmd) Stop() {
 	cmd.status = monitorStatusStop
 }
 
-type VectorInfo struct {
-	Name  string
-	Score float64
-}
-
-type VectorInfoSliceCmd struct {
+type VectorScoreSliceCmd struct {
 	baseCmd
 
-	val []VectorInfo
+	val []VectorScore
 }
 
-var _ Cmder = (*VectorInfoSliceCmd)(nil)
+var _ Cmder = (*VectorScoreSliceCmd)(nil)
 
-func NewVectorInfoSliceCmd(ctx context.Context, args ...any) *VectorInfoSliceCmd {
-	return &VectorInfoSliceCmd{
+func NewVectorInfoSliceCmd(ctx context.Context, args ...any) *VectorScoreSliceCmd {
+	return &VectorScoreSliceCmd{
 		baseCmd: baseCmd{
 			ctx:  ctx,
 			args: args,
 		},
 	}
 }
 
-func (cmd *VectorInfoSliceCmd) SetVal(val []VectorInfo) {
+func (cmd *VectorScoreSliceCmd) SetVal(val []VectorScore) {
 	cmd.val = val
 }
 
-func (cmd *VectorInfoSliceCmd) Val() []VectorInfo {
+func (cmd *VectorScoreSliceCmd) Val() []VectorScore {
 	return cmd.val
 }
 
-func (cmd *VectorInfoSliceCmd) Result() ([]VectorInfo, error) {
+func (cmd *VectorScoreSliceCmd) Result() ([]VectorScore, error) {
 	return cmd.val, cmd.err
 }
 
-func (cmd *VectorInfoSliceCmd) String() string {
+func (cmd *VectorScoreSliceCmd) String() string {
 	return cmdString(cmd, cmd.val)
 }
 
-func (cmd *VectorInfoSliceCmd) readReply(rd *proto.Reader) error {
+func (cmd *VectorScoreSliceCmd) readReply(rd *proto.Reader) error {
 	n, err := rd.ReadMapLen()
 	if err != nil {
 		return err
 	}
 
-	cmd.val = make([]VectorInfo, n)
+	cmd.val = make([]VectorScore, n)
 	for i := 0; i < n; i++ {
 		name, err := rd.ReadString()
 		if err != nil {

vectorset_commands.go

@@ -5,6 +5,7 @@ import (
 	"strconv"
 )
 
+// note: the APIs is experimental and may be subject to change.
 type VectorSetCmdable interface {
 	VAdd(ctx context.Context, key, element string, val Vector) *BoolCmd
 	VAddWithArgs(ctx context.Context, key, element string, val Vector, addArgs *VAddArgs) *BoolCmd
@@ -14,15 +15,16 @@ type VectorSetCmdable interface {
 	VGetAttr(ctx context.Context, key, element string) *StringCmd
 	VInfo(ctx context.Context, key string) *MapStringInterfaceCmd
 	VLinks(ctx context.Context, key, element string) *StringSliceCmd
-	VLinksWithScores(ctx context.Context, key, element string) *VectorInfoSliceCmd
+	VLinksWithScores(ctx context.Context, key, element string) *VectorScoreSliceCmd
 	VRandMember(ctx context.Context, key string) *StringCmd
 	VRandMemberCount(ctx context.Context, key string, count int) *StringSliceCmd
 	VRem(ctx context.Context, key, element string) *BoolCmd
-	VSetAttr(ctx context.Context, key, element, attr string) *BoolCmd
+	VSetAttr(ctx context.Context, key, element string, attr VectorAttributeMarshaller) *BoolCmd
+	VRemAttr(ctx context.Context, key, element string) *BoolCmd
 	VSim(ctx context.Context, key string, val Vector) *StringSliceCmd
-	VSimWithScores(ctx context.Context, key string, val Vector) *VectorInfoSliceCmd
+	VSimWithScores(ctx context.Context, key string, val Vector) *VectorScoreSliceCmd
 	VSimWithArgs(ctx context.Context, key string, val Vector, args *VSimArgs) *StringSliceCmd
-	VSimWithArgsWithScores(ctx context.Context, key string, val Vector, args *VSimArgs) *VectorInfoSliceCmd
+	VSimWithArgsWithScores(ctx context.Context, key string, val Vector, args *VSimArgs) *VectorScoreSliceCmd
 }
 
 type Vector interface {
@@ -42,7 +44,7 @@ func (v *VectorFP32) Value() []any {
 	return []any{vectorFormatFP32, v.Val}
 }
 
-var _ Vector = &VectorFP32{}
+var _ Vector = (*VectorFP32)(nil)
 
 type VectorValues struct {
 	Val []float64
@@ -58,7 +60,7 @@ func (v *VectorValues) Value() []any {
 	return res
 }
 
-var _ Vector = &VectorValues{}
+var _ Vector = (*VectorValues)(nil)
 
 type VectorRef struct {
 	Name string // the name of the referent vector
@@ -68,9 +70,27 @@ func (v *VectorRef) Value() []any {
 	return []any{"ele", v.Name}
 }
 
-var _ Vector = &VectorRef{}
+var _ Vector = (*VectorRef)(nil)
+
+type VectorScore struct {
+	Name  string
+	Score float64
+}
+
+type VectorAttributeMarshaller interface {
+	Marshall() string
+}
+
+type VectorAttributeRawString string
+
+func (a *VectorAttributeRawString) Marshall() string {
+	return string(*a)
+}
+
+var _ VectorAttributeMarshaller = (*VectorAttributeRawString)(nil)
 
 // `VADD key (FP32 | VALUES num) vector element`
+// note: the API is experimental and may be subject to change.
 func (c cmdable) VAdd(ctx context.Context, key, element string, val Vector) *BoolCmd {
 	return c.VAddWithArgs(ctx, key, element, val, &VAddArgs{})
 }
@@ -120,6 +140,7 @@ func (v VAddArgs) appendArgs(args []any) []any {
 }
 
 // `VADD key [REDUCE dim] (FP32 | VALUES num) vector element [CAS] [NOQUANT | Q8 | BIN] [EF build-exploration-factor] [SETATTR attributes] [M numlinks]`
+// note: the API is experimental and may be subject to change.
 func (c cmdable) VAddWithArgs(ctx context.Context, key, element string, val Vector, addArgs *VAddArgs) *BoolCmd {
 	if addArgs == nil {
 		addArgs = &VAddArgs{}
@@ -137,20 +158,23 @@ func (c cmdable) VAddWithArgs(ctx context.Context, key, element string, val Vect
 }
 
 // `VCARD key`
+// note: the API is experimental and may be subject to change.
 func (c cmdable) VCard(ctx context.Context, key string) *IntCmd {
 	cmd := NewIntCmd(ctx, "vcard", key)
 	_ = c(ctx, cmd)
 	return cmd
 }
 
 // `VDIM key`
+// note: the API is experimental and may be subject to change.
 func (c cmdable) VDim(ctx context.Context, key string) *IntCmd {
 	cmd := NewIntCmd(ctx, "vdim", key)
 	_ = c(ctx, cmd)
 	return cmd
 }
 
 // `VEMB key element [RAW]`
+// note: the API is experimental and may be subject to change.
 func (c cmdable) VEmb(ctx context.Context, key, element string, raw bool) *SliceCmd {
 	args := []any{"vemb", key, element}
 	if raw {
@@ -162,68 +186,87 @@ func (c cmdable) VEmb(ctx context.Context, key, element string, raw bool) *Slice
 }
 
 // `VGETATTR key element`
+// note: the API is experimental and may be subject to change.
 func (c cmdable) VGetAttr(ctx context.Context, key, element string) *StringCmd {
 	cmd := NewStringCmd(ctx, "vgetattr", key, element)
 	_ = c(ctx, cmd)
 	return cmd
 }
 
 // `VINFO key`
+// note: the API is experimental and may be subject to change.
 func (c cmdable) VInfo(ctx context.Context, key string) *MapStringInterfaceCmd {
 	cmd := NewMapStringInterfaceCmd(ctx, "vinfo", key)
 	_ = c(ctx, cmd)
 	return cmd
 }
 
 // `VLINKS key element`
+// note: the API is experimental and may be subject to change.
 func (c cmdable) VLinks(ctx context.Context, key, element string) *StringSliceCmd {
 	cmd := NewStringSliceCmd(ctx, "vlinks", key, element)
 	_ = c(ctx, cmd)
 	return cmd
 }
 
 // `VLINKS key element WITHSCORES`
-func (c cmdable) VLinksWithScores(ctx context.Context, key, element string) *VectorInfoSliceCmd {
+// note: the API is experimental and may be subject to change.
+func (c cmdable) VLinksWithScores(ctx context.Context, key, element string) *VectorScoreSliceCmd {
 	cmd := NewVectorInfoSliceCmd(ctx, "vlinks", key, element, "withscores")
 	_ = c(ctx, cmd)
 	return cmd
 }
 
 // `VRANDMEMBER key`
+// note: the API is experimental and may be subject to change.
 func (c cmdable) VRandMember(ctx context.Context, key string) *StringCmd {
 	cmd := NewStringCmd(ctx, "vrandmember", key)
 	_ = c(ctx, cmd)
 	return cmd
 }
 
 // `VRANDMEMBER key [count]`
+// note: the API is experimental and may be subject to change.
 func (c cmdable) VRandMemberCount(ctx context.Context, key string, count int) *StringSliceCmd {
 	cmd := NewStringSliceCmd(ctx, "vrandmember", key, count)
 	_ = c(ctx, cmd)
 	return cmd
 }
 
 // `VREM key element`
+// note: the API is experimental and may be subject to change.
 func (c cmdable) VRem(ctx context.Context, key, element string) *BoolCmd {
 	cmd := NewBoolCmd(ctx, "vrem", key, element)
 	_ = c(ctx, cmd)
 	return cmd
 }
 
 // `VSETATTR key element "{ JSON obj }"`
-func (c cmdable) VSetAttr(ctx context.Context, key, element, attr string) *BoolCmd {
-	cmd := NewBoolCmd(ctx, "vsetattr", key, element, attr)
+// note: the API is experimental and may be subject to change.
+func (c cmdable) VSetAttr(ctx context.Context, key, element string, attr VectorAttributeMarshaller) *BoolCmd {
+	cmd := NewBoolCmd(ctx, "vsetattr", key, element, attr.Marshall())
+	_ = c(ctx, cmd)
+	return cmd
+}
+
+// `VREMATTR` removes attributes on a vector set element.
+// is equal to `VSETATTR key element ""`
+// note: the API is experimental and may be subject to change.
+func (c cmdable) VRemAttr(ctx context.Context, key, element string) *BoolCmd {
+	cmd := NewBoolCmd(ctx, "vsetattr", key, element, "")
 	_ = c(ctx, cmd)
 	return cmd
 }
 
 // `VSIM key (ELE | FP32 | VALUES num) (vector | element)`
+// note: the API is experimental and may be subject to change.
 func (c cmdable) VSim(ctx context.Context, key string, val Vector) *StringSliceCmd {
 	return c.VSimWithArgs(ctx, key, val, &VSimArgs{})
 }
 
 // `VSIM key (ELE | FP32 | VALUES num) (vector | element) WITHSCORES`
-func (c cmdable) VSimWithScores(ctx context.Context, key string, val Vector) *VectorInfoSliceCmd {
+// note: the API is experimental and may be subject to change.
+func (c cmdable) VSimWithScores(ctx context.Context, key string, val Vector) *VectorScoreSliceCmd {
 	return c.VSimWithArgsWithScores(ctx, key, val, &VSimArgs{})
 }
 
@@ -265,6 +308,7 @@ func (v VSimArgs) appendArgs(args []any) []any {
 
 // `VSIM key (ELE | FP32 | VALUES num) (vector | element) [COUNT num]
 // [EF search-exploration-factor] [FILTER expression] [FILTER-EF max-filtering-effort] [TRUTH] [NOTHREAD]`
+// note: the API is experimental and may be subject to change.
 func (c cmdable) VSimWithArgs(ctx context.Context, key string, val Vector, simArgs *VSimArgs) *StringSliceCmd {
 	if simArgs == nil {
 		simArgs = &VSimArgs{}
@@ -279,7 +323,8 @@ func (c cmdable) VSimWithArgs(ctx context.Context, key string, val Vector, simAr
 
 // `VSIM key (ELE | FP32 | VALUES num) (vector | element) [WITHSCORES] [COUNT num]
 // [EF search-exploration-factor] [FILTER expression] [FILTER-EF max-filtering-effort] [TRUTH] [NOTHREAD]`
-func (c cmdable) VSimWithArgsWithScores(ctx context.Context, key string, val Vector, simArgs *VSimArgs) *VectorInfoSliceCmd {
+// note: the API is experimental and may be subject to change.
+func (c cmdable) VSimWithArgsWithScores(ctx context.Context, key string, val Vector, simArgs *VSimArgs) *VectorScoreSliceCmd {
 	if simArgs == nil {
 		simArgs = &VSimArgs{}
 	}

vectorset_commands_test.go

@@ -195,7 +195,7 @@ var _ = Describe("Redis VectorSet commands", Label("vectorset"), func() {
 				vals := []struct {
 					name string
 					v    redis.VectorValues
-					attr string
+					attr redis.VectorAttributeRawString
 				}{
 					{
 						name: "k0",
@@ -237,7 +237,7 @@ var _ = Describe("Redis VectorSet commands", Label("vectorset"), func() {
 					expectNil(err)
 					expectTrue(ok)
 					if len(v.attr) > 0 {
-						ok, err = client.VSetAttr(ctx, vecName, v.name, v.attr).Result()
+						ok, err = client.VSetAttr(ctx, vecName, v.name, &v.attr).Result()
 						expectNil(err)
 						expectTrue(ok)
 					}