Package io.dingodb.common

Interface Common.VectorSearchParameterOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Common.VectorSearchParameter, Common.VectorSearchParameter.Builder
Enclosing class:
Common
public static interface Common.VectorSearchParameterOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getTopN

      int getTopN()
       The number of top results to return.
      uint32 top_n = 1;
      Returns:
      The topN.

    • getWithoutVectorData

      boolean getWithoutVectorData()
       Default false, if true, response without vector data.
      bool without_vector_data = 2;
      Returns:
      The withoutVectorData.

    • getWithoutScalarData

      boolean getWithoutScalarData()
       Default false, if true, response without scalar data.
      bool without_scalar_data = 3;
      Returns:
      The withoutScalarData.

    • getSelectedKeysList

      List<String> getSelectedKeysList()
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 4;
      Returns:
      A list containing the selectedKeys.

    • getSelectedKeysCount

      int getSelectedKeysCount()
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 4;
      Returns:
      The count of selectedKeys.

    • getSelectedKeys

      String getSelectedKeys(int index)
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 4;
      Parameters:
      index - The index of the element to return.
      Returns:
      The selectedKeys at the given index.

    • getSelectedKeysBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the selectedKeys at the given index.

    • getWithoutTableData

      boolean getWithoutTableData()
       if this parameter is null, all scalar data will be returned.
      bool without_table_data = 5;
      Returns:
      The withoutTableData.

    • getEnableRangeSearch

      boolean getEnableRangeSearch()
       Whether to enable range search. true : enable , false disable.
      bool enable_range_search = 6;
      Returns:
      The enableRangeSearch.

    • getRadius

      float getRadius()
       if enable_range_search = true. top_n disabled.
      float radius = 7;
      Returns:
      The radius.

    • hasFlat

      boolean hasFlat()
      .dingodb.pb.common.SearchFlatParam flat = 11;
      Returns:
      Whether the flat field is set.

    • getFlat

      Common.SearchFlatParam getFlat()
      .dingodb.pb.common.SearchFlatParam flat = 11;
      Returns:
      The flat.

    • getFlatOrBuilder

      Common.SearchFlatParamOrBuilder getFlatOrBuilder()
      .dingodb.pb.common.SearchFlatParam flat = 11;

    • hasIvfFlat

      boolean hasIvfFlat()
      .dingodb.pb.common.SearchIvfFlatParam ivf_flat = 12;
      Returns:
      Whether the ivfFlat field is set.

    • getIvfFlat

      Common.SearchIvfFlatParam getIvfFlat()
      .dingodb.pb.common.SearchIvfFlatParam ivf_flat = 12;
      Returns:
      The ivfFlat.

    • getIvfFlatOrBuilder

      Common.SearchIvfFlatParamOrBuilder getIvfFlatOrBuilder()
      .dingodb.pb.common.SearchIvfFlatParam ivf_flat = 12;

    • hasIvfPq

      boolean hasIvfPq()
      .dingodb.pb.common.SearchIvfPqParam ivf_pq = 13;
      Returns:
      Whether the ivfPq field is set.

    • getIvfPq

      Common.SearchIvfPqParam getIvfPq()
      .dingodb.pb.common.SearchIvfPqParam ivf_pq = 13;
      Returns:
      The ivfPq.

    • getIvfPqOrBuilder

      Common.SearchIvfPqParamOrBuilder getIvfPqOrBuilder()
      .dingodb.pb.common.SearchIvfPqParam ivf_pq = 13;

    • hasHnsw

      boolean hasHnsw()
      .dingodb.pb.common.SearchHNSWParam hnsw = 14;
      Returns:
      Whether the hnsw field is set.

    • getHnsw

      Common.SearchHNSWParam getHnsw()
      .dingodb.pb.common.SearchHNSWParam hnsw = 14;
      Returns:
      The hnsw.

    • getHnswOrBuilder

      Common.SearchHNSWParamOrBuilder getHnswOrBuilder()
      .dingodb.pb.common.SearchHNSWParam hnsw = 14;

    • hasDiskann

      boolean hasDiskann()
      .dingodb.pb.common.SearchDiskAnnParam diskann = 15;
      Returns:
      Whether the diskann field is set.

    • getDiskann

      Common.SearchDiskAnnParam getDiskann()
      .dingodb.pb.common.SearchDiskAnnParam diskann = 15;
      Returns:
      The diskann.

    • getDiskannOrBuilder

      Common.SearchDiskAnnParamOrBuilder getDiskannOrBuilder()
      .dingodb.pb.common.SearchDiskAnnParam diskann = 15;

    • hasBinaryFlat

      boolean hasBinaryFlat()
      .dingodb.pb.common.SearchBinaryFlatParam binary_flat = 30;
      Returns:
      Whether the binaryFlat field is set.

    • getBinaryFlat

      Common.SearchBinaryFlatParam getBinaryFlat()
      .dingodb.pb.common.SearchBinaryFlatParam binary_flat = 30;
      Returns:
      The binaryFlat.

    • getBinaryFlatOrBuilder

      Common.SearchBinaryFlatParamOrBuilder getBinaryFlatOrBuilder()
      .dingodb.pb.common.SearchBinaryFlatParam binary_flat = 30;

    • hasBinaryIvfFlat

      boolean hasBinaryIvfFlat()
      .dingodb.pb.common.SearchBinaryIvfFlatParam binary_ivf_flat = 31;
      Returns:
      Whether the binaryIvfFlat field is set.

    • getBinaryIvfFlat

      Common.SearchBinaryIvfFlatParam getBinaryIvfFlat()
      .dingodb.pb.common.SearchBinaryIvfFlatParam binary_ivf_flat = 31;
      Returns:
      The binaryIvfFlat.

    • getBinaryIvfFlatOrBuilder

      Common.SearchBinaryIvfFlatParamOrBuilder getBinaryIvfFlatOrBuilder()
      .dingodb.pb.common.SearchBinaryIvfFlatParam binary_ivf_flat = 31;

    • getVectorFilterValue

      int getVectorFilterValue()
       filter source
      .dingodb.pb.common.VectorFilter vector_filter = 21;
      Returns:
      The enum numeric value on the wire for vectorFilter.

    • getVectorFilter

      Common.VectorFilter getVectorFilter()
       filter source
      .dingodb.pb.common.VectorFilter vector_filter = 21;
      Returns:
      The vectorFilter.

    • getVectorFilterTypeValue

      int getVectorFilterTypeValue()
       only include pre filter and post filter
      .dingodb.pb.common.VectorFilterType vector_filter_type = 22;
      Returns:
      The enum numeric value on the wire for vectorFilterType.

    • getVectorFilterType

      Common.VectorFilterType getVectorFilterType()
       only include pre filter and post filter
      .dingodb.pb.common.VectorFilterType vector_filter_type = 22;
      Returns:
      The vectorFilterType.

    • hasVectorCoprocessor

      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;
      Returns:
      Whether the vectorCoprocessor field is set.

    • getVectorCoprocessor

      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;
      Returns:
      The vectorCoprocessor.

    • getVectorCoprocessorOrBuilder

      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;

    • getIsNegation

      boolean getIsNegation()
       vector id array vector_filter == VECTOR_ID_FILTER enable vector_ids
      bool is_negation = 26;
      Returns:
      The isNegation.

    • getIsSorted

      boolean getIsSorted()
       vector_ids is sorted
      bool is_sorted = 27;
      Returns:
      The isSorted.

    • getVectorIdsList

      List<Long> getVectorIdsList()
      repeated int64 vector_ids = 24;
      Returns:
      A list containing the vectorIds.

    • getVectorIdsCount

      int getVectorIdsCount()
      repeated int64 vector_ids = 24;
      Returns:
      The count of vectorIds.

    • getVectorIds

      long getVectorIds(int index)
      repeated int64 vector_ids = 24;
      Parameters:
      index - The index of the element to return.
      Returns:
      The vectorIds at the given index.

    • getUseBruteForce

      boolean getUseBruteForce()
       use brute-force search
      bool use_brute_force = 25;
      Returns:
      The useBruteForce.

    • getSearchCase

      Common.VectorSearchParameter.SearchCase getSearchCase()