UiPath Documentation
ixp
latest
false
IXP in Flow user guide
  • Overview
  • Model building
    • Overview
    • Managing Extract nodes
    • Uploading sample documents​
    • Reviewing predictions
    • Validating predicted values
    • Model configuration
    • Bring your own subscription (BYOS)
  • Model evaluation
  • Model deployment
  • Consuming models
  • Developer
  • Frequently asked questions

Reviewing predictions

Review initial model predictions against your extraction schema to identify where prompt instructions need adjustment to improve IXP model performance in the Flow Extract node.

Overview​

The model uses generative AI to map fields and field groups defined in the extraction schema and predict them with confidence and accuracy. It extracts these fields and field groups and returns them in a structured JSON format, if they are present in the document.

Predictions are generated automatically the first time after you upload a document. Each time you change the taxonomy or switch the extraction model, select Refresh predictions in the annotation view to update the predictions.

Recommendations​

  1. Review the predictions on a sample of 2-3 documents.
  2. Decide if you need to modify your prompt instructions.
  3. Gradually increase the test sample to 10, 20, 30 documents, and so on. This will be an iterative process. You can decide how many documents to update, beyond the minimum of 10, based on your business acceptance criteria.

Viewing predictions​

To view the predictions for a document, proceed as follows:

  1. Hover over the Flow Extract node, and select Open full view.
  2. In the Dataset tab, open your document. Alternatively, after you upload your document, select Annotate document in the Definition tab.
  3. Review the predictions in the annotation panel.

Each time you change the taxonomy or switch the extraction model, select Refresh predictions to update the predictions.

Filtering annotations​

To filter annotations, proceed as follows:

  1. Hover over the Flow Extract node, and select Open full view.
  2. In the Dataset tab, open a document.
  3. In the annotation panel, select the Hide fields filter.
  4. Select the fields to hide:
    • Confirmed
    • Not extracted

Filtering documents​

To filter the documents list, proceed as follows:

  1. Hover over the Flow Extract node, and select Open full view.
  2. In the Dataset tab, open a document. The documents panel appears on the left.
  3. In the documents panel, select Filter documents, and filter by:
    • Annotation status - Not started, In progress, Annotated, or Annotated (Editing).
    • Predictions status - Up to date or Outdated.

Modifying instructions​

Once you review the out-of-the-box predictions, check where you need to modify the original prompt instructions to provide additional context for the model. The iterative refinement of instructions is essential to enhance the performance of the model.

You can't edit fields, field groups, or their instructions from the annotation panel. The annotation panel only lets you change, confirm, revert, or mark extracted values as missing.

Modifying the overall extraction instruction​

To modify the overall extraction instruction, proceed as follows:

  1. Hover over the Flow Extract node, and select Open full view.
  2. In the Definition tab, under Taxonomy, expand Overall extraction instructions.
  3. Modify your instruction in the text box.

Modifying field instructions​

To modify the prompt instructions of fields, proceed as follows:

  1. Hover over the Flow Extract node, and select Open full view.
  2. In the Definition tab, under Taxonomy, expand a field group.
  3. For a specific field, select its instruction in the Instructions column, and modify it directly in the table.

Modifying field group instructions​

To modify the prompt instructions of field groups, proceed as follows:

  1. Hover over the Flow Extract node, and select Open full view.
  2. In the Definition tab, under Taxonomy, select the instruction of a field group in the Instructions column.
  3. Modify the instruction directly in the table.

Using change history for fields and field groups​

The Change history feature allows you to review, compare, and restore previous versions of a field or field group. You can use it to safely iterate on names, field types, and instructions without reverting the entire project version.

To use the Change history feature, proceed as follows:

  1. Hover over the Flow Extract node, and select Open full view.

  2. In the Definition tab, under Taxonomy, select the ellipsis on a field group or field.

  3. Select View change history.

  4. In the window that appears, you can view all prior versions of the selected field or field group. For each version, the list shows the version number, its score, and when the version was created.

  5. Enable the option Compare with current to compare any past version with the current one. The feature displays the following details:

    • Field name
    • Field type
    • Instruction
    • Model configuration - Extraction model, Pre-processing, Execution mode, and Attribution.

    Use the version list to select any prior state and review how it differs from the current configuration.

  6. After you have compared the versions between them, select one of the following options:

    • Restore all - Restores the entire selected version, including name, field type, and instructions.
    • Restore instruction - Restores only the instructions from the selected version while keeping the current name and field type. The system applies the restored configuration immediately and records it as a new project version.
Warning:

Changing the field type on a field results in the loss of any existing annotations and discards the field version history. This action can only be undone by reverting to a previously deployed model version. Deploy the latest model version before making significant changes.

Reverting to previous instructions​

To revert to a previous instruction, proceed as follows:

  1. Hover over the Flow Extract node, and select Open full view.
  2. In the Definition tab, under Taxonomy, hover over your field or field group, select the ellipsis, and then View change history. In the window that appears, you can view all prior versions of the selected field or field group.
  3. Then, select the version that contains the instructions you want to restore.
  4. Enable the option Compare with current to compare any past version with the current one.
  5. Select Restore instruction to restore only the instructions from the selected version while keeping the current name and field type.

Checking new predictions​

To check new predictions, proceed as follows:

  1. Hover over the Flow Extract node, and select Open full view.
  2. In the Dataset tab, select Annotate, or the pencil icon, for your document.
  3. Select Refresh predictions.
  4. Review the new predictions in the annotation panel.

Missing field groups in predictions​

Extraction can occasionally return an empty field group for a document, while the same field group is extracted correctly from documents that look identical in the same project. This comes from variability in the underlying model rather than from the content or the structure of the document.

Detecting missed field groups​

To detect missed field groups, add the Missed predictions column to the field performance table of an evaluation run, as follows:

  1. Hover over the Flow Extract node, and select Open full view.
  2. In the Eval runs tab, select a row of an evaluation run.
  3. Select By field.
  4. Select Columns, and then, under Predictions and errors, select Missed predictions.

A high count for a field group indicates that entire groups are being missed, rather than individual values being extracted incorrectly. For more details, refer to Field performance table.

Getting new predictions​

After you change the taxonomy or switch the extraction model, select Refresh predictions in the annotation view to get new predictions. For more details, refer to Switching from one model to another.

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated