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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of avs-client-java Show documentation
This project includes the Java client for Aerospike Vector Search for high-performance data interactions.
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: types.proto

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

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.proto.HnswBatchingParams getBatchingParams();
  /**
   *    * Configures batching behaviour for batch based index update.
   * 
   *
   * .aerospike.vector.HnswBatchingParams batchingParams = 4;
   */
  com.aerospike.vector.client.proto.HnswBatchingParamsOrBuilder getBatchingParamsOrBuilder();

  /**
   *    * Maximum size of in-memory queue for inserted/updated vector records.
   * If the queue is full the record upsert will either be rejected with
   * a RESOURCE_EXHAUSTED error or written to storage for index healer to
   * later pick the record for indexing based on the put option.
   * Defaults to global indexing config configured for the VectorDB.
   * 
   *
   * optional uint32 maxMemQueueSize = 5;
   * @return Whether the maxMemQueueSize field is set.
   */
  boolean hasMaxMemQueueSize();
  /**
   *    * Maximum size of in-memory queue for inserted/updated vector records.
   * If the queue is full the record upsert will either be rejected with
   * a RESOURCE_EXHAUSTED error or written to storage for index healer to
   * later pick the record for indexing based on the put option.
   * Defaults to global indexing config configured for the VectorDB.
   * 
   *
   * optional uint32 maxMemQueueSize = 5;
   * @return The maxMemQueueSize.
   */
  int getMaxMemQueueSize();

  /**
   *    * Configures caching for Hnsw Index. It is turned on by default with maximum
   * 2 million entries and 1 hour expiry.
   * 
   *
   * .aerospike.vector.HnswCachingParams indexCachingParams = 6;
   * @return Whether the indexCachingParams field is set.
   */
  boolean hasIndexCachingParams();
  /**
   *    * Configures caching for Hnsw Index. It is turned on by default with maximum
   * 2 million entries and 1 hour expiry.
   * 
   *
   * .aerospike.vector.HnswCachingParams indexCachingParams = 6;
   * @return The indexCachingParams.
   */
  com.aerospike.vector.client.proto.HnswCachingParams getIndexCachingParams();
  /**
   *    * Configures caching for Hnsw Index. It is turned on by default with maximum
   * 2 million entries and 1 hour expiry.
   * 
   *
   * .aerospike.vector.HnswCachingParams indexCachingParams = 6;
   */
  com.aerospike.vector.client.proto.HnswCachingParamsOrBuilder getIndexCachingParamsOrBuilder();

  /**
   *    * Configures index healer params.
   * 
   *
   * .aerospike.vector.HnswHealerParams healerParams = 7;
   * @return Whether the healerParams field is set.
   */
  boolean hasHealerParams();
  /**
   *    * Configures index healer params.
   * 
   *
   * .aerospike.vector.HnswHealerParams healerParams = 7;
   * @return The healerParams.
   */
  com.aerospike.vector.client.proto.HnswHealerParams getHealerParams();
  /**
   *    * Configures index healer params.
   * 
   *
   * .aerospike.vector.HnswHealerParams healerParams = 7;
   */
  com.aerospike.vector.client.proto.HnswHealerParamsOrBuilder getHealerParamsOrBuilder();

  /**
   *    * Configures merge of batch indices to main index.
   * 
   *
   * .aerospike.vector.HnswIndexMergeParams mergeParams = 8;
   * @return Whether the mergeParams field is set.
   */
  boolean hasMergeParams();
  /**
   *    * Configures merge of batch indices to main index.
   * 
   *
   * .aerospike.vector.HnswIndexMergeParams mergeParams = 8;
   * @return The mergeParams.
   */
  com.aerospike.vector.client.proto.HnswIndexMergeParams getMergeParams();
  /**
   *    * Configures merge of batch indices to main index.
   * 
   *
   * .aerospike.vector.HnswIndexMergeParams mergeParams = 8;
   */
  com.aerospike.vector.client.proto.HnswIndexMergeParamsOrBuilder getMergeParamsOrBuilder();

  /**
   *    * Verify whether the underlying vector has changed before returning the kAnn
   * result. Defaults to true.
   * 
   *
   * optional bool enableVectorIntegrityCheck = 9;
   * @return Whether the enableVectorIntegrityCheck field is set.
   */
  boolean hasEnableVectorIntegrityCheck();
  /**
   *    * Verify whether the underlying vector has changed before returning the kAnn
   * result. Defaults to true.
   * 
   *
   * optional bool enableVectorIntegrityCheck = 9;
   * @return The enableVectorIntegrityCheck.
   */
  boolean getEnableVectorIntegrityCheck();

  /**
   *    * Configures caching for vector records. It is turned off by default.
   * 
   *
   * optional .aerospike.vector.HnswCachingParams recordCachingParams = 10;
   * @return Whether the recordCachingParams field is set.
   */
  boolean hasRecordCachingParams();
  /**
   *    * Configures caching for vector records. It is turned off by default.
   * 
   *
   * optional .aerospike.vector.HnswCachingParams recordCachingParams = 10;
   * @return The recordCachingParams.
   */
  com.aerospike.vector.client.proto.HnswCachingParams getRecordCachingParams();
  /**
   *    * Configures caching for vector records. It is turned off by default.
   * 
   *
   * optional .aerospike.vector.HnswCachingParams recordCachingParams = 10;
   */
  com.aerospike.vector.client.proto.HnswCachingParamsOrBuilder getRecordCachingParamsOrBuilder();
}