Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

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.

Python
# 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
)
JavaScript
// 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
});
Java
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);
    }
}
Go
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))
    }
}
C#
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);
curl
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
  }'
curl
{
  "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

Api-Keystringrequired

An API Key is required to call Pinecone APIs. Get yours from the console.

namespace?string

The namespace to query.

Example: example-namespace

Typestring
topKintegerrequired

The number of results to return for each query.

Required range: 1 <= x <= 10000. Example: 10

Typeinteger
filter?object

The filter to apply. You can use vector metadata to limit your search. See Understanding metadata.

includeValues?boolean

Indicates 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

Typeboolean
Defaultfalse
includeMetadata?boolean

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

Example: true

Typeboolean
Defaultfalse
queries?object[]deprecated

DEPRECATED. Use vector or id instead.

Required string length: 1 - 10

Typeobject[]
Show child attributes
valuesnumber[]required

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

Required string length: 1 - 20000

Typenumber[]
sparseValues?object

Vector sparse data. Represented as a list of indices and a list of corresponded values, which must be with the same length.

Typeobject
Show child attributes
indicesinteger[]required

The indices of the sparse data.

Required string length: 1 - 1000

Typeinteger[]
valuesnumber[]required

The corresponding values of the sparse data, which must be with the same length as the indices.

Required string length: 1 - 1000

Typenumber[]
topK?integer

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

Required range: 1 <= x <= 10000. Example: 10

Typeinteger
namespace?string

An override the namespace to search.

Example: example-namespace

Typestring
filter?object

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

Typeobject
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

Typenumber[]
sparseVector?object

Vector sparse data. Represented as a list of indices and a list of corresponded values, which must be with the same length.

Typeobject
Show child attributes
indicesinteger[]required

The indices of the sparse data.

Required string length: 1 - 1000

Typeinteger[]
valuesnumber[]required

The corresponding values of the sparse data, which must be with the same length as the indices.

Required string length: 1 - 1000

Typenumber[]
id?string

The 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

Typestring

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[]deprecated

DEPRECATED. The results of each query. The order is the same as QueryRequest.queries.

Typeobject[]
Show child attributes
matches?object[]

The matches for the vectors.

Typeobject[]
Show child attributes
idstringrequired

This is the vector's unique id.

Required string length: 1 - 512. Example: example-vector-1

Typestring
score?number

This is a measure of similarity between this vector and the query vector. The higher the score, the more they are similar.

Example: 0.08

Typenumber
values?number[]

This is the vector data, if it is requested.

Typenumber[]
sparseValues?object

Vector sparse data. Represented as a list of indices and a list of corresponded values, which must be with the same length.

Typeobject
Show child attributes
indicesinteger[]required

The indices of the sparse data.

Required string length: 1 - 1000

Typeinteger[]
valuesnumber[]required

The corresponding values of the sparse data, which must be with the same length as the indices.

Required string length: 1 - 1000

Typenumber[]
metadata?object

This is the metadata, if it is requested.

Typeobject
namespace?string

The namespace for the vectors.

Example: example-namespace

Typestring
matches?object[]

The matches for the vectors.

Typeobject[]
Show child attributes
idstringrequired

This is the vector's unique id.

Required string length: 1 - 512. Example: example-vector-1

Typestring
score?number

This is a measure of similarity between this vector and the query vector. The higher the score, the more they are similar.

Example: 0.08

Typenumber
values?number[]

This is the vector data, if it is requested.

Typenumber[]
sparseValues?object

Vector sparse data. Represented as a list of indices and a list of corresponded values, which must be with the same length.

Typeobject
Show child attributes
indicesinteger[]required

The indices of the sparse data.

Required string length: 1 - 1000

Typeinteger[]
valuesnumber[]required

The corresponding values of the sparse data, which must be with the same length as the indices.

Required string length: 1 - 1000

Typenumber[]
metadata?object

This is the metadata, if it is requested.

Typeobject
namespace?string

The namespace for the vectors.

Typestring
usage?object
Show child attributes
readUnits?integer

The number of read units consumed by this operation.

Example: 5

Typeinteger
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu