Package io.qdrant.client.grpc

Class Collections.OptimizersConfigDiff

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.qdrant.client.grpc.Collections.OptimizersConfigDiff
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Collections.OptimizersConfigDiffOrBuilder, Serializable
Enclosing class:
Collections
public static final class Collections.OptimizersConfigDiff extends com.google.protobuf.GeneratedMessageV3 implements Collections.OptimizersConfigDiffOrBuilder
Protobuf type qdrant.OptimizersConfigDiff
See Also:

  • Field Details

    • DELETED_THRESHOLD_FIELD_NUMBER

      public static final int DELETED_THRESHOLD_FIELD_NUMBER
      See Also:

    • VACUUM_MIN_VECTOR_NUMBER_FIELD_NUMBER

      public static final int VACUUM_MIN_VECTOR_NUMBER_FIELD_NUMBER
      See Also:

    • DEFAULT_SEGMENT_NUMBER_FIELD_NUMBER

      public static final int DEFAULT_SEGMENT_NUMBER_FIELD_NUMBER
      See Also:

    • MAX_SEGMENT_SIZE_FIELD_NUMBER

      public static final int MAX_SEGMENT_SIZE_FIELD_NUMBER
      See Also:

    • MEMMAP_THRESHOLD_FIELD_NUMBER

      public static final int MEMMAP_THRESHOLD_FIELD_NUMBER
      See Also:

    • INDEXING_THRESHOLD_FIELD_NUMBER

      public static final int INDEXING_THRESHOLD_FIELD_NUMBER
      See Also:

    • FLUSH_INTERVAL_SEC_FIELD_NUMBER

      public static final int FLUSH_INTERVAL_SEC_FIELD_NUMBER
      See Also:

    • MAX_OPTIMIZATION_THREADS_FIELD_NUMBER

      public static final int MAX_OPTIMIZATION_THREADS_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

    • hasDeletedThreshold

      public boolean hasDeletedThreshold()
      
The minimal fraction of deleted vectors in a segment, required to perform segment optimization
      optional double deleted_threshold = 1;
      Specified by:
      hasDeletedThreshold in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the deletedThreshold field is set.

    • getDeletedThreshold

      public double getDeletedThreshold()
      
The minimal fraction of deleted vectors in a segment, required to perform segment optimization
      optional double deleted_threshold = 1;
      Specified by:
      getDeletedThreshold in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The deletedThreshold.

    • hasVacuumMinVectorNumber

      public boolean hasVacuumMinVectorNumber()
      
The minimal number of vectors in a segment, required to perform segment optimization
      optional uint64 vacuum_min_vector_number = 2;
      Specified by:
      hasVacuumMinVectorNumber in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the vacuumMinVectorNumber field is set.

    • getVacuumMinVectorNumber

      public long getVacuumMinVectorNumber()
      
The minimal number of vectors in a segment, required to perform segment optimization
      optional uint64 vacuum_min_vector_number = 2;
      Specified by:
      getVacuumMinVectorNumber in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The vacuumMinVectorNumber.

    • hasDefaultSegmentNumber

      public boolean hasDefaultSegmentNumber()
      
Target amount of segments the optimizer will try to keep.
Real amount of segments may vary depending on multiple parameters:

- Amount of stored points.
- Current write RPS.

It is recommended to select the default number of segments as a factor of the number of search threads,
so that each segment would be handled evenly by one of the threads.
      optional uint64 default_segment_number = 3;
      Specified by:
      hasDefaultSegmentNumber in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the defaultSegmentNumber field is set.

    • getDefaultSegmentNumber

      public long getDefaultSegmentNumber()
      
Target amount of segments the optimizer will try to keep.
Real amount of segments may vary depending on multiple parameters:

- Amount of stored points.
- Current write RPS.

It is recommended to select the default number of segments as a factor of the number of search threads,
so that each segment would be handled evenly by one of the threads.
      optional uint64 default_segment_number = 3;
      Specified by:
      getDefaultSegmentNumber in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The defaultSegmentNumber.

    • hasMaxSegmentSize

      public boolean hasMaxSegmentSize()
      
Do not create segments larger this size (in kilobytes).
Large segments might require disproportionately long indexation times,
therefore it makes sense to limit the size of segments.

