master
Search...
/
Cloud
GitHub
API Reference
Collections
points
POST
Retrieve points
PUT
Upsert points
GET
Retrieve a point
POST
Delete points
PUT
Update vectors
POST
Delete vectors
POST
Set payload
PUT
Overwrite payload
POST
Delete payload
POST
Clear payload
POST
Batch update points
POST
Scroll points
POST
Count points
POST
Facet a payload key with a given filter.
POST
Search points matrix distance pairs
POST
Search points matrix distance offsets
Search
Indexes
Snapshots
Aliases
Distributed
Service
Beta
Cloud
GitHub
API Reference
points
Search points matrix distance offsets
POST
http://localhost:6333
/
collections
/
:collection_name
/
points
/
search
/
matrix
/
offsets
Retrieve distance matrix with an offset based output format
Path parameters
collection_name
string
Required
Name of the collection to search in
Query parameters
consistency
integer or enum
Optional
Define read consistency guarantees for the operation
Show 2 variants
timeout
integer
Optional
If set, overrides global timeout for this request. Unit is seconds.
Request
This endpoint expects an object.
sample
integer
Required
How many points to select and search within.
limit
integer
Required
How many neighbours per sample to find
shard_key
string or integer or list of strings or integers or any
Optional
Specify in which shards to look for the points, if not specified - look in all shards
Show 2 variants
filter
object or any
Optional
Look only for points which satisfies this conditions
Show 2 variants
using
string
Optional
Define which vector name to use for querying. If missing, the default vector is used.
Response
This endpoint returns an object.
time
double
Optional
Time spent to process this request
status
string
Optional
result
object
Optional
Show 4 properties
Built with