GET /fields/{field_id}/validation-details

Retrieve the validation details for a field. This allows you to review the validation details for every annotations in the files this field has been trained.

There are 3 validation types that can be returned:

  • True Positive (TP) is an annotation added by the user that the AI agrees with.
  • False Negative (FN) is an annotation added by the user that the AI disagrees with.
  • False Positive (FP) is an annotation that the user did not add, but that the AI suggests they add to training.

Headers

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

Parameters

  • field_id Path Required

    the field identifier for the validation details 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>/validation-details
validation_details = zdai.fields.get_validation_details(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

  • file_id

    the file identifier that was used for training.

  • type

    whether the annotation is a true positive (tp), false positive (fp) or false negative (fn).

  • location

    the start and end positions of the text used to train.

Response
[
    {
        "file_id": "c71pmdbo2ua691f0fkog",
        "type": "tp",
        "location": [
            26952,
            27310
        ]
    }
]

Need Help?

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

Contact us at support@zuva.ai