com.aliyun.dashvector.utils

类 Validator

java.lang.Object

com.aliyun.dashvector.utils.Validator

public class Validator
extends Object

作者:

sanyi

字段概要

字段

限定符和类型	字段和说明
static int	MAX_VECTORS_COUNT
static String	RESERVE_DENSE_VECTOR
static String	RESERVE_DENSE_VECTOR_MSG
static String	RESERVE_SPARSE_VECTOR
static String	RESERVE_SPARSE_VECTOR_MSG

构造器概要

构造器

构造器和说明
Validator()

方法概要

限定符和类型	方法和说明
static void	verifyArrayFieldsValue(String fieldName, FieldType fieldType, Object fieldValue, Class<?> cls)
static void	verifyBatchSize(List<Doc> docs) Verify bach size
static void	verifyCollectionName(@NonNull String name) Verify DashVectorCollection Name
static void	verifyDimension(int dimension) Verify DashVectorCollection dimension
static void	verifyDocId(String id)
static void	verifyDocIdList(List<String> docIds) Verify DocId List
static void	verifyDocIdRequireNonEmpty(@NonNull String id) Verify Doc id
static boolean	verifyEndpoint(@NonNull String endpoint) endpoint域名检查
static void	verifyFields(Map<String,?> fieldsMap) Verify DashVectorCollection field schema/data_map
static void	verifyFieldsValue(Map<String,?> fieldsMap, Map<String,FieldType> fieldsScheme)
static void	verifyFilter(String filter) Verify Filter
static void	verifyGroupByField(String groupByField) Verify groupByField
static void	verifyGroupCount(int groupCount, boolean includeVector) Verify groupCount
static void	verifyGroupTopK(int groupTopK, boolean includeVector) Verify groupTopk
static void	verifyIndex(Map<String,Index> indexes, Map<String,FieldType> filedsSchema)
static void	verifyOrderByFields(List<OrderByField> orderByFields) Verify orderByFields
static void	verifyOutputFields(List<String> outputFields) Verify outputFields
static void	verifyPartitionName(@NonNull String name) Verify Partition Name
static void	verifyRequestSize(@NonNull com.google.protobuf.Message message) Verify request size
static void	verifyScalarFieldsValue(String fieldName, FieldType fieldType, Object fieldValue, Class<?> cls)
static void	verifySparseVector(Map<Long,Float> sparseVector, @NonNull CollectionMeta collectionMeta)
static void	verifySparseVector(String sparseVectorName, Map<Long,Float> sparseVector, @NonNull CollectionMeta collectionMeta)
static void	verifyTopK(int topk, boolean includeVector) Verify topk
static void	verifyVector(Vector vector, DocOpResult.DocOp docOp, int dimension)
static void	verifyVectorCount(int size)
static void	verifyVectorNameAndCount(Map<String,?> vectors)
static void	verifyVectorParam(VectorParam param)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

RESERVE_DENSE_VECTOR

public static final String RESERVE_DENSE_VECTOR

另请参阅:

常量字段值

RESERVE_DENSE_VECTOR_MSG

public static final String RESERVE_DENSE_VECTOR_MSG

RESERVE_SPARSE_VECTOR

public static final String RESERVE_SPARSE_VECTOR

另请参阅:

常量字段值

RESERVE_SPARSE_VECTOR_MSG

public static final String RESERVE_SPARSE_VECTOR_MSG

MAX_VECTORS_COUNT

public static final int MAX_VECTORS_COUNT

另请参阅:

常量字段值

构造器详细资料

Validator

public Validator()

方法详细资料

verifyRequestSize

public static void verifyRequestSize(@NonNull
                                     @NonNull com.google.protobuf.Message message)
                              throws DashVectorException

Verify request size

参数:

message - Message

抛出:

DashVectorException - When message size greater then 2MiB

verifyDocIdRequireNonEmpty

public static void verifyDocIdRequireNonEmpty(@NonNull
                                              @NonNull String id)
                                       throws DashVectorException

Verify Doc id

参数:

id - the id of Doc

抛出:

DashVectorException - When id violates naming constraints

verifyDocId

public static void verifyDocId(String id)
                        throws DashVectorException

抛出:

DashVectorException

verifyOutputFields

public static void verifyOutputFields(List<String> outputFields)
                               throws DashVectorException

Verify outputFields

参数:

outputFields - the list of output field

抛出:

DashVectorException - When field of outputFields violates naming constraints

verifyTopK

public static void verifyTopK(int topk,
                              boolean includeVector)
                       throws DashVectorException

Verify topk

