UiPath Documentation
document-understanding
latest
false
Document Understanding API guide
  • Getting Started
    • Overview
    • Limits and Quota
    • Migrating automations from Document Understanding API v1 to v2
  • Examples Using the Document Understanding™ Cloud API v1
  • Licensing
  • Troubleshooting

Use the Validation Service

Validation Service API usage for Document Understanding, including how to create validation tasks in Action Center using polling-based GET calls.

Document Understanding supports two approaches to human validation:

  • Validation Service — Creates a validation task directly in Action Center. Use this for standard validation flows managed within Action Center.
  • App Tasks — Prepares validation artifacts independently, then lets your application create a UiPath App Task for human validation. Use this when you need control over when, where, and with what user interface the validation task is presented. To use UiPath App Tasks, use the artifacts APIs described in Create artifacts for extraction validation.

Validation Service

Validate the data by using the documentId and the classifierId or the extractorId. By calling this API, a validation task is created in Action Center.

Each action requires one POST and multiple GET calls (due to polling), meaning that if you want to validate a classification result, then you need to do a POST and multiple GET calls. Same applies for validating an extraction result.

When a POST call is initiated you need to add the classificationResults / extractionResults previously received when calling the classifier/extractor in the Request body of the POST request.

Customize the validation experience

You can also pass a taxonomy as an input parameter to customize the validation experience. For example, you can change field hotkeys or the display color of fields.

Note:

Validation data is soft deleted after 30 days.

Note:

If you are using the validation APIs to validate the extraction or classification for generative models, make sure to also provide the prompts on the request.

  • Validation Service
  • Customize the validation experience

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated