com.yelp.nrtsearch.server.grpc.VectorIndexingOptionsOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of clientlib Show documentation
GRPC Clientlib for nrtSearch
There is a newer version: 1.0.0-beta.1
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yelp/nrtsearch/luceneserver.proto

// Protobuf Java Version: 3.25.3
package com.yelp.nrtsearch.server.grpc;

public interface VectorIndexingOptionsOrBuilder extends
    // @@protoc_insertion_point(interface_extends:luceneserver.VectorIndexingOptions)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The vector indexing type, supports 'hnsw' and 'hnsw_scalar_quantized', default: hnsw
   * 
   *
   * optional string type = 1;
   * @return Whether the type field is set.
   */
  boolean hasType();
  /**
   *    * The vector indexing type, supports 'hnsw' and 'hnsw_scalar_quantized', default: hnsw
   * 
   *
   * optional string type = 1;
   * @return The type.
   */
  java.lang.String getType();
  /**
   *    * The vector indexing type, supports 'hnsw' and 'hnsw_scalar_quantized', default: hnsw
   * 
   *
   * optional string type = 1;
   * @return The bytes for type.
   */
  com.google.protobuf.ByteString
      getTypeBytes();

  /**
   *    * The number of neighbors each node will be connected to in the HNSW graph, default: 16
   * 
   *
   * optional int32 hnsw_m = 2;
   * @return Whether the hnswM field is set.
   */
  boolean hasHnswM();
  /**
   *    * The number of neighbors each node will be connected to in the HNSW graph, default: 16
   * 
   *
   * optional int32 hnsw_m = 2;
   * @return The hnswM.
   */
  int getHnswM();

  /**
   *    * The number of candidates to track while assembling the list of nearest neighbors for each new node, default: 100
   * 
   *
   * optional int32 hnsw_ef_construction = 3;
   * @return Whether the hnswEfConstruction field is set.
   */
  boolean hasHnswEfConstruction();
  /**
   *    * The number of candidates to track while assembling the list of nearest neighbors for each new node, default: 100
   * 
   *
   * optional int32 hnsw_ef_construction = 3;
   * @return The hnswEfConstruction.
   */
  int getHnswEfConstruction();

  /**
   *    * Number of threads to use for merging vector data, default: 1
   * 
   *
   * optional int32 merge_workers = 4;
   * @return Whether the mergeWorkers field is set.
   */
  boolean hasMergeWorkers();
  /**
   *    * Number of threads to use for merging vector data, default: 1
   * 
   *
   * optional int32 merge_workers = 4;
   * @return The mergeWorkers.
   */
  int getMergeWorkers();

  /**
   *    * The confidenceInterval for scalar quantizing the vectors. When unset, it is calculated based on the vector dimension.
   * When `0`, the quantiles are dynamically determined by sampling many confidence intervals and determining the most accurate pair.
   * Otherwise, the value must be between 0.9 and 1.0 (both inclusive). default: unset
   * 
   *
   * optional float quantized_confidence_interval = 5;
   * @return Whether the quantizedConfidenceInterval field is set.
   */
  boolean hasQuantizedConfidenceInterval();
  /**
   *    * The confidenceInterval for scalar quantizing the vectors. When unset, it is calculated based on the vector dimension.
   * When `0`, the quantiles are dynamically determined by sampling many confidence intervals and determining the most accurate pair.
   * Otherwise, the value must be between 0.9 and 1.0 (both inclusive). default: unset
   * 
   *
   * optional float quantized_confidence_interval = 5;
   * @return The quantizedConfidenceInterval.
   */
  float getQuantizedConfidenceInterval();

  /**
   *    * The number of bits to use for quantizing the vectors. It can have the following values:
   *      4 - half byte
   *      7 - signed byte (default)
   *      8 - unsigned byte
   * 
   *
   * optional int32 quantized_bits = 6;
   * @return Whether the quantizedBits field is set.
   */
  boolean hasQuantizedBits();
  /**
   *    * The number of bits to use for quantizing the vectors. It can have the following values:
   *      4 - half byte
   *      7 - signed byte (default)
   *      8 - unsigned byte
   * 
   *
   * optional int32 quantized_bits = 6;
   * @return The quantizedBits.
   */
  int getQuantizedBits();

  /**
   *    * Whether to compress the vectors, if true, the vectors that are quantized with <= 4 bits will be compressed into
   * a single byte. If false, the vectors will be stored as is. This provides a trade-off of memory usage and speed. default: false
   * 
   *
   * optional bool quantized_compress = 7;
   * @return Whether the quantizedCompress field is set.
   */
  boolean hasQuantizedCompress();
  /**
   *    * Whether to compress the vectors, if true, the vectors that are quantized with <= 4 bits will be compressed into
   * a single byte. If false, the vectors will be stored as is. This provides a trade-off of memory usage and speed. default: false
   * 
   *
   * optional bool quantized_compress = 7;
   * @return The quantizedCompress.
   */
  boolean getQuantizedCompress();
}