Package io.qdrant.client.grpc

Interface Collections.HnswConfigDiffOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getEfConstruct()
    Number of neighbours to consider during the index building.
    long
    getFullScanThreshold()
    Minimal size (in KiloBytes) of vectors for additional payload-based indexing.
    long
    getM()
    Number of edges per node in the index graph.
    long
    getMaxIndexingThreads()
    Number of parallel threads used for background index building.
    boolean
    getOnDisk()
    Store HNSW index on disk.
    long
    getPayloadM()
    Number of additional payload-aware links per node in the index graph.
    boolean
    hasEfConstruct()
    Number of neighbours to consider during the index building.
    boolean
    hasFullScanThreshold()
    Minimal size (in KiloBytes) of vectors for additional payload-based indexing.
    boolean
    hasM()
    Number of edges per node in the index graph.
    boolean
    hasMaxIndexingThreads()
    Number of parallel threads used for background index building.
    boolean
    hasOnDisk()
    Store HNSW index on disk.
    boolean
    hasPayloadM()
    Number of additional payload-aware links per node in the index graph.

    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

    • hasM

      boolean hasM()
      
Number of edges per node in the index graph. Larger the value - more accurate the search, more space required.
      optional uint64 m = 1;
      Returns:
      Whether the m field is set.

    • getM

      long getM()
      
Number of edges per node in the index graph. Larger the value - more accurate the search, more space required.
      optional uint64 m = 1;
      Returns:
      The m.

    • hasEfConstruct

      boolean hasEfConstruct()
      
Number of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build the index.
      optional uint64 ef_construct = 2;
      Returns:
      Whether the efConstruct field is set.

    • getEfConstruct

      long getEfConstruct()
      
Number of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build the index.
      optional uint64 ef_construct = 2;
      Returns:
      The efConstruct.

    • hasFullScanThreshold

      boolean hasFullScanThreshold()
      
Minimal size (in KiloBytes) of vectors for additional payload-based indexing.
If the payload chunk is smaller than `full_scan_threshold` additional indexing won't be used -
in this case full-scan search should be preferred by query planner and additional indexing is not required.
Note: 1 Kb = 1 vector of size 256
      optional uint64 full_scan_threshold = 3;
      Returns:
      Whether the fullScanThreshold field is set.

    • getFullScanThreshold

      long getFullScanThreshold()
      
Minimal size (in KiloBytes) of vectors for additional payload-based indexing.
If the payload chunk is smaller than `full_scan_threshold` additional indexing won't be used -
in this case full-scan search should be preferred by query planner and additional indexing is not required.
Note: 1 Kb = 1 vector of size 256
      optional uint64 full_scan_threshold = 3;
      Returns:
      The fullScanThreshold.

    • hasMaxIndexingThreads

      boolean hasMaxIndexingThreads()
      
Number of parallel threads used for background index building. If 0 - auto selection.
      optional uint64 max_indexing_threads = 4;
      Returns:
      Whether the maxIndexingThreads field is set.

    • getMaxIndexingThreads

      long getMaxIndexingThreads()
      
Number of parallel threads used for background index building. If 0 - auto selection.
      optional uint64 max_indexing_threads = 4;
      Returns:
      The maxIndexingThreads.

    • hasOnDisk

      boolean hasOnDisk()
      
Store HNSW index on disk. If set to false, the index will be stored in RAM.
      optional bool on_disk = 5;
      Returns:
      Whether the onDisk field is set.

    • getOnDisk

      boolean getOnDisk()
      
Store HNSW index on disk. If set to false, the index will be stored in RAM.
      optional bool on_disk = 5;
      Returns:
      The onDisk.

    • hasPayloadM

      boolean hasPayloadM()
      
Number of additional payload-aware links per node in the index graph. If not set - regular M parameter will be used.
      optional uint64 payload_m = 6;
      Returns:
      Whether the payloadM field is set.

    • getPayloadM

      long getPayloadM()
      
Number of additional payload-aware links per node in the index graph. If not set - regular M parameter will be used.
      optional uint64 payload_m = 6;
      Returns:
      The payloadM.