参数:

topk - the topk of QueryDocRequest

抛出:

DashVectorException - When topk not in [1,1024]

verifyGroupTopK

public static void verifyGroupTopK(int groupTopK,
                                   boolean includeVector)
                            throws DashVectorException

Verify groupTopk

参数:

groupTopK - the groupCount of QueryDocGroupByRequest

抛出:

DashVectorException - When groupCount not in [1,1024]

verifyGroupCount

public static void verifyGroupCount(int groupCount,
                                    boolean includeVector)
                             throws DashVectorException

Verify groupCount

参数:

groupCount - the groupCount of QueryDocGroupByRequest

抛出:

DashVectorException - When groupCount not in [1,64]

verifyGroupByField

public static void verifyGroupByField(String groupByField)
                               throws DashVectorException

Verify groupByField

参数:

groupByField - the groupByField of QueryDocGroupByRequest

抛出:

DashVectorException - When groupByField is empty

verifyBatchSize

public static void verifyBatchSize(List<Doc> docs)
                            throws DashVectorException

Verify bach size

参数:

docs - the list of Doc

抛出:

DashVectorException - When bach size not in [1,1024]

verifyCollectionName

public static void verifyCollectionName(@NonNull
                                        @NonNull String name)
                                 throws DashVectorException

Verify DashVectorCollection Name

参数:

name - the collection name

抛出:

DashVectorException - When the collection name violates naming constraints

verifyPartitionName

public static void verifyPartitionName(@NonNull
                                       @NonNull String name)
                                throws DashVectorException

Verify Partition Name

参数:

name - the partition name

抛出:

DashVectorException - When the partition name violates naming constraints

verifyDimension

public static void verifyDimension(int dimension)
                            throws DashVectorException

Verify DashVectorCollection dimension

参数:

dimension - the dimension

抛出:

DashVectorException - When the dimension not in [1,1024]

verifyFields

public static void verifyFields(Map<String,?> fieldsMap)
                         throws DashVectorException

Verify DashVectorCollection field schema/data_map

参数:

fieldsMap - the field schema/data_map of Collection

抛出:

DashVectorException - When fieldsMap is null or its size not in [1,1024]

verifyScalarFieldsValue

public static void verifyScalarFieldsValue(String fieldName,
                                           FieldType fieldType,
                                           Object fieldValue,
                                           Class<?> cls)
                                    throws DashVectorException

抛出:

DashVectorException

verifyArrayFieldsValue

public static void verifyArrayFieldsValue(String fieldName,
                                          FieldType fieldType,
                                          Object fieldValue,
                                          Class<?> cls)
                                   throws DashVectorException

抛出:

DashVectorException

verifyFieldsValue

public static void verifyFieldsValue(Map<String,?> fieldsMap,
                                     Map<String,FieldType> fieldsScheme)
                              throws DashVectorException

抛出:

DashVectorException

verifyFilter

public static void verifyFilter(String filter)
                         throws DashVectorException

Verify Filter

参数:

filter - the filter of Query

抛出:

DashVectorException - When filter violates naming constraints

verifyDocIdList

public static void verifyDocIdList(List<String> docIds)
                            throws DashVectorException

Verify DocId List

参数:

docIds - the list of id which from Doc

抛出:

DashVectorException - When docids size not in [1,1024]

verifyVector

public static void verifyVector(Vector vector,
                                DocOpResult.DocOp docOp,
                                int dimension)

verifySparseVector

public static void verifySparseVector(Map<Long,Float> sparseVector,
                                      @NonNull
                                      @NonNull CollectionMeta collectionMeta)

verifySparseVector

public static void verifySparseVector(String sparseVectorName,
                                      Map<Long,Float> sparseVector,
                                      @NonNull
                                      @NonNull CollectionMeta collectionMeta)

verifyEndpoint

public static boolean verifyEndpoint(@NonNull
                                     @NonNull String endpoint)

endpoint域名检查

参数:

endpoint - dashvector service endpoint

返回:

verifyVectorParam

public static void verifyVectorParam(VectorParam param)

verifyVectorCount

public static void verifyVectorCount(int size)

verifyVectorNameAndCount

public static void verifyVectorNameAndCount(Map<String,?> vectors)

verifyIndex

public static void verifyIndex(Map<String,Index> indexes,
                               Map<String,FieldType> filedsSchema)

verifyOrderByFields

public static void verifyOrderByFields(List<OrderByField> orderByFields)
                                throws DashVectorException

Verify orderByFields

参数:

orderByFields - the list of output field

抛出:

DashVectorException