io.pinecone.proto

Interface QueryRequestOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

QueryRequest, QueryRequest.Builder

public interface QueryRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Struct	getFilter() The filter to apply.
com.google.protobuf.StructOrBuilder	getFilterOrBuilder() The filter to apply.
java.lang.String	getId() The unique ID of the vector to be used as a query vector.
com.google.protobuf.ByteString	getIdBytes() The unique ID of the vector to be used as a query 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.
QueryVector	getQueries(int index) Deprecated.
int	getQueriesCount() Deprecated.
java.util.List<QueryVector>	getQueriesList() Deprecated.
QueryVectorOrBuilder	getQueriesOrBuilder(int index) Deprecated.
java.util.List<? extends QueryVectorOrBuilder>	getQueriesOrBuilderList() Deprecated.
SparseValues	getSparseVector() The query sparse values.
SparseValuesOrBuilder	getSparseVectorOrBuilder() The query sparse values.
int	getTopK() The number of results to return for each query.
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.
boolean	hasSparseVector() 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

getNamespace

java.lang.String getNamespace()

 The namespace to query.
 

string namespace = 1;

Returns:

The namespace.

getNamespaceBytes

com.google.protobuf.ByteString getNamespaceBytes()

 The namespace to query.
 

string namespace = 1;

Returns:

The bytes for namespace.

getTopK

int getTopK()

 The number of results to return for each query.
 

uint32 top_k = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The topK.

hasFilter

boolean hasFilter()

 The filter to apply. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/.
 

.google.protobuf.Struct filter = 3;

Returns:

Whether the filter field is set.

getFilter

com.google.protobuf.Struct getFilter()

 The filter to apply. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/.
 

.google.protobuf.Struct filter = 3;

Returns:

The filter.

getFilterOrBuilder

com.google.protobuf.StructOrBuilder getFilterOrBuilder()

 The filter to apply. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/.
 

.google.protobuf.Struct filter = 3;

getIncludeValues

boolean getIncludeValues()

 Indicates whether vector values are included in the response.
 

bool include_values = 4;

Returns:

The includeValues.

getIncludeMetadata

boolean getIncludeMetadata()

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

bool include_metadata = 5;

Returns:

The includeMetadata.

getQueriesList

@Deprecated
java.util.List<QueryVector> getQueriesList()

Deprecated.

 DEPRECATED. The query vectors. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
 

repeated .QueryVector queries = 6 [deprecated = true];

getQueries

@Deprecated
QueryVector getQueries(int index)

Deprecated.

 DEPRECATED. The query vectors. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
 

repeated .QueryVector queries = 6 [deprecated = true];

getQueriesCount

@Deprecated
int getQueriesCount()

Deprecated.

 DEPRECATED. The query vectors. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
 

repeated .QueryVector queries = 6 [deprecated = true];

getQueriesOrBuilderList

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

Deprecated.

 DEPRECATED. The query vectors. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
 

repeated .QueryVector queries = 6 [deprecated = true];

getQueriesOrBuilder

@Deprecated
QueryVectorOrBuilder getQueriesOrBuilder(int index)

Deprecated.

 DEPRECATED. The query vectors. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
 

repeated .QueryVector queries = 6 [deprecated = true];

getVectorList

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

 The query vector. This should be the same length as the dimension of the index being queried. Each `query()` request can contain only one of the parameters `id` or `vector`.
 

repeated float vector = 7;

Returns:

A list containing the vector.

getVectorCount

int getVectorCount()

 The query vector. This should be the same length as the dimension of the index being queried. Each `query()` request can contain only one of the parameters `id` or `vector`.
 

repeated float vector = 7;

Returns:

The count of vector.

getVector

float getVector(int index)

 The query vector. This should be the same length as the dimension of the index being queried. Each `query()` request can contain only one of the parameters `id` or `vector`.
 

repeated float vector = 7;

Parameters:

index - The index of the element to return.

Returns:

The vector at the given index.

hasSparseVector

boolean hasSparseVector()

 The query sparse values.
 

.SparseValues sparse_vector = 9;

Returns:

Whether the sparseVector field is set.

getSparseVector

SparseValues getSparseVector()

 The query sparse values.
 

.SparseValues sparse_vector = 9;

Returns:

The sparseVector.

getSparseVectorOrBuilder

SparseValuesOrBuilder getSparseVectorOrBuilder()

 The query sparse values.
 

.SparseValues sparse_vector = 9;

getId

java.lang.String getId()

 The unique ID of the vector to be used as a query vector. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
 

string id = 8;

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 The unique ID of the vector to be used as a query vector. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
 

string id = 8;

Returns:

The bytes for id.