Sign in

v17

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-05-2575397522.8 KB
Search

Search points matrix distance pairs

Compute distance matrix for sampled points with a pair based output format

post/collections/{collection_name}/points/search/matrix/pairs

Path parameters

collection_namestring required

Name of the collection to search in

Query parameters

integer
OR
'majority' | 'quorum' | 'all'

  • majority - send N/2+1 random request and return points, which present on all of them

  • quorum - send requests to all nodes and return points which present on majority of nodes

  • all - send requests to all nodes and return points which present on all nodes

Define read consistency guarantees for the operation

timeoutinteger

If set, overrides global timeout for this request. Unit is seconds.

Request body

sampleinteger nullable

How many points to select and search within. Default is 10.

limitinteger nullable

How many neighbours per sample to find. Default is 3.

usingstring nullable

Define which vector name to use for querying. If missing, the default vector is used.

Response

successful operation

timenumber float

Time spent to process this request

statusstring

Example response

{
  "time": 0.002,
  "status": "ok",
  "result": {
    "pairs": [
      {
        "a": 42,
        "b": 42
      }
    ]
  }
}