Search

Search points

POST
Retrieves the closest points based on vector similarity and given filtering conditions.

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.
vector
unionRequired
Vector data separator for named and unnamed modes Unnamed mode: { "vector": [1.0, 2.0, 3.0] } or named mode: { "vector": { "vector": [1.0, 2.0, 3.0], "name": "image-embeddings" } }
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
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 is false.
with_vector
unionOptional
Options for specifying which vectors to include into response. Default is false.
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.

Response

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