v3

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-3041516.4 KB

Search for nearest neighbors

Return the top k records for a query. Provide exactly one of vector (approximate nearest neighbor search) or bm25 (full-text BM25 search over a text field); the two are mutually exclusive. Optionally filter results by metadata attributes using a filter expression.

The nprobe parameter controls how many posting lists are searched for ANN queries. Higher values improve recall at the cost of latency.

The includeFields parameter controls which attributes are returned for each result. When omitted, all attributes are returned.

Supports both binary protobuf (application/protobuf) and ProtoJSON (application/protobuf+json) request bodies.

post/api/v1/vector/search

Response

Search results ranked by similarity.