Search

Recommend batch points

POST
Retrieves points in batches that are closer to stored positive examples and further from negative examples.

Path parameters

collection_namestringRequired
Name of the collection to search in

Query parameters

consistencyunionOptional
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.
searches
list of objectsRequired

Recommendation request. Provides positive and negative examples of the vectors, which can be ids of points that are already stored in the collection, raw vectors, or even ids and vectors combined.

Service should look for the points which are closer to positive examples and at the same time further to negative examples. The concrete way of how to compare negative and positive distances is up to the strategy chosen.

Response

This endpoint returns an object
time
doubleOptional
Time spent to process this request
status
stringOptional
result
list of lists of objectsOptional
Search result
POST
1curl -X POST http://localhost:6333/collections/collection_name/points/recommend/batch \
2     -H "api-key: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "searches": [
6    {
7      "limit": 1
8    }
9  ]
10}'
200Successful
1{
2  "time": 1.1,
3  "status": "status",
4  "result": [
5    [
6      {
7        "id": 1,
8        "version": 1,
9        "score": 1.1
10      }
11    ]
12  ]
13}
Built with