If indexing speed is more important - make this parameter lower.
If search speed is more important - make this parameter higher.
Note: 1Kb = 1 vector of size 256
If not set, will be automatically selected considering the number of available CPUs.
      optional uint64 max_segment_size = 4;
      Specified by:
      hasMaxSegmentSize in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the maxSegmentSize field is set.

    • getMaxSegmentSize

      public long getMaxSegmentSize()
      
Do not create segments larger this size (in kilobytes).
Large segments might require disproportionately long indexation times,
therefore it makes sense to limit the size of segments.

If indexing speed is more important - make this parameter lower.
If search speed is more important - make this parameter higher.
Note: 1Kb = 1 vector of size 256
If not set, will be automatically selected considering the number of available CPUs.
      optional uint64 max_segment_size = 4;
      Specified by:
      getMaxSegmentSize in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The maxSegmentSize.

    • hasMemmapThreshold

      public boolean hasMemmapThreshold()
      
Maximum size (in kilobytes) of vectors to store in-memory per segment.
Segments larger than this threshold will be stored as read-only memmaped file.

Memmap storage is disabled by default, to enable it, set this threshold to a reasonable value.

To disable memmap storage, set this to `0`.

Note: 1Kb = 1 vector of size 256
      optional uint64 memmap_threshold = 5;
      Specified by:
      hasMemmapThreshold in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the memmapThreshold field is set.

    • getMemmapThreshold

      public long getMemmapThreshold()
      
Maximum size (in kilobytes) of vectors to store in-memory per segment.
Segments larger than this threshold will be stored as read-only memmaped file.

Memmap storage is disabled by default, to enable it, set this threshold to a reasonable value.

To disable memmap storage, set this to `0`.

Note: 1Kb = 1 vector of size 256
      optional uint64 memmap_threshold = 5;
      Specified by:
      getMemmapThreshold in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The memmapThreshold.

    • hasIndexingThreshold

      public boolean hasIndexingThreshold()
      
Maximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing

Default value is 20,000, based on <https://github.com/google-research/google-research/blob/master/scann/docs/algorithms.md>.

To disable vector indexing, set to `0`.

Note: 1kB = 1 vector of size 256.
      optional uint64 indexing_threshold = 6;
      Specified by:
      hasIndexingThreshold in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the indexingThreshold field is set.

    • getIndexingThreshold

      public long getIndexingThreshold()
      
Maximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing

Default value is 20,000, based on <https://github.com/google-research/google-research/blob/master/scann/docs/algorithms.md>.

To disable vector indexing, set to `0`.

Note: 1kB = 1 vector of size 256.
      optional uint64 indexing_threshold = 6;
      Specified by:
      getIndexingThreshold in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The indexingThreshold.

    • hasFlushIntervalSec

      public boolean hasFlushIntervalSec()
      
Interval between forced flushes.
      optional uint64 flush_interval_sec = 7;
      Specified by:
      hasFlushIntervalSec in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the flushIntervalSec field is set.

    • getFlushIntervalSec

      public long getFlushIntervalSec()
      
Interval between forced flushes.
      optional uint64 flush_interval_sec = 7;
      Specified by:
      getFlushIntervalSec in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The flushIntervalSec.

    • hasMaxOptimizationThreads

      public boolean hasMaxOptimizationThreads()
      
Max number of threads, which can be used for optimization. If 0 - `NUM_CPU - 1` will be used
      optional uint64 max_optimization_threads = 8;
      Specified by:
      hasMaxOptimizationThreads in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      Whether the maxOptimizationThreads field is set.

    • getMaxOptimizationThreads

      public long getMaxOptimizationThreads()
      
Max number of threads, which can be used for optimization. If 0 - `NUM_CPU - 1` will be used
      optional uint64 max_optimization_threads = 8;
      Specified by:
      getMaxOptimizationThreads in interface Collections.OptimizersConfigDiffOrBuilder
      Returns:
      The maxOptimizationThreads.

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

    • parseFrom

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

    • parseFrom

      public static Collections.OptimizersConfigDiff parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Collections.OptimizersConfigDiff parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Collections.OptimizersConfigDiff parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Collections.OptimizersConfigDiff parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Collections.OptimizersConfigDiff parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static Collections.OptimizersConfigDiff parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Collections.OptimizersConfigDiff.Builder newBuilder()

    • newBuilder

      public static Collections.OptimizersConfigDiff.Builder newBuilder(Collections.OptimizersConfigDiff prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Collections.OptimizersConfigDiff getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Collections.OptimizersConfigDiff> parser()

    • getParserForType

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