Package io.dingodb.common

Interface Common.CreateDiskAnnParamOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAppendReorderData()
    Include full precision data in the index.
    int
    getBuildPqBytes()
    Number of PQ bytes to build the index; 0 for full precision build.
    String
    getCodebookPrefix()
    Path prefix for pre-trained codebook.
    com.google.protobuf.ByteString
    getCodebookPrefixBytes()
    Path prefix for pre-trained codebook.
    int
    getDimension()
    The number of dimensions in the vector data.
    int
    getMaxDegree()
    the degree of the graph index, typically between 60 and 150.
    Common.MetricType
    getMetricType()
    distance calculation method (L2 or InnerProduct) required The distance calculation method to be used for the index.
    int
    getMetricTypeValue()
    distance calculation method (L2 or InnerProduct) required The distance calculation method to be used for the index.
    int
    getPqDiskBytes()
    Number of bytes to which vectors should be compressed " "on SSD; 0 for no compression.
    int
    getQd()
    Quantized Dimension for compression.
    int
    getSearchListSize()
    the size of search list during index build.
    boolean
    getUseOpq()
    use OPQ instead of PQ.
    Common.ValueType
    getValueType()
    value_type , one of {int8, uint8, float} - float is single precision (32 bit) Note that we currently only support float.
    int
    getValueTypeValue()
    value_type , one of {int8, uint8, float} - float is single precision (32 bit) Note that we currently only support float.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDimension

      int getDimension()
       The number of dimensions in the vector data. required
      uint32 dimension = 1;
      Returns:
      The dimension.

    • getMetricTypeValue

      int getMetricTypeValue()
       distance calculation method (L2 or InnerProduct) required
 The distance calculation method to be used for the index.
      .dingodb.pb.common.MetricType metric_type = 2;
      Returns:
      The enum numeric value on the wire for metricType.

    • getMetricType

      Common.MetricType getMetricType()
       distance calculation method (L2 or InnerProduct) required
 The distance calculation method to be used for the index.
      .dingodb.pb.common.MetricType metric_type = 2;
      Returns:
      The metricType.

    • getValueTypeValue

      int getValueTypeValue()
       value_type , one of {int8, uint8, float} - float is single precision (32 bit)
 Note that we currently only support float. default is float. required
      .dingodb.pb.common.ValueType value_type = 3;
      Returns:
      The enum numeric value on the wire for valueType.

    • getValueType

      Common.ValueType getValueType()
       value_type , one of {int8, uint8, float} - float is single precision (32 bit)
 Note that we currently only support float. default is float. required
      .dingodb.pb.common.ValueType value_type = 3;
      Returns:
      The valueType.

    • getMaxDegree

      int getMaxDegree()
       the degree of the graph index, typically between 60 and 150.
 Larger max_degree will result in larger indices and longer indexing times, but better search quality.
 (default is 64) . R . required
      uint32 max_degree = 4;
      Returns:
      The maxDegree.

    • getSearchListSize

      int getSearchListSize()
       the size of search list during index build. Typical values are between 75 to 200.
 Larger values will take more time to build but result in indices that provide higher recall for the same search
 complexity. Use a value for search_list_size value that is at least the value of max_degree unless you need to
 build indices really quickly and can somewhat compromise on quality. (default is 100) . L . required
      uint32 search_list_size = 5;
      Returns:
      The searchListSize.

    • getQd

      int getQd()
       Quantized Dimension for compression. default is 0. optional
      uint32 qd = 6;
      Returns:
      The qd.

    • getCodebookPrefix

      String getCodebookPrefix()
       Path prefix for pre-trained codebook. default is "". optional
      string codebook_prefix = 7;
      Returns:
      The codebookPrefix.

    • getCodebookPrefixBytes

      com.google.protobuf.ByteString getCodebookPrefixBytes()
       Path prefix for pre-trained codebook. default is "". optional
      string codebook_prefix = 7;
      Returns:
      The bytes for codebookPrefix.

    • getPqDiskBytes

      int getPqDiskBytes()
       Number of bytes to which vectors should be compressed "
 "on SSD; 0 for no compression. default is 0. optional
      uint32 pq_disk_bytes = 8;
      Returns:
      The pqDiskBytes.

    • getAppendReorderData

      boolean getAppendReorderData()
       Include full precision data in the index. Use only in "
 "conjuction with compressed data on SSD. default is false. optional
      bool append_reorder_data = 9;
      Returns:
      The appendReorderData.

    • getBuildPqBytes

      int getBuildPqBytes()
       Number of PQ bytes to build the index; 0 for full precision build. default is 0. optional
      uint32 build_pq_bytes = 10;
      Returns:
      The buildPqBytes.

    • getUseOpq

      boolean getUseOpq()
       use OPQ instead of PQ. default is false. optional
      bool use_opq = 11;
      Returns:
      The useOpq.