Get index stats
The describe_index_stats operation returns statistics about the contents of an index, including the vector count per namespace, the number of dimensions, and the index fullness.
Serverless indexes scale automatically as needed, so index fullness is relevant only for pod-based indexes.
For pod-based indexes, the index fullness result may be inaccurate during pod resizing; to get the status of a pod resizing process, use describe_index.
Authorizations
An API Key is required to call Pinecone APIs. Get yours from the console.
Body
The request for the describe_index_stats operation.
If this parameter is present, the operation only returns statistics for vectors that satisfy the filter. See Filter with metadata.
Serverless indexes do not support filtering describe_index_stats by metadata.
Response
The response for the describe_index_stats operation.
A mapping for each namespace in the index from the namespace name to a summary of its contents. If a metadata filter expression is present, the summary will reflect only vectors matching that expression.
The dimension of the indexed vectors.
The fullness of the index, regardless of whether a metadata filter expression was passed. The granularity of this metric is 10%.
Serverless indexes scale automatically as needed, so index fullness is relevant only for pod-based indexes.
The index fullness result may be inaccurate during pod resizing; to get the status of a pod resizing process, use describe_index.
The total number of vectors in the index, regardless of whether a metadata filter expression was passed
Was this page helpful?