Package io.milvus.param

Class ParamUtils

java.lang.Object

io.milvus.param.ParamUtils

public class ParamUtils
extends Object

Utility functions for param classes

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParamUtils.InsertBuilderWrapper
static class	ParamUtils.InsertDataInfo

Constructor Summary

Constructors

Constructor	Description
ParamUtils()

Method Summary

Modifier and Type	Method	Description
static List<KeyValuePair>	AssembleKvPair(Map<String,String> sourceMap)
static int	calculateBinVectorDim(DataType dataType, int byteCount)
static void	checkFieldData(FieldType fieldSchema, InsertParam.Field fieldData)
static void	checkFieldData(FieldType fieldSchema, List<?> values, boolean verifyElementType)
static Object	checkFieldValue(String fieldName, DataType dataType, DataType elementType, int dim, int maxLength, int maxCapacity, boolean isNullable, Object defaultVal, com.google.gson.JsonElement value)
static void	CheckNullEmptyString(String target, String name)	Checks if a string is empty or null.
static void	CheckNullString(String target, String name)	Checks if a string is null.
static void	compatibleSearchParams(Map<String,Object> searchParams, SearchRequest.Builder builder)
static SearchRequest	convertAnnSearchParam(AnnSearchParam annSearchParam, ConsistencyLevelEnum consistencyLevel)
static FieldType	ConvertField(FieldSchema field)	Convert a grpc field schema to client field schema
static FieldSchema	ConvertField(FieldType field)	Convert a client field schema to grpc field schema
static HybridSearchRequest	convertHybridSearchParam(HybridSearchParam requestParam)
static List<Object>	convertJsonArray(com.google.gson.JsonArray jsonArray, DataType elementType, String fieldName)
static com.google.protobuf.ByteString	convertPlaceholder(List<?> vectors, PlaceholderType placeType)
static com.google.protobuf.ByteString	convertPlaceholder(List<?> vectors, PlaceholderType placeType, boolean elementLevel)
static QueryRequest	convertQueryParam(QueryParam requestParam)
static SearchRequest	convertSearchParam(SearchParam requestParam)
static SortedMap<Long,Float>	decodeSparseFloatVector(ByteBuffer buf)
static ByteBuffer	encodeSparseFloatVector(SortedMap<Long,Float> sparse)
static FieldData	genFieldData(String fieldName, DataType dataType, DataType elementType, boolean isNullable, Object defaultVal, List<?> objects, boolean isDynamic)
static ScalarField	genScalarField(DataType dataType, DataType elementType, List<?> objects)
static VectorField	genVectorField(DataType dataType, List<?> objects)
static HashMap<DataType,String>	getTypeErrorMsgForRowInsert()
static boolean	isDenseVectorDataType(DataType dataType)
static boolean	isVectorDataType(DataType dataType)
static ValueField	objectToValueField(Object obj, DataType dataType)
static Object	valueFieldToObject(ValueField value, DataType dataType)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamUtils

public ParamUtils()

Method Detail

getTypeErrorMsgForRowInsert

public static HashMap<DataType,String> getTypeErrorMsgForRowInsert()

checkFieldData

public static void checkFieldData(FieldType fieldSchema,
                                  InsertParam.Field fieldData)

calculateBinVectorDim

public static int calculateBinVectorDim(DataType dataType,
                                        int byteCount)

checkFieldData

public static void checkFieldData(FieldType fieldSchema,
                                  List<?> values,
                                  boolean verifyElementType)

checkFieldValue

public static Object checkFieldValue(String fieldName,
                                     DataType dataType,
                                     DataType elementType,
                                     int dim,
                                     int maxLength,
                                     int maxCapacity,
                                     boolean isNullable,
                                     Object defaultVal,
                                     com.google.gson.JsonElement value)

convertJsonArray

public static List<Object> convertJsonArray(com.google.gson.JsonArray jsonArray,
                                            DataType elementType,
                                            String fieldName)

CheckNullEmptyString

public static void CheckNullEmptyString(String target,
                                        String name)
                                 throws ParamException

Checks if a string is empty or null. Throws ParamException if the string is empty of null.

Parameters:

target - target string

name - a name to describe this string

Throws:

ParamException

CheckNullString

public static void CheckNullString(String target,
                                   String name)
                            throws ParamException

Checks if a string is null. Throws ParamException if the string is null.

Parameters:

target - target string

name - a name to describe this string

Throws:

ParamException

convertPlaceholder

public static com.google.protobuf.ByteString convertPlaceholder(List<?> vectors,
                                                                PlaceholderType placeType)
                                                         throws ParamException

Throws:

ParamException

convertPlaceholder

public static com.google.protobuf.ByteString convertPlaceholder(List<?> vectors,
                                                                PlaceholderType placeType,
                                                                boolean elementLevel)
                                                         throws ParamException

Throws:

ParamException

compatibleSearchParams

public static void compatibleSearchParams(Map<String,Object> searchParams,
                                          SearchRequest.Builder builder)

convertSearchParam

public static SearchRequest convertSearchParam(SearchParam requestParam)
                                        throws ParamException

Throws:

ParamException

convertAnnSearchParam

public static SearchRequest convertAnnSearchParam(AnnSearchParam annSearchParam,
                                                  ConsistencyLevelEnum consistencyLevel)

convertHybridSearchParam

public static HybridSearchRequest convertHybridSearchParam(HybridSearchParam requestParam)
                                                    throws ParamException

Throws:

ParamException

convertQueryParam

public static QueryRequest convertQueryParam(QueryParam requestParam)

isDenseVectorDataType

public static boolean isDenseVectorDataType(DataType dataType)

isVectorDataType

public static boolean isVectorDataType(DataType dataType)

genFieldData

public static FieldData genFieldData(String fieldName,
                                     DataType dataType,
                                     DataType elementType,
                                     boolean isNullable,
                                     Object defaultVal,
                                     List<?> objects,
                                     boolean isDynamic)

genVectorField

public static VectorField genVectorField(DataType dataType,
                                         List<?> objects)

encodeSparseFloatVector

public static ByteBuffer encodeSparseFloatVector(SortedMap<Long,Float> sparse)

decodeSparseFloatVector

public static SortedMap<Long,Float> decodeSparseFloatVector(ByteBuffer buf)

genScalarField

public static ScalarField genScalarField(DataType dataType,
                                         DataType elementType,
                                         List<?> objects)

ConvertField

public static FieldType ConvertField(FieldSchema field)

Convert a grpc field schema to client field schema

Parameters:

field - FieldSchema object

Returns:

FieldType schema of the field

ConvertField

public static FieldSchema ConvertField(FieldType field)

Convert a client field schema to grpc field schema

Parameters:

field - FieldType object

Returns:

FieldSchema schema of the field

objectToValueField

public static ValueField objectToValueField(Object obj,
                                            DataType dataType)

valueFieldToObject

public static Object valueFieldToObject(ValueField value,
                                        DataType dataType)

AssembleKvPair

public static List<KeyValuePair> AssembleKvPair(Map<String,String> sourceMap)