io.pinecone.proto

Class QueryRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.pinecone.proto.QueryRequest

All Implemented Interfaces:

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

public final class QueryRequest
extends com.google.protobuf.GeneratedMessageV3
implements QueryRequestOrBuilder

 The request for the `Query` operation.
 

Protobuf type QueryRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryRequest.Builder The request for the `Query` operation.

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	ID_FIELD_NUMBER
static int	INCLUDE_METADATA_FIELD_NUMBER
static int	INCLUDE_VALUES_FIELD_NUMBER
static int	NAMESPACE_FIELD_NUMBER
static int	QUERIES_FIELD_NUMBER
static int	SPARSE_VECTOR_FIELD_NUMBER
static int	TOP_K_FIELD_NUMBER
static int	VECTOR_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 QueryRequest	getDefaultInstance()
QueryRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Struct	getFilter() The filter to apply if no filter is specified in `QueryVector.
com.google.protobuf.StructOrBuilder	getFilterOrBuilder() The filter to apply if no filter is specified in `QueryVector.
java.lang.String	getId() The id of the vector
com.google.protobuf.ByteString	getIdBytes() The id of the vector
boolean	getIncludeMetadata() Indicates whether metadata is included in the response as well as the ids.
boolean	getIncludeValues() Indicates whether vector values are included in the response.
java.lang.String	getNamespace() The namespace to query.
com.google.protobuf.ByteString	getNamespaceBytes() The namespace to query.
com.google.protobuf.Parser<QueryRequest>	getParserForType()
QueryVector	getQueries(int index) The query vectors.
int	getQueriesCount() The query vectors.
java.util.List<QueryVector>	getQueriesList() The query vectors.
QueryVectorOrBuilder	getQueriesOrBuilder(int index) The query vectors.
java.util.List<? extends QueryVectorOrBuilder>	getQueriesOrBuilderList() The query vectors.
int	getSerializedSize()
SparseValues	getSparseVector() The query sparse values.
SparseValuesOrBuilder	getSparseVectorOrBuilder() The query sparse values.
int	getTopK() The number of results to return for each query.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
float	getVector(int index) The query vector.
int	getVectorCount() The query vector.
java.util.List<java.lang.Float>	getVectorList() The query vector.
boolean	hasFilter() The filter to apply if no filter is specified in `QueryVector.
int	hashCode()
boolean	hasSparseVector() The query sparse values.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static QueryRequest.Builder	newBuilder()
static QueryRequest.Builder	newBuilder(QueryRequest prototype)
QueryRequest.Builder	newBuilderForType()
protected QueryRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static QueryRequest	parseDelimitedFrom(java.io.InputStream input)
static QueryRequest	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryRequest	parseFrom(byte[] data)
static QueryRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryRequest	parseFrom(java.nio.ByteBuffer data)
static QueryRequest	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryRequest	parseFrom(com.google.protobuf.ByteString data)
static QueryRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static QueryRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryRequest	parseFrom(java.io.InputStream input)
static QueryRequest	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<QueryRequest>	parser()
QueryRequest.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

NAMESPACE_FIELD_NUMBER

public static final int NAMESPACE_FIELD_NUMBER

See Also:

Constant Field Values

TOP_K_FIELD_NUMBER

public static final int TOP_K_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

INCLUDE_VALUES_FIELD_NUMBER

public static final int INCLUDE_VALUES_FIELD_NUMBER

See Also:

Constant Field Values

INCLUDE_METADATA_FIELD_NUMBER

public static final int INCLUDE_METADATA_FIELD_NUMBER

See Also:

Constant Field Values

QUERIES_FIELD_NUMBER

public static final int QUERIES_FIELD_NUMBER

See Also:

Constant Field Values

VECTOR_FIELD_NUMBER

public static final int VECTOR_FIELD_NUMBER

See Also:

Constant Field Values

SPARSE_VECTOR_FIELD_NUMBER

public static final int SPARSE_VECTOR_FIELD_NUMBER

See Also:

Constant Field Values

ID_FIELD_NUMBER

public static final int ID_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

getNamespace

public java.lang.String getNamespace()

 The namespace to query.
 

string namespace = 1;

Specified by:

getNamespace in interface QueryRequestOrBuilder

Returns:

The namespace.

getNamespaceBytes

public com.google.protobuf.ByteString getNamespaceBytes()

 The namespace to query.
 

string namespace = 1;

Specified by:

getNamespaceBytes in interface QueryRequestOrBuilder

Returns:

The bytes for namespace.

getTopK

public int getTopK()

 The number of results to return for each query.
 

uint32 top_k = 2;

Specified by:

getTopK in interface QueryRequestOrBuilder

Returns:

The topK.

hasFilter

public boolean hasFilter()

 The filter to apply if no filter is specified in `QueryVector. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/`
 

.google.protobuf.Struct filter = 3;

Specified by:

hasFilter in interface QueryRequestOrBuilder

Returns:

Whether the filter field is set.

getFilter

public com.google.protobuf.Struct getFilter()

 The filter to apply if no filter is specified in `QueryVector. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/`
 

.google.protobuf.Struct filter = 3;

Specified by:

getFilter in interface QueryRequestOrBuilder

Returns:

The filter.

getFilterOrBuilder

public com.google.protobuf.StructOrBuilder getFilterOrBuilder()

 The filter to apply if no filter is specified in `QueryVector. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/`
 

.google.protobuf.Struct filter = 3;

Specified by:

getFilterOrBuilder in interface QueryRequestOrBuilder

getIncludeValues

public boolean getIncludeValues()

 Indicates whether vector values are included in the response.
 

bool include_values = 4;

Specified by:

getIncludeValues in interface QueryRequestOrBuilder

Returns:

The includeValues.

getIncludeMetadata

public boolean getIncludeMetadata()

 Indicates whether metadata is included in the response as well as the ids.
 

bool include_metadata = 5;

Specified by:

getIncludeMetadata in interface QueryRequestOrBuilder

Returns:

The includeMetadata.

getQueriesList

public java.util.List<QueryVector> getQueriesList()

 The query vectors.
 

repeated .QueryVector queries = 6;

Specified by:

getQueriesList in interface QueryRequestOrBuilder

getQueriesOrBuilderList

public java.util.List<? extends QueryVectorOrBuilder> getQueriesOrBuilderList()

 The query vectors.
 

repeated .QueryVector queries = 6;

Specified by:

getQueriesOrBuilderList in interface QueryRequestOrBuilder

getQueriesCount

public int getQueriesCount()

 The query vectors.
 

repeated .QueryVector queries = 6;

Specified by:

getQueriesCount in interface QueryRequestOrBuilder

getQueries

public QueryVector getQueries(int index)

 The query vectors.
 

repeated .QueryVector queries = 6;

Specified by:

getQueries in interface QueryRequestOrBuilder

getQueriesOrBuilder

public QueryVectorOrBuilder getQueriesOrBuilder(int index)

 The query vectors.
 

repeated .QueryVector queries = 6;

Specified by:

getQueriesOrBuilder in interface QueryRequestOrBuilder

getVectorList

public java.util.List<java.lang.Float> getVectorList()

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

repeated float vector = 7;

Specified by:

getVectorList in interface QueryRequestOrBuilder

Returns:

A list containing the vector.

getVectorCount

public int getVectorCount()

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

repeated float vector = 7;

Specified by:

getVectorCount in interface QueryRequestOrBuilder

Returns:

The count of vector.

getVector

public float getVector(int index)

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

repeated float vector = 7;

Specified by:

getVector in interface QueryRequestOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The vector at the given index.

hasSparseVector

public boolean hasSparseVector()

 The query sparse values.
 

.SparseValues sparse_vector = 9;

Specified by:

hasSparseVector in interface QueryRequestOrBuilder

Returns:

Whether the sparseVector field is set.

getSparseVector

public SparseValues getSparseVector()

 The query sparse values.
 

.SparseValues sparse_vector = 9;

Specified by:

getSparseVector in interface QueryRequestOrBuilder

Returns:

The sparseVector.

getSparseVectorOrBuilder

public SparseValuesOrBuilder getSparseVectorOrBuilder()

 The query sparse values.
 

.SparseValues sparse_vector = 9;

Specified by:

getSparseVectorOrBuilder in interface QueryRequestOrBuilder

getId

public java.lang.String getId()

 The id of the vector
 

string id = 8;

Specified by:

getId in interface QueryRequestOrBuilder

Returns:

The id.

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

 The id of the vector
 

string id = 8;

Specified by:

getIdBytes in interface QueryRequestOrBuilder

Returns:

The bytes for id.

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 QueryRequest parseFrom(java.nio.ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public QueryRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static QueryRequest.Builder newBuilder()

newBuilder

public static QueryRequest.Builder newBuilder(QueryRequest prototype)

toBuilder

public QueryRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static QueryRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<QueryRequest> 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 QueryRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder