Describe an index

GET

indexes

{index_name}

# pip install pinecone[grpc]
from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

pc.describe_index(name="movie-recommendations")

{
  "dimension": 1536,
  "host": "movie-recommendations-c01b5b5.svc.us-east1-gcp.pinecone.io",
  "metric": "cosine",
  "name": "movie-recommendations",
  "spec": {
    "serverless": {
      "cloud": "aws",
      "region": "us-east-1"
    }
  },
  "status": {
    "ready": false,
    "state": "Initializing"
  }
}

# pip install pinecone[grpc]
from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

pc.describe_index(name="movie-recommendations")

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 be described.

Response

200

application/json

Configuration information and deployment status of the index.

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"

dimension

integer

required

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

Required range: 1 <= x <= 20000

Example:

1536

metric

enum<string>

default:cosine

required

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.

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"
}

deletion_protection

enum<string>

default:disabled

Whether deletion protection is enabled/disabled for the index.

Available options:

disabled,

enabled

Was this page helpful?

Create an index Delete an index

# pip install pinecone[grpc]
from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

pc.describe_index(name="movie-recommendations")

{
  "dimension": 1536,
  "host": "movie-recommendations-c01b5b5.svc.us-east1-gcp.pinecone.io",
  "metric": "cosine",
  "name": "movie-recommendations",
  "spec": {
    "serverless": {
      "cloud": "aws",
      "region": "us-east-1"
    }
  },
  "status": {
    "ready": false,
    "state": "Initializing"
  }
}

APIs

Database

SDKs

Architecture

Tools

Authorizations

Path Parameters

Response