enhance: refine group_strict_size parameter(#37482)

Signed-off-by: MrPresent-Han <[email protected]>

internal/distributed/proxy/httpserver/constant.go

@@ -148,6 +148,6 @@ const (
 	ParamRangeFilter     = "range_filter"
 	ParamGroupByField    = "group_by_field"
 	ParamGroupSize       = "group_size"
-	ParamGroupStrictSize = "group_strict_size"
+	ParamStrictGroupSize = "strict_group_size"
 	BoundedTimestamp     = 2
 )

internal/distributed/proxy/httpserver/handler_v2.go

@@ -995,7 +995,7 @@ func (h *HandlersV2) search(ctx context.Context, c *gin.Context, anyReq any, dbN
 	}
 	if httpReq.GroupByField != "" && httpReq.GroupSize > 0 {
 		searchParams = append(searchParams, &commonpb.KeyValuePair{Key: ParamGroupSize, Value: strconv.FormatInt(int64(httpReq.GroupSize), 10)})
-		searchParams = append(searchParams, &commonpb.KeyValuePair{Key: ParamGroupStrictSize, Value: strconv.FormatBool(httpReq.GroupStrictSize)})
+		searchParams = append(searchParams, &commonpb.KeyValuePair{Key: ParamStrictGroupSize, Value: strconv.FormatBool(httpReq.StrictGroupSize)})
 	}
 	searchParams = append(searchParams, &commonpb.KeyValuePair{Key: proxy.AnnsFieldKey, Value: httpReq.AnnsField})
 	body, _ := c.Get(gin.BodyBytesKey)
@@ -1100,7 +1100,7 @@ func (h *HandlersV2) advancedSearch(ctx context.Context, c *gin.Context, anyReq
 	}
 	if httpReq.GroupByField != "" && httpReq.GroupSize > 0 {
 		req.RankParams = append(req.RankParams, &commonpb.KeyValuePair{Key: ParamGroupSize, Value: strconv.FormatInt(int64(httpReq.GroupSize), 10)})
-		req.RankParams = append(req.RankParams, &commonpb.KeyValuePair{Key: ParamGroupStrictSize, Value: strconv.FormatBool(httpReq.GroupStrictSize)})
+		req.RankParams = append(req.RankParams, &commonpb.KeyValuePair{Key: ParamStrictGroupSize, Value: strconv.FormatBool(httpReq.StrictGroupSize)})
 	}
 	resp, err := wrapperProxyWithLimit(ctx, c, req, h.checkAuth, false, "/milvus.proto.milvus.MilvusService/HybridSearch", true, h.proxy, func(reqCtx context.Context, req any) (interface{}, error) {
 		return h.proxy.HybridSearch(reqCtx, req.(*milvuspb.HybridSearchRequest))

internal/distributed/proxy/httpserver/request_v2.go

@@ -160,7 +160,7 @@ type SearchReqV2 struct {
 	Filter           string        `json:"filter"`
 	GroupByField     string        `json:"groupingField"`
 	GroupSize        int32         `json:"groupSize"`
-	GroupStrictSize  bool          `json:"groupStrictSize"`
+	StrictGroupSize  bool          `json:"strictGroupSize"`
 	Limit            int32         `json:"limit"`
 	Offset           int32         `json:"offset"`
 	OutputFields     []string      `json:"outputFields"`
@@ -197,7 +197,7 @@ type HybridSearchReq struct {
 	Limit            int32          `json:"limit"`
 	GroupByField     string         `json:"groupingField"`
 	GroupSize        int32          `json:"groupSize"`
-	GroupStrictSize  bool           `json:"groupStrictSize"`
+	StrictGroupSize  bool           `json:"strictGroupSize"`
 	OutputFields     []string       `json:"outputFields"`
 	ConsistencyLevel string         `json:"consistencyLevel"`
 }

internal/proto/plan.proto

@@ -63,7 +63,7 @@ message QueryInfo {
   int64 group_by_field_id = 6;
   bool materialized_view_involved = 7;
   int64 group_size = 8;
-  bool group_strict_size = 9;
+  bool strict_group_size = 9;
   double bm25_avgdl = 10;
   int64 query_field_id =11;
 }

internal/proxy/search_util.go

@@ -26,7 +26,7 @@ type rankParams struct {
 	roundDecimal    int64
 	groupByFieldId  int64
 	groupSize       int64
-	groupStrictSize bool
+	strictGroupSize bool
 }
 
 func (r *rankParams) GetLimit() int64 {
@@ -64,9 +64,9 @@ func (r *rankParams) GetGroupSize() int64 {
 	return 1
 }
 
-func (r *rankParams) GetGroupStrictSize() bool {
+func (r *rankParams) GetStrictGroupSize() bool {
 	if r != nil {
-		return r.groupStrictSize
+		return r.strictGroupSize
 	}
 	return false
 }
@@ -170,15 +170,15 @@ func parseSearchInfo(searchParamsPair []*commonpb.KeyValuePair, schema *schemapb
 
 	// 5. parse group by field and group by size
 	var groupByFieldId, groupSize int64
-	var groupStrictSize bool
+	var strictGroupSize bool
 	if isAdvanced {
-		groupByFieldId, groupSize, groupStrictSize = rankParams.GetGroupByFieldId(), rankParams.GetGroupSize(), rankParams.GetGroupStrictSize()
+		groupByFieldId, groupSize, strictGroupSize = rankParams.GetGroupByFieldId(), rankParams.GetGroupSize(), rankParams.GetStrictGroupSize()
 	} else {
 		groupByInfo := parseGroupByInfo(searchParamsPair, schema)
 		if groupByInfo.err != nil {
 			return &SearchInfo{planInfo: nil, offset: 0, isIterator: false, parseError: groupByInfo.err}
 		}
-		groupByFieldId, groupSize, groupStrictSize = groupByInfo.GetGroupByFieldId(), groupByInfo.GetGroupSize(), groupByInfo.GetGroupStrictSize()
+		groupByFieldId, groupSize, strictGroupSize = groupByInfo.GetGroupByFieldId(), groupByInfo.GetGroupSize(), groupByInfo.GetStrictGroupSize()
 	}
 
 	// 6. parse iterator tag, prevent trying to groupBy when doing iteration or doing range-search
@@ -199,7 +199,7 @@ func parseSearchInfo(searchParamsPair []*commonpb.KeyValuePair, schema *schemapb
 			RoundDecimal:    roundDecimal,
 			GroupByFieldId:  groupByFieldId,
 			GroupSize:       groupSize,
-			GroupStrictSize: groupStrictSize,
+			StrictGroupSize: strictGroupSize,
 		},
 		offset:     offset,
 		isIterator: isIterator,
@@ -303,7 +303,7 @@ func getPartitionIDs(ctx context.Context, dbName string, collectionName string,
 type groupByInfo struct {
 	groupByFieldId  int64
 	groupSize       int64
-	groupStrictSize bool
+	strictGroupSize bool
 	err             error
 }
 
@@ -321,9 +321,9 @@ func (g *groupByInfo) GetGroupSize() int64 {
 	return 0
 }
 
-func (g *groupByInfo) GetGroupStrictSize() bool {
+func (g *groupByInfo) GetStrictGroupSize() bool {
 	if g != nil {
-		return g.groupStrictSize
+		return g.strictGroupSize
 	}
 	return false
 }
@@ -389,17 +389,17 @@ func parseGroupByInfo(searchParamsPair []*commonpb.KeyValuePair, schema *schemap
 	ret.groupSize = groupSize
 
 	// 3.  parse group strict size
-	var groupStrictSize bool
-	groupStrictSizeStr, err := funcutil.GetAttrByKeyFromRepeatedKV(GroupStrictSize, searchParamsPair)
+	var strictGroupSize bool
+	strictGroupSizeStr, err := funcutil.GetAttrByKeyFromRepeatedKV(StrictGroupSize, searchParamsPair)
 	if err != nil {
-		groupStrictSize = false
+		strictGroupSize = false
 	} else {
-		groupStrictSize, err = strconv.ParseBool(groupStrictSizeStr)
+		strictGroupSize, err = strconv.ParseBool(strictGroupSizeStr)
 		if err != nil {
-			groupStrictSize = false
+			strictGroupSize = false
 		}
 	}
-	ret.groupStrictSize = groupStrictSize
+	ret.strictGroupSize = strictGroupSize
 	return ret
 }
 
@@ -460,7 +460,7 @@ func parseRankParams(rankParamsPair []*commonpb.KeyValuePair, schema *schemapb.C
 		roundDecimal:    roundDecimal,
 		groupByFieldId:  groupByInfo.GetGroupByFieldId(),
 		groupSize:       groupByInfo.GetGroupSize(),
-		groupStrictSize: groupByInfo.GetGroupStrictSize(),
+		strictGroupSize: groupByInfo.GetStrictGroupSize(),
 	}, nil
 }
 

internal/proxy/task.go

@@ -55,7 +55,7 @@ const (
 	IteratorField        = "iterator"
 	GroupByFieldKey      = "group_by_field"
 	GroupSizeKey         = "group_size"
-	GroupStrictSize      = "group_strict_size"
+	StrictGroupSize      = "strict_group_size"
 	RankGroupScorer      = "rank_group_scorer"
 	AnnsFieldKey         = "anns_field"
 	TopKKey              = "topk"

internal/proxy/task_search_test.go

@@ -2325,7 +2325,7 @@ func TestTaskSearch_parseSearchInfo(t *testing.T) {
 			},
 		}
 		// 1. first parse rank params
-		// outer params require to group by field 101 and groupSize=3 and groupStrictSize=false
+		// outer params require to group by field 101 and groupSize=3 and strictGroupSize=false
 		testRankParamsPairs := getValidSearchParams()
 		testRankParamsPairs = append(testRankParamsPairs, &commonpb.KeyValuePair{
 			Key:   GroupByFieldKey,
@@ -2336,7 +2336,7 @@ func TestTaskSearch_parseSearchInfo(t *testing.T) {
 			Value: strconv.FormatInt(3, 10),
 		})
 		testRankParamsPairs = append(testRankParamsPairs, &commonpb.KeyValuePair{
-			Key:   GroupStrictSize,
+			Key:   StrictGroupSize,
 			Value: "false",
 		})
 		testRankParamsPairs = append(testRankParamsPairs, &commonpb.KeyValuePair{
@@ -2348,7 +2348,7 @@ func TestTaskSearch_parseSearchInfo(t *testing.T) {
 
 		// 2. parse search params for sub request in hybridsearch
 		params := getValidSearchParams()
-		// inner params require to group by field 103 and groupSize=10 and groupStrictSize=true
+		// inner params require to group by field 103 and groupSize=10 and strictGroupSize=true
 		params = append(params, &commonpb.KeyValuePair{
 			Key:   GroupByFieldKey,
 			Value: "c3",
@@ -2358,7 +2358,7 @@ func TestTaskSearch_parseSearchInfo(t *testing.T) {
 			Value: strconv.FormatInt(10, 10),
 		})
 		params = append(params, &commonpb.KeyValuePair{
-			Key:   GroupStrictSize,
+			Key:   StrictGroupSize,
 			Value: "true",
 		})
 
@@ -2370,7 +2370,7 @@ func TestTaskSearch_parseSearchInfo(t *testing.T) {
 		// set by main request rather than inner sub request
 		assert.Equal(t, int64(101), searchInfo.planInfo.GetGroupByFieldId())
 		assert.Equal(t, int64(3), searchInfo.planInfo.GetGroupSize())
-		assert.False(t, searchInfo.planInfo.GetGroupStrictSize())
+		assert.False(t, searchInfo.planInfo.GetStrictGroupSize())
 	})
 
 	t.Run("parseSearchInfo error", func(t *testing.T) {