Package io.qdrant.client.grpc

Interface Collections.OptimizersConfigDiffOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Collections.OptimizersConfigDiff, Collections.OptimizersConfigDiff.Builder
Enclosing class:
Collections
public static interface Collections.OptimizersConfigDiffOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getDefaultSegmentNumber()
    Target amount of segments the optimizer will try to keep.
    double
    getDeletedThreshold()
    The minimal fraction of deleted vectors in a segment, required to perform segment optimization
    long
    getFlushIntervalSec()
    Interval between forced flushes.
    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>.
    long
    getMaxOptimizationThreads()
    Max number of threads, which can be used for optimization.
    long
    getMaxSegmentSize()
    Do not create segments larger this size (in kilobytes).
    long
    getMemmapThreshold()
    Maximum size (in kilobytes) of vectors to store in-memory per segment.
    long
    getVacuumMinVectorNumber()
    The minimal number of vectors in a segment, required to perform segment optimization
    boolean
    hasDefaultSegmentNumber()
    Target amount of segments the optimizer will try to keep.
    boolean
    hasDeletedThreshold()
    The minimal fraction of deleted vectors in a segment, required to perform segment optimization
    boolean
    hasFlushIntervalSec()
    Interval between forced flushes.
    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>.
    boolean
    hasMaxOptimizationThreads()
    Max number of threads, which can be used for optimization.
    boolean
    hasMaxSegmentSize()
    Do not create segments larger this size (in kilobytes).
    boolean
    hasMemmapThreshold()
    Maximum size (in kilobytes) of vectors to store in-memory per segment.
    boolean
    hasVacuumMinVectorNumber()
    The minimal number of vectors in a segment, required to perform segment optimization

    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

    • hasDeletedThreshold

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

    • getDeletedThreshold

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

    • hasVacuumMinVectorNumber

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

    • getVacuumMinVectorNumber

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

    • hasDefaultSegmentNumber

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

    • getDefaultSegmentNumber

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

    • hasMaxSegmentSize

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

    • getMaxSegmentSize

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

    • hasMemmapThreshold

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

    • getMemmapThreshold

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

    • hasIndexingThreshold

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

    • getIndexingThreshold

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

    • hasFlushIntervalSec

      boolean hasFlushIntervalSec()
      
Interval between forced flushes.
      optional uint64 flush_interval_sec = 7;
      Returns:
      Whether the flushIntervalSec field is set.

    • getFlushIntervalSec

      long getFlushIntervalSec()
      
Interval between forced flushes.
      optional uint64 flush_interval_sec = 7;
      Returns:
      The flushIntervalSec.

    • hasMaxOptimizationThreads

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

    • getMaxOptimizationThreads

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