io.pinecone.proto

Interface ScoredVectorOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ScoredVector, ScoredVector.Builder

public interface ScoredVectorOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() This is the vector's unique id.
com.google.protobuf.ByteString	getIdBytes() This is the vector's unique id.
com.google.protobuf.Struct	getMetadata() This is the metadata, if it is requested.
com.google.protobuf.StructOrBuilder	getMetadataOrBuilder() This is the metadata, if it is requested.
float	getScore() This is a measure of similarity between this vector and the query vector.
SparseValues	getSparseValues() This is the sparse data, if it is requested.
SparseValuesOrBuilder	getSparseValuesOrBuilder() This is the sparse data, if it is requested.
float	getValues(int index) This is the vector data, if it is requested.
int	getValuesCount() This is the vector data, if it is requested.
java.util.List<java.lang.Float>	getValuesList() This is the vector data, if it is requested.
boolean	hasMetadata() This is the metadata, if it is requested.
boolean	hasSparseValues() This is the sparse data, if it is requested.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getId

java.lang.String getId()

 This is the vector's unique id.
 

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 This is the vector's unique id.
 

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for id.

getScore

float getScore()

 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;

Returns:

The score.

getValuesList

java.util.List<java.lang.Float> getValuesList()

 This is the vector data, if it is requested.
 

repeated float values = 3;

Returns:

A list containing the values.

getValuesCount

int getValuesCount()

 This is the vector data, if it is requested.
 

repeated float values = 3;

Returns:

The count of values.

getValues

float getValues(int index)

 This is the vector data, if it is requested.
 

repeated float values = 3;

Parameters:

index - The index of the element to return.

Returns:

The values at the given index.

hasSparseValues

boolean hasSparseValues()

 This is the sparse data, if it is requested.
 

.SparseValues sparse_values = 5;

Returns:

Whether the sparseValues field is set.

getSparseValues

SparseValues getSparseValues()

 This is the sparse data, if it is requested.
 

.SparseValues sparse_values = 5;

Returns:

The sparseValues.

getSparseValuesOrBuilder

SparseValuesOrBuilder getSparseValuesOrBuilder()

 This is the sparse data, if it is requested.
 

.SparseValues sparse_values = 5;

hasMetadata

boolean hasMetadata()

 This is the metadata, if it is requested.
 

.google.protobuf.Struct metadata = 4;

Returns:

Whether the metadata field is set.

getMetadata

com.google.protobuf.Struct getMetadata()

 This is the metadata, if it is requested.
 

.google.protobuf.Struct metadata = 4;

Returns:

The metadata.

getMetadataOrBuilder

com.google.protobuf.StructOrBuilder getMetadataOrBuilder()

 This is the metadata, if it is requested.
 

.google.protobuf.Struct metadata = 4;