API ReferenceSearch

Distance matrix pairs

Retrieves sparse matrix of pairwise distances between points sampled from the collection. Output is a list of pairs of points and their distances.

Path parameters

collection_namestringRequired

Name of the collection to search in

Headers

api-keystringRequired

Query parameters

consistencyinteger or enumOptional

Define read consistency guarantees for the operation

timeoutintegerOptional

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

Request

This endpoint expects an object.
shard_keystring or integer or list of strings or integers 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

sampleintegerOptional>=2

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

limitintegerOptional>=1

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

usingstringOptional

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

Response

This endpoint returns an object.
usageobject or anyOptional
timedoubleOptional

Time spent to process this request

statusstringOptional
resultobjectOptional