ZUzuva
Fields

Get field validation details

Changed on

Returns the details (file ID, type, location) of each extraction used for validation during training of the field.

Possible values of type are:

  • tp: True Positive - an annotation added by the user that the AI agrees with.

  • fn: False Negative - an annotation added by the user that the AI disagrees with.

  • fp: False Positive - an annotation that the user did not add, but that the AI suggests they add to training.

  • na: Not Applicable - an annotation that was not used for validation, either because it was part of the initial training batch, or because the file was a duplicate of a file that was already trained on.

If the example type is tp or fp, the location refers to the text found by the ML. If the example type is fn or na, the location refers to the original user highlight that was missed.

get/fields/{field_id}/validation-details

Request

Path parameters

field_idstring required

Field ID

Response

The field's validation details

file_idstring required
locationinteger[] required

The start and end character locations of the extraction.

type'tp' | 'fn' | 'fp' | 'na' required

Example response

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

Changes