Search Points
Retrieve the closest points based on vector similarity and optional filtering conditions.Name of the collection to search in
Read consistency level:
majority, quorum, or allRequest timeout in seconds
Vector to search for. Can be a dense vector array, sparse vector, or named vector.
Maximum number of results to return. Default is 10.
Offset for pagination. Default is 0.
Only return results with a score above this threshold
Whether to return payload. Can be
true, false, array of field names, or include/exclude object.Whether to return vectors. Can be
true, false, or array of vector names.Batch Search
Perform multiple search queries in a single request for better performance.Name of the collection to search in
Read consistency level
Request timeout in seconds
Array of search requests. Each search has the same parameters as the single search endpoint.
Array of result arrays, one for each search query
Search Groups
Search for points grouped by a specific payload field.Name of the collection to search in
Read consistency level
Request timeout in seconds
Vector to search for
Payload field to group results by
Maximum number of groups to return
Maximum number of points per group
Filter conditions
Whether to return payload
Whether to return vectors
Join payload from another collection
Recommend Points
Get recommendations based on positive and negative example points.Name of the collection
Read consistency level
Request timeout in seconds
Array of point IDs or vectors to use as positive examples
Array of point IDs or vectors to use as negative examples
Maximum number of results to return
Offset for pagination
Filter conditions
Vector name to use for recommendation (for named vectors)
Lookup positive/negative examples from another collection
Minimum score threshold
Whether to return payload
Whether to return vectors
Array of scored points with id, score, payload, and vector
Recommend Batch
Perform multiple recommendation queries in a single request.Name of the collection
Read consistency level
Request timeout in seconds
Array of recommendation requests
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.Name of the collection
Read consistency level
Request timeout in seconds
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
Maximum number of results
Offset for pagination
Filter conditions
Minimum score threshold
Whether to return payload
Whether to return vectors
Query Batch
Perform multiple query operations in a single request.Name of the collection
Read consistency level
Request timeout in seconds
Array of query requests
Array of query results
Query Groups
Perform query operations with results grouped by a payload field.Name of the collection
Read consistency level
Request timeout in seconds
Query specification (same as query points)
Payload field to group by
Maximum number of groups
Maximum points per group
Filter conditions
Whether to return payload
Whether to return vectors
Search Matrix (Pairs)
Compute similarity scores between all pairs of points.Name of the collection
Number of points to sample for matrix computation
Number of neighbors per point
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.Name of the collection to count in
Read consistency level:
majority, quorum, or allRequest timeout in seconds
Filter conditions to apply. Only points matching this filter will be counted.
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.Name of the collection to facet in
Read consistency level:
majority, quorum, or allRequest timeout in seconds
Payload key to facet by
Maximum number of unique values to return. Default is 10.
Filter conditions to apply before faceting
If true, provide exact counts. If false, may use approximations for better performance.
Discover Points
Look for points that satisfy context pairs (positive/negative examples) and optionally approach a target.Name of the collection to search in
Read consistency level:
majority, quorum, or allRequest timeout in seconds
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.Optional target vector to approach. Can be a dense vector or named vector.
Maximum number of results to return. Default is 10.
Filter conditions to apply
Whether to return payload
Whether to return vectors