Package io.dingodb.common

Class Common.CreateDiskAnnParam

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.dingodb.common.Common.CreateDiskAnnParam
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Common.CreateDiskAnnParamOrBuilder, Serializable
Enclosing class:
Common
public static final class Common.CreateDiskAnnParam extends com.google.protobuf.GeneratedMessageV3 implements Common.CreateDiskAnnParamOrBuilder
Protobuf type dingodb.pb.common.CreateDiskAnnParam
See Also:

  • Field Details

    • DIMENSION_FIELD_NUMBER

      public static final int DIMENSION_FIELD_NUMBER
      See Also:

    • METRIC_TYPE_FIELD_NUMBER

      public static final int METRIC_TYPE_FIELD_NUMBER
      See Also:

    • VALUE_TYPE_FIELD_NUMBER

      public static final int VALUE_TYPE_FIELD_NUMBER
      See Also:

    • MAX_DEGREE_FIELD_NUMBER

      public static final int MAX_DEGREE_FIELD_NUMBER
      See Also:

    • SEARCH_LIST_SIZE_FIELD_NUMBER

      public static final int SEARCH_LIST_SIZE_FIELD_NUMBER
      See Also:

    • QD_FIELD_NUMBER

      public static final int QD_FIELD_NUMBER
      See Also:

    • CODEBOOK_PREFIX_FIELD_NUMBER

      public static final int CODEBOOK_PREFIX_FIELD_NUMBER
      See Also:

    • PQ_DISK_BYTES_FIELD_NUMBER

      public static final int PQ_DISK_BYTES_FIELD_NUMBER
      See Also:

    • APPEND_REORDER_DATA_FIELD_NUMBER

      public static final int APPEND_REORDER_DATA_FIELD_NUMBER
      See Also:

    • BUILD_PQ_BYTES_FIELD_NUMBER

      public static final int BUILD_PQ_BYTES_FIELD_NUMBER
      See Also:

    • USE_OPQ_FIELD_NUMBER

      public static final int USE_OPQ_FIELD_NUMBER
      See Also:

  • 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

    • getDimension

      public int getDimension()
       The number of dimensions in the vector data. required
      uint32 dimension = 1;
      Specified by:
      getDimension in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The dimension.

    • getMetricTypeValue

      public 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;
      Specified by:
      getMetricTypeValue in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The enum numeric value on the wire for metricType.

    • getMetricType

      public 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;
      Specified by:
      getMetricType in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The metricType.

    • getValueTypeValue

      public 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;
      Specified by:
      getValueTypeValue in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The enum numeric value on the wire for valueType.

    • getValueType

      public 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;
      Specified by:
      getValueType in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The valueType.

    • getMaxDegree

      public 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;
      Specified by:
      getMaxDegree in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The maxDegree.

    • getSearchListSize

      public 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;
      Specified by:
      getSearchListSize in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The searchListSize.

    • getQd

      public int getQd()
       Quantized Dimension for compression. default is 0. optional
      uint32 qd = 6;
      Specified by:
      getQd in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The qd.

    • getCodebookPrefix

      public String getCodebookPrefix()
       Path prefix for pre-trained codebook. default is "". optional
      string codebook_prefix = 7;
      Specified by:
      getCodebookPrefix in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The codebookPrefix.

    • getCodebookPrefixBytes

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

    • getPqDiskBytes

      public 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;
      Specified by:
      getPqDiskBytes in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The pqDiskBytes.

    • getAppendReorderData

      public 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;
      Specified by:
      getAppendReorderData in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The appendReorderData.

    • getBuildPqBytes

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

    • getUseOpq

      public boolean getUseOpq()
       use OPQ instead of PQ. default is false. optional
      bool use_opq = 11;
      Specified by:
      getUseOpq in interface Common.CreateDiskAnnParamOrBuilder
      Returns:
      The useOpq.

    • 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.CreateDiskAnnParam parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Common.CreateDiskAnnParam parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Common.CreateDiskAnnParam 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.CreateDiskAnnParam parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Common.CreateDiskAnnParam parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Common.CreateDiskAnnParam parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static Common.CreateDiskAnnParam parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

      public Common.CreateDiskAnnParam.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Common.CreateDiskAnnParam.Builder newBuilder()

    • newBuilder

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

    • toBuilder

      public Common.CreateDiskAnnParam.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Common.CreateDiskAnnParam.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Common.CreateDiskAnnParam getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Common.CreateDiskAnnParam> 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.CreateDiskAnnParam getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder