io.pinecone.proto.QueryRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pinecone-client Show documentation
The Pinecone.io Java Client
There is a newer version: 3.0.0
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: vector_service.proto

// Protobuf Java Version: 3.25.3
package io.pinecone.proto;

public interface QueryRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:QueryRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The namespace to query.
   * 
   *
   * string namespace = 1;
   * @return The namespace.
   */
  java.lang.String getNamespace();
  /**
   *    * The namespace to query.
   * 
   *
   * string namespace = 1;
   * @return The bytes for namespace.
   */
  com.google.protobuf.ByteString
      getNamespaceBytes();

  /**
   *    * The number of results to return for each query.
   * 
   *
   * uint32 top_k = 2 [(.google.api.field_behavior) = REQUIRED];
   * @return The topK.
   */
  int getTopK();

  /**
   *    * The filter to apply. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/.
   * 
   *
   * .google.protobuf.Struct filter = 3;
   * @return Whether the filter field is set.
   */
  boolean hasFilter();
  /**
   *    * The filter to apply. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/.
   * 
   *
   * .google.protobuf.Struct filter = 3;
   * @return The filter.
   */
  com.google.protobuf.Struct getFilter();
  /**
   *    * The filter to apply. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/.
   * 
   *
   * .google.protobuf.Struct filter = 3;
   */
  com.google.protobuf.StructOrBuilder getFilterOrBuilder();

  /**
   *    * Indicates whether vector values are included in the response.
   * 
   *
   * bool include_values = 4;
   * @return The includeValues.
   */
  boolean getIncludeValues();

  /**
   *    * Indicates whether metadata is included in the response as well as the ids.
   * 
   *
   * bool include_metadata = 5;
   * @return The includeMetadata.
   */
  boolean getIncludeMetadata();

  /**
   *    * DEPRECATED. The query vectors. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
   * 
   *
   * repeated .QueryVector queries = 6 [deprecated = true];
   */
  @java.lang.Deprecated java.util.List 
      getQueriesList();
  /**
   *    * DEPRECATED. The query vectors. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
   * 
   *
   * repeated .QueryVector queries = 6 [deprecated = true];
   */
  @java.lang.Deprecated io.pinecone.proto.QueryVector getQueries(int index);
  /**
   *    * DEPRECATED. The query vectors. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
   * 
   *
   * repeated .QueryVector queries = 6 [deprecated = true];
   */
  @java.lang.Deprecated int getQueriesCount();
  /**
   *    * DEPRECATED. The query vectors. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
   * 
   *
   * repeated .QueryVector queries = 6 [deprecated = true];
   */
  @java.lang.Deprecated java.util.List 
      getQueriesOrBuilderList();
  /**
   *    * DEPRECATED. The query vectors. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
   * 
   *
   * repeated .QueryVector queries = 6 [deprecated = true];
   */
  @java.lang.Deprecated io.pinecone.proto.QueryVectorOrBuilder getQueriesOrBuilder(
      int index);

  /**
   *    * The query vector. This should be the same length as the dimension of the index being queried. Each `query()` request can contain only one of the parameters `id` or `vector`.
   * 
   *
   * repeated float vector = 7;
   * @return A list containing the vector.
   */
  java.util.List getVectorList();
  /**
   *    * The query vector. This should be the same length as the dimension of the index being queried. Each `query()` request can contain only one of the parameters `id` or `vector`.
   * 
   *
   * repeated float vector = 7;
   * @return The count of vector.
   */
  int getVectorCount();
  /**
   *    * The query vector. This should be the same length as the dimension of the index being queried. Each `query()` request can contain only one of the parameters `id` or `vector`.
   * 
   *
   * repeated float vector = 7;
   * @param index The index of the element to return.
   * @return The vector at the given index.
   */
  float getVector(int index);

  /**
   *    * The query sparse values.
   * 
   *
   * .SparseValues sparse_vector = 9;
   * @return Whether the sparseVector field is set.
   */
  boolean hasSparseVector();
  /**
   *    * The query sparse values.
   * 
   *
   * .SparseValues sparse_vector = 9;
   * @return The sparseVector.
   */
  io.pinecone.proto.SparseValues getSparseVector();
  /**
   *    * The query sparse values.
   * 
   *
   * .SparseValues sparse_vector = 9;
   */
  io.pinecone.proto.SparseValuesOrBuilder getSparseVectorOrBuilder();

  /**
   *    * The unique ID of the vector to be used as a query vector. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
   * 
   *
   * string id = 8;
   * @return The id.
   */
  java.lang.String getId();
  /**
   *    * The unique ID of the vector to be used as a query vector. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
   * 
   *
   * string id = 8;
   * @return The bytes for id.
   */
  com.google.protobuf.ByteString
      getIdBytes();
}