Skip to main content

Documentation Index

Fetch the complete documentation index at: https://upstash.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Used to retrieve the stats of an index.

​
Response

​
vectorCount
number
required
The total number of vectors in the index, that are ready to use.
​
pendingVectorCount
number
required
The number of vectors in the index, that is still processing and not ready to use.
​
indexSize
number
required
The size of the index, in b.
​
dimension
number
required
Dimension of the vectors.
​
similarityFunction
string
required
Name of the similarity function used in indexing and queries.
​
namespaces
Record<string, Object>
required
A map of namespaces to their information in the following format
const infoResponse = await index.info();
/*
{ 
  vectorCount: 17,
  pendingVectorCount: 0,
  indexSize: 551158,
  dimension: 1536,
  similarityFunction: "COSINE",
  namespaces: {
    "": { // default namespace
      vectorCount: 10,
      pendingVectorCount: 0,
    },
    "my-namespace": {
      vectorCount: 7,
      pendingVectorCount: 0,
    }
  }
}
*/