io.pinecone.proto.ScoredVectorOrBuilder 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 ScoredVectorOrBuilder extends
    // @@protoc_insertion_point(interface_extends:ScoredVector)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * This is the vector's unique id.
   * 
   *
   * string id = 1 [(.google.api.field_behavior) = REQUIRED];
   * @return The id.
   */
  java.lang.String getId();
  /**
   *    * This is the vector's unique id.
   * 
   *
   * string id = 1 [(.google.api.field_behavior) = REQUIRED];
   * @return The bytes for id.
   */
  com.google.protobuf.ByteString
      getIdBytes();

  /**
   *    * This is a measure of similarity between this vector and the query vector.  The higher the score, the more they are similar.
   * 
   *
   * float score = 2;
   * @return The score.
   */
  float getScore();

  /**
   *    * This is the vector data, if it is requested.
   * 
   *
   * repeated float values = 3;
   * @return A list containing the values.
   */
  java.util.List getValuesList();
  /**
   *    * This is the vector data, if it is requested.
   * 
   *
   * repeated float values = 3;
   * @return The count of values.
   */
  int getValuesCount();
  /**
   *    * This is the vector data, if it is requested.
   * 
   *
   * repeated float values = 3;
   * @param index The index of the element to return.
   * @return The values at the given index.
   */
  float getValues(int index);

  /**
   *    * This is the sparse data, if it is requested.
   * 
   *
   * .SparseValues sparse_values = 5;
   * @return Whether the sparseValues field is set.
   */
  boolean hasSparseValues();
  /**
   *    * This is the sparse data, if it is requested.
   * 
   *
   * .SparseValues sparse_values = 5;
   * @return The sparseValues.
   */
  io.pinecone.proto.SparseValues getSparseValues();
  /**
   *    * This is the sparse data, if it is requested.
   * 
   *
   * .SparseValues sparse_values = 5;
   */
  io.pinecone.proto.SparseValuesOrBuilder getSparseValuesOrBuilder();

  /**
   *    * This is the metadata, if it is requested.
   * 
   *
   * .google.protobuf.Struct metadata = 4;
   * @return Whether the metadata field is set.
   */
  boolean hasMetadata();
  /**
   *    * This is the metadata, if it is requested.
   * 
   *
   * .google.protobuf.Struct metadata = 4;
   * @return The metadata.
   */
  com.google.protobuf.Struct getMetadata();
  /**
   *    * This is the metadata, if it is requested.
   * 
   *
   * .google.protobuf.Struct metadata = 4;
   */
  com.google.protobuf.StructOrBuilder getMetadataOrBuilder();
}