Search with a vector
Search a namespace with a query vector or record ID and return the IDs of the most similar records, along with their similarity scores.
For guidance, examples, and limits, see Search.
# pip install "pinecone[grpc]"
from pinecone.grpc import PineconeGRPC as Pinecone
pc = Pinecone(api_key="YOUR_API_KEY")
index = pc.Index("docs-example")
index.query(
namespace="example-namespace",
vector=[0.3, 0.3, 0.3, 0.3, 0.3, 0.3, 0.3, 0.3],
filter={
"genre": {"$eq": "documentary"}
},
top_k=3,
include_values=True
)// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone'
const pc = new Pinecone({ apiKey: 'YOUR_API_KEY' })
const index = pc.index("docs-example")
const queryResponse = await index.namespace('example-namespace').query({
vector: [0.3, 0.3, 0.3, 0.3, 0.3, 0.3, 0.3, 0.3],
filter: {
'genre': {'$eq': 'documentary'}
},
topK: 3,
includeValues: true
});import com.google.protobuf.Struct;
import com.google.protobuf.Value;
import io.pinecone.clients.Index;
import io.pinecone.clients.Pinecone;
import io.pinecone.unsigned_indices_model.QueryResponseWithUnsignedIndices;
import java.util.Arrays;
import java.util.List;
public class QueryByMetadataExample {
public static void main(String[] args) {
Pinecone pc = new Pinecone.Builder("YOUR_API_KEY").build();
Index index = pc.getIndexConnection("docs-example");
List<Float> query = Arrays.asList(0.3f, 0.3f, 0.3f, 0.3f, 0.3f, 0.3f, 0.3f, 0.3f);
Struct filter = Struct.newBuilder()
.putFields("genre", Value.newBuilder()
.setStructValue(Struct.newBuilder()
.putFields("$eq", Value.newBuilder()
.setStringValue("documentary")
.build()))
.build())
.build();
QueryResponseWithUnsignedIndices queryResponse = index.query(3, query, null, null, null, "example-namespace", filter, false, true);
System.out.println(queryResponse);
}
}package main
import (
"context"
"encoding/json"
"fmt"
"log"
"github.com/pinecone-io/go-pinecone/v2/pinecone"
"google.golang.org/protobuf/types/known/structpb"
)
func prettifyStruct(obj interface{}) string {
bytes, _ := json.MarshalIndent(obj, "", " ")
return string(bytes)
}
func main() {
ctx := context.Background()
pc, err := pinecone.NewClient(pinecone.NewClientParams{
ApiKey: "YOUR_API_KEY",
})
if err != nil {
log.Fatalf("Failed to create Client: %v", err)
}
idx, err := pc.DescribeIndex(ctx, "docs-example")
if err != nil {
log.Fatalf("Failed to describe index \"%v\": %v", idx.Name, err)
}
idxConnection, err := pc.Index(pinecone.NewIndexConnParams{Host: idx.Host, Namespace: "example-namespace"})
if err != nil {
log.Fatalf("Failed to create IndexConnection for Host %v: %v", idx.Host, err)
}
queryVector := []float32{0.3, 0.3, 0.3, 0.3, 0.3, 0.3, 0.3, 0.3}
metadataMap := map[string]interface{}{
"genre": map[string]interface{}{
"$eq": "documentary",
},
}
metadataFilter, err := structpb.NewStruct(metadataMap)
if err != nil {
log.Fatalf("Failed to create metadata map: %v", err)
}
res, err := idxConnection.QueryByVectorValues(ctx, &pinecone.QueryByVectorValuesRequest{
Vector: queryVector,
TopK: 3,
MetadataFilter: metadataFilter,
IncludeValues: true,
})
if err != nil {
log.Fatalf("Error encountered when querying by vector: %v", err)
} else {
fmt.Printf(prettifyStruct(res))
}
}using Pinecone;
var pinecone = new PineconeClient("YOUR_API_KEY");
var index = pinecone.Index("docs-example");
var queryResponse = await index.QueryAsync(new QueryRequest {
Vector = new[] { 0.3f, 0.3f, 0.3f, 0.3f, 0.3f, 0.3f, 0.3f, 0.3f },
Namespace = "example-namespace",
TopK = 3,
Filter = new Metadata
{
["genre"] =
new Metadata
{
["$eq"] = "documentary",
}
}
});
Console.WriteLine(queryResponse);PINECONE_API_KEY="YOUR_API_KEY"
INDEX_HOST="INDEX_HOST"
curl "https://$INDEX_HOST/query" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "Content-Type: application/json" \
-H "X-Pinecone-Api-Version: 2024-07" \
-d '{
"vector": [0.3, 0.3, 0.3, 0.3, 0.3, 0.3, 0.3, 0.3],
"filter": {"genre": {"$eq": "documentary"}},
"topK": 3,
"includeValues": true
}'{
"matches":[
{
"id": "vec3",
"score": 0,
"values": [0.3,0.3,0.3,0.3,0.3,0.3,0.3,0.3]
},
{
"id": "vec2",
"score": 0.0800000429,
"values": [0.2, 0.2, 0.2, 0.2, 0.2, 0.2, 0.2, 0.2]
},
{
"id": "vec4",
"score": 0.0799999237,
"values": [0.4, 0.4, 0.4, 0.4, 0.4, 0.4, 0.4, 0.4]
}
],
"namespace": "example-namespace",
"usage": {"read_units": 6}
}POST /query
Authorizations
Section titled “Authorizations”Api-KeystringrequiredAn API Key is required to call Pinecone APIs. Get yours from the console.
namespace?stringThe namespace to query.
Example: example-namespace
topKintegerrequiredThe number of results to return for each query.
Required range: 1 <= x <= 10000. Example: 10
filter?objectThe filter to apply. You can use vector metadata to limit your search. See Understanding metadata.
includeValues?booleanIndicates whether vector values are included in the response. For on-demand indexes, setting this to true may increase latency, especially with higher topK values, because vector values are retrieved from object storage. Unless you need vector values, set this to false for better performance.
Example: true
includeMetadata?booleanIndicates whether metadata is included in the response as well as the ids.
Example: true
queries?object[]deprecatedDEPRECATED. Use vector or id instead.
Required string length: 1 - 10
Show child attributes
valuesnumber[]requiredThe query vector values. This should be the same length as the dimension of the index being queried.
Required string length: 1 - 20000
sparseValues?objectVector sparse data. Represented as a list of indices and a list of corresponded values, which must be with the same length.
Show child attributes
indicesinteger[]requiredThe indices of the sparse data.
Required string length: 1 - 1000
valuesnumber[]requiredThe corresponding values of the sparse data, which must be with the same length as the indices.
Required string length: 1 - 1000
topK?integerAn override for the number of results to return for this query vector.
Required range: 1 <= x <= 10000. Example: 10
namespace?stringAn override the namespace to search.
Example: example-namespace
filter?objectAn override for the metadata filter to apply. This replaces the request-level filter.
vector?number[]The query vector. This should be the same length as the dimension of the index being queried. Each request can contain either the id or vector parameter.
Required string length: 1 - 20000
sparseVector?objectVector sparse data. Represented as a list of indices and a list of corresponded values, which must be with the same length.
Show child attributes
indicesinteger[]requiredThe indices of the sparse data.
Required string length: 1 - 1000
valuesnumber[]requiredThe corresponding values of the sparse data, which must be with the same length as the indices.
Required string length: 1 - 1000
id?stringThe unique ID of the vector to be used as a query vector. Each request can contain either the vector or id parameter.
Required string length: 0 - 512. Example: example-vector-1
Response
Section titled “Response”200 — A successful 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.
results?object[]deprecatedDEPRECATED. The results of each query. The order is the same as QueryRequest.queries.
Show child attributes
matches?object[]The matches for the vectors.
Show child attributes
idstringrequiredThis is the vector's unique id.
Required string length: 1 - 512. Example: example-vector-1
score?numberThis is a measure of similarity between this vector and the query vector. The higher the score, the more they are similar.
Example: 0.08
values?number[]This is the vector data, if it is requested.
sparseValues?objectVector sparse data. Represented as a list of indices and a list of corresponded values, which must be with the same length.
Show child attributes
indicesinteger[]requiredThe indices of the sparse data.
Required string length: 1 - 1000
valuesnumber[]requiredThe corresponding values of the sparse data, which must be with the same length as the indices.
Required string length: 1 - 1000
metadata?objectThis is the metadata, if it is requested.
namespace?stringThe namespace for the vectors.
Example: example-namespace
matches?object[]The matches for the vectors.
Show child attributes
idstringrequiredThis is the vector's unique id.
Required string length: 1 - 512. Example: example-vector-1
score?numberThis is a measure of similarity between this vector and the query vector. The higher the score, the more they are similar.
Example: 0.08
values?number[]This is the vector data, if it is requested.
sparseValues?objectVector sparse data. Represented as a list of indices and a list of corresponded values, which must be with the same length.
Show child attributes
indicesinteger[]requiredThe indices of the sparse data.
Required string length: 1 - 1000
valuesnumber[]requiredThe corresponding values of the sparse data, which must be with the same length as the indices.
Required string length: 1 - 1000
metadata?objectThis is the metadata, if it is requested.
namespace?stringThe namespace for the vectors.
usage?objectShow child attributes
readUnits?integerThe number of read units consumed by this operation.
Example: 5