Search Points
Retrieve the closest points based on vector similarity and optional filtering conditions.string
required
Name of the collection to search in
string
Read consistency level:
majority, quorum, or allinteger
Request timeout in seconds
array | object
required
Vector to search for. Can be a dense vector array, sparse vector, or named vector.
integer
Maximum number of results to return. Default is 10.
integer
Offset for pagination. Default is 0.
object
object
float
Only return results with a score above this threshold
boolean | array | object
Whether to return payload. Can be
true, false, array of field names, or include/exclude object.boolean | array
Whether to return vectors. Can be
true, false, or array of vector names.array
Batch Search
Perform multiple search queries in a single request for better performance.string
required
Name of the collection to search in
string
Read consistency level
integer
Request timeout in seconds
array
required
Array of search requests. Each search has the same parameters as the single search endpoint.
array
Array of result arrays, one for each search query
Search Groups
Search for points grouped by a specific payload field.string
required
Name of the collection to search in
string
Read consistency level
integer
Request timeout in seconds
array | object
required
Vector to search for
string
required
Payload field to group results by
integer
required
Maximum number of groups to return
integer
required
Maximum number of points per group
object
Filter conditions
boolean | array | object
Whether to return payload
boolean | array
Whether to return vectors
object
Join payload from another collection
object
Recommend Points
Get recommendations based on positive and negative example points.string
required
Name of the collection
string
Read consistency level
integer
Request timeout in seconds
array
required
Array of point IDs or vectors to use as positive examples
array
Array of point IDs or vectors to use as negative examples
integer
Maximum number of results to return
integer
Offset for pagination
object
Filter conditions
string
Vector name to use for recommendation (for named vectors)
object
Lookup positive/negative examples from another collection
float
Minimum score threshold
boolean | array | object
Whether to return payload
boolean | array
Whether to return vectors
array
Array of scored points with id, score, payload, and vector
Recommend Batch
Perform multiple recommendation queries in a single request.string
required
Name of the collection
string
Read consistency level
integer
Request timeout in seconds
array
required
Array of recommendation requests
array
Array of result arrays, one for each recommendation query
Recommend Groups
Get recommendations grouped by a payload field.Query Points
Unified query API that supports multiple query types including nearest neighbors, discovery, and context-based search.string
required
Name of the collection
string
Read consistency level
integer
Request timeout in seconds
array | object
required
Query specification. Can be:
- Dense vector array for nearest neighbor search
- Object with
nearestfor vector search - Object with
recommendfor recommendation - Object with
discoverfor discovery search - Object with
contextfor context-based search - Object with
order_byfor payload-based ordering
integer
Maximum number of results
integer
Offset for pagination
object
Filter conditions
float
Minimum score threshold
boolean | array | object
Whether to return payload
boolean | array
Whether to return vectors
Query Batch
Perform multiple query operations in a single request.string
required
Name of the collection
string
Read consistency level
integer
Request timeout in seconds
array
required
Array of query requests
array
Array of query results
Query Groups
Perform query operations with results grouped by a payload field.string
required
Name of the collection
string
Read consistency level
integer
Request timeout in seconds
array | object
required
Query specification (same as query points)
string
required
Payload field to group by
integer
required
Maximum number of groups
integer
required
Maximum points per group
object
Filter conditions
boolean | array | object
Whether to return payload
boolean | array
Whether to return vectors
Search Matrix (Pairs)
Compute similarity scores between all pairs of points.string
required
Name of the collection
integer
Number of points to sample for matrix computation
integer
Number of neighbors per point
object
Filter to select points
Search Matrix (Offsets)
Compute similarity matrix in offset format.Count Points
Count points in a collection that match a given filter.string
required
Name of the collection to count in
string
Read consistency level:
majority, quorum, or allinteger
Request timeout in seconds
object
Filter conditions to apply. Only points matching this filter will be counted.
boolean
If true, provide exact count. If false, may provide approximate count for better performance.
Facet
Count points for each unique value of a payload key, optionally with filtering.string
required
Name of the collection to facet in
string
Read consistency level:
majority, quorum, or allinteger
Request timeout in seconds
string
required
Payload key to facet by
integer
Maximum number of unique values to return. Default is 10.
object
Filter conditions to apply before faceting
boolean
If true, provide exact counts. If false, may use approximations for better performance.
object
Discover Points
Look for points that satisfy context pairs (positive/negative examples) and optionally approach a target.string
required
Name of the collection to search in
string
Read consistency level:
majority, quorum, or allinteger
Request timeout in seconds
array
Array of positive-negative example pairs. Each pair consists of a
positive point ID and a negative point ID. Results will be points that are more similar to positives than negatives.array | object
Optional target vector to approach. Can be a dense vector or named vector.
integer
Maximum number of results to return. Default is 10.
object
Filter conditions to apply
boolean | array | object
Whether to return payload
boolean | array
Whether to return vectors
array