🎓 Instructor-Led Training
To be done with the Instructor in ILT (Instructor-Led Training). Follow along during your live session.
📎 Exercise files
Download the sample paystub documents needed for this practical exercise:
Download samples_paystubfiles.zip
🎬 Video Reference
Watch the full walkthrough on YouTube: Generative Extraction in IXP — Practical Demo →
📥 Prefer a written copy?
If you'd rather follow along on paper (or reference it later without rewatching the video), download the written step-by-step guide:
Download step-by-step guide (.pdf)

Building the Generative Extraction Project

Building a Generative Extraction project follows the same Build → Measure → Publish lifecycle as Modern DU projects, but uses generative AI prompts instead of annotated ML training.

Step 1: Create a New Generative Extraction Project

  1. Log into cloud.uipath.com and navigate to the Generative Extraction service
  2. Click New Project — choose Blank Project or a Template
  3. Give the project a name (e.g., Paystubs Extraction) and description
  4. Projects can only be created by an IXP Service Admin

Step 2: Upload Sample Documents

  • Upload a representative sample of documents covering all layout variations
  • Supported formats: PDF, PNG, JPG/JPEG, TIF/TIFF
  • You can filter documents by annotated/unannotated status and search by document name
  • No minimum number of documents required to start — predictions appear immediately

Step 3: Define the Extraction Schema (Taxonomy)

  1. Go to Manage Taxonomy
  2. Write a project-level instruction — describe the document type and industry context
  3. Click New Field Group — give it a name and instruction (e.g., "Employee Information")
  4. Add individual Fields within each group — specify name, data type, and instruction
  5. For hierarchical data, use > in field group names (e.g., Paystub > Deductions)
💡 Tip
Configure your extraction schema upfront before reviewing predictions — this allows you to immediately assess AI-generated output across all your fields.

Step 4: Review and Validate Predictions

  1. Once schema is defined, the AI immediately generates predictions for all uploaded documents
  2. Review each document — check if predictions are correct
  3. Modify prompt instructions and observe the impact on prediction quality
  4. Accept correct predictions or correct wrong ones to build ground truth
  5. Validated documents become the basis for performance evaluation in the Measure phase
📖 Official Documentation
For the full Build phase reference, see: Overview – Build · IXP User Guide →

Evaluating the Project (Measure Phase)

The Measure phase evaluates how well your model is performing before you deploy it to production. It uses your validated annotations as the ground truth.

Key Performance Metrics

  • Project Score — overall model performance across all fields
  • Precision — of all values the model extracted, how many were correct
  • Recall — of all values that should have been extracted, how many did the model find
  • F1 Score — harmonic mean of precision and recall; best single measure of performance
  • Per-field performance — identify which specific fields need improvement
Project Performance gauge showing a score of 99 (Excellent), model configuration GPT-Vision, and the Poor/Average/Good/Excellent score ranges

Project score — calculated based on the average field F1 score

Comparing Model Versions

Every time you change the extraction schema or validate more documents, Generative Extraction creates a new model version. In the Measure phase you can:

  • Compare model versions side by side
  • See field-level performance differences between versions
  • Identify which fields need more annotation or better prompt instructions
  • Decide which version is best suited for production deployment
Project summary in Measure tab

Measure tab — project summary with version selection and high-level metrics

How to Improve Performance

  • Refine field instructions — be more specific about expected format and edge cases
  • Add more validated annotation examples (few-shot)
  • Review low-scoring fields and adjust prompt wording
  • Ensure the project-level instruction accurately describes the document type
  • Annotate more diverse document samples to cover edge cases
Field performance table in Measure showing precision, recall and F1 per field

Field performance table — precision, recall and F1 score per field

Field performance table before and after applying a quick filter

Quick filter — narrow down fields to identify underperforming areas

💡 Tip
Performance Benchmarks: There is no universal threshold — align targets with business requirements. For high-stakes use cases (legal, financial), aim for 90%+ F1. For lower-stakes automation with human-in-the-loop, 75–80% may be acceptable.
📖 Official Documentation
For the full Validation reference, see: Overview – Validation · IXP User Guide →

Consuming the Generative Extraction Project in Studio

Once your model meets performance criteria, publish it and integrate it into a UiPath Studio workflow.

Step 1: Publish the Model

  1. Go to the Publish tab in your Generative Extraction project
  2. Select the model version to deploy (based on your Measure results)
  3. Add deployment tags to identify the version (e.g., v1.0-production)
  4. Click Publish — the model becomes available as an API endpoint
  5. Copy the project ID / endpoint details for use in Studio
  6. To roll back, simply publish a previous model version

Step 2: Integrate in Studio Workflow

  1. Install UiPath.DocumentUnderstanding.Activities package in Studio
  2. Add a Document Understanding Scope activity and connect to your Generative Extraction project
  3. Add Extract Document Data — pass the file path of each document
  4. Access extracted fields from the returned DocumentData object
  5. Add Present Validation Station for human-in-the-loop review if confidence is below threshold
  6. Export validated results to Excel, database, or downstream system

Supported Document Limits

ParameterLimit
Maximum document length150 pages (use DU with RAG for longer documents)
Supported file formatsPDF, PNG, JPG/JPEG, TIF/TIFF
AI infrastructureSpecialized UiPath models + Azure OpenAI LLMs (data residency maintained per region)
📌 Note
Model Governance: Generative Extraction maintains full version history. You can roll back to any previous version if a newer model underperforms in production. Always test new versions on a representative validation set before replacing production.