Describe an index
Get a description of an index.
The describe_index
operation uses a different API (api.pinecone.io
) than data plane operations such as upsert
and query
. In production, you should therefore not rely on describe_index
to programmatically get an index endpoint for data manipulation operations. Instead, you should get an index endpoint once and cache it for reuse or specify the endpoint directly.
Authorizations
An API Key is required to call Pinecone APIs. Get yours from the console.
Path Parameters
The name of the index to be described.
Response
The IndexModel describes the configuration and status of a Pinecone index.
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 '-'.
The dimensions of the vectors to be inserted in the index.
The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.
cosine
, euclidean
, dotproduct
The URL address where the index is hosted.
Whether deletion protection is enabled/disabled for the index.
disabled
, enabled
Was this page helpful?