Query points in batch

POST

Universally query points in batch. This endpoint covers all capabilities of search, recommend, discover, filters. But also enables hybrid and multi-stage queries.

Path parameters

collection_namestringRequired

Name of the collection to query

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

This endpoint returns an object.

usageobject or anyOptional

timedoubleOptional

Time spent to process this request

statusstringOptional

resultlist of objectsOptional

POST

1 curl  -X POST \
2   'http://localhost:6333/collections/collection_name/points/query/batch' \
3   --header 'api-key: <api-key-value>' \
4   --header 'Content-Type: application/json' \
5   --data-raw '{
6   "searches": [
7     {
8       "query": [
9         0.23,
10         0.325,
11         0.623
12       ],
13       "limit": 1
14     },
15     {
16       "query": [
17         0.423,
18         0.23,
19         0.623
20       ],
21       "limit": 5,
22       "using": "image-vector"
23     }
24   ]
25 }'

200Successful

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

Query point groups

Up Next

Built with

1	curl -X POST \
2	'http://localhost:6333/collections/collection_name/points/query/batch' \
3	--header 'api-key: <api-key-value>' \
4	--header 'Content-Type: application/json' \
5	--data-raw '{
6	"searches": [
7	{
8	"query": [
9	0.23,
10	0.325,
11	0.623
12	],
13	"limit": 1
14	},
15	{
16	"query": [
17	0.423,
18	0.23,
19	0.623
20	],
21	"limit": 5,
22	"using": "image-vector"
23	}
24	]
25	}'

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