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

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.
limit
integerRequired
Max number of result to return
shard_key
unionOptional
Specify in which shards to look for the points, if not specified - look in all shards
positive
list of unionsOptional
Look for vectors closest to those
negative
list of unionsOptional
Try to avoid vectors like this
strategy
unionOptional
How to use positive and negative examples to find the results
filter
unionOptional
Look only for points which satisfies this conditions
params
unionOptional
Additional search params
offset
integerOptional
Offset of the first result to return. May be used to paginate results. Note: large offset values may cause performance issues.
with_payload
unionOptional
Select which payload to return with the response. Default: None
with_vector
unionOptional
Whether to return the point vector with the result?
score_threshold
doubleOptional
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.
using
unionOptional
Define which vector to use for recommendation, if not specified - try to use default vector
lookup_from
unionOptional
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

This endpoint returns an object
time
doubleOptional
Time spent to process this request
status
stringOptional
result
list of objectsOptional
Search result