Search API precision (beta)

Use the precision parameter of the search API to tune precision and recall for a query. Learn more in Precision tuning (beta).

The value of the precision parameter must be an integer between 1 and 11, inclusive. The range of values represents a sliding scale that manages the inherent tradeoff between precision and recall. Lower values favor recall, while higher values favor precision.

See Precision tuning values for a description of all possible values.

GET /api/as/v1/engines/{ENGINE_NAME}/search

{
  "query": "{STRING}",
  "precision": {INTEGER}
}

# 200 OK
{
  "meta" : {
    # ...
    "precision" : 3,
    # ...
  },
  "results" : [
    # ...
  ]
}

# 400 Bad Request
{
  "errors": [
    "Precision must be an integer between 1 and 11"
  ]
}