io.pinecone.proto

Interface QueryVectorOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

QueryVector, QueryVector.Builder

public interface QueryVectorOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Struct	getFilter() An override for the metadata filter to apply.
com.google.protobuf.StructOrBuilder	getFilterOrBuilder() An override for the metadata filter to apply.
java.lang.String	getNamespace() An override the namespace to search.
com.google.protobuf.ByteString	getNamespaceBytes() An override the namespace to search.
SparseValues	getSparseValues() The query sparse values.
SparseValuesOrBuilder	getSparseValuesOrBuilder() The query sparse values.
int	getTopK() An override for the number of results to return for this query vector.
float	getValues(int index) The query vector values.
int	getValuesCount() The query vector values.
java.util.List<java.lang.Float>	getValuesList() The query vector values.
boolean	hasFilter() An override for the metadata filter to apply.
boolean	hasSparseValues() The query sparse values.

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

getValuesList

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

 The query vector values. This should be the same length as the dimension of the index being queried.
 

repeated float values = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

A list containing the values.

getValuesCount

int getValuesCount()

 The query vector values. This should be the same length as the dimension of the index being queried.
 

repeated float values = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The count of values.

getValues

float getValues(int index)

 The query vector values. This should be the same length as the dimension of the index being queried.
 

repeated float values = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:

index - The index of the element to return.

Returns:

The values at the given index.

hasSparseValues

boolean hasSparseValues()

 The query sparse values.
 

.SparseValues sparse_values = 5;

Returns:

Whether the sparseValues field is set.

getSparseValues

SparseValues getSparseValues()

 The query sparse values.
 

.SparseValues sparse_values = 5;

Returns:

The sparseValues.

getSparseValuesOrBuilder

SparseValuesOrBuilder getSparseValuesOrBuilder()

 The query sparse values.
 

.SparseValues sparse_values = 5;

getTopK

int getTopK()

 An override for the number of results to return for this query vector.
 

uint32 top_k = 2;

Returns:

The topK.

getNamespace

java.lang.String getNamespace()

 An override the namespace to search.
 

string namespace = 3;

Returns:

The namespace.

getNamespaceBytes

com.google.protobuf.ByteString getNamespaceBytes()

 An override the namespace to search.
 

string namespace = 3;

Returns:

The bytes for namespace.

hasFilter

boolean hasFilter()

 An override for the metadata filter to apply. This replaces the request-level filter.
 

.google.protobuf.Struct filter = 4;

Returns:

Whether the filter field is set.

getFilter

com.google.protobuf.Struct getFilter()

 An override for the metadata filter to apply. This replaces the request-level filter.
 

.google.protobuf.Struct filter = 4;

Returns:

The filter.

getFilterOrBuilder

com.google.protobuf.StructOrBuilder getFilterOrBuilder()

 An override for the metadata filter to apply. This replaces the request-level filter.
 

.google.protobuf.Struct filter = 4;