Search point groups

POST
Retrieves the closest points based on vector similarity and given filtering conditions, grouped by a given payload field.

Path parameters

collection_namestringRequired
Name of the collection to search in

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.
vectorlist of doubles or objectRequired
Vector data separator for named and unnamed modes Unnamed mode: { "vector": [1.0, 2.0, 3.0] } or named mode: { "vector": { "vector": [1.0, 2.0, 3.0], "name": "image-embeddings" } }
group_bystringRequired
Payload field to group by, must be a string or number field. If the field contains more than 1 value, all values will be used for grouping. One point can be in multiple groups.
group_sizeintegerRequired
Maximum amount of points to return per group
limitintegerRequired
Maximum amount of groups to return
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
paramsobject or anyOptional
Additional search params
with_payloadboolean or list of strings or object or anyOptional
Select which payload to return with the response. Default: None
with_vectorboolean or list of strings or anyOptional
Whether to return the point vector with the result?
score_thresholddoubleOptional
Define a minimal score threshold for the result. If defined, less similar results will not be returned. Score of the returned result might be higher or smaller than the threshold depending on the Distance function used. E.g. for cosine similarity only higher scores will be returned.
with_lookupstring or object or anyOptional
Look for points in another collection using the group ids

Response

This endpoint returns an object.
timedoubleOptional
Time spent to process this request
statusstringOptional
resultobjectOptional
Built with