Upstash Documentation

Index Info

Returns some information about the index.
2 min read
gethttps://{endpoint}/info
gethttps://{endpoint}/info

Info will be updated eventually, so it might take some time to see the effect of changes in this endpoint.

Request#

This request doesn't require any additional data.

Response#

vectorCountnumberrequired#

The number of vectors in the index, that are ready to use. This is the total number of vectors across all namespaces.

pendingVectorCountnumberrequired#

The number of vectors in the index, that are still processing and not ready to use. This is the total number of pending vectors across all namespaces.

indexSizenumberrequired#

The total size of the index, in bytes.

dimensionnumberrequired#

Dimension of the vectors.

similarityFunctionstringrequired#

Name of the similarity function used in indexing and queries.

indexTypestringrequired#

Type of the index. Possible values: "DENSE", "SPARSE", "HYBRID"

denseIndexobject#

Information about the dense vector index configuration.

Show properties
dimensionnumberrequired#

Dimension of the dense vectors.

similarityFunctionstringrequired#

Similarity function used for dense vector comparisons. Possible values: "COSINE", "EUCLIDEAN", "DOT_PRODUCT"

embeddingModelstringrequired#

Name of the embedding model used for dense vectors.

sparseIndexobject#

Information about the sparse vector index configuration.

Show properties
embeddingModelstringrequired#

Name of the embedding model used for sparse vectors.

namespacesobjectrequired#

Map of namespace names to namespace .

Note
Every index has at least one namespace called default namespace, whose name is the empty string "".
Show properties
vectorCountnumberrequired#

The number of vectors in the namespace, that are ready to use.

pendingVectorCountnumberrequired#

The number of vectors in the namespace, that are still processing and not ready to use.

Reset Namespace(s)List Namespaces