Search batch points

POST

Retrieves the closest points in batches based on vector similarity and given filtering conditions.

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.

searcheslist of objectsRequired

Response

successful operation

timedoubleOptional

Time spent to process this request

statusstringOptional

resultlist of lists of objectsOptional

POST

1 curl  -X POST \
2   'http://localhost:6333/collections/collection_name/points/search/batch' \
3   --header 'api-key: <api-key-value>' \
4   --header 'Content-Type: application/json' \
5   --data-raw '{
6   "searches": [
7     {
8       "vector": [
9         0.2,
10         0.1,
11         0.9,
12         0.7
13       ],
14       "limit": 3
15     },
16     {
17       "vector": [
18         0.5,
19         0.3,
20         0.2,
21         0.3
22       ],
23       "filter": {
24         "must": [
25           {
26             "key": "city",
27             "match": {
28               "value": "London"
29             }
30           }
31         ]
32       },
33       "limit": 3
34     }
35   ]
36 }'

200Successful

1 {
2   "time": 0.002,
3   "status": "ok",
4   "result": [
5     [
6       {
7         "id": 42,
8         "version": 3,
9         "score": 0.75,
10         "payload": {
11           "city": "London",
12           "color": "green"
13         },
14         "vector": [
15           0.875,
16           0.140625,
17           0.897599995136261
18         ],
19         "shard_key": "region_1",
20         "order_value": 42
21       }
22     ]
23   ]
24 }

Search point groups

Up Next

Built with

1	curl -X POST \
2	'http://localhost:6333/collections/collection_name/points/search/batch' \
3	--header 'api-key: <api-key-value>' \
4	--header 'Content-Type: application/json' \
5	--data-raw '{
6	"searches": [
7	{
8	"vector": [
9	0.2,
10	0.1,
11	0.9,
12	0.7
13	],
14	"limit": 3
15	},
16	{
17	"vector": [
18	0.5,
19	0.3,
20	0.2,
21	0.3
22	],
23	"filter": {
24	"must": [
25	{
26	"key": "city",
27	"match": {
28	"value": "London"
29	}
30	}
31	]
32	},
33	"limit": 3
34	}
35	]
36	}'

1	{
2	"time": 0.002,
3	"status": "ok",
4	"result": [
5	[
6	{
7	"id": 42,
8	"version": 3,
9	"score": 0.75,
10	"payload": {
11	"city": "London",
12	"color": "green"
13	},
14	"vector": [
15	0.875,
16	0.140625,
17	0.897599995136261
18	],
19	"shard_key": "region_1",
20	"order_value": 42
21	}
22	]
23	]
24	}