- Overview
- Model building
- Model validation
- Model deployment
- Overview
- Publishing model versions
- Managing published versions
- CLI
- Consuming models
- API
- Frequently asked questions
Unstructured and complex documents user guide
Once you are content with the performance of the model, and you want to test or compare it, deploy it.
IXP provides the following deployment options, depending on how you want to use the model version:
To project - Use this option to save a snapshot of the current state of the project. Deploy each time you want to save a specific model version, which also lets you roll back your training data and taxonomy to that version. It is useful to deploy before making significant taxonomy changes that you may want to revert if they have a negative performance impact. Model versions deployed with the To project option are available to automation developers in the Studio workflow.
To folder (preview) - Use this option to make the model available to automation developers in the Flow canvas. The IXP model version is published as an IXP package, visible under the Packages tab, and an associated deployment is created in the selected Orchestrator folder. You can only deploy models to folders where you have the Orchestrator permission IXP Models - Create. For more details on using the model in the Flow canvas, refer to Extract node.
To deploy a model version, proceed as follows:
- Go to the Deploy tab.
- Select Deploy on your model. A pop-up window opens with the To project and To folder options.
- Select the option that matches your deployment target.
To project
Deploy the model within the current project. The model is discoverable via activities for RPA and API projects, and accessible via API.
Configure the option as follows:
- Optionally, enter a description.
- Select Deploy.
For more details on where you can find your deployed models, refer to the Result section.
To folder (preview)
Deploy the model to an Orchestrator folder only if you want to build Flow projects.
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. No additional manual steps are required to set up the IXP model in the new environment.
Prerequisites: You need at least the IXP Package Reader role for the To folder option to become visible when deploying models. For more details, refer to Managing access.
Configure the option as follows:
- Optionally, enter a summary of the key updates, fixes, and features for this version in the Package change log field.
- Enable the Deploy IXP model option.
- Configure the following options:
- Deployment name - Enter a name for the deployment.
- Location - From the dropdown list, select the Orchestrator folder where you want to deploy the model.
- Select Deploy.
Alternatively, disable the Deploy IXP model option and select Deploy to save the package without deploying it to an Orchestrator folder.
Result
The location of the deployed model version depends on the deployment option you selected. For To project deployments, the model version appears in the Deployed versions list, under the Deploy tab.
For To folder (preview) deployments, the model version is published as a package, visible under the Packages tab on the main Unstructured and Complex Documents page. If a model deployment is also created in a folder, with the Deploy IXP model toggle enabled, it is also visible in the Orchestrator folder UI, under the IXP models tab.
For more details, refer to Managing published versions.