Package io.dingodb.common

Class Common.SearchIvfPqParam.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Common.SearchIvfPqParam.Builder>
io.dingodb.common.Common.SearchIvfPqParam.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Common.SearchIvfPqParamOrBuilder, Cloneable
Enclosing class:
Common.SearchIvfPqParam
public static final class Common.SearchIvfPqParam.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Common.SearchIvfPqParam.Builder> implements Common.SearchIvfPqParamOrBuilder
Protobuf type dingodb.pb.common.SearchIvfPqParam

  • Method Details

    • 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.Builder<Common.SearchIvfPqParam.Builder>

    • clear

      public Common.SearchIvfPqParam.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<Common.SearchIvfPqParam.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Common.SearchIvfPqParam.Builder>

    • getDefaultInstanceForType

      public Common.SearchIvfPqParam getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • clone

      public Common.SearchIvfPqParam.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<Common.SearchIvfPqParam.Builder>

    • setField

      public Common.SearchIvfPqParam.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Common.SearchIvfPqParam.Builder>

    • clearField

      public Common.SearchIvfPqParam.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Common.SearchIvfPqParam.Builder>

    • clearOneof

      public Common.SearchIvfPqParam.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Common.SearchIvfPqParam.Builder>

    • setRepeatedField

      public Common.SearchIvfPqParam.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Common.SearchIvfPqParam.Builder>

    • addRepeatedField

      public Common.SearchIvfPqParam.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Common.SearchIvfPqParam.Builder>

    • mergeFrom

      public Common.SearchIvfPqParam.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Common.SearchIvfPqParam.Builder>

    • mergeFrom

      public Common.SearchIvfPqParam.Builder mergeFrom(Common.SearchIvfPqParam other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Common.SearchIvfPqParam.Builder>

    • mergeFrom

      public Common.SearchIvfPqParam.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Common.SearchIvfPqParam.Builder>
      Throws:
      IOException

    • getNprobe

      public int getNprobe()
       How many buckets to query, the default is 80, and cannot exceed the size of ncentroids Optional parameters
      int32 nprobe = 1;
      Specified by:
      getNprobe in interface Common.SearchIvfPqParamOrBuilder
      Returns:
      The nprobe.

    • setNprobe

      public Common.SearchIvfPqParam.Builder setNprobe(int value)
       How many buckets to query, the default is 80, and cannot exceed the size of ncentroids Optional parameters
      int32 nprobe = 1;
      Parameters:
      value - The nprobe to set.
      Returns:
      This builder for chaining.

    • clearNprobe

      public Common.SearchIvfPqParam.Builder clearNprobe()
       How many buckets to query, the default is 80, and cannot exceed the size of ncentroids Optional parameters
      int32 nprobe = 1;
      Returns:
      This builder for chaining.

    • getParallelOnQueries

      public int getParallelOnQueries()
       Default 1, parallel between queries; 0, parallel in a single query.
 Inter-query parallelism refers to a query in which a single query contains multiple vectors, and is parallelized
 between each vector query. If there is only a single vector, it can be queried in parallel across nprobe buckets
 optional parameters
      int32 parallel_on_queries = 2;
      Specified by:
      getParallelOnQueries in interface Common.SearchIvfPqParamOrBuilder
      Returns:
      The parallelOnQueries.

    • setParallelOnQueries

      public Common.SearchIvfPqParam.Builder setParallelOnQueries(int value)
       Default 1, parallel between queries; 0, parallel in a single query.
 Inter-query parallelism refers to a query in which a single query contains multiple vectors, and is parallelized
 between each vector query. If there is only a single vector, it can be queried in parallel across nprobe buckets
 optional parameters
      int32 parallel_on_queries = 2;
      Parameters:
      value - The parallelOnQueries to set.
      Returns:
      This builder for chaining.

    • clearParallelOnQueries

      public Common.SearchIvfPqParam.Builder clearParallelOnQueries()
       Default 1, parallel between queries; 0, parallel in a single query.
 Inter-query parallelism refers to a query in which a single query contains multiple vectors, and is parallelized
 between each vector query. If there is only a single vector, it can be queried in parallel across nprobe buckets
 optional parameters
      int32 parallel_on_queries = 2;
      Returns:
      This builder for chaining.

    • getRecallNum

      public int getRecallNum()
       number of results recalled from the index
 The default is 100. This parameter is for whether to use the original vector for fine sorting. When searching, it
 will look for recall_num results in the IVF index. Then use the original vectors to reorder to get the topK final
 results. Among them, whether to use the original vector to reorder is specified by the quick parameter. optional
 parameters
      int32 recall_num = 3;
      Specified by:
      getRecallNum in interface Common.SearchIvfPqParamOrBuilder
      Returns:
      The recallNum.

    • setRecallNum

      public Common.SearchIvfPqParam.Builder setRecallNum(int value)
       number of results recalled from the index
 The default is 100. This parameter is for whether to use the original vector for fine sorting. When searching, it
 will look for recall_num results in the IVF index. Then use the original vectors to reorder to get the topK final
 results. Among them, whether to use the original vector to reorder is specified by the quick parameter. optional
 parameters
      int32 recall_num = 3;
      Parameters:
      value - The recallNum to set.
      Returns:
      This builder for chaining.

    • clearRecallNum

      public Common.SearchIvfPqParam.Builder clearRecallNum()
       number of results recalled from the index
 The default is 100. This parameter is for whether to use the original vector for fine sorting. When searching, it
 will look for recall_num results in the IVF index. Then use the original vectors to reorder to get the topK final
 results. Among them, whether to use the original vector to reorder is specified by the quick parameter. optional
 parameters
      int32 recall_num = 3;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final Common.SearchIvfPqParam.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Common.SearchIvfPqParam.Builder>

    • mergeUnknownFields

      public final Common.SearchIvfPqParam.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Common.SearchIvfPqParam.Builder>