Describe an index

Get a description of an index.

Python

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

pc = Pinecone(api_key="YOUR_API_KEY")

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

Python

{'dimension': 1536,
  'host': 'example-index-4mkljsz.svc.aped-4627-b74a.pinecone.io',
  'metric': 'cosine',
  'name': 'docs-example',
  'spec': {'serverless': {'cloud': 'aws', 'region': 'us-east-1'}},
  'status': {'ready': True, 'state': 'Ready'}}

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

Show child attributes

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

Show child attributes

Example:

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

deletion_protection · enum<string> · default: disabled

Whether deletion protection is enabled/disabled for the index.

Available options:

disabled,

enabled

tags · object

Custom user tags added to an index. Keys must be 80 characters or less. Values must be 120 characters or less. Keys must be alphanumeric, '', or '-'. Values must be alphanumeric, ';', '@', '', '-', '.', '+', or ' '. To unset a key, set the value to be an empty string.

Show child attributes

Example:

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