GET /fields/{field_id}/accuracy

Retrieve the accuracy of a field. This allows you to review the precision, recall and f-score of a field once it has been trained.

Precision measures the extent to which only relevant results are found; irrelevant results hurt precision. Effectively, precision shows how many hits are junk out of the total number returned.

Recall measures the extent to which relevant results are found. For example, in a set of documents with 50 assignment provisions, if a search system found 48 of the 50, recall would be 96%.

F-Score measures of the model’s overall accuracy, by showing the harmonic mean of precision and recall.

Headers

Authorization (required) - Requires the standard authentication header used in the system.

Parameters

  • field_id Path Required

    the field identifier for the accuracy to be retrieved.

Code Sample
curl -X GET -H "Accept: application/json"  
-H "Authorization: Bearer <token>"
-H "Content-Type: application/json"
-d "{}" https://<base_url>/api/v2/fields/<field_id>/accuracy
accuracy = zdai.fields.get_accuracy(field_id=‘fieldID’)
Response Codes
  • 200 OK
    Request was successful.
  • 403 Forbidden
    Invalid or missing authentication token.
  • 404 Not Found
    The field_id does not exist or has been cleaned up.
  • 500 Internal Server Error
    Something went wrong unrelated to the users request.

Response Data

  • precision

    the extent to which only relevant results are found

  • recall

    the extent to which relevant results are found.

  • f-score

    the harmonic mean of precision and recall.

Response
{
    "f_score": 0.95,
    "precision": 0.9,
    "recall": 1
}

Need Help?

Couldn’t find the information you were looking for or need more assistance?

Contact Support