com.yelp.nrtsearch.server.grpc.KnnQueryOrBuilder 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
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yelp/nrtsearch/search.proto

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

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

  /**
   *    * Vector field name
   * 
   *
   * string field = 1;
   * @return The field.
   */
  java.lang.String getField();
  /**
   *    * Vector field name
   * 
   *
   * string field = 1;
   * @return The bytes for field.
   */
  com.google.protobuf.ByteString
      getFieldBytes();

  /**
   *    * Query used to filter vector search, or unset for no filter
   * 
   *
   * .luceneserver.Query filter = 2;
   * @return Whether the filter field is set.
   */
  boolean hasFilter();
  /**
   *    * Query used to filter vector search, or unset for no filter
   * 
   *
   * .luceneserver.Query filter = 2;
   * @return The filter.
   */
  com.yelp.nrtsearch.server.grpc.Query getFilter();
  /**
   *    * Query used to filter vector search, or unset for no filter
   * 
   *
   * .luceneserver.Query filter = 2;
   */
  com.yelp.nrtsearch.server.grpc.QueryOrBuilder getFilterOrBuilder();

  /**
   *    * Number of top nearest neighbor documents to collect, must be <= num_candidates
   * 
   *
   * int32 k = 3;
   * @return The k.
   */
  int getK();

  /**
   *    * Number of nearest neighbors to consider per segment. A larger value produces a more accurate top k. Must be <= 10000.
   * 
   *
   * int32 num_candidates = 4;
   * @return The numCandidates.
   */
  int getNumCandidates();

  /**
   *    * Vector value to use for query vector, for fields with float element type
   * 
   *
   * repeated float query_vector = 5;
   * @return A list containing the queryVector.
   */
  java.util.List getQueryVectorList();
  /**
   *    * Vector value to use for query vector, for fields with float element type
   * 
   *
   * repeated float query_vector = 5;
   * @return The count of queryVector.
   */
  int getQueryVectorCount();
  /**
   *    * Vector value to use for query vector, for fields with float element type
   * 
   *
   * repeated float query_vector = 5;
   * @param index The index of the element to return.
   * @return The queryVector at the given index.
   */
  float getQueryVector(int index);

  /**
   *    * Vector value to use for query vector, for fields with byte element type
   * 
   *
   * bytes query_byte_vector = 6;
   * @return The queryByteVector.
   */
  com.google.protobuf.ByteString getQueryByteVector();

  /**
   *    * Boost multiplier for similarity score
   * 
   *
   * float boost = 7;
   * @return The boost.
   */
  float getBoost();
}