Sign in

Evaluate recall.

post/v1/namespaces/{namespace}/_debug/recall

Path parameters

namespacestring required

The name of the namespace.

Request body

numinteger

The number of searches to run.

top_kinteger

Search for top_k nearest neighbors.

{"stackTrail":"paths:/v1/namespaces/{namespace}/_debug/recall:post:requestBody:content:application/json:schema:properties:filters","oasType":"schema","type":"unknown","description":"Filter by attributes. Same syntax as the query endpoint.","extensionFields":{"x-stainless-any":true}}
queriesnumber[]

Use specific query vectors for the measurement. If omitted, sampled from the index.

include_ground_truthboolean

Include ground truth data (query vectors and true nearest neighbors) in the response.

Response

The status of the cache warm request.

avg_recallnumber required

The average recall of the queries.

avg_exhaustive_countnumber required

The average number of documents retrieved by the exhaustive searches.

avg_ann_countnumber required

The average number of documents retrieved by the approximate nearest neighbor searches.

Changes