RERANK.STATS
RERANK.STATS namespace
- Group
- Keyed caches
- Complexity
- O(1)
- Arity
- 2 (exactly, counting the command name)
- Flags
- read-only, fast
- Keys
- first 1, last 1, step 1
- HotKV Cloud
- Performance and Scale
- On-Premise
- requires the rerank-cache license feature
The rerank cache stores cross-encoder rerank scores for a query and document pair in a retrieval pipeline, so a repeated pair does not have to be scored again. RERANK.STATS reports counters for one namespace. For a
namespace that does not exist, every counter is zero.
Return value
Section titled “Return value”The reply is a flat array of alternating field names and values in both RESP2 and RESP3 (it is not sent as a RESP3 map). The fields, in order:
| Field | Type | Meaning |
|---|---|---|
entries |
Integer | Entries currently stored. |
hits |
Integer | Lookups that found a live entry. |
misses |
Integer | Lookups that found nothing or an expired entry. |
evictions |
Integer | Entries removed to make room or because they expired. |
memory_bytes |
Integer | Approximate memory used by the entries. |
usage_saved_requests |
Integer | Hits on entries that carried usage options. |
usage_saved_input_tokens |
Integer | Input tokens those hits did not have to spend. |
usage_saved_output_tokens |
Integer | Output tokens those hits did not have to spend. |
usage_saved_cache_read_tokens |
Integer | Provider cache-read tokens saved. |
usage_saved_cache_write_tokens |
Integer | Provider cache-write tokens saved (5-minute and 1-hour combined). |
usage_saved_cost_usd |
Bulk string | Cost saved in US dollars with six decimals, for priced models only. |
The usage_saved_* fields only grow for entries stored with the usage
options of RERANK.SET.
Errors:
ERR wrong number of arguments for 'rerank.stats' commandif the argument count is wrong.NOLICENSE rerank-cache requires a HotKV license. Contact sales@hotkv.comif your license does not include thererank-cachefeature.
Examples
Section titled “Examples”127.0.0.1:6379> RERANK.STATS rerank_scores 1) "entries" 2) (integer) 2 3) "hits" 4) (integer) 5 5) "misses" 6) (integer) 1 7) "evictions" 8) (integer) 0 9) "memory_bytes"10) (integer) 19011) "usage_saved_requests"12) (integer) 013) "usage_saved_input_tokens"14) (integer) 015) "usage_saved_output_tokens"16) (integer) 017) "usage_saved_cache_read_tokens"18) (integer) 019) "usage_saved_cache_write_tokens"20) (integer) 021) "usage_saved_cost_usd"22) "0.000000"The memory figure depends on your data.
Compatibility
Section titled “Compatibility”HotKV-only command. Redis and Valkey have no equivalent.
See also
Section titled “See also”RERANK.CREATE, RERANK.SET, RERANK.GET, RERANK.DEL, RERANK.FLUSH, RERANK.DROP, RERANK.LIST, AI features guide
Was this page helpful?
Thanks for the feedback.