Start with install notes or jump straight into the API.

API

Result Count

Result count answers “how many rows match this ranked query?” It is separate from scan count, which counts rows matching a filter.

POST /v2/namespaces/products/result-count
Content-Type: application/json

{
  "query": {"field": "title", "fts": "wireless headphones"},
  "filters": ["category", "Eq", "Electronics"],
  "mode": "bounded",
  "timeout_seconds": 30
}
{
  "count": 4210,
  "bounded": false,
  "timed_out": false,
  "shards_saturated": 0,
  "shards_total": 1,
  "elapsed_ms": 42
}
ShapeRequired fieldsNotes
FTSfield, ftsBM25 query against a BM25-indexed field.
Vectorvector, max_distancemax_distance is required; without an upper bound every row matches. field defaults to vector.
ModeBehavior
boundedOne scatter/gather. Saturated shards contribute their top_k as a lower bound.
exhaustiveRecurses through saturated shards until every page is short or the request deadline expires.

Every call carries a deadline, default 30s and server-side max 300s. On timeout the partial count is returned with bounded: true and timed_out: true.