Package io.dingodb.common

Class Common.VectorSearchParameter

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.dingodb.common.Common.VectorSearchParameter

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Common.VectorSearchParameterOrBuilder, Serializable

Enclosing class:

Common

public static final class Common.VectorSearchParameter
extends com.google.protobuf.GeneratedMessageV3
implements Common.VectorSearchParameterOrBuilder

Protobuf type dingodb.pb.common.VectorSearchParameter

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Common.VectorSearchParameter.Builder	Protobuf type dingodb.pb.common.VectorSearchParameter
static enum	Common.VectorSearchParameter.SearchCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BINARY_FLAT_FIELD_NUMBER
static final int	BINARY_IVF_FLAT_FIELD_NUMBER
static final int	DISKANN_FIELD_NUMBER
static final int	ENABLE_RANGE_SEARCH_FIELD_NUMBER
static final int	FLAT_FIELD_NUMBER
static final int	HNSW_FIELD_NUMBER
static final int	IS_NEGATION_FIELD_NUMBER
static final int	IS_SORTED_FIELD_NUMBER
static final int	IVF_FLAT_FIELD_NUMBER
static final int	IVF_PQ_FIELD_NUMBER
static final int	RADIUS_FIELD_NUMBER
static final int	SELECTED_KEYS_FIELD_NUMBER
static final int	TOP_N_FIELD_NUMBER
static final int	USE_BRUTE_FORCE_FIELD_NUMBER
static final int	VECTOR_COPROCESSOR_FIELD_NUMBER
static final int	VECTOR_FILTER_FIELD_NUMBER
static final int	VECTOR_FILTER_TYPE_FIELD_NUMBER
static final int	VECTOR_IDS_FIELD_NUMBER
static final int	WITHOUT_SCALAR_DATA_FIELD_NUMBER
static final int	WITHOUT_TABLE_DATA_FIELD_NUMBER
static final int	WITHOUT_VECTOR_DATA_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Common.SearchBinaryFlatParam	getBinaryFlat()	.dingodb.pb.common.SearchBinaryFlatParam binary_flat = 30;
Common.SearchBinaryFlatParamOrBuilder	getBinaryFlatOrBuilder()	.dingodb.pb.common.SearchBinaryFlatParam binary_flat = 30;
Common.SearchBinaryIvfFlatParam	getBinaryIvfFlat()	.dingodb.pb.common.SearchBinaryIvfFlatParam binary_ivf_flat = 31;
Common.SearchBinaryIvfFlatParamOrBuilder	getBinaryIvfFlatOrBuilder()	.dingodb.pb.common.SearchBinaryIvfFlatParam binary_ivf_flat = 31;
static Common.VectorSearchParameter	getDefaultInstance()
Common.VectorSearchParameter	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Common.SearchDiskAnnParam	getDiskann()	.dingodb.pb.common.SearchDiskAnnParam diskann = 15;
Common.SearchDiskAnnParamOrBuilder	getDiskannOrBuilder()	.dingodb.pb.common.SearchDiskAnnParam diskann = 15;
boolean	getEnableRangeSearch()	Whether to enable range search.
Common.SearchFlatParam	getFlat()	.dingodb.pb.common.SearchFlatParam flat = 11;
Common.SearchFlatParamOrBuilder	getFlatOrBuilder()	.dingodb.pb.common.SearchFlatParam flat = 11;
Common.SearchHNSWParam	getHnsw()	.dingodb.pb.common.SearchHNSWParam hnsw = 14;
Common.SearchHNSWParamOrBuilder	getHnswOrBuilder()	.dingodb.pb.common.SearchHNSWParam hnsw = 14;
boolean	getIsNegation()	vector id array vector_filter == VECTOR_ID_FILTER enable vector_ids
boolean	getIsSorted()	vector_ids is sorted
Common.SearchIvfFlatParam	getIvfFlat()	.dingodb.pb.common.SearchIvfFlatParam ivf_flat = 12;
Common.SearchIvfFlatParamOrBuilder	getIvfFlatOrBuilder()	.dingodb.pb.common.SearchIvfFlatParam ivf_flat = 12;
Common.SearchIvfPqParam	getIvfPq()	.dingodb.pb.common.SearchIvfPqParam ivf_pq = 13;
Common.SearchIvfPqParamOrBuilder	getIvfPqOrBuilder()	.dingodb.pb.common.SearchIvfPqParam ivf_pq = 13;
com.google.protobuf.Parser<Common.VectorSearchParameter>	getParserForType()
float	getRadius()	if enable_range_search = true.
Common.VectorSearchParameter.SearchCase	getSearchCase()
String	getSelectedKeys(int index)	If without_scalar_data is false, selected_keys is used to select scalar data,
com.google.protobuf.ByteString	getSelectedKeysBytes(int index)	If without_scalar_data is false, selected_keys is used to select scalar data,
int	getSelectedKeysCount()	If without_scalar_data is false, selected_keys is used to select scalar data,
com.google.protobuf.ProtocolStringList	getSelectedKeysList()	If without_scalar_data is false, selected_keys is used to select scalar data,
int	getSerializedSize()
int	getTopN()	The number of top results to return.
boolean	getUseBruteForce()	use brute-force search
Common.CoprocessorV2	getVectorCoprocessor()	if vector_filter == TABLE_FILTER and vector_query_type = QUERY_PRE enable vector_coprocessor coprocessor request
Common.CoprocessorV2OrBuilder	getVectorCoprocessorOrBuilder()	if vector_filter == TABLE_FILTER and vector_query_type = QUERY_PRE enable vector_coprocessor coprocessor request
Common.VectorFilter	getVectorFilter()	filter source
Common.VectorFilterType	getVectorFilterType()	only include pre filter and post filter
int	getVectorFilterTypeValue()	only include pre filter and post filter
int	getVectorFilterValue()	filter source
long	getVectorIds(int index)	repeated int64 vector_ids = 24;
int	getVectorIdsCount()	repeated int64 vector_ids = 24;
List<Long>	getVectorIdsList()	repeated int64 vector_ids = 24;
boolean	getWithoutScalarData()	Default false, if true, response without scalar data.
boolean	getWithoutTableData()	if this parameter is null, all scalar data will be returned.
boolean	getWithoutVectorData()	Default false, if true, response without vector data.
boolean	hasBinaryFlat()	.dingodb.pb.common.SearchBinaryFlatParam binary_flat = 30;
boolean	hasBinaryIvfFlat()	.dingodb.pb.common.SearchBinaryIvfFlatParam binary_ivf_flat = 31;
boolean	hasDiskann()	.dingodb.pb.common.SearchDiskAnnParam diskann = 15;
boolean	hasFlat()	.dingodb.pb.common.SearchFlatParam flat = 11;
int	hashCode()
boolean	hasHnsw()	.dingodb.pb.common.SearchHNSWParam hnsw = 14;
boolean	hasIvfFlat()	.dingodb.pb.common.SearchIvfFlatParam ivf_flat = 12;
boolean	hasIvfPq()	.dingodb.pb.common.SearchIvfPqParam ivf_pq = 13;
boolean	hasVectorCoprocessor()	if vector_filter == TABLE_FILTER and vector_query_type = QUERY_PRE enable vector_coprocessor coprocessor request
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static Common.VectorSearchParameter.Builder	newBuilder()
static Common.VectorSearchParameter.Builder	newBuilder(Common.VectorSearchParameter prototype)
Common.VectorSearchParameter.Builder	newBuilderForType()
protected Common.VectorSearchParameter.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Common.VectorSearchParameter	parseDelimitedFrom(InputStream input)
static Common.VectorSearchParameter	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Common.VectorSearchParameter	parseFrom(byte[] data)
static Common.VectorSearchParameter	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Common.VectorSearchParameter	parseFrom(com.google.protobuf.ByteString data)
static Common.VectorSearchParameter	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Common.VectorSearchParameter	parseFrom(com.google.protobuf.CodedInputStream input)
static Common.VectorSearchParameter	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Common.VectorSearchParameter	parseFrom(InputStream input)
static Common.VectorSearchParameter	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Common.VectorSearchParameter	parseFrom(ByteBuffer data)
static Common.VectorSearchParameter	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Common.VectorSearchParameter>	parser()
Common.VectorSearchParameter.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

