---
title: "Get field validation details"
method: GET
path: "/fields/{field_id}/validation-details"
tags: ["Fields"]
---

# Get field validation details

`GET /fields/{field_id}/validation-details`

## Request

- Base URL: `https://us.app.zuva.ai/api/v2`
- URL: `https://us.app.zuva.ai/api/v2/fields/{field_id}/validation-details`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/zuva/apis/zuva-docai/docs/fields/:field_id/validation-details/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `field_id` string, required

## Response `200`

The field's validation details

- FieldValidationDetails[]
  - `file_id` string, required
  - `location` integer[], required: The start and end character locations of the extraction.
  - `type` 'tp' | 'fn' | 'fp' | 'na', required

## Other responses

- `400`: Invalid field ID
- `404`: Field not found.
- `409`: A training request is in progress for this field
- `500`: Internal Server Error

## Changes

- **2023-12-13** `51f2a4c5de2e`: 1 warning
  - added the new `na` enum value to the `items/type` response property for the response status `200`

[Operation history](https://skmtc.dev/zuva/apis/zuva-docai/changes/fields/:field_id/validation-details/get.md)

---

[API](https://skmtc.dev/zuva/apis/zuva-docai.md) - [All operations](https://skmtc.dev/zuva/apis/zuva-docai/llms.txt) - [OpenAPI document](https://skmtc.dev/zuva/apis/zuva-docai/revisions/7397ad071d55?raw)