io.pinecone.proto

Class QueryVector

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.pinecone.proto.QueryVector

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, QueryVectorOrBuilder, java.io.Serializable

public final class QueryVector
extends com.google.protobuf.GeneratedMessageV3
implements QueryVectorOrBuilder

 A single query vector within a `QueryRequest`.
 

Protobuf type QueryVector

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryVector.Builder A single query vector within a `QueryRequest`.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_FIELD_NUMBER
static int	NAMESPACE_FIELD_NUMBER
static int	SPARSE_VALUES_FIELD_NUMBER
static int	TOP_K_FIELD_NUMBER
static int	VALUES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static QueryVector	getDefaultInstance()
QueryVector	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<QueryVector>	getParserForType()
int	getSerializedSize()
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.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
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.
int	hashCode()
boolean	hasSparseValues() The query sparse values.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static QueryVector.Builder	newBuilder()
static QueryVector.Builder	newBuilder(QueryVector prototype)
QueryVector.Builder	newBuilderForType()
protected QueryVector.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static QueryVector	parseDelimitedFrom(java.io.InputStream input)
static QueryVector	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryVector	parseFrom(byte[] data)
static QueryVector	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryVector	parseFrom(java.nio.ByteBuffer data)
static QueryVector	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryVector	parseFrom(com.google.protobuf.ByteString data)
static QueryVector	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryVector	parseFrom(com.google.protobuf.CodedInputStream input)
static QueryVector	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryVector	parseFrom(java.io.InputStream input)
static QueryVector	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<QueryVector>	parser()
QueryVector.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER

See Also:

Constant Field Values

SPARSE_VALUES_FIELD_NUMBER

public static final int SPARSE_VALUES_FIELD_NUMBER

See Also:

Constant Field Values

TOP_K_FIELD_NUMBER

public static final int TOP_K_FIELD_NUMBER

See Also:

Constant Field Values

NAMESPACE_FIELD_NUMBER

public static final int NAMESPACE_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getValuesList

public 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;

Specified by:

getValuesList in interface QueryVectorOrBuilder

Returns:

A list containing the values.

getValuesCount

public int getValuesCount()

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

repeated float values = 1;

Specified by:

getValuesCount in interface QueryVectorOrBuilder

Returns:

The count of values.

getValues

public 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;

Specified by:

getValues in interface QueryVectorOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The values at the given index.

hasSparseValues

public boolean hasSparseValues()

 The query sparse values.
 

.SparseValues sparse_values = 5;

Specified by:

hasSparseValues in interface QueryVectorOrBuilder

Returns:

Whether the sparseValues field is set.

getSparseValues

public SparseValues getSparseValues()

 The query sparse values.
 

.SparseValues sparse_values = 5;

Specified by:

getSparseValues in interface QueryVectorOrBuilder

Returns:

The sparseValues.

getSparseValuesOrBuilder

public SparseValuesOrBuilder getSparseValuesOrBuilder()

 The query sparse values.
 

.SparseValues sparse_values = 5;

Specified by:

getSparseValuesOrBuilder in interface QueryVectorOrBuilder

getTopK

public int getTopK()

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

uint32 top_k = 2;

Specified by:

getTopK in interface QueryVectorOrBuilder

Returns:

The topK.

getNamespace

public java.lang.String getNamespace()

 An override the namespace to search.
 

string namespace = 3;

Specified by:

getNamespace in interface QueryVectorOrBuilder

Returns:

The namespace.

getNamespaceBytes

public com.google.protobuf.ByteString getNamespaceBytes()

 An override the namespace to search.
 

string namespace = 3;

Specified by:

getNamespaceBytes in interface QueryVectorOrBuilder

Returns:

The bytes for namespace.

hasFilter

public boolean hasFilter()

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

.google.protobuf.Struct filter = 4;

Specified by:

hasFilter in interface QueryVectorOrBuilder

Returns:

Whether the filter field is set.

getFilter

public com.google.protobuf.Struct getFilter()

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

.google.protobuf.Struct filter = 4;

Specified by:

getFilter in interface QueryVectorOrBuilder

Returns:

The filter.

getFilterOrBuilder

public com.google.protobuf.StructOrBuilder getFilterOrBuilder()

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

.google.protobuf.Struct filter = 4;

Specified by:

getFilterOrBuilder in interface QueryVectorOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static QueryVector parseFrom(java.nio.ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryVector parseFrom(java.nio.ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryVector parseFrom(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryVector parseFrom(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryVector parseFrom(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryVector parseFrom(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryVector parseFrom(java.io.InputStream input)
                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static QueryVector parseFrom(java.io.InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static QueryVector parseDelimitedFrom(java.io.InputStream input)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static QueryVector parseDelimitedFrom(java.io.InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static QueryVector parseFrom(com.google.protobuf.CodedInputStream input)
                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static QueryVector parseFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public QueryVector.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static QueryVector.Builder newBuilder()

newBuilder

public static QueryVector.Builder newBuilder(QueryVector prototype)

toBuilder

public QueryVector.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected QueryVector.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static QueryVector getDefaultInstance()

parser

public static com.google.protobuf.Parser<QueryVector> parser()

getParserForType

public com.google.protobuf.Parser<QueryVector> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public QueryVector getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder