DescribeIndexStats
Warning: The legacy version of the API, which requires regional URLs for control plane operations, is deprecated as of April 15, 2024 and will be removed in a future, to be announced, release. For more information, see Migrate to the new API.
The DescribeIndexStats
operation returns statistics about the index’s contents, including the vector count per namespace and the number of dimensions.
Authorizations
An API Key is required to call Pinecone APIs. Get yours at https://app.pinecone.io/.
Body
If this parameter is present, the operation only returns statistics for vectors that satisfy the filter. See https://www.pinecone.io/docs/metadata-filtering/.
Response
A mapping for each <a href='https://docs.pinecone.io/docs/namespaces'>namespace</a> 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%.
The total number of vectors in the index, regardless of whether a metadata filter expression was passed
Was this page helpful?