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_sizeuintRequired

Maximum amount of points to return per group

limituintRequired

Maximum amount of groups to return

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

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 is false.

with_vectorboolean or list of strings or anyOptional

Options for specifying which vectors to include into response. Default is false.

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

successful operation

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

POST

1 curl  -X POST \
2   'http://localhost:6333/collections/collection_name/points/search/groups' \
3   --header 'api-key: <api-key-value>' \
4   --header 'Content-Type: application/json' \
5   --data-raw '{
6   "vector": [
7     0.2,
8     0.1,
9     0.9,
10     0.7
11   ],
12   "group_by": "document_id",
13   "limit": 4,
14   "group_size": 2
15 }'

200Successful

1 {
2   "time": 0.002,
3   "status": "ok",
4   "result": {
5     "groups": [
6       {
7         "hits": [
8           {
9             "id": 42,
10             "version": 3,
11             "score": 0.75,
12             "payload": {
13               "city": "London",
14               "color": "green"
15             },
16             "vector": [
17               0.875,
18               0.140625,
19               0.897599995136261
20             ],
21             "shard_key": "region_1",
22             "order_value": 42
23           }
24         ],
25         "id": "id",
26         "lookup": {
27           "id": 42,
28           "payload": {
29             "city": "London",
30             "color": "green"
31           },
32           "vector": [
33             0.875,
34             0.140625,
35             0.897599995136261
36           ],
37           "shard_key": "region_1",
38           "order_value": 42
39         }
40       }
41     ]
42   }
43 }

Recommend points

Up Next

Built with

1	curl -X POST \
2	'http://localhost:6333/collections/collection_name/points/search/groups' \
3	--header 'api-key: <api-key-value>' \
4	--header 'Content-Type: application/json' \
5	--data-raw '{
6	"vector": [
7	0.2,
8	0.1,
9	0.9,
10	0.7
11	],
12	"group_by": "document_id",
13	"limit": 4,
14	"group_size": 2
15	}'

1	{
2	"time": 0.002,
3	"status": "ok",
4	"result": {
5	"groups": [
6	{
7	"hits": [
8	{
9	"id": 42,
10	"version": 3,
11	"score": 0.75,
12	"payload": {
13	"city": "London",
14	"color": "green"
15	},
16	"vector": [
17	0.875,
18	0.140625,
19	0.897599995136261
20	],
21	"shard_key": "region_1",
22	"order_value": 42
23	}
24	],
25	"id": "id",
26	"lookup": {
27	"id": 42,
28	"payload": {
29	"city": "London",
30	"color": "green"
31	},
32	"vector": [
33	0.875,
34	0.140625,
35	0.897599995136261
36	],
37	"shard_key": "region_1",
38	"order_value": 42
39	}
40	}
41	]
42	}
43	}