API Reference

Cloud GitHub

API Reference Search

Recommend points

POST

Retrieves points 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

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.

limitintegerRequired

Max number of result 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

positivelist of uint64s or strings or lists of doubles or objectsOptional

Look for vectors closest to those

negativelist of uint64s or strings or lists of doubles or objectsOptional

Try to avoid vectors like this

strategy"average_vector" or "best_score" or anyOptional

How to use positive and negative examples to find the results

filterobject or anyOptional

Look only for points which satisfies this conditions

paramsobject or anyOptional

Additional search params

offsetintegerOptional

Offset of the first result to return. May be used to paginate results. Note: large offset values may cause performance issues.

with_payloadboolean or list of strings or object or anyOptional

Select which payload to return with the response. Default: None

with_vectorboolean or list of strings or anyOptional

Whether to return the point vector with the result?

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.

usingstring or anyOptional

Define which vector to use for recommendation, if not specified - try to use default vector

lookup_fromobject or anyOptional

The location used to lookup vectors. If not specified - use current collection. Note: the other collection should have the same vector size as the current collection

Response

successful operation

timedoubleOptional

Time spent to process this request

statusstringOptional

resultlist of objectsOptional

POST

1 curl -X POST http://localhost:6333/collections/collection_name/points/recommend \
2      -H "api-key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "limit": 1
6 }'

200Successful

1 {
2   "time": 1.1,
3   "status": "status",
4   "result": [
5     {
6       "id": 1000000,
7       "version": 1000000,
8       "score": 1.1,
9       "payload": {
10         "key": "value"
11       },
12       "vector": [
13         1.1
14       ],
15       "shard_key": "shard_key"
16     }
17   ]
18 }

Recommend batch points

Up Next

Built with

1	curl -X POST http://localhost:6333/collections/collection_name/points/recommend \
2	-H "api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"limit": 1
6	}'

1	{
2	"time": 1.1,
3	"status": "status",
4	"result": [
5	{
6	"id": 1000000,
7	"version": 1000000,
8	"score": 1.1,
9	"payload": {
10	"key": "value"
11	},
12	"vector": [
13	1.1
14	],
15	"shard_key": "shard_key"
16	}
17	]
18	}