com.aliyun.dashvector.utils

类 Validator

java.lang.Object

com.aliyun.dashvector.utils.Validator

public class Validator
extends Object

作者:

sanyi

构造器概要

构造器

构造器和说明
Validator()

方法概要

限定符和类型	方法和说明
static void	verifyBachSize(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 void	verifyDocParam(@NonNull WriteDocRequest<? extends com.google.protobuf.Message> writeDocRequest, @NonNull CollectionMeta collectionMeta, DocOpResult.DocOp docOp) Verify Model DocParam
static boolean	verifyEndpoint(@NonNull String endpoint) endpoint域名检查
static void	verifyFields(Map<String,?> fieldsSchema) Verify DashVectorCollection filedsSchema
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	verifyOutputFields(List<String> outputFields) Verify outputFields
static void	verifyPartitionName(@NonNull String name) Verify Partition Name
static void	verifyQueryGroupByParam(@NonNull QueryDocGroupByRequest queryDocGroupByRequest, @NonNull CollectionMeta collectionMeta) Verify Model QueryDocRequest
static void	verifyQueryParma(@NonNull QueryDocRequest queryDocRequest, @NonNull CollectionMeta collectionMeta) Verify Model QueryDocRequest
static void	verifyRequestSize(@NonNull com.google.protobuf.Message message) Verify request size
static void	verifySparseVector(Map<Long,Float> sparseVector) 验证sparse indices 是否大于uint32
static void	verifyTopK(int topk, boolean includeVector) Verify topk
static void	verifyVectorType(List<? extends Number> vector) Verify Doc Vector Type

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

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

构造器详细资料

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

verifyBachSize

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

Verify bach size

参数:

docs - the list of Doc

抛出:

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

verifyVectorType

public static void verifyVectorType(List<? extends Number> vector)
                             throws DashVectorException

Verify Doc Vector Type

参数:

vector - Vector

抛出:

DashVectorException - When vector is null or vector type not in [float, int]

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,?> fieldsSchema)
                         throws DashVectorException

Verify DashVectorCollection filedsSchema

参数:

fieldsSchema - the filedsSchema of Collection

抛出:

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

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]

verifyDocParam

public static void verifyDocParam(@NonNull
                                  @NonNull WriteDocRequest<? extends com.google.protobuf.Message> writeDocRequest,
                                  @NonNull
                                  @NonNull CollectionMeta collectionMeta,
                                  DocOpResult.DocOp docOp)
                           throws DashVectorException

Verify Model DocParam

参数:

writeDocRequest - WriteDocRequest

collectionMeta - CollectionMeta

抛出:

DashVectorException - When dimension mismatch, metric mismatch or invalid sparse vector

verifyQueryParma

public static void verifyQueryParma(@NonNull
                                    @NonNull QueryDocRequest queryDocRequest,
                                    @NonNull
                                    @NonNull CollectionMeta collectionMeta)
                             throws DashVectorException

Verify Model QueryDocRequest

参数:

queryDocRequest - QueryDocRequest

collectionMeta - CollectionMeta

抛出:

DashVectorException - When dimension mismatch, metric mismatch or invalid sparse vector

verifyQueryGroupByParam

public static void verifyQueryGroupByParam(@NonNull
                                           @NonNull QueryDocGroupByRequest queryDocGroupByRequest,
                                           @NonNull
                                           @NonNull CollectionMeta collectionMeta)
                                    throws DashVectorException

Verify Model QueryDocRequest

参数:

queryDocGroupByRequest - QueryDocGroupByRequest

collectionMeta - CollectionMeta

抛出:

DashVectorException - When dimension mismatch, metric mismatch or invalid sparse vector

verifyEndpoint

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

endpoint域名检查

参数:

endpoint - dashvector service endpoint

返回:

verifySparseVector

public static void verifySparseVector(Map<Long,Float> sparseVector)

验证sparse indices 是否大于uint32

参数:

sparseVector - sparseVector