Skip to main content

Table of Contents

Starting a model update

Use this endpoint to start an update process to replace a model in a prediction.

POST /predictions/{predictionID}/model_update

Sample URL

{predictionID} is an identifier of a prediction in which you want to update a model. You can view this prediction ID in Prediction Studio:

  1. In Prediction Studio, click Predictions.
  2. Open a prediction, and then click Actions Show more info .

    The Prediction ID field contains the prediction ID that you need to add to your URL, for example, CDHSAMPLE-DATA-CUSTOMER!CUSTOMERCHURNPREDICTION.


  • {
  • "model_source": "",
  • "validation_dataset": "churn-all.csv",
  • "outcome_field_name": "Outcome",
  • "model_label": "Churn GBM",
  • "supporting_documents": [
  • {
  • "description": "Behavior report",
  • "name": "BehaviorReport.pdf"
  • },
  • {
  • "description": "Population report",
  • "name": "PopulationReport.pdf"
  • },
  • ],
  • "override_mappings": [
  • {
  • "predictor": "Credit_History",
  • "property": "pyCreditHistory"
  • }
  • ]
  • }

Model update request parameters

Name Type Description
model_source String

For file-based models, the path to the model that you want to add.

For cloud-based models, the path to the metadata file of the model that you want to add. Ensure that the model is uploaded to a folder in the repository that is configured as the Prediction Studio analytics repository. For more information, see:

validation_dataset String The path to the validation data set that you want to use to compare the active and candidate models before you approve or reject a model update.
perform_validation Boolean (True, False) This parameter allows you to validate the model.
outcome_field_name String The name of the column that contains the outcome in the validation data set CSV file.
target_component_name String

For supporting models, the name of the component that holds the model in a prediction strategy.

For outcome-based models, the outcome name.

model_label String The name of the candidate model.
supporting_documents Array An array of documentation files for the model.
override_mappings Array An array of mappings of predictors in the models to the corresponding Pega Platform properties.

Supporting documents parameters

Name Type Description
name String The path to a documentation file for the model.
description String The description of the documentation file.

Override mappings parameters

Name Type Description
predictor String A field in the candidate model that you want to select as predictor data and map to a corresponding Pega Platform property.
property String A Pega Platform property that corresponds to the field in the candidate model.


  • {
  • "referenceID": "M-9012"
  • }

Response parameters

Name Type Description
referenceID String Contains a reference ID that uniquely identifies a model update. Other endpoints use reference IDs to process requests about specific model updates, for example, to review (approve or reject) the model update or to retrieve the status of the model update.
Did you find this content helpful?

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega Community has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice
Contact us