Indexes

Configure an index

Configure an existing index.

For serverless indexes, you can configure index deletion protection, tags, and integrated inference embedding settings for the index. For pod-based indexes, you can configure the pod size, number of replicas, tags, and index deletion protection.

It is not possible to change the pod type of a pod-based index. However, you can create a collection from a pod-based index and then create a new pod-based index with a different pod type from the collection. For guidance and examples, see Configure an index.

PATCH

indexes

{index_name}

from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

pc.configure_index(
   name="example-index", 
   deletion_protection="disabled"
)

{
    "name": "example-index",
    "metric": "cosine",
    "dimension": 1536,
    "status": {
        "ready": true,
        "state": "Ready"
    },
    "host": "example-index1-4zo0ijk.svc.dev-us-west2-aws.pinecone.io",
    "spec": {
        "serverless": {
            "region": "us-east-1",
            "cloud": "aws"
        },
    "tags": {
            "example": "tag",
            "environment": "production"
        }
    },
    "deletion_protection": "disabled"
}

from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

pc.configure_index(
   name="example-index", 
   deletion_protection="disabled"
)

{
    "name": "example-index",
    "metric": "cosine",
    "dimension": 1536,
    "status": {
        "ready": true,
        "state": "Ready"
    },
    "host": "example-index1-4zo0ijk.svc.dev-us-west2-aws.pinecone.io",
    "spec": {
        "serverless": {
            "region": "us-east-1",
            "cloud": "aws"
        },
    "tags": {
            "example": "tag",
            "environment": "production"
        }
    },
    "deletion_protection": "disabled"
}

Authorizations

Api-Key

string

header

required

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

Path Parameters

index_name

string

required

The name of the index to configure.

Body

application/json

The desired pod size and replica configuration for the index.

Configuration used to scale an index.

spec

object

deletion_protection

enum<string>

default:disabled

Whether deletion protection is enabled/disabled for the index.

Available options:

disabled,

enabled

Response

202

application/json

The request to configure the index has been accepted. Check the index status to see when the change has been applied.

The IndexModel describes the configuration and status of a Pinecone index.

name

string

required

The name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

Required string length: 1 - 45

Example:

"example-index"

metric

enum<string>

required

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'. If the 'vector_type' is 'sparse', the metric must be 'dotproduct'. If the vector_type is dense, the metric defaults to 'cosine'.

Available options:

cosine,

euclidean,

dotproduct

host

string

required

The URL address where the index is hosted.

Example:

"semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io"

spec

object

required

spec.pod

object

Configuration needed to deploy a pod-based index.

spec.pod.environment

string

required

The environment where the index is hosted.

Example:

"us-east1-gcp"

spec.pod.pod_type

string

default:p1.x1

required

The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.

spec.pod.replicas

integer

default:1

The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.

Required range: x >= 1

spec.pod.shards

integer

default:1

The number of shards. Shards split your data across multiple pods so you can fit more data into an index.

Required range: x >= 1

spec.pod.pods

integer

default:1

The number of pods to be used in the index. This should be equal to shards x replicas.'

Required range: x >= 1

Example:

1

spec.pod.metadata_config

object

Configuration for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when metadata_config is present, only specified metadata fields are indexed. These configurations are only valid for use with pod-based indexes.

Example:

{
  "indexed": ["genre", "title", "imdb_rating"]
}

spec.pod.source_collection

string

The name of the collection to be used as the source for the index.

Example:

"movie-embeddings"

Example:

{
  "environment": "us-east1-gcp",
  "metadata_config": {
    "indexed": ["genre", "title", "imdb_rating"]
  },
  "pod_type": "p1.x1",
  "pods": 1,
  "replicas": 1,
  "shards": 1,
  "source_collection": "movie-embeddings"
}

spec.serverless

object

Configuration needed to deploy a serverless index.

Example:

{
  "pod": {
    "environment": "us-east-1-aws",
    "metadata_config": {
      "indexed": ["genre", "title", "imdb_rating"]
    },
    "pod_type": "p1.x1",
    "pods": 1,
    "replicas": 1,
    "shards": 1
  }
}

status

object

required

Example:

{
  "ready": true,
  "state": "ScalingUpPodSize"
}

vector_type

string

default:dense

required

The index vector type. You can use 'dense' or 'sparse'. If 'dense', the vector dimension must be specified. If 'sparse', the vector dimension should not be specified.

dimension

integer

The dimensions of the vectors to be inserted in the index.

Required range: 1 <= x <= 20000

Example:

1536

deletion_protection

enum<string>

default:disabled

Whether deletion protection is enabled/disabled for the index.

Available options:

disabled,

enabled

tags

object

Example:

{ "tag0": "val0", "tag1": "val1" }

embed

object

The embedding model and document fields mapped to embedding inputs.

embed.model

string

required

The name of the embedding model used to create the index.

Example:

"multilingual-e5-large"

embed.metric

enum<string>

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'. If not specified, the metric will be defaulted according to the model. Cannot be updated once set.

Available options:

cosine,

euclidean,

dotproduct

embed.dimension

integer

The dimensions of the vectors to be inserted in the index.

Required range: 1 <= x <= 20000

Example:

1536

embed.vector_type

string

default:dense

The index vector type. You can use 'dense' or 'sparse'. If 'dense', the vector dimension must be specified. If 'sparse', the vector dimension should not be specified.

embed.field_map

object

Identifies the name of the text field from your document model that is embedded.

Example:

{ "text": "your-text-field" }

embed.read_parameters

object

The read parameters for the embedding model.

embed.write_parameters

object

The write parameters for the embedding model.

Example:

{
  "field_map": { "text": "your-text-field" },
  "metric": "cosine",
  "model": "multilingual-e5-large",
  "read_parameters": { "input_type": "query", "truncate": "NONE" },
  "write_parameters": { "input_type": "passage" }
}

Delete an index Get index stats

from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

pc.configure_index(
   name="example-index", 
   deletion_protection="disabled"
)

{
    "name": "example-index",
    "metric": "cosine",
    "dimension": 1536,
    "status": {
        "ready": true,
        "state": "Ready"
    },
    "host": "example-index1-4zo0ijk.svc.dev-us-west2-aws.pinecone.io",
    "spec": {
        "serverless": {
            "region": "us-east-1",
            "cloud": "aws"
        },
    "tags": {
            "example": "tag",
            "environment": "production"
        }
    },
    "deletion_protection": "disabled"
}

APIs

Database

Inference

SDKs

Architecture

Tools

Configure an index

Authorizations

Path Parameters

Body

Response