- Overview
- Model building
- Model validation
- Model deployment
- Consuming models
- Consuming models via a workflow
- Consuming models via Flow
- Consuming models via Document Understanding API
- Developer
- Frequently asked questions
Consuming models via Flow
Consume a deployed IXP Unstructured and Complex Documents model version in UiPath Maestro™ Flow through the Extract node.
The node sends a document to the model and returns the extracted fields for downstream nodes to use. For the full node reference, including the output structure and error handling, check Extract node in the Maestro user guide.
Prerequisites
Make sure you meet the following requirements:
- Your tenant has both the IXP and the Document Understanding services enabled.
- You have at least one of these:
- IXP Package Reader role in IXP, so that the To folder option is visible when you deploy. For more details, check Managing access.
- IXP Models - Create permission in Orchestrator in the folder where you deploy the model.
- You have access to the Orchestrator folder where the model is deployed.
- A model version is ready to be deployed using the To folder (preview) option. For more details, check Publishing model versions.
Consuming a deployed model in Flow
To consume a deployed model version in Flow, proceed as follows:
- In IXP, go to the Deploy tab and deploy your model version with the To folder (preview) option:
- Enable the Deploy IXP model option.
- Enter a Deployment name.
- From the Location dropdown list, select the Orchestrator folder.
- Select Deploy.
- In your Flow project, open the node palette and go to Document processing, then Extract.
- Select the model.
- Add the model to the Flow canvas, which creates an Extract node bound to that model.
- Configure the node in the properties panel.
Result: When the flow runs, the Extract node returns the extraction result at $vars.<nodeName>.output. To read individual field values, check Reading the result.
IXP models used in Flow projects are onboarded to Solutions Management. When you publish and deploy a Flow solution that includes an IXP model to a new environment, the IXP model is packaged, migrated, and deployed along with the rest of the solution.