com.aerospike.vector.client.HnswParamsOrBuilder Maven / Gradle / Ivy

Go to download
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: types.proto

// Protobuf Java Version: 3.25.1
package com.aerospike.vector.client;

public interface HnswParamsOrBuilder extends
    // @@protoc_insertion_point(interface_extends:aerospike.vector.HnswParams)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Maximum number bi-directional links per HNSW vertex. Greater values of
   * 'm' in general provide better recall for data with high dimensionality, while
   * lower values work well for data with lower dimensionality.
   * The storage space required for the index increases proportionally with 'm'.
   * The default value is 16.
   * 
   *
   * optional uint32 m = 1;
   * @return Whether the m field is set.
   */
  boolean hasM();
  /**
   *    * Maximum number bi-directional links per HNSW vertex. Greater values of
   * 'm' in general provide better recall for data with high dimensionality, while
   * lower values work well for data with lower dimensionality.
   * The storage space required for the index increases proportionally with 'm'.
   * The default value is 16.
   * 
   *
   * optional uint32 m = 1;
   * @return The m.
   */
  int getM();

  /**
   *    * The number of candidate nearest neighbors shortlisted during index creation.
   * Larger values provide better recall at the cost of longer index update times.
   * The default is 100.
   * 
   *
   * optional uint32 efConstruction = 2;
   * @return Whether the efConstruction field is set.
   */
  boolean hasEfConstruction();
  /**
   *    * The number of candidate nearest neighbors shortlisted during index creation.
   * Larger values provide better recall at the cost of longer index update times.
   * The default is 100.
   * 
   *
   * optional uint32 efConstruction = 2;
   * @return The efConstruction.
   */
  int getEfConstruction();

  /**
   *    * The default number of candidate nearest neighbors shortlisted during search.
   * Larger values provide better recall at the cost of longer search times.
   * The default is 100.
   * 
   *
   * optional uint32 ef = 3;
   * @return Whether the ef field is set.
   */
  boolean hasEf();
  /**
   *    * The default number of candidate nearest neighbors shortlisted during search.
   * Larger values provide better recall at the cost of longer search times.
   * The default is 100.
   * 
   *
   * optional uint32 ef = 3;
   * @return The ef.
   */
  int getEf();

  /**
   *    * Configures batching behaviour for batch based index update.
   * 
   *
   * .aerospike.vector.HnswBatchingParams batchingParams = 4;
   * @return Whether the batchingParams field is set.
   */
  boolean hasBatchingParams();
  /**
   *    * Configures batching behaviour for batch based index update.
   * 
   *
   * .aerospike.vector.HnswBatchingParams batchingParams = 4;
   * @return The batchingParams.
   */
  com.aerospike.vector.client.HnswBatchingParams getBatchingParams();
  /**
   *    * Configures batching behaviour for batch based index update.
   * 
   *
   * .aerospike.vector.HnswBatchingParams batchingParams = 4;
   */
  com.aerospike.vector.client.HnswBatchingParamsOrBuilder getBatchingParamsOrBuilder();
}