TOP_N_FIELD_NUMBER

public static final int TOP_N_FIELD_NUMBER

See Also:

• Constant Field Values

WITHOUT_VECTOR_DATA_FIELD_NUMBER

public static final int WITHOUT_VECTOR_DATA_FIELD_NUMBER

See Also:

• Constant Field Values

WITHOUT_SCALAR_DATA_FIELD_NUMBER

public static final int WITHOUT_SCALAR_DATA_FIELD_NUMBER

See Also:

• Constant Field Values

SELECTED_KEYS_FIELD_NUMBER

public static final int SELECTED_KEYS_FIELD_NUMBER

See Also:

• Constant Field Values

WITHOUT_TABLE_DATA_FIELD_NUMBER

public static final int WITHOUT_TABLE_DATA_FIELD_NUMBER

See Also:

• Constant Field Values

ENABLE_RANGE_SEARCH_FIELD_NUMBER

public static final int ENABLE_RANGE_SEARCH_FIELD_NUMBER

See Also:

• Constant Field Values

RADIUS_FIELD_NUMBER

public static final int RADIUS_FIELD_NUMBER

See Also:

• Constant Field Values

FLAT_FIELD_NUMBER

public static final int FLAT_FIELD_NUMBER

See Also:

• Constant Field Values

IVF_FLAT_FIELD_NUMBER

public static final int IVF_FLAT_FIELD_NUMBER

See Also:

• Constant Field Values

IVF_PQ_FIELD_NUMBER

public static final int IVF_PQ_FIELD_NUMBER

See Also:

• Constant Field Values

HNSW_FIELD_NUMBER

public static final int HNSW_FIELD_NUMBER

See Also:

• Constant Field Values

DISKANN_FIELD_NUMBER

public static final int DISKANN_FIELD_NUMBER

See Also:

• Constant Field Values

BINARY_FLAT_FIELD_NUMBER

public static final int BINARY_FLAT_FIELD_NUMBER

See Also:

• Constant Field Values

BINARY_IVF_FLAT_FIELD_NUMBER

public static final int BINARY_IVF_FLAT_FIELD_NUMBER

See Also:

• Constant Field Values

VECTOR_FILTER_FIELD_NUMBER

public static final int VECTOR_FILTER_FIELD_NUMBER

See Also:

• Constant Field Values

VECTOR_FILTER_TYPE_FIELD_NUMBER

public static final int VECTOR_FILTER_TYPE_FIELD_NUMBER

See Also:

• Constant Field Values

VECTOR_COPROCESSOR_FIELD_NUMBER

public static final int VECTOR_COPROCESSOR_FIELD_NUMBER

See Also:

• Constant Field Values

IS_NEGATION_FIELD_NUMBER

public static final int IS_NEGATION_FIELD_NUMBER

See Also:

• Constant Field Values

IS_SORTED_FIELD_NUMBER

public static final int IS_SORTED_FIELD_NUMBER

See Also:

• Constant Field Values

VECTOR_IDS_FIELD_NUMBER

public static final int VECTOR_IDS_FIELD_NUMBER

See Also:

• Constant Field Values

USE_BRUTE_FORCE_FIELD_NUMBER

public static final int USE_BRUTE_FORCE_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSearchCase

public Common.VectorSearchParameter.SearchCase getSearchCase()

Specified by:

getSearchCase in interface Common.VectorSearchParameterOrBuilder

getTopN

public int getTopN()

 The number of top results to return.
 

uint32 top_n = 1;

Specified by:

getTopN in interface Common.VectorSearchParameterOrBuilder

Returns:

The topN.

getWithoutVectorData

public boolean getWithoutVectorData()

 Default false, if true, response without vector data.
 

bool without_vector_data = 2;

Specified by:

getWithoutVectorData in interface Common.VectorSearchParameterOrBuilder

Returns:

The withoutVectorData.

getWithoutScalarData

public boolean getWithoutScalarData()

 Default false, if true, response without scalar data.
 

bool without_scalar_data = 3;

Specified by:

getWithoutScalarData in interface Common.VectorSearchParameterOrBuilder

Returns:

The withoutScalarData.

getSelectedKeysList

public com.google.protobuf.ProtocolStringList getSelectedKeysList()

 If without_scalar_data is false, selected_keys is used to select scalar data,
 

repeated string selected_keys = 4;

Specified by:

getSelectedKeysList in interface Common.VectorSearchParameterOrBuilder

Returns:

A list containing the selectedKeys.

getSelectedKeysCount

public int getSelectedKeysCount()

 If without_scalar_data is false, selected_keys is used to select scalar data,
 

repeated string selected_keys = 4;

Specified by:

getSelectedKeysCount in interface Common.VectorSearchParameterOrBuilder

Returns:

The count of selectedKeys.

getSelectedKeys

public String getSelectedKeys(int index)

 If without_scalar_data is false, selected_keys is used to select scalar data,
 

repeated string selected_keys = 4;

Specified by:

getSelectedKeys in interface Common.VectorSearchParameterOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The selectedKeys at the given index.

getSelectedKeysBytes

public com.google.protobuf.ByteString getSelectedKeysBytes(int index)

 If without_scalar_data is false, selected_keys is used to select scalar data,
 

repeated string selected_keys = 4;

Specified by:

getSelectedKeysBytes in interface Common.VectorSearchParameterOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the selectedKeys at the given index.

getWithoutTableData

public boolean getWithoutTableData()

 if this parameter is null, all scalar data will be returned.
 

bool without_table_data = 5;

Specified by:

getWithoutTableData in interface Common.VectorSearchParameterOrBuilder

Returns:

The withoutTableData.

getEnableRangeSearch

public boolean getEnableRangeSearch()

 Whether to enable range search. true : enable , false disable.
 

bool enable_range_search = 6;

Specified by:

getEnableRangeSearch in interface Common.VectorSearchParameterOrBuilder

Returns:

The enableRangeSearch.

getRadius

public float getRadius()

 if enable_range_search = true. top_n disabled.
 

float radius = 7;

Specified by:

getRadius in interface Common.VectorSearchParameterOrBuilder

Returns:

The radius.

hasFlat

public boolean hasFlat()

.dingodb.pb.common.SearchFlatParam flat = 11;

Specified by:

hasFlat in interface Common.VectorSearchParameterOrBuilder

Returns:

Whether the flat field is set.

getFlat

public Common.SearchFlatParam getFlat()

.dingodb.pb.common.SearchFlatParam flat = 11;

Specified by:

getFlat in interface Common.VectorSearchParameterOrBuilder

Returns:

The flat.

getFlatOrBuilder

public Common.SearchFlatParamOrBuilder getFlatOrBuilder()

.dingodb.pb.common.SearchFlatParam flat = 11;

Specified by:

getFlatOrBuilder in interface Common.VectorSearchParameterOrBuilder

hasIvfFlat

public boolean hasIvfFlat()

.dingodb.pb.common.SearchIvfFlatParam ivf_flat = 12;

Specified by:

hasIvfFlat in interface Common.VectorSearchParameterOrBuilder

Returns:

Whether the ivfFlat field is set.

getIvfFlat

public Common.SearchIvfFlatParam getIvfFlat()

.dingodb.pb.common.SearchIvfFlatParam ivf_flat = 12;

Specified by:

getIvfFlat in interface Common.VectorSearchParameterOrBuilder

Returns:

The ivfFlat.

getIvfFlatOrBuilder

public Common.SearchIvfFlatParamOrBuilder getIvfFlatOrBuilder()

.dingodb.pb.common.SearchIvfFlatParam ivf_flat = 12;

Specified by:

getIvfFlatOrBuilder in interface Common.VectorSearchParameterOrBuilder

hasIvfPq

public boolean hasIvfPq()

.dingodb.pb.common.SearchIvfPqParam ivf_pq = 13;

Specified by:

hasIvfPq in interface Common.VectorSearchParameterOrBuilder

Returns:

Whether the ivfPq field is set.

getIvfPq

public Common.SearchIvfPqParam getIvfPq()

.dingodb.pb.common.SearchIvfPqParam ivf_pq = 13;

Specified by:

getIvfPq in interface Common.VectorSearchParameterOrBuilder

Returns:

The ivfPq.

getIvfPqOrBuilder

public Common.SearchIvfPqParamOrBuilder getIvfPqOrBuilder()

.dingodb.pb.common.SearchIvfPqParam ivf_pq = 13;

Specified by:

getIvfPqOrBuilder in interface Common.VectorSearchParameterOrBuilder

hasHnsw

public boolean hasHnsw()

.dingodb.pb.common.SearchHNSWParam hnsw = 14;

Specified by:

hasHnsw in interface Common.VectorSearchParameterOrBuilder

Returns:

Whether the hnsw field is set.

getHnsw

public Common.SearchHNSWParam getHnsw()

.dingodb.pb.common.SearchHNSWParam hnsw = 14;

Specified by:

getHnsw in interface Common.VectorSearchParameterOrBuilder

Returns:

The hnsw.

getHnswOrBuilder

public Common.SearchHNSWParamOrBuilder getHnswOrBuilder()

.dingodb.pb.common.SearchHNSWParam hnsw = 14;

Specified by:

getHnswOrBuilder in interface Common.VectorSearchParameterOrBuilder

hasDiskann

public boolean hasDiskann()

.dingodb.pb.common.SearchDiskAnnParam diskann = 15;

Specified by:

hasDiskann in interface Common.VectorSearchParameterOrBuilder

Returns:

Whether the diskann field is set.

getDiskann

public Common.SearchDiskAnnParam getDiskann()

.dingodb.pb.common.SearchDiskAnnParam diskann = 15;

Specified by:

getDiskann in interface Common.VectorSearchParameterOrBuilder

Returns:

The diskann.

getDiskannOrBuilder

public Common.SearchDiskAnnParamOrBuilder getDiskannOrBuilder()

.dingodb.pb.common.SearchDiskAnnParam diskann = 15;

Specified by:

getDiskannOrBuilder in interface Common.VectorSearchParameterOrBuilder

hasBinaryFlat

public boolean hasBinaryFlat()

.dingodb.pb.common.SearchBinaryFlatParam binary_flat = 30;

Specified by:

hasBinaryFlat in interface Common.VectorSearchParameterOrBuilder

Returns:

Whether the binaryFlat field is set.

getBinaryFlat

public Common.SearchBinaryFlatParam getBinaryFlat()

.dingodb.pb.common.SearchBinaryFlatParam binary_flat = 30;

Specified by:

getBinaryFlat in interface Common.VectorSearchParameterOrBuilder

Returns:

The binaryFlat.

getBinaryFlatOrBuilder

public Common.SearchBinaryFlatParamOrBuilder getBinaryFlatOrBuilder()

.dingodb.pb.common.SearchBinaryFlatParam binary_flat = 30;

Specified by:

getBinaryFlatOrBuilder in interface Common.VectorSearchParameterOrBuilder

hasBinaryIvfFlat

public boolean hasBinaryIvfFlat()

.dingodb.pb.common.SearchBinaryIvfFlatParam binary_ivf_flat = 31;

Specified by:

hasBinaryIvfFlat in interface Common.VectorSearchParameterOrBuilder

Returns:

Whether the binaryIvfFlat field is set.

getBinaryIvfFlat

public Common.SearchBinaryIvfFlatParam getBinaryIvfFlat()

.dingodb.pb.common.SearchBinaryIvfFlatParam binary_ivf_flat = 31;

Specified by:

getBinaryIvfFlat in interface Common.VectorSearchParameterOrBuilder

Returns:

The binaryIvfFlat.

getBinaryIvfFlatOrBuilder

public Common.SearchBinaryIvfFlatParamOrBuilder getBinaryIvfFlatOrBuilder()

.dingodb.pb.common.SearchBinaryIvfFlatParam binary_ivf_flat = 31;

Specified by:

getBinaryIvfFlatOrBuilder in interface Common.VectorSearchParameterOrBuilder

getVectorFilterValue

public int getVectorFilterValue()

 filter source
 

.dingodb.pb.common.VectorFilter vector_filter = 21;

Specified by:

getVectorFilterValue in interface Common.VectorSearchParameterOrBuilder

Returns:

The enum numeric value on the wire for vectorFilter.

getVectorFilter

public Common.VectorFilter getVectorFilter()

 filter source
 

.dingodb.pb.common.VectorFilter vector_filter = 21;

Specified by:

getVectorFilter in interface Common.VectorSearchParameterOrBuilder

Returns:

The vectorFilter.

getVectorFilterTypeValue

public int getVectorFilterTypeValue()

 only include pre filter and post filter
 

.dingodb.pb.common.VectorFilterType vector_filter_type = 22;

Specified by:

getVectorFilterTypeValue in interface Common.VectorSearchParameterOrBuilder

Returns:

The enum numeric value on the wire for vectorFilterType.

getVectorFilterType

public Common.VectorFilterType getVectorFilterType()

 only include pre filter and post filter
 

.dingodb.pb.common.VectorFilterType vector_filter_type = 22;

Specified by:

getVectorFilterType in interface Common.VectorSearchParameterOrBuilder

Returns:

The vectorFilterType.

hasVectorCoprocessor

public boolean hasVectorCoprocessor()

  if vector_filter == TABLE_FILTER and  vector_query_type = QUERY_PRE enable vector_coprocessor
  coprocessor request
 

.dingodb.pb.common.CoprocessorV2 vector_coprocessor = 23;

Specified by:

hasVectorCoprocessor in interface Common.VectorSearchParameterOrBuilder

Returns:

Whether the vectorCoprocessor field is set.

getVectorCoprocessor

public Common.CoprocessorV2 getVectorCoprocessor()

  if vector_filter == TABLE_FILTER and  vector_query_type = QUERY_PRE enable vector_coprocessor
  coprocessor request
 

.dingodb.pb.common.CoprocessorV2 vector_coprocessor = 23;

Specified by:

getVectorCoprocessor in interface Common.VectorSearchParameterOrBuilder

Returns:

The vectorCoprocessor.

getVectorCoprocessorOrBuilder

public Common.CoprocessorV2OrBuilder getVectorCoprocessorOrBuilder()

  if vector_filter == TABLE_FILTER and  vector_query_type = QUERY_PRE enable vector_coprocessor
  coprocessor request
 

.dingodb.pb.common.CoprocessorV2 vector_coprocessor = 23;

Specified by:

getVectorCoprocessorOrBuilder in interface Common.VectorSearchParameterOrBuilder

getIsNegation

public boolean getIsNegation()

 vector id array vector_filter == VECTOR_ID_FILTER enable vector_ids
 

bool is_negation = 26;

Specified by:

getIsNegation in interface Common.VectorSearchParameterOrBuilder

Returns:

The isNegation.

getIsSorted

public boolean getIsSorted()

 vector_ids is sorted
 

bool is_sorted = 27;

Specified by:

getIsSorted in interface Common.VectorSearchParameterOrBuilder

Returns:

The isSorted.

getVectorIdsList

public List<Long> getVectorIdsList()

repeated int64 vector_ids = 24;

Specified by:

getVectorIdsList in interface Common.VectorSearchParameterOrBuilder

Returns:

A list containing the vectorIds.

getVectorIdsCount

public int getVectorIdsCount()

repeated int64 vector_ids = 24;

Specified by:

getVectorIdsCount in interface Common.VectorSearchParameterOrBuilder

Returns:

The count of vectorIds.

getVectorIds

public long getVectorIds(int index)

repeated int64 vector_ids = 24;

Specified by:

getVectorIds in interface Common.VectorSearchParameterOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The vectorIds at the given index.

getUseBruteForce

public boolean getUseBruteForce()

 use brute-force search
 

bool use_brute_force = 25;

Specified by:

getUseBruteForce in interface Common.VectorSearchParameterOrBuilder

Returns:

The useBruteForce.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Common.VectorSearchParameter parseFrom(ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Common.VectorSearchParameter parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Common.VectorSearchParameter parseFrom(com.google.protobuf.ByteString data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Common.VectorSearchParameter parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Common.VectorSearchParameter parseFrom(byte[] data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Common.VectorSearchParameter parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Common.VectorSearchParameter parseFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

public static Common.VectorSearchParameter parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static Common.VectorSearchParameter parseDelimitedFrom(InputStream input)
                                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static Common.VectorSearchParameter parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws IOException

Throws:

IOException

parseFrom

public static Common.VectorSearchParameter parseFrom(com.google.protobuf.CodedInputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

public static Common.VectorSearchParameter parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

newBuilderForType

public Common.VectorSearchParameter.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Common.VectorSearchParameter.Builder newBuilder()

newBuilder

public static Common.VectorSearchParameter.Builder newBuilder(Common.VectorSearchParameter prototype)

toBuilder

public Common.VectorSearchParameter.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Common.VectorSearchParameter.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Common.VectorSearchParameter getDefaultInstance()

parser

public static com.google.protobuf.Parser<Common.VectorSearchParameter> parser()

getParserForType

public com.google.protobuf.Parser<Common.VectorSearchParameter> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Common.VectorSearchParameter getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder