Query vectors
The query operation searches a namespace, using a query vector. It retrieves the ids of the most similar items in a namespace, along with their similarity scores.
For guidance and examples, see Query data.
Authorizations
An API Key is required to call Pinecone APIs. Get yours from the console.
Body
The request for the query operation.
The namespace to query.
The number of results to return for each query.
The filter to apply. You can use vector metadata to limit your search. See Filter with metadata.
Indicates whether vector values are included in the response.
Indicates whether metadata is included in the response as well as the ids.
DEPRECATED. The query vectors. Each query() request can contain only one of the parameters queries, vector, or id.
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.
Vector sparse data. Represented as a list of indices and a list of corresponded values, which must be with the same length.
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.
Response
The response for the query operation. These are the matches found for a particular query vector. The matches are ordered from most similar to least similar.
DEPRECATED. The results of each query. The order is the same as QueryRequest.queries.
The matches for the vectors.
The namespace for the vectors.
Was this page helpful?