For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CloudGitHub
  • API Reference
      • POSTSearch points
      • POSTSearch batch points
      • POSTSearch point groups
      • POSTRecommend points
      • POSTRecommend batch points
      • POSTRecommend point groups
      • POSTDiscover points
      • POSTDiscover batch points
      • POSTQuery points
      • POSTQuery points in batch
      • POSTQuery point groups
      • POSTDistance matrix pairs
      • POSTDistance matrix offsets
LogoLogo
CloudGitHub
API ReferenceSearch

Recommend batch points

Deprecated
POST
/collections/:collection_name/points/recommend/batch
POST
/collections/:collection_name/points/recommend/batch
$curl -X POST \
> 'http://localhost:6333/collections/collection_name/points/recommend/batch' \
> --header 'api-key: <api-key-value>' \
> --header 'Content-Type: application/json' \
> --data-raw '{
> "searches": [
> {
> "positive": [
> 100,
> 231
> ],
> "negative": [
> "9ad0884a-7bfe-43c0-b88f-c1d9a588b7e1"
> ],
> "limit": 1
> },
> {
> "positive": [
> 200,
> 67
> ],
> "negative": [
> 300
> ],
> "limit": 5
> }
> ]
>}'
200Successful
1{
2 "usage": {
3 "cpu": 1,
4 "payload_io_read": 1,
5 "payload_io_write": 1,
6 "payload_index_io_read": 1,
7 "payload_index_io_write": 1,
8 "vector_io_read": 1,
9 "vector_io_write": 1
10 },
11 "time": 0.002,
12 "status": "ok",
13 "result": [
14 [
15 {
16 "id": 42,
17 "version": 3,
18 "score": 0.75,
19 "payload": {},
20 "vector": {},
21 "shard_key": "region_1",
22 "order_value": 42
23 }
24 ]
25 ]
26}
Retrieves points in batches that are closer to stored positive examples and further from negative examples.
Was this page helpful?
Previous

Recommend point groups

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection to search in

Query parameters

consistencyinteger or enumOptional
Define read consistency guarantees for the operation
timeoutintegerOptional>=1
If set, overrides global timeout for this request. Unit is seconds.

Request

Request points based on positive and negative examples.
searcheslist of objectsRequired

Response

successful operation
usageobject or any
timedouble
Time spent to process this request
statusstring
resultlist of lists of objects