Skip to content

Commit 30dc06e

Browse files
v1.13.1: Update /stats with rawDocumentDbSize and avgDocumentDbSize (#3266)
1 parent e5c5249 commit 30dc06e

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

reference/api/stats.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ The `/stats` route gives extended information and metrics about indexes and the
2323
"numberOfDocuments": 19654,
2424
"numberOfEmbeddedDocuments": 1,
2525
"numberOfEmbeddings": 1,
26+
"rawDocumentDbSize": 5320,
27+
"avgDocumentSize": 92,
2628
"isIndexing": false,
2729
"fieldDistribution": {
2830
"poster": 19654,
@@ -36,6 +38,8 @@ The `/stats` route gives extended information and metrics about indexes and the
3638
"numberOfDocuments": 5,
3739
"numberOfEmbeddedDocuments": 5,
3840
"numberOfEmbeddings": 10,
41+
"rawDocumentDbSize": 8780,
42+
"avgDocumentSize": 422,
3943
"isIndexing": false,
4044
"fieldDistribution": {
4145
"id": 5,
@@ -58,6 +62,8 @@ The `/stats` route gives extended information and metrics about indexes and the
5862
| **`numberOfDocuments`** | Integer | Total number of documents in an index |
5963
| **`numberOfEmbeddedDocuments`** | Integer | Total number of documents with at least one embedding |
6064
| **`numberOfEmbeddings`** | Integer | Total number of embeddings in an index |
65+
| **`rawDocumentDbSize`** | Integer | Storage space claimed by all documents in the index in bytes |
66+
| **`avgDocumentDbSize`** | Integer | Total size of the documents stored in an index divided by the number of documents in that same index |
6167
| **`isIndexing`** | Boolean | If `true`, the index is still processing documents and attempts to search will result in undefined behavior |
6268
| **`fieldDistribution`** | Object | Shows every field in the index along with the total number of documents containing that field in said index |
6369

@@ -87,6 +93,8 @@ Get stats of all indexes.
8793
"numberOfDocuments": 19654,
8894
"numberOfEmbeddedDocuments": 1,
8995
"numberOfEmbeddings": 1,
96+
"rawDocumentDbSize": 2087,
97+
"avgDocumentSize": 41,
9098
"isIndexing": false,
9199
"fieldDistribution": {
92100
"poster": 19654,
@@ -136,6 +144,8 @@ Get stats of an index.
136144
"numberOfDocuments": 19654,
137145
"numberOfEmbeddedDocuments": 1,
138146
"numberOfEmbeddings": 1,
147+
"rawDocumentDbSize": 3618,
148+
"avgDocumentSize": 104,
139149
"isIndexing": false,
140150
"fieldDistribution": {
141151
"poster": 19654,

0 commit comments

Comments
 (0)