milvus/internal/util/indexparamcheck/ngram_index_checker.go
2025-09-03 16:45:54 +08:00

75 lines
2.4 KiB
Go

package indexparamcheck
import (
"fmt"
"strconv"
"strings"
"github.com/milvus-io/milvus-proto/go-api/v2/schemapb"
"github.com/milvus-io/milvus/pkg/v2/common"
"github.com/milvus-io/milvus/pkg/v2/util/merr"
"github.com/milvus-io/milvus/pkg/v2/util/typeutil"
)
const (
MinGramKey = "min_gram"
MaxGramKey = "max_gram"
)
type NgramIndexChecker struct {
scalarIndexChecker
}
func newNgramIndexChecker() *NgramIndexChecker {
return &NgramIndexChecker{}
}
func (c *NgramIndexChecker) CheckTrain(dataType schemapb.DataType, elementType schemapb.DataType, params map[string]string) error {
if dataType != schemapb.DataType_VarChar && dataType != schemapb.DataType_JSON {
return merr.WrapErrParameterInvalidMsg("Ngram index can only be created on VARCHAR or JSON field")
}
// For JSON field with ngram index, json_cast_type must be VARCHAR
if dataType == schemapb.DataType_JSON {
castType, exists := params[common.JSONCastTypeKey]
if !exists {
return merr.WrapErrParameterInvalidMsg("JSON field with ngram index must specify json_cast_type")
}
// Normalize cast type to uppercase for comparison
castType = strings.ToUpper(strings.TrimSpace(castType))
if castType != "VARCHAR" {
return merr.WrapErrParameterInvalidMsg("JSON field with ngram index only supports VARCHAR cast type, got: %s", castType)
}
}
minGramStr, minGramExist := params[MinGramKey]
maxGramStr, maxGramExist := params[MaxGramKey]
if !minGramExist || !maxGramExist {
return merr.WrapErrParameterInvalidMsg("Ngram index must specify both min_gram and max_gram")
}
minGram, err := strconv.Atoi(minGramStr)
if err != nil {
return merr.WrapErrParameterInvalidMsg("min_gram for Ngram index must be an integer, got: %s", minGramStr)
}
maxGram, err := strconv.Atoi(maxGramStr)
if err != nil {
return merr.WrapErrParameterInvalidMsg("max_gram for Ngram index must be an integer, got: %s", maxGramStr)
}
if minGram <= 0 || maxGram <= 0 || minGram > maxGram {
return merr.WrapErrParameterInvalidMsg("invalid min_gram or max_gram value for Ngram index, min_gram: %d, max_gram: %d", minGram, maxGram)
}
return c.scalarIndexChecker.CheckTrain(dataType, elementType, params)
}
func (c *NgramIndexChecker) CheckValidDataType(indexType IndexType, field *schemapb.FieldSchema) error {
dType := field.GetDataType()
if !typeutil.IsStringType(dType) && dType != schemapb.DataType_JSON {
return fmt.Errorf("ngram index can only be created on VARCHAR or JSON field")
}
return nil
}