For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CloudGitHub
  • API Reference
      • POSTSearch points
      • POSTSearch batch points
      • POSTSearch point groups
      • POSTRecommend points
      • POSTRecommend batch points
      • POSTRecommend point groups
      • POSTDiscover points
      • POSTDiscover batch points
      • POSTQuery points
      • POSTQuery points in batch
      • POSTQuery point groups
      • POSTDistance matrix pairs
      • POSTDistance matrix offsets
LogoLogo
CloudGitHub
API ReferenceSearch

Distance matrix offsets

POST
/collections/:collection_name/points/search/matrix/offsets
POST
/collections/:collection_name/points/search/matrix/offsets
$curl -X POST http://localhost:6333/collections/collection_name/points/search/matrix/offsets \
>     -H "api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
200Successful
1{
2  "usage": {
3    "cpu": 1,
4    "payload_io_read": 1,
5    "payload_io_write": 1,
6    "payload_index_io_read": 1,
7    "payload_index_io_write": 1,
8    "vector_io_read": 1,
9    "vector_io_write": 1
10  },
11  "time": 0.002,
12  "status": "ok",
13  "result": {
14    "offsets_row": [
15      1
16    ],
17    "offsets_col": [
18      1
19    ],
20    "scores": [
21      1.1
22    ],
23    "ids": [
24      42
25    ]
26  }
27}
Retrieves sparse matrix of pairwise distances between points sampled from the collection. Output is a form of row and column offsets and list of distances.
Was this page helpful?
Previous

Create payload index

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection to search in

Query parameters

consistencyinteger or enumOptional
Define read consistency guarantees for the operation
timeoutintegerOptional>=1
If set, overrides global timeout for this request. Unit is seconds.

Request

Search matrix request with optional filtering
shard_keystring or uint64 or list of strings or uint64s or anyOptional

Specify in which shards to look for the points, if not specified - look in all shards

filterobject or anyOptional
Look only for points which satisfies this conditions
sampleinteger or nullOptional>=2
How many points to select and search within. Default is 10.
limitinteger or nullOptional>=1
How many neighbours per sample to find. Default is 3.
usingstring or nullOptional
Define which vector name to use for querying. If missing, the default vector is used.

Response

successful operation
usageobject or any
timedouble
Time spent to process this request
statusstring
resultobject