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(@NonNull String id) Verify Doc id
static void	verifyDocIdList(List<String> docIds) Verify DocId List
static void	verifyDocList(List<Doc> docs) Verify Doc List
static void	verifyDocParam(@NonNull WriteDocRequest<? extends com.google.protobuf.Message> writeDocRequest, @NonNull CollectionMeta collectionMeta) Verify Model DocParam
static boolean	verifyEndpoint(@NonNull String endpoint)
static void	verifyFields(Map<String,?> fieldsSchema) Verify DashVectorCollection filedsSchema
static void	verifyFilter(String filter) Verify Filter
static void	verifyOutputFields(List<String> outputFields) Verify outputFields
static void	verifyPartitionName(@NonNull String name) Verify Partition Name
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	verifyTopK(int topk) 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

verifyDocId

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

Verify Doc id

参数:

id - the id of Doc

抛出:

DashVectorException - When id violates naming constraints

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)
                       throws DashVectorException

Verify topk

参数:

topk - the topk of QueryDocRequest

抛出:

DashVectorException - When topk not in [1,1024]

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]

verifyDocList

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

Verify Doc List

参数:

docs - the list of Doc

抛出:

DashVectorException - When docs is null or doc field is abnormal

verifyDocParam

public static void verifyDocParam(@NonNull
                                  @NonNull WriteDocRequest<? extends com.google.protobuf.Message> writeDocRequest,
                                  @NonNull
                                  @NonNull CollectionMeta collectionMeta)
                           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

verifyEndpoint

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