Skip to content

v1.13.1: Update /stats with rawDocumentDbSize and avgDocumentDbSize #3266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 3, 2025
Merged

v1.13.1: Update /stats with rawDocumentDbSize and avgDocumentDbSize #3266

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
149b419
add new document size fields to `/stats` response
guimachiavelli May 21, 2025
e7d1bfe
wording adjustment
guimachiavelli May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions reference/api/stats.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ The `/stats` route gives extended information and metrics about indexes and the
"numberOfDocuments": 19654,
"numberOfEmbeddedDocuments": 1,
"numberOfEmbeddings": 1,
"rawDocumentDbSize": 5320,
"avgDocumentSize": 92,
"isIndexing": false,
"fieldDistribution": {
"poster": 19654,
Expand All @@ -36,6 +38,8 @@ The `/stats` route gives extended information and metrics about indexes and the
"numberOfDocuments": 5,
"numberOfEmbeddedDocuments": 5,
"numberOfEmbeddings": 10,
"rawDocumentDbSize": 8780,
"avgDocumentSize": 422,
"isIndexing": false,
"fieldDistribution": {
"id": 5,
Expand All @@ -58,6 +62,8 @@ The `/stats` route gives extended information and metrics about indexes and the
| **`numberOfDocuments`** | Integer | Total number of documents in an index |
| **`numberOfEmbeddedDocuments`** | Integer | Total number of documents with at least one embedding |
| **`numberOfEmbeddings`** | Integer | Total number of embeddings in an index |
| **`rawDocumentDbSize`** | Integer | Storage space claimed by all documents in the index in bytes |
| **`avgDocumentDbSize`** | Integer | Total size of the documents stored in an index divided by the number of documents in that same index |
| **`isIndexing`** | Boolean | If `true`, the index is still processing documents and attempts to search will result in undefined behavior |
| **`fieldDistribution`** | Object | Shows every field in the index along with the total number of documents containing that field in said index |

Expand Down Expand Up @@ -87,6 +93,8 @@ Get stats of all indexes.
"numberOfDocuments": 19654,
"numberOfEmbeddedDocuments": 1,
"numberOfEmbeddings": 1,
"rawDocumentDbSize": 2087,
"avgDocumentSize": 41,
"isIndexing": false,
"fieldDistribution": {
"poster": 19654,
Expand Down Expand Up @@ -136,6 +144,8 @@ Get stats of an index.
"numberOfDocuments": 19654,
"numberOfEmbeddedDocuments": 1,
"numberOfEmbeddings": 1,
"rawDocumentDbSize": 3618,
"avgDocumentSize": 104,
"isIndexing": false,
"fieldDistribution": {
"poster": 19654,
Expand Down