Retraining¶
Use the endpoints described below to manage retraining. To maintain model performance after deployment without extensive manual work, DataRobot provides an automatic retraining capability for deployments. Upon providing a retraining dataset registered in the Data Registry, you can define up to five retraining policies on each deployment. Each policy consists of a trigger, a modeling strategy, modeling settings, and a replacement action. When triggered, retraining will produce a new model based on these settings and notify you to consider promoting it.
GET /api/v2/deployments/{deploymentId}/retrainingPolicies/¶
Retrieve a list of deployment retraining policies.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | integer | false | Number of results to skip. |
| limit | query | integer | false | At most this many results are returned. The default may change without notice. |
| deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of retraining policies.",
"items": {
"properties": {
"action": {
"description": "Configure the action to take on the resultant new model.",
"enum": [
"create_challenger",
"create_model_package",
"model_replacement"
],
"type": "string"
},
"autopilotOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"blendBestModels": {
"description": "Blend best models during Autopilot run. This option is not supported in SHAP-only mode.",
"type": "boolean"
},
"mode": {
"description": "The autopilot mode.",
"enum": [
"auto",
"comprehensive",
"quick"
],
"type": "string"
},
"runLeakageRemovedFeatureList": {
"description": "Run Autopilot on Leakage Removed feature list (if exists).",
"type": "boolean"
},
"scoringCodeOnly": {
"description": "Keep only models that can be converted to scorable java code during Autopilot run.",
"type": "boolean"
},
"shapOnlyMode": {
"description": "Include only models with SHAP value support.",
"type": "boolean"
}
},
"type": "object"
},
"customJob": {
"description": "The ID, schedule, and last run for the custom job.",
"properties": {
"id": {
"description": "The ID of the custom job associated with the policy.",
"maxLength": 24,
"type": "string"
},
"lastRun": {
"description": "The ISO-8601 timestamp of when the custom job was last run.",
"maxLength": 256,
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the custom job run.",
"type": [
"string",
"null"
]
}
},
"required": [
"lastRun",
"status"
],
"type": "object",
"x-versionadded": "v2.37"
},
"description": {
"description": "Description of the retraining policy.",
"type": [
"string",
"null"
]
},
"featureListStrategy": {
"description": "Configure the feature list strategy used for modeling.",
"enum": [
"informative_features",
"same_as_champion"
],
"type": "string"
},
"id": {
"description": "ID of the retraining policy.",
"type": "string"
},
"latestRun": {
"description": "Latest run of the retraining policy.",
"properties": {
"challengerId": {
"description": "ID of the challenger created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"errorMessage": {
"description": "Error message of the retraining policy run.",
"type": [
"string",
"null"
]
},
"finishTime": {
"description": "Finish time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the retraining policy run.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"description": "ID of the model package created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "ID of the project created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"registeredModelId": {
"description": "ID of the registered model associated with model package created from this retraining policy run",
"type": [
"string",
"null"
]
},
"startTime": {
"description": "Start time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the retraining policy run.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case associated with the model package created from this retraining policy run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"challengerId",
"errorMessage",
"finishTime",
"id",
"modelPackageId",
"projectId",
"registeredModelId",
"startTime",
"status"
],
"type": "object"
},
"modelSelectionStrategy": {
"description": "Configure how new model is selected when the retraining policy runs.",
"enum": [
"autopilot_recommended",
"same_blueprint",
"same_hyperparameters",
"custom_job"
],
"type": "string"
},
"name": {
"description": "Name of the retraining policy.",
"type": "string"
},
"projectOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"cvMethod": {
"description": "The partitioning method for projects used to build new models.",
"enum": [
"RandomCV",
"StratifiedCV"
],
"type": "string"
},
"holdoutPct": {
"default": null,
"description": "The percentage of dataset to assign to holdout set in projects used to build new models.",
"maximum": 98,
"minimum": 0,
"type": [
"number",
"null"
]
},
"metric": {
"default": null,
"description": "The model selection metric in projects used to build new models.",
"enum": [
"Accuracy",
"AUC",
"Balanced Accuracy",
"FVE Binomial",
"Gini Norm",
"Kolmogorov-Smirnov",
"LogLoss",
"Rate@Top5%",
"Rate@Top10%",
"TPR",
"FPR",
"TNR",
"PPV",
"NPV",
"F1",
"MCC",
"FVE Gamma",
"FVE Poisson",
"FVE Tweedie",
"Gamma Deviance",
"MAE",
"MAPE",
"Poisson Deviance",
"R Squared",
"RMSE",
"RMSLE",
"Tweedie Deviance",
null
],
"type": [
"string",
"null"
]
},
"reps": {
"default": null,
"description": "The number of cross validation folds to use for projects used to build new models.",
"maximum": 50,
"minimum": 2,
"type": [
"integer",
"null"
]
},
"validationPct": {
"default": null,
"description": "The percentage of dataset to assign to validation set in projects used to build new models.",
"maximum": 99,
"minimum": 1,
"type": [
"number",
"null"
]
},
"validationType": {
"description": "The validation type for projects used to build new models.",
"enum": [
"CV",
"TVH"
],
"type": "string"
}
},
"type": "object"
},
"projectOptionsStrategy": {
"description": "Configure the project option strategy used for modeling.",
"enum": [
"same_as_champion",
"override_champion",
"custom"
],
"type": "string"
},
"timeSeriesOptions": {
"description": "Time Series project option used to build new models.",
"properties": {
"calendarId": {
"description": "The ID of the calendar to be used in this project.",
"type": [
"string",
"null"
]
},
"differencingMethod": {
"description": "For time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems `simple` and `seasonal` are not allowed. Parameter `periodicities` must be specified if `seasonal` is chosen. Defaults to `auto`.",
"enum": [
"auto",
"none",
"simple",
"seasonal"
],
"type": [
"string",
"null"
]
},
"exponentiallyWeightedMovingAlpha": {
"description": "Discount factor (alpha) used for exponentially weighted moving features",
"exclusiveMinimum": 0,
"maximum": 1,
"type": [
"number",
"null"
]
},
"periodicities": {
"description": "A list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter 'differencing_method' will default to 'seasonal' if not provided or 'auto'.",
"items": {
"properties": {
"timeSteps": {
"description": "The number of time steps.",
"minimum": 0,
"type": "integer"
},
"timeUnit": {
"description": "The time unit or `ROW` if windowsBasisUnit is `ROW`",
"enum": [
"MILLISECOND",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"WEEK",
"MONTH",
"QUARTER",
"YEAR",
"ROW"
],
"type": "string"
}
},
"required": [
"timeSteps",
"timeUnit"
],
"type": "object"
},
"type": "array"
},
"treatAsExponential": {
"description": "For time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems `always` is not allowed. Defaults to `auto`.",
"enum": [
"auto",
"never",
"always"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"trigger": {
"description": "Retraining policy trigger.",
"properties": {
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"minIntervalBetweenRuns": {
"description": "Minimal interval between policy runs in ISO 8601 duration string.",
"type": [
"string",
"null"
]
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "The date(s) of the month that the job will run. Allowed values are either ``[1 ... 31]`` or ``[\"*\"]`` for all days of the month. This field is additive with ``dayOfWeek``, meaning the job will run both on the date(s) defined in this field and the day specified by ``dayOfWeek`` (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If ``dayOfMonth`` is set to ``[\"*\"]`` and ``dayOfWeek`` is defined, the scheduler will trigger on every day of the month that matches ``dayOfWeek`` (for example, Tuesday the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are ignored.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week that the job will run. Allowed values are ``[0 .. 6]``, where (Sunday=0), or ``[\"*\"]``, for all days of the week. Strings, either 3-letter abbreviations or the full name of the day, can be used interchangeably (e.g., \"sunday\", \"Sunday\", \"sun\", or \"Sun\", all map to ``[0]``. This field is additive with ``dayOfMonth``, meaning the job will run both on the date specified by ``dayOfMonth`` and the day defined in this field.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "The month(s) of the year that the job will run. Allowed values are either ``[1 ... 12]`` or ``[\"*\"]`` for all months of the year. Strings, either 3-letter abbreviations or the full name of the month, can be used interchangeably (e.g., \"jan\" or \"october\"). Months that are not compatible with ``dayOfMonth`` are ignored, for example ``{\"dayOfMonth\": [31], \"month\":[\"feb\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"statusDeclinesToFailing": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to failing.",
"type": "boolean"
},
"statusDeclinesToWarning": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to warning.",
"type": "boolean"
},
"statusStillInDecline": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status still in decline.",
"type": [
"boolean",
"null"
]
},
"type": {
"description": "Type of retraining policy trigger.",
"enum": [
"schedule",
"data_drift_decline",
"accuracy_decline",
"custom_job",
null
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"useCase": {
"description": "The use case to link the retrained model to.",
"properties": {
"id": {
"description": "ID of the use case.",
"type": "string"
},
"name": {
"description": "Name of the use case.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object",
"x-versionadded": "v2.37"
}
},
"required": [
"action",
"autopilotOptions",
"description",
"id",
"latestRun",
"modelSelectionStrategy",
"name",
"projectOptions",
"trigger"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Retrieve a list of deployment retraining policies. | RetrainingPolicyListResponse |
| 404 | Not Found | Deployment not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/retrainingPolicies/¶
Create a deployment retraining policy.
Body parameter¶
{
"properties": {
"action": {
"description": "Configure the action to take on the resultant new model.",
"enum": [
"create_challenger",
"create_model_package",
"model_replacement"
],
"type": "string"
},
"autopilotOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"blendBestModels": {
"description": "Blend best models during Autopilot run. This option is not supported in SHAP-only mode.",
"type": "boolean"
},
"mode": {
"description": "The autopilot mode.",
"enum": [
"auto",
"comprehensive",
"quick"
],
"type": "string"
},
"runLeakageRemovedFeatureList": {
"description": "Run Autopilot on Leakage Removed feature list (if exists).",
"type": "boolean"
},
"scoringCodeOnly": {
"description": "Keep only models that can be converted to scorable java code during Autopilot run.",
"type": "boolean"
},
"shapOnlyMode": {
"description": "Include only models with SHAP value support.",
"type": "boolean"
}
},
"type": "object"
},
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"description": {
"default": null,
"description": "Description of the retraining policy.",
"maxLength": 10000,
"type": [
"string",
"null"
]
},
"featureListStrategy": {
"description": "Configure the feature list strategy used for modeling.",
"enum": [
"informative_features",
"same_as_champion"
],
"type": "string"
},
"modelSelectionStrategy": {
"description": "Configure how new model is selected when the retraining policy runs.",
"enum": [
"autopilot_recommended",
"same_blueprint",
"same_hyperparameters",
"custom_job"
],
"type": "string"
},
"name": {
"description": "Name of the retraining policy.",
"maxLength": 512,
"type": "string"
},
"projectOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"cvMethod": {
"description": "The partitioning method for projects used to build new models.",
"enum": [
"RandomCV",
"StratifiedCV"
],
"type": "string"
},
"holdoutPct": {
"default": null,
"description": "The percentage of dataset to assign to holdout set in projects used to build new models.",
"maximum": 98,
"minimum": 0,
"type": [
"number",
"null"
]
},
"metric": {
"default": null,
"description": "The model selection metric in projects used to build new models.",
"enum": [
"Accuracy",
"AUC",
"Balanced Accuracy",
"FVE Binomial",
"Gini Norm",
"Kolmogorov-Smirnov",
"LogLoss",
"Rate@Top5%",
"Rate@Top10%",
"TPR",
"FPR",
"TNR",
"PPV",
"NPV",
"F1",
"MCC",
"FVE Gamma",
"FVE Poisson",
"FVE Tweedie",
"Gamma Deviance",
"MAE",
"MAPE",
"Poisson Deviance",
"R Squared",
"RMSE",
"RMSLE",
"Tweedie Deviance",
null
],
"type": [
"string",
"null"
]
},
"reps": {
"default": null,
"description": "The number of cross validation folds to use for projects used to build new models.",
"maximum": 50,
"minimum": 2,
"type": [
"integer",
"null"
]
},
"validationPct": {
"default": null,
"description": "The percentage of dataset to assign to validation set in projects used to build new models.",
"maximum": 99,
"minimum": 1,
"type": [
"number",
"null"
]
},
"validationType": {
"description": "The validation type for projects used to build new models.",
"enum": [
"CV",
"TVH"
],
"type": "string"
}
},
"type": "object"
},
"projectOptionsStrategy": {
"description": "Configure the project option strategy used for modeling.",
"enum": [
"same_as_champion",
"override_champion",
"custom"
],
"type": "string"
},
"timeSeriesOptions": {
"description": "Time Series project option used to build new models.",
"properties": {
"calendarId": {
"description": "The ID of the calendar to be used in this project.",
"type": [
"string",
"null"
]
},
"differencingMethod": {
"description": "For time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems `simple` and `seasonal` are not allowed. Parameter `periodicities` must be specified if `seasonal` is chosen. Defaults to `auto`.",
"enum": [
"auto",
"none",
"simple",
"seasonal"
],
"type": [
"string",
"null"
]
},
"exponentiallyWeightedMovingAlpha": {
"description": "Discount factor (alpha) used for exponentially weighted moving features",
"exclusiveMinimum": 0,
"maximum": 1,
"type": [
"number",
"null"
]
},
"periodicities": {
"description": "A list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter 'differencing_method' will default to 'seasonal' if not provided or 'auto'.",
"items": {
"properties": {
"timeSteps": {
"description": "The number of time steps.",
"minimum": 0,
"type": "integer"
},
"timeUnit": {
"description": "The time unit or `ROW` if windowsBasisUnit is `ROW`",
"enum": [
"MILLISECOND",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"WEEK",
"MONTH",
"QUARTER",
"YEAR",
"ROW"
],
"type": "string"
}
},
"required": [
"timeSteps",
"timeUnit"
],
"type": "object"
},
"type": "array"
},
"treatAsExponential": {
"description": "For time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems `always` is not allowed. Defaults to `auto`.",
"enum": [
"auto",
"never",
"always"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"trigger": {
"description": "Retraining policy trigger.",
"properties": {
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"minIntervalBetweenRuns": {
"description": "Minimal interval between policy runs in ISO 8601 duration string.",
"type": [
"string",
"null"
]
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "The date(s) of the month that the job will run. Allowed values are either ``[1 ... 31]`` or ``[\"*\"]`` for all days of the month. This field is additive with ``dayOfWeek``, meaning the job will run both on the date(s) defined in this field and the day specified by ``dayOfWeek`` (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If ``dayOfMonth`` is set to ``[\"*\"]`` and ``dayOfWeek`` is defined, the scheduler will trigger on every day of the month that matches ``dayOfWeek`` (for example, Tuesday the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are ignored.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week that the job will run. Allowed values are ``[0 .. 6]``, where (Sunday=0), or ``[\"*\"]``, for all days of the week. Strings, either 3-letter abbreviations or the full name of the day, can be used interchangeably (e.g., \"sunday\", \"Sunday\", \"sun\", or \"Sun\", all map to ``[0]``. This field is additive with ``dayOfMonth``, meaning the job will run both on the date specified by ``dayOfMonth`` and the day defined in this field.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "The month(s) of the year that the job will run. Allowed values are either ``[1 ... 12]`` or ``[\"*\"]`` for all months of the year. Strings, either 3-letter abbreviations or the full name of the month, can be used interchangeably (e.g., \"jan\" or \"october\"). Months that are not compatible with ``dayOfMonth`` are ignored, for example ``{\"dayOfMonth\": [31], \"month\":[\"feb\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"statusDeclinesToFailing": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to failing.",
"type": "boolean"
},
"statusDeclinesToWarning": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to warning.",
"type": "boolean"
},
"statusStillInDecline": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status still in decline.",
"type": [
"boolean",
"null"
]
},
"type": {
"description": "Type of retraining policy trigger.",
"enum": [
"schedule",
"data_drift_decline",
"accuracy_decline",
"custom_job",
null
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"useCaseId": {
"description": "The ID of the use case to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
}
},
"required": [
"description",
"name"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| deploymentId | path | string | true | Unique identifier of the deployment. |
| body | body | RetrainingPolicyCreate | false | none |
Example responses¶
200 Response
{
"properties": {
"action": {
"description": "Configure the action to take on the resultant new model.",
"enum": [
"create_challenger",
"create_model_package",
"model_replacement"
],
"type": "string"
},
"autopilotOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"blendBestModels": {
"description": "Blend best models during Autopilot run. This option is not supported in SHAP-only mode.",
"type": "boolean"
},
"mode": {
"description": "The autopilot mode.",
"enum": [
"auto",
"comprehensive",
"quick"
],
"type": "string"
},
"runLeakageRemovedFeatureList": {
"description": "Run Autopilot on Leakage Removed feature list (if exists).",
"type": "boolean"
},
"scoringCodeOnly": {
"description": "Keep only models that can be converted to scorable java code during Autopilot run.",
"type": "boolean"
},
"shapOnlyMode": {
"description": "Include only models with SHAP value support.",
"type": "boolean"
}
},
"type": "object"
},
"customJob": {
"description": "The ID, schedule, and last run for the custom job.",
"properties": {
"id": {
"description": "The ID of the custom job associated with the policy.",
"maxLength": 24,
"type": "string"
},
"lastRun": {
"description": "The ISO-8601 timestamp of when the custom job was last run.",
"maxLength": 256,
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the custom job run.",
"type": [
"string",
"null"
]
}
},
"required": [
"lastRun",
"status"
],
"type": "object",
"x-versionadded": "v2.37"
},
"description": {
"description": "Description of the retraining policy.",
"type": [
"string",
"null"
]
},
"featureListStrategy": {
"description": "Configure the feature list strategy used for modeling.",
"enum": [
"informative_features",
"same_as_champion"
],
"type": "string"
},
"id": {
"description": "ID of the retraining policy.",
"type": "string"
},
"latestRun": {
"description": "Latest run of the retraining policy.",
"properties": {
"challengerId": {
"description": "ID of the challenger created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"errorMessage": {
"description": "Error message of the retraining policy run.",
"type": [
"string",
"null"
]
},
"finishTime": {
"description": "Finish time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the retraining policy run.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"description": "ID of the model package created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "ID of the project created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"registeredModelId": {
"description": "ID of the registered model associated with model package created from this retraining policy run",
"type": [
"string",
"null"
]
},
"startTime": {
"description": "Start time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the retraining policy run.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case associated with the model package created from this retraining policy run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"challengerId",
"errorMessage",
"finishTime",
"id",
"modelPackageId",
"projectId",
"registeredModelId",
"startTime",
"status"
],
"type": "object"
},
"modelSelectionStrategy": {
"description": "Configure how new model is selected when the retraining policy runs.",
"enum": [
"autopilot_recommended",
"same_blueprint",
"same_hyperparameters",
"custom_job"
],
"type": "string"
},
"name": {
"description": "Name of the retraining policy.",
"type": "string"
},
"projectOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"cvMethod": {
"description": "The partitioning method for projects used to build new models.",
"enum": [
"RandomCV",
"StratifiedCV"
],
"type": "string"
},
"holdoutPct": {
"default": null,
"description": "The percentage of dataset to assign to holdout set in projects used to build new models.",
"maximum": 98,
"minimum": 0,
"type": [
"number",
"null"
]
},
"metric": {
"default": null,
"description": "The model selection metric in projects used to build new models.",
"enum": [
"Accuracy",
"AUC",
"Balanced Accuracy",
"FVE Binomial",
"Gini Norm",
"Kolmogorov-Smirnov",
"LogLoss",
"Rate@Top5%",
"Rate@Top10%",
"TPR",
"FPR",
"TNR",
"PPV",
"NPV",
"F1",
"MCC",
"FVE Gamma",
"FVE Poisson",
"FVE Tweedie",
"Gamma Deviance",
"MAE",
"MAPE",
"Poisson Deviance",
"R Squared",
"RMSE",
"RMSLE",
"Tweedie Deviance",
null
],
"type": [
"string",
"null"
]
},
"reps": {
"default": null,
"description": "The number of cross validation folds to use for projects used to build new models.",
"maximum": 50,
"minimum": 2,
"type": [
"integer",
"null"
]
},
"validationPct": {
"default": null,
"description": "The percentage of dataset to assign to validation set in projects used to build new models.",
"maximum": 99,
"minimum": 1,
"type": [
"number",
"null"
]
},
"validationType": {
"description": "The validation type for projects used to build new models.",
"enum": [
"CV",
"TVH"
],
"type": "string"
}
},
"type": "object"
},
"projectOptionsStrategy": {
"description": "Configure the project option strategy used for modeling.",
"enum": [
"same_as_champion",
"override_champion",
"custom"
],
"type": "string"
},
"timeSeriesOptions": {
"description": "Time Series project option used to build new models.",
"properties": {
"calendarId": {
"description": "The ID of the calendar to be used in this project.",
"type": [
"string",
"null"
]
},
"differencingMethod": {
"description": "For time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems `simple` and `seasonal` are not allowed. Parameter `periodicities` must be specified if `seasonal` is chosen. Defaults to `auto`.",
"enum": [
"auto",
"none",
"simple",
"seasonal"
],
"type": [
"string",
"null"
]
},
"exponentiallyWeightedMovingAlpha": {
"description": "Discount factor (alpha) used for exponentially weighted moving features",
"exclusiveMinimum": 0,
"maximum": 1,
"type": [
"number",
"null"
]
},
"periodicities": {
"description": "A list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter 'differencing_method' will default to 'seasonal' if not provided or 'auto'.",
"items": {
"properties": {
"timeSteps": {
"description": "The number of time steps.",
"minimum": 0,
"type": "integer"
},
"timeUnit": {
"description": "The time unit or `ROW` if windowsBasisUnit is `ROW`",
"enum": [
"MILLISECOND",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"WEEK",
"MONTH",
"QUARTER",
"YEAR",
"ROW"
],
"type": "string"
}
},
"required": [
"timeSteps",
"timeUnit"
],
"type": "object"
},
"type": "array"
},
"treatAsExponential": {
"description": "For time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems `always` is not allowed. Defaults to `auto`.",
"enum": [
"auto",
"never",
"always"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"trigger": {
"description": "Retraining policy trigger.",
"properties": {
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"minIntervalBetweenRuns": {
"description": "Minimal interval between policy runs in ISO 8601 duration string.",
"type": [
"string",
"null"
]
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "The date(s) of the month that the job will run. Allowed values are either ``[1 ... 31]`` or ``[\"*\"]`` for all days of the month. This field is additive with ``dayOfWeek``, meaning the job will run both on the date(s) defined in this field and the day specified by ``dayOfWeek`` (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If ``dayOfMonth`` is set to ``[\"*\"]`` and ``dayOfWeek`` is defined, the scheduler will trigger on every day of the month that matches ``dayOfWeek`` (for example, Tuesday the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are ignored.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week that the job will run. Allowed values are ``[0 .. 6]``, where (Sunday=0), or ``[\"*\"]``, for all days of the week. Strings, either 3-letter abbreviations or the full name of the day, can be used interchangeably (e.g., \"sunday\", \"Sunday\", \"sun\", or \"Sun\", all map to ``[0]``. This field is additive with ``dayOfMonth``, meaning the job will run both on the date specified by ``dayOfMonth`` and the day defined in this field.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "The month(s) of the year that the job will run. Allowed values are either ``[1 ... 12]`` or ``[\"*\"]`` for all months of the year. Strings, either 3-letter abbreviations or the full name of the month, can be used interchangeably (e.g., \"jan\" or \"october\"). Months that are not compatible with ``dayOfMonth`` are ignored, for example ``{\"dayOfMonth\": [31], \"month\":[\"feb\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"statusDeclinesToFailing": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to failing.",
"type": "boolean"
},
"statusDeclinesToWarning": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to warning.",
"type": "boolean"
},
"statusStillInDecline": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status still in decline.",
"type": [
"boolean",
"null"
]
},
"type": {
"description": "Type of retraining policy trigger.",
"enum": [
"schedule",
"data_drift_decline",
"accuracy_decline",
"custom_job",
null
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"useCase": {
"description": "The use case to link the retrained model to.",
"properties": {
"id": {
"description": "ID of the use case.",
"type": "string"
},
"name": {
"description": "Name of the use case.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object",
"x-versionadded": "v2.37"
}
},
"required": [
"action",
"autopilotOptions",
"description",
"id",
"latestRun",
"modelSelectionStrategy",
"name",
"projectOptions",
"trigger"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RetrainingPolicyRetrieve |
| 404 | Not Found | Deployment not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/¶
Delete a deployment retraining policy.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| deploymentId | path | string | true | Unique identifier of the deployment. |
| retrainingPolicyId | path | string | true | ID of the retraining policy. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Delete a deployment retraining policy. | None |
| 404 | Not Found | Deployment or retraining policy not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/¶
Retrieve a deployment retraining policy.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| deploymentId | path | string | true | Unique identifier of the deployment. |
| retrainingPolicyId | path | string | true | ID of the retraining policy. |
Example responses¶
200 Response
{
"properties": {
"action": {
"description": "Configure the action to take on the resultant new model.",
"enum": [
"create_challenger",
"create_model_package",
"model_replacement"
],
"type": "string"
},
"autopilotOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"blendBestModels": {
"description": "Blend best models during Autopilot run. This option is not supported in SHAP-only mode.",
"type": "boolean"
},
"mode": {
"description": "The autopilot mode.",
"enum": [
"auto",
"comprehensive",
"quick"
],
"type": "string"
},
"runLeakageRemovedFeatureList": {
"description": "Run Autopilot on Leakage Removed feature list (if exists).",
"type": "boolean"
},
"scoringCodeOnly": {
"description": "Keep only models that can be converted to scorable java code during Autopilot run.",
"type": "boolean"
},
"shapOnlyMode": {
"description": "Include only models with SHAP value support.",
"type": "boolean"
}
},
"type": "object"
},
"customJob": {
"description": "The ID, schedule, and last run for the custom job.",
"properties": {
"id": {
"description": "The ID of the custom job associated with the policy.",
"maxLength": 24,
"type": "string"
},
"lastRun": {
"description": "The ISO-8601 timestamp of when the custom job was last run.",
"maxLength": 256,
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the custom job run.",
"type": [
"string",
"null"
]
}
},
"required": [
"lastRun",
"status"
],
"type": "object",
"x-versionadded": "v2.37"
},
"description": {
"description": "Description of the retraining policy.",
"type": [
"string",
"null"
]
},
"featureListStrategy": {
"description": "Configure the feature list strategy used for modeling.",
"enum": [
"informative_features",
"same_as_champion"
],
"type": "string"
},
"id": {
"description": "ID of the retraining policy.",
"type": "string"
},
"latestRun": {
"description": "Latest run of the retraining policy.",
"properties": {
"challengerId": {
"description": "ID of the challenger created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"errorMessage": {
"description": "Error message of the retraining policy run.",
"type": [
"string",
"null"
]
},
"finishTime": {
"description": "Finish time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the retraining policy run.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"description": "ID of the model package created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "ID of the project created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"registeredModelId": {
"description": "ID of the registered model associated with model package created from this retraining policy run",
"type": [
"string",
"null"
]
},
"startTime": {
"description": "Start time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the retraining policy run.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case associated with the model package created from this retraining policy run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"challengerId",
"errorMessage",
"finishTime",
"id",
"modelPackageId",
"projectId",
"registeredModelId",
"startTime",
"status"
],
"type": "object"
},
"modelSelectionStrategy": {
"description": "Configure how new model is selected when the retraining policy runs.",
"enum": [
"autopilot_recommended",
"same_blueprint",
"same_hyperparameters",
"custom_job"
],
"type": "string"
},
"name": {
"description": "Name of the retraining policy.",
"type": "string"
},
"projectOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"cvMethod": {
"description": "The partitioning method for projects used to build new models.",
"enum": [
"RandomCV",
"StratifiedCV"
],
"type": "string"
},
"holdoutPct": {
"default": null,
"description": "The percentage of dataset to assign to holdout set in projects used to build new models.",
"maximum": 98,
"minimum": 0,
"type": [
"number",
"null"
]
},
"metric": {
"default": null,
"description": "The model selection metric in projects used to build new models.",
"enum": [
"Accuracy",
"AUC",
"Balanced Accuracy",
"FVE Binomial",
"Gini Norm",
"Kolmogorov-Smirnov",
"LogLoss",
"Rate@Top5%",
"Rate@Top10%",
"TPR",
"FPR",
"TNR",
"PPV",
"NPV",
"F1",
"MCC",
"FVE Gamma",
"FVE Poisson",
"FVE Tweedie",
"Gamma Deviance",
"MAE",
"MAPE",
"Poisson Deviance",
"R Squared",
"RMSE",
"RMSLE",
"Tweedie Deviance",
null
],
"type": [
"string",
"null"
]
},
"reps": {
"default": null,
"description": "The number of cross validation folds to use for projects used to build new models.",
"maximum": 50,
"minimum": 2,
"type": [
"integer",
"null"
]
},
"validationPct": {
"default": null,
"description": "The percentage of dataset to assign to validation set in projects used to build new models.",
"maximum": 99,
"minimum": 1,
"type": [
"number",
"null"
]
},
"validationType": {
"description": "The validation type for projects used to build new models.",
"enum": [
"CV",
"TVH"
],
"type": "string"
}
},
"type": "object"
},
"projectOptionsStrategy": {
"description": "Configure the project option strategy used for modeling.",
"enum": [
"same_as_champion",
"override_champion",
"custom"
],
"type": "string"
},
"timeSeriesOptions": {
"description": "Time Series project option used to build new models.",
"properties": {
"calendarId": {
"description": "The ID of the calendar to be used in this project.",
"type": [
"string",
"null"
]
},
"differencingMethod": {
"description": "For time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems `simple` and `seasonal` are not allowed. Parameter `periodicities` must be specified if `seasonal` is chosen. Defaults to `auto`.",
"enum": [
"auto",
"none",
"simple",
"seasonal"
],
"type": [
"string",
"null"
]
},
"exponentiallyWeightedMovingAlpha": {
"description": "Discount factor (alpha) used for exponentially weighted moving features",
"exclusiveMinimum": 0,
"maximum": 1,
"type": [
"number",
"null"
]
},
"periodicities": {
"description": "A list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter 'differencing_method' will default to 'seasonal' if not provided or 'auto'.",
"items": {
"properties": {
"timeSteps": {
"description": "The number of time steps.",
"minimum": 0,
"type": "integer"
},
"timeUnit": {
"description": "The time unit or `ROW` if windowsBasisUnit is `ROW`",
"enum": [
"MILLISECOND",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"WEEK",
"MONTH",
"QUARTER",
"YEAR",
"ROW"
],
"type": "string"
}
},
"required": [
"timeSteps",
"timeUnit"
],
"type": "object"
},
"type": "array"
},
"treatAsExponential": {
"description": "For time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems `always` is not allowed. Defaults to `auto`.",
"enum": [
"auto",
"never",
"always"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"trigger": {
"description": "Retraining policy trigger.",
"properties": {
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"minIntervalBetweenRuns": {
"description": "Minimal interval between policy runs in ISO 8601 duration string.",
"type": [
"string",
"null"
]
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "The date(s) of the month that the job will run. Allowed values are either ``[1 ... 31]`` or ``[\"*\"]`` for all days of the month. This field is additive with ``dayOfWeek``, meaning the job will run both on the date(s) defined in this field and the day specified by ``dayOfWeek`` (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If ``dayOfMonth`` is set to ``[\"*\"]`` and ``dayOfWeek`` is defined, the scheduler will trigger on every day of the month that matches ``dayOfWeek`` (for example, Tuesday the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are ignored.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week that the job will run. Allowed values are ``[0 .. 6]``, where (Sunday=0), or ``[\"*\"]``, for all days of the week. Strings, either 3-letter abbreviations or the full name of the day, can be used interchangeably (e.g., \"sunday\", \"Sunday\", \"sun\", or \"Sun\", all map to ``[0]``. This field is additive with ``dayOfMonth``, meaning the job will run both on the date specified by ``dayOfMonth`` and the day defined in this field.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "The month(s) of the year that the job will run. Allowed values are either ``[1 ... 12]`` or ``[\"*\"]`` for all months of the year. Strings, either 3-letter abbreviations or the full name of the month, can be used interchangeably (e.g., \"jan\" or \"october\"). Months that are not compatible with ``dayOfMonth`` are ignored, for example ``{\"dayOfMonth\": [31], \"month\":[\"feb\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"statusDeclinesToFailing": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to failing.",
"type": "boolean"
},
"statusDeclinesToWarning": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to warning.",
"type": "boolean"
},
"statusStillInDecline": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status still in decline.",
"type": [
"boolean",
"null"
]
},
"type": {
"description": "Type of retraining policy trigger.",
"enum": [
"schedule",
"data_drift_decline",
"accuracy_decline",
"custom_job",
null
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"useCase": {
"description": "The use case to link the retrained model to.",
"properties": {
"id": {
"description": "ID of the use case.",
"type": "string"
},
"name": {
"description": "Name of the use case.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object",
"x-versionadded": "v2.37"
}
},
"required": [
"action",
"autopilotOptions",
"description",
"id",
"latestRun",
"modelSelectionStrategy",
"name",
"projectOptions",
"trigger"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Retrieve a deployment retraining policy. | RetrainingPolicyRetrieve |
| 404 | Not Found | Deployment or retraining policy not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/¶
Update a deployment retraining policy.
Body parameter¶
{
"properties": {
"action": {
"description": "Configure the action to take on the resultant new model.",
"enum": [
"create_challenger",
"create_model_package",
"model_replacement"
],
"type": "string"
},
"autopilotOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"blendBestModels": {
"description": "Blend best models during Autopilot run. This option is not supported in SHAP-only mode.",
"type": "boolean"
},
"mode": {
"description": "The autopilot mode.",
"enum": [
"auto",
"comprehensive",
"quick"
],
"type": "string"
},
"runLeakageRemovedFeatureList": {
"description": "Run Autopilot on Leakage Removed feature list (if exists).",
"type": "boolean"
},
"scoringCodeOnly": {
"description": "Keep only models that can be converted to scorable java code during Autopilot run.",
"type": "boolean"
},
"shapOnlyMode": {
"description": "Include only models with SHAP value support.",
"type": "boolean"
}
},
"type": "object"
},
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"description": {
"description": "Description of the retraining policy.",
"maxLength": 10000,
"type": [
"string",
"null"
]
},
"featureListStrategy": {
"description": "Configure the feature list strategy used for modeling.",
"enum": [
"informative_features",
"same_as_champion"
],
"type": "string"
},
"modelSelectionStrategy": {
"description": "Configure how new model is selected when the retraining policy runs.",
"enum": [
"autopilot_recommended",
"same_blueprint",
"same_hyperparameters",
"custom_job"
],
"type": "string"
},
"name": {
"description": "Name of the retraining policy.",
"maxLength": 512,
"type": "string"
},
"projectOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"cvMethod": {
"description": "The partitioning method for projects used to build new models.",
"enum": [
"RandomCV",
"StratifiedCV"
],
"type": "string"
},
"holdoutPct": {
"default": null,
"description": "The percentage of dataset to assign to holdout set in projects used to build new models.",
"maximum": 98,
"minimum": 0,
"type": [
"number",
"null"
]
},
"metric": {
"default": null,
"description": "The model selection metric in projects used to build new models.",
"enum": [
"Accuracy",
"AUC",
"Balanced Accuracy",
"FVE Binomial",
"Gini Norm",
"Kolmogorov-Smirnov",
"LogLoss",
"Rate@Top5%",
"Rate@Top10%",
"TPR",
"FPR",
"TNR",
"PPV",
"NPV",
"F1",
"MCC",
"FVE Gamma",
"FVE Poisson",
"FVE Tweedie",
"Gamma Deviance",
"MAE",
"MAPE",
"Poisson Deviance",
"R Squared",
"RMSE",
"RMSLE",
"Tweedie Deviance",
null
],
"type": [
"string",
"null"
]
},
"reps": {
"default": null,
"description": "The number of cross validation folds to use for projects used to build new models.",
"maximum": 50,
"minimum": 2,
"type": [
"integer",
"null"
]
},
"validationPct": {
"default": null,
"description": "The percentage of dataset to assign to validation set in projects used to build new models.",
"maximum": 99,
"minimum": 1,
"type": [
"number",
"null"
]
},
"validationType": {
"description": "The validation type for projects used to build new models.",
"enum": [
"CV",
"TVH"
],
"type": "string"
}
},
"type": "object"
},
"projectOptionsStrategy": {
"description": "Configure the project option strategy used for modeling.",
"enum": [
"same_as_champion",
"override_champion",
"custom"
],
"type": "string"
},
"timeSeriesOptions": {
"description": "Time Series project option used to build new models.",
"properties": {
"calendarId": {
"description": "The ID of the calendar to be used in this project.",
"type": [
"string",
"null"
]
},
"differencingMethod": {
"description": "For time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems `simple` and `seasonal` are not allowed. Parameter `periodicities` must be specified if `seasonal` is chosen. Defaults to `auto`.",
"enum": [
"auto",
"none",
"simple",
"seasonal"
],
"type": [
"string",
"null"
]
},
"exponentiallyWeightedMovingAlpha": {
"description": "Discount factor (alpha) used for exponentially weighted moving features",
"exclusiveMinimum": 0,
"maximum": 1,
"type": [
"number",
"null"
]
},
"periodicities": {
"description": "A list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter 'differencing_method' will default to 'seasonal' if not provided or 'auto'.",
"items": {
"properties": {
"timeSteps": {
"description": "The number of time steps.",
"minimum": 0,
"type": "integer"
},
"timeUnit": {
"description": "The time unit or `ROW` if windowsBasisUnit is `ROW`",
"enum": [
"MILLISECOND",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"WEEK",
"MONTH",
"QUARTER",
"YEAR",
"ROW"
],
"type": "string"
}
},
"required": [
"timeSteps",
"timeUnit"
],
"type": "object"
},
"type": "array"
},
"treatAsExponential": {
"description": "For time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems `always` is not allowed. Defaults to `auto`.",
"enum": [
"auto",
"never",
"always"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"trigger": {
"description": "Retraining policy trigger.",
"properties": {
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"minIntervalBetweenRuns": {
"description": "Minimal interval between policy runs in ISO 8601 duration string.",
"type": [
"string",
"null"
]
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "The date(s) of the month that the job will run. Allowed values are either ``[1 ... 31]`` or ``[\"*\"]`` for all days of the month. This field is additive with ``dayOfWeek``, meaning the job will run both on the date(s) defined in this field and the day specified by ``dayOfWeek`` (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If ``dayOfMonth`` is set to ``[\"*\"]`` and ``dayOfWeek`` is defined, the scheduler will trigger on every day of the month that matches ``dayOfWeek`` (for example, Tuesday the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are ignored.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week that the job will run. Allowed values are ``[0 .. 6]``, where (Sunday=0), or ``[\"*\"]``, for all days of the week. Strings, either 3-letter abbreviations or the full name of the day, can be used interchangeably (e.g., \"sunday\", \"Sunday\", \"sun\", or \"Sun\", all map to ``[0]``. This field is additive with ``dayOfMonth``, meaning the job will run both on the date specified by ``dayOfMonth`` and the day defined in this field.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "The month(s) of the year that the job will run. Allowed values are either ``[1 ... 12]`` or ``[\"*\"]`` for all months of the year. Strings, either 3-letter abbreviations or the full name of the month, can be used interchangeably (e.g., \"jan\" or \"october\"). Months that are not compatible with ``dayOfMonth`` are ignored, for example ``{\"dayOfMonth\": [31], \"month\":[\"feb\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"statusDeclinesToFailing": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to failing.",
"type": "boolean"
},
"statusDeclinesToWarning": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to warning.",
"type": "boolean"
},
"statusStillInDecline": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status still in decline.",
"type": [
"boolean",
"null"
]
},
"type": {
"description": "Type of retraining policy trigger.",
"enum": [
"schedule",
"data_drift_decline",
"accuracy_decline",
"custom_job",
null
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"useCaseId": {
"description": "The ID of the use case to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
}
},
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| deploymentId | path | string | true | Unique identifier of the deployment. |
| retrainingPolicyId | path | string | true | ID of the retraining policy. |
| body | body | RetrainingPolicyUpdate | false | none |
Example responses¶
200 Response
{
"properties": {
"action": {
"description": "Configure the action to take on the resultant new model.",
"enum": [
"create_challenger",
"create_model_package",
"model_replacement"
],
"type": "string"
},
"autopilotOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"blendBestModels": {
"description": "Blend best models during Autopilot run. This option is not supported in SHAP-only mode.",
"type": "boolean"
},
"mode": {
"description": "The autopilot mode.",
"enum": [
"auto",
"comprehensive",
"quick"
],
"type": "string"
},
"runLeakageRemovedFeatureList": {
"description": "Run Autopilot on Leakage Removed feature list (if exists).",
"type": "boolean"
},
"scoringCodeOnly": {
"description": "Keep only models that can be converted to scorable java code during Autopilot run.",
"type": "boolean"
},
"shapOnlyMode": {
"description": "Include only models with SHAP value support.",
"type": "boolean"
}
},
"type": "object"
},
"customJob": {
"description": "The ID, schedule, and last run for the custom job.",
"properties": {
"id": {
"description": "The ID of the custom job associated with the policy.",
"maxLength": 24,
"type": "string"
},
"lastRun": {
"description": "The ISO-8601 timestamp of when the custom job was last run.",
"maxLength": 256,
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the custom job run.",
"type": [
"string",
"null"
]
}
},
"required": [
"lastRun",
"status"
],
"type": "object",
"x-versionadded": "v2.37"
},
"description": {
"description": "Description of the retraining policy.",
"type": [
"string",
"null"
]
},
"featureListStrategy": {
"description": "Configure the feature list strategy used for modeling.",
"enum": [
"informative_features",
"same_as_champion"
],
"type": "string"
},
"id": {
"description": "ID of the retraining policy.",
"type": "string"
},
"latestRun": {
"description": "Latest run of the retraining policy.",
"properties": {
"challengerId": {
"description": "ID of the challenger created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"errorMessage": {
"description": "Error message of the retraining policy run.",
"type": [
"string",
"null"
]
},
"finishTime": {
"description": "Finish time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the retraining policy run.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"description": "ID of the model package created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "ID of the project created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"registeredModelId": {
"description": "ID of the registered model associated with model package created from this retraining policy run",
"type": [
"string",
"null"
]
},
"startTime": {
"description": "Start time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the retraining policy run.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case associated with the model package created from this retraining policy run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"challengerId",
"errorMessage",
"finishTime",
"id",
"modelPackageId",
"projectId",
"registeredModelId",
"startTime",
"status"
],
"type": "object"
},
"modelSelectionStrategy": {
"description": "Configure how new model is selected when the retraining policy runs.",
"enum": [
"autopilot_recommended",
"same_blueprint",
"same_hyperparameters",
"custom_job"
],
"type": "string"
},
"name": {
"description": "Name of the retraining policy.",
"type": "string"
},
"projectOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"cvMethod": {
"description": "The partitioning method for projects used to build new models.",
"enum": [
"RandomCV",
"StratifiedCV"
],
"type": "string"
},
"holdoutPct": {
"default": null,
"description": "The percentage of dataset to assign to holdout set in projects used to build new models.",
"maximum": 98,
"minimum": 0,
"type": [
"number",
"null"
]
},
"metric": {
"default": null,
"description": "The model selection metric in projects used to build new models.",
"enum": [
"Accuracy",
"AUC",
"Balanced Accuracy",
"FVE Binomial",
"Gini Norm",
"Kolmogorov-Smirnov",
"LogLoss",
"Rate@Top5%",
"Rate@Top10%",
"TPR",
"FPR",
"TNR",
"PPV",
"NPV",
"F1",
"MCC",
"FVE Gamma",
"FVE Poisson",
"FVE Tweedie",
"Gamma Deviance",
"MAE",
"MAPE",
"Poisson Deviance",
"R Squared",
"RMSE",
"RMSLE",
"Tweedie Deviance",
null
],
"type": [
"string",
"null"
]
},
"reps": {
"default": null,
"description": "The number of cross validation folds to use for projects used to build new models.",
"maximum": 50,
"minimum": 2,
"type": [
"integer",
"null"
]
},
"validationPct": {
"default": null,
"description": "The percentage of dataset to assign to validation set in projects used to build new models.",
"maximum": 99,
"minimum": 1,
"type": [
"number",
"null"
]
},
"validationType": {
"description": "The validation type for projects used to build new models.",
"enum": [
"CV",
"TVH"
],
"type": "string"
}
},
"type": "object"
},
"projectOptionsStrategy": {
"description": "Configure the project option strategy used for modeling.",
"enum": [
"same_as_champion",
"override_champion",
"custom"
],
"type": "string"
},
"timeSeriesOptions": {
"description": "Time Series project option used to build new models.",
"properties": {
"calendarId": {
"description": "The ID of the calendar to be used in this project.",
"type": [
"string",
"null"
]
},
"differencingMethod": {
"description": "For time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems `simple` and `seasonal` are not allowed. Parameter `periodicities` must be specified if `seasonal` is chosen. Defaults to `auto`.",
"enum": [
"auto",
"none",
"simple",
"seasonal"
],
"type": [
"string",
"null"
]
},
"exponentiallyWeightedMovingAlpha": {
"description": "Discount factor (alpha) used for exponentially weighted moving features",
"exclusiveMinimum": 0,
"maximum": 1,
"type": [
"number",
"null"
]
},
"periodicities": {
"description": "A list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter 'differencing_method' will default to 'seasonal' if not provided or 'auto'.",
"items": {
"properties": {
"timeSteps": {
"description": "The number of time steps.",
"minimum": 0,
"type": "integer"
},
"timeUnit": {
"description": "The time unit or `ROW` if windowsBasisUnit is `ROW`",
"enum": [
"MILLISECOND",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"WEEK",
"MONTH",
"QUARTER",
"YEAR",
"ROW"
],
"type": "string"
}
},
"required": [
"timeSteps",
"timeUnit"
],
"type": "object"
},
"type": "array"
},
"treatAsExponential": {
"description": "For time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems `always` is not allowed. Defaults to `auto`.",
"enum": [
"auto",
"never",
"always"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"trigger": {
"description": "Retraining policy trigger.",
"properties": {
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"minIntervalBetweenRuns": {
"description": "Minimal interval between policy runs in ISO 8601 duration string.",
"type": [
"string",
"null"
]
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "The date(s) of the month that the job will run. Allowed values are either ``[1 ... 31]`` or ``[\"*\"]`` for all days of the month. This field is additive with ``dayOfWeek``, meaning the job will run both on the date(s) defined in this field and the day specified by ``dayOfWeek`` (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If ``dayOfMonth`` is set to ``[\"*\"]`` and ``dayOfWeek`` is defined, the scheduler will trigger on every day of the month that matches ``dayOfWeek`` (for example, Tuesday the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are ignored.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week that the job will run. Allowed values are ``[0 .. 6]``, where (Sunday=0), or ``[\"*\"]``, for all days of the week. Strings, either 3-letter abbreviations or the full name of the day, can be used interchangeably (e.g., \"sunday\", \"Sunday\", \"sun\", or \"Sun\", all map to ``[0]``. This field is additive with ``dayOfMonth``, meaning the job will run both on the date specified by ``dayOfMonth`` and the day defined in this field.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "The month(s) of the year that the job will run. Allowed values are either ``[1 ... 12]`` or ``[\"*\"]`` for all months of the year. Strings, either 3-letter abbreviations or the full name of the month, can be used interchangeably (e.g., \"jan\" or \"october\"). Months that are not compatible with ``dayOfMonth`` are ignored, for example ``{\"dayOfMonth\": [31], \"month\":[\"feb\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"statusDeclinesToFailing": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to failing.",
"type": "boolean"
},
"statusDeclinesToWarning": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to warning.",
"type": "boolean"
},
"statusStillInDecline": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status still in decline.",
"type": [
"boolean",
"null"
]
},
"type": {
"description": "Type of retraining policy trigger.",
"enum": [
"schedule",
"data_drift_decline",
"accuracy_decline",
"custom_job",
null
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"useCase": {
"description": "The use case to link the retrained model to.",
"properties": {
"id": {
"description": "ID of the use case.",
"type": "string"
},
"name": {
"description": "Name of the use case.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object",
"x-versionadded": "v2.37"
}
},
"required": [
"action",
"autopilotOptions",
"description",
"id",
"latestRun",
"modelSelectionStrategy",
"name",
"projectOptions",
"trigger"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RetrainingPolicyRetrieve |
| 404 | Not Found | Deployment or retraining policy not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/¶
Retrieve a list of deployment retraining policy runs.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | integer | false | Number of results to skip. |
| limit | query | integer | false | At most this many results are returned. The default may change without notice. |
| deploymentId | path | string | true | Unique identifier of the deployment. |
| retrainingPolicyId | path | string | true | ID of the retraining policy. |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of retraining policy runs.",
"items": {
"description": "Latest run of the retraining policy.",
"properties": {
"challengerId": {
"description": "ID of the challenger created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"errorMessage": {
"description": "Error message of the retraining policy run.",
"type": [
"string",
"null"
]
},
"finishTime": {
"description": "Finish time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the retraining policy run.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"description": "ID of the model package created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "ID of the project created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"registeredModelId": {
"description": "ID of the registered model associated with model package created from this retraining policy run",
"type": [
"string",
"null"
]
},
"startTime": {
"description": "Start time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the retraining policy run.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case associated with the model package created from this retraining policy run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"challengerId",
"errorMessage",
"finishTime",
"id",
"modelPackageId",
"projectId",
"registeredModelId",
"startTime",
"status"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Retrieve a list of deployment retraining policy runs. | RetrainingPolicyRunListResponse |
| 404 | Not Found | Deployment or retraining policy not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/¶
Initiate a deployment retraining policy run.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| deploymentId | path | string | true | Unique identifier of the deployment. |
| retrainingPolicyId | path | string | true | ID of the retraining policy. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | None |
| 404 | Not Found | Deployment or retraining policy not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/{runId}/¶
Retrieve a single deployment retraining policy run.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| deploymentId | path | string | true | Unique identifier of the deployment. |
| retrainingPolicyId | path | string | true | ID of the retraining policy. |
| runId | path | string | true | ID of the retraining policy run. |
Example responses¶
200 Response
{
"description": "Latest run of the retraining policy.",
"properties": {
"challengerId": {
"description": "ID of the challenger created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"errorMessage": {
"description": "Error message of the retraining policy run.",
"type": [
"string",
"null"
]
},
"finishTime": {
"description": "Finish time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the retraining policy run.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"description": "ID of the model package created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "ID of the project created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"registeredModelId": {
"description": "ID of the registered model associated with model package created from this retraining policy run",
"type": [
"string",
"null"
]
},
"startTime": {
"description": "Start time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the retraining policy run.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case associated with the model package created from this retraining policy run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"challengerId",
"errorMessage",
"finishTime",
"id",
"modelPackageId",
"projectId",
"registeredModelId",
"startTime",
"status"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Retrieve a single deployment retraining policy run. | RetrainingPolicyRunRetrieve |
| 404 | Not Found | Deployment or retraining policy not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/{runId}/¶
Update a single deployment retraining policy run.
Body parameter¶
{
"properties": {
"status": {
"description": "New status of the retraining policy.",
"enum": [
"cancelled"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| deploymentId | path | string | true | Unique identifier of the deployment. |
| retrainingPolicyId | path | string | true | ID of the retraining policy. |
| runId | path | string | true | ID of the retraining policy run. |
| body | body | RetrainingPolicyRunUpdate | false | none |
Example responses¶
200 Response
{
"description": "Latest run of the retraining policy.",
"properties": {
"challengerId": {
"description": "ID of the challenger created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"errorMessage": {
"description": "Error message of the retraining policy run.",
"type": [
"string",
"null"
]
},
"finishTime": {
"description": "Finish time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the retraining policy run.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"description": "ID of the model package created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "ID of the project created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"registeredModelId": {
"description": "ID of the registered model associated with model package created from this retraining policy run",
"type": [
"string",
"null"
]
},
"startTime": {
"description": "Start time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the retraining policy run.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case associated with the model package created from this retraining policy run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"challengerId",
"errorMessage",
"finishTime",
"id",
"modelPackageId",
"projectId",
"registeredModelId",
"startTime",
"status"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Update a single deployment retraining policy run. | RetrainingPolicyRunRetrieve |
| 404 | Not Found | Deployment or retraining policy not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/retrainingSettings/¶
Retrieve deployment retraining settings.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"properties": {
"dataset": {
"description": "The dataset that will be used as retraining data.",
"properties": {
"id": {
"description": "ID of the retraining dataset.",
"type": "string"
},
"name": {
"description": "Name of the retraining dataset.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"predictionEnvironment": {
"description": "The prediction environment that will be associated with the challengers created by retraining policies.",
"properties": {
"id": {
"description": "ID of the prediction environment.",
"type": "string"
},
"name": {
"description": "Name of the prediction environment.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"retrainingUser": {
"description": "The user scheduled retraining will be performed on behalf of.",
"properties": {
"id": {
"description": "ID of the scheduled retraining user.",
"type": "string"
},
"username": {
"description": "Username of the scheduled retraining user.",
"type": "string"
}
},
"required": [
"id",
"username"
],
"type": "object"
}
},
"required": [
"dataset",
"predictionEnvironment",
"retrainingUser"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Retrieve deployment retraining settings. | RetrainingSettingsRetrieve |
| 404 | Not Found | Deployment not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/retrainingSettings/¶
Update deployment retraining settings.
Body parameter¶
{
"properties": {
"credentialId": {
"description": "ID of the credential used to refresh retraining dataset.",
"type": [
"string",
"null"
]
},
"datasetId": {
"description": "ID of the retraining dataset.",
"type": [
"string",
"null"
]
},
"predictionEnvironmentId": {
"description": "ID of the prediction environment to associate with the challengers created by retraining policies.",
"type": [
"string",
"null"
]
},
"retrainingUserId": {
"description": "ID of the retraining user.",
"type": "string"
}
},
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| deploymentId | path | string | true | Unique identifier of the deployment. |
| body | body | RetrainingSettingsUpdate | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Update deployment retraining settings. | None |
| 404 | Not Found | Deployment not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas¶
AutopilotOptions
{
"description": "Options for projects used to build new models.",
"properties": {
"blendBestModels": {
"description": "Blend best models during Autopilot run. This option is not supported in SHAP-only mode.",
"type": "boolean"
},
"mode": {
"description": "The autopilot mode.",
"enum": [
"auto",
"comprehensive",
"quick"
],
"type": "string"
},
"runLeakageRemovedFeatureList": {
"description": "Run Autopilot on Leakage Removed feature list (if exists).",
"type": "boolean"
},
"scoringCodeOnly": {
"description": "Keep only models that can be converted to scorable java code during Autopilot run.",
"type": "boolean"
},
"shapOnlyMode": {
"description": "Include only models with SHAP value support.",
"type": "boolean"
}
},
"type": "object"
}
Options for projects used to build new models.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| blendBestModels | boolean | false | Blend best models during Autopilot run. This option is not supported in SHAP-only mode. | |
| mode | string | false | The autopilot mode. | |
| runLeakageRemovedFeatureList | boolean | false | Run Autopilot on Leakage Removed feature list (if exists). | |
| scoringCodeOnly | boolean | false | Keep only models that can be converted to scorable java code during Autopilot run. | |
| shapOnlyMode | boolean | false | Include only models with SHAP value support. |
Enumerated Values¶
| Property | Value |
|---|---|
| mode | [auto, comprehensive, quick] |
CustomRetrainingJob
{
"description": "The ID, schedule, and last run for the custom job.",
"properties": {
"id": {
"description": "The ID of the custom job associated with the policy.",
"maxLength": 24,
"type": "string"
},
"lastRun": {
"description": "The ISO-8601 timestamp of when the custom job was last run.",
"maxLength": 256,
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the custom job run.",
"type": [
"string",
"null"
]
}
},
"required": [
"lastRun",
"status"
],
"type": "object",
"x-versionadded": "v2.37"
}
The ID, schedule, and last run for the custom job.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | maxLength: 24 |
The ID of the custom job associated with the policy. |
| lastRun | string,null | true | maxLength: 256 |
The ISO-8601 timestamp of when the custom job was last run. |
| status | string,null | true | Status of the custom job run. |
Dataset
{
"description": "The dataset that will be used as retraining data.",
"properties": {
"id": {
"description": "ID of the retraining dataset.",
"type": "string"
},
"name": {
"description": "Name of the retraining dataset.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
The dataset that will be used as retraining data.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | ID of the retraining dataset. | |
| name | string | true | Name of the retraining dataset. |
Periodicity
{
"properties": {
"timeSteps": {
"description": "The number of time steps.",
"minimum": 0,
"type": "integer"
},
"timeUnit": {
"description": "The time unit or `ROW` if windowsBasisUnit is `ROW`",
"enum": [
"MILLISECOND",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"WEEK",
"MONTH",
"QUARTER",
"YEAR",
"ROW"
],
"type": "string"
}
},
"required": [
"timeSteps",
"timeUnit"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| timeSteps | integer | true | minimum: 0 |
The number of time steps. |
| timeUnit | string | true | The time unit or ROW if windowsBasisUnit is ROW |
Enumerated Values¶
| Property | Value |
|---|---|
| timeUnit | [MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR, ROW] |
PredictionEnvironment
{
"description": "The prediction environment that will be associated with the challengers created by retraining policies.",
"properties": {
"id": {
"description": "ID of the prediction environment.",
"type": "string"
},
"name": {
"description": "Name of the prediction environment.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
The prediction environment that will be associated with the challengers created by retraining policies.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | ID of the prediction environment. | |
| name | string | true | Name of the prediction environment. |
ProjectOptions
{
"description": "Options for projects used to build new models.",
"properties": {
"cvMethod": {
"description": "The partitioning method for projects used to build new models.",
"enum": [
"RandomCV",
"StratifiedCV"
],
"type": "string"
},
"holdoutPct": {
"default": null,
"description": "The percentage of dataset to assign to holdout set in projects used to build new models.",
"maximum": 98,
"minimum": 0,
"type": [
"number",
"null"
]
},
"metric": {
"default": null,
"description": "The model selection metric in projects used to build new models.",
"enum": [
"Accuracy",
"AUC",
"Balanced Accuracy",
"FVE Binomial",
"Gini Norm",
"Kolmogorov-Smirnov",
"LogLoss",
"Rate@Top5%",
"Rate@Top10%",
"TPR",
"FPR",
"TNR",
"PPV",
"NPV",
"F1",
"MCC",
"FVE Gamma",
"FVE Poisson",
"FVE Tweedie",
"Gamma Deviance",
"MAE",
"MAPE",
"Poisson Deviance",
"R Squared",
"RMSE",
"RMSLE",
"Tweedie Deviance",
null
],
"type": [
"string",
"null"
]
},
"reps": {
"default": null,
"description": "The number of cross validation folds to use for projects used to build new models.",
"maximum": 50,
"minimum": 2,
"type": [
"integer",
"null"
]
},
"validationPct": {
"default": null,
"description": "The percentage of dataset to assign to validation set in projects used to build new models.",
"maximum": 99,
"minimum": 1,
"type": [
"number",
"null"
]
},
"validationType": {
"description": "The validation type for projects used to build new models.",
"enum": [
"CV",
"TVH"
],
"type": "string"
}
},
"type": "object"
}
Options for projects used to build new models.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cvMethod | string | false | The partitioning method for projects used to build new models. | |
| holdoutPct | number,null | false | maximum: 98 minimum: 0 |
The percentage of dataset to assign to holdout set in projects used to build new models. |
| metric | string,null | false | The model selection metric in projects used to build new models. | |
| reps | integer,null | false | maximum: 50 minimum: 2 |
The number of cross validation folds to use for projects used to build new models. |
| validationPct | number,null | false | maximum: 99 minimum: 1 |
The percentage of dataset to assign to validation set in projects used to build new models. |
| validationType | string | false | The validation type for projects used to build new models. |
Enumerated Values¶
| Property | Value |
|---|---|
| cvMethod | [RandomCV, StratifiedCV] |
| metric | [Accuracy, AUC, Balanced Accuracy, FVE Binomial, Gini Norm, Kolmogorov-Smirnov, LogLoss, Rate@Top5%, Rate@Top10%, TPR, FPR, TNR, PPV, NPV, F1, MCC, FVE Gamma, FVE Poisson, FVE Tweedie, Gamma Deviance, MAE, MAPE, Poisson Deviance, R Squared, RMSE, RMSLE, Tweedie Deviance, null] |
| validationType | [CV, TVH] |
RetrainingPolicyCreate
{
"properties": {
"action": {
"description": "Configure the action to take on the resultant new model.",
"enum": [
"create_challenger",
"create_model_package",
"model_replacement"
],
"type": "string"
},
"autopilotOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"blendBestModels": {
"description": "Blend best models during Autopilot run. This option is not supported in SHAP-only mode.",
"type": "boolean"
},
"mode": {
"description": "The autopilot mode.",
"enum": [
"auto",
"comprehensive",
"quick"
],
"type": "string"
},
"runLeakageRemovedFeatureList": {
"description": "Run Autopilot on Leakage Removed feature list (if exists).",
"type": "boolean"
},
"scoringCodeOnly": {
"description": "Keep only models that can be converted to scorable java code during Autopilot run.",
"type": "boolean"
},
"shapOnlyMode": {
"description": "Include only models with SHAP value support.",
"type": "boolean"
}
},
"type": "object"
},
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"description": {
"default": null,
"description": "Description of the retraining policy.",
"maxLength": 10000,
"type": [
"string",
"null"
]
},
"featureListStrategy": {
"description": "Configure the feature list strategy used for modeling.",
"enum": [
"informative_features",
"same_as_champion"
],
"type": "string"
},
"modelSelectionStrategy": {
"description": "Configure how new model is selected when the retraining policy runs.",
"enum": [
"autopilot_recommended",
"same_blueprint",
"same_hyperparameters",
"custom_job"
],
"type": "string"
},
"name": {
"description": "Name of the retraining policy.",
"maxLength": 512,
"type": "string"
},
"projectOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"cvMethod": {
"description": "The partitioning method for projects used to build new models.",
"enum": [
"RandomCV",
"StratifiedCV"
],
"type": "string"
},
"holdoutPct": {
"default": null,
"description": "The percentage of dataset to assign to holdout set in projects used to build new models.",
"maximum": 98,
"minimum": 0,
"type": [
"number",
"null"
]
},
"metric": {
"default": null,
"description": "The model selection metric in projects used to build new models.",
"enum": [
"Accuracy",
"AUC",
"Balanced Accuracy",
"FVE Binomial",
"Gini Norm",
"Kolmogorov-Smirnov",
"LogLoss",
"Rate@Top5%",
"Rate@Top10%",
"TPR",
"FPR",
"TNR",
"PPV",
"NPV",
"F1",
"MCC",
"FVE Gamma",
"FVE Poisson",
"FVE Tweedie",
"Gamma Deviance",
"MAE",
"MAPE",
"Poisson Deviance",
"R Squared",
"RMSE",
"RMSLE",
"Tweedie Deviance",
null
],
"type": [
"string",
"null"
]
},
"reps": {
"default": null,
"description": "The number of cross validation folds to use for projects used to build new models.",
"maximum": 50,
"minimum": 2,
"type": [
"integer",
"null"
]
},
"validationPct": {
"default": null,
"description": "The percentage of dataset to assign to validation set in projects used to build new models.",
"maximum": 99,
"minimum": 1,
"type": [
"number",
"null"
]
},
"validationType": {
"description": "The validation type for projects used to build new models.",
"enum": [
"CV",
"TVH"
],
"type": "string"
}
},
"type": "object"
},
"projectOptionsStrategy": {
"description": "Configure the project option strategy used for modeling.",
"enum": [
"same_as_champion",
"override_champion",
"custom"
],
"type": "string"
},
"timeSeriesOptions": {
"description": "Time Series project option used to build new models.",
"properties": {
"calendarId": {
"description": "The ID of the calendar to be used in this project.",
"type": [
"string",
"null"
]
},
"differencingMethod": {
"description": "For time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems `simple` and `seasonal` are not allowed. Parameter `periodicities` must be specified if `seasonal` is chosen. Defaults to `auto`.",
"enum": [
"auto",
"none",
"simple",
"seasonal"
],
"type": [
"string",
"null"
]
},
"exponentiallyWeightedMovingAlpha": {
"description": "Discount factor (alpha) used for exponentially weighted moving features",
"exclusiveMinimum": 0,
"maximum": 1,
"type": [
"number",
"null"
]
},
"periodicities": {
"description": "A list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter 'differencing_method' will default to 'seasonal' if not provided or 'auto'.",
"items": {
"properties": {
"timeSteps": {
"description": "The number of time steps.",
"minimum": 0,
"type": "integer"
},
"timeUnit": {
"description": "The time unit or `ROW` if windowsBasisUnit is `ROW`",
"enum": [
"MILLISECOND",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"WEEK",
"MONTH",
"QUARTER",
"YEAR",
"ROW"
],
"type": "string"
}
},
"required": [
"timeSteps",
"timeUnit"
],
"type": "object"
},
"type": "array"
},
"treatAsExponential": {
"description": "For time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems `always` is not allowed. Defaults to `auto`.",
"enum": [
"auto",
"never",
"always"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"trigger": {
"description": "Retraining policy trigger.",
"properties": {
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"minIntervalBetweenRuns": {
"description": "Minimal interval between policy runs in ISO 8601 duration string.",
"type": [
"string",
"null"
]
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "The date(s) of the month that the job will run. Allowed values are either ``[1 ... 31]`` or ``[\"*\"]`` for all days of the month. This field is additive with ``dayOfWeek``, meaning the job will run both on the date(s) defined in this field and the day specified by ``dayOfWeek`` (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If ``dayOfMonth`` is set to ``[\"*\"]`` and ``dayOfWeek`` is defined, the scheduler will trigger on every day of the month that matches ``dayOfWeek`` (for example, Tuesday the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are ignored.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week that the job will run. Allowed values are ``[0 .. 6]``, where (Sunday=0), or ``[\"*\"]``, for all days of the week. Strings, either 3-letter abbreviations or the full name of the day, can be used interchangeably (e.g., \"sunday\", \"Sunday\", \"sun\", or \"Sun\", all map to ``[0]``. This field is additive with ``dayOfMonth``, meaning the job will run both on the date specified by ``dayOfMonth`` and the day defined in this field.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "The month(s) of the year that the job will run. Allowed values are either ``[1 ... 12]`` or ``[\"*\"]`` for all months of the year. Strings, either 3-letter abbreviations or the full name of the month, can be used interchangeably (e.g., \"jan\" or \"october\"). Months that are not compatible with ``dayOfMonth`` are ignored, for example ``{\"dayOfMonth\": [31], \"month\":[\"feb\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"statusDeclinesToFailing": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to failing.",
"type": "boolean"
},
"statusDeclinesToWarning": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to warning.",
"type": "boolean"
},
"statusStillInDecline": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status still in decline.",
"type": [
"boolean",
"null"
]
},
"type": {
"description": "Type of retraining policy trigger.",
"enum": [
"schedule",
"data_drift_decline",
"accuracy_decline",
"custom_job",
null
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"useCaseId": {
"description": "The ID of the use case to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
}
},
"required": [
"description",
"name"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| action | string | false | Configure the action to take on the resultant new model. | |
| autopilotOptions | AutopilotOptions | false | Options for projects used to build new models. | |
| customJobId | string,null | false | The ID of the custom job to be used in this policy. | |
| description | string,null | true | maxLength: 10000 |
Description of the retraining policy. |
| featureListStrategy | string | false | Configure the feature list strategy used for modeling. | |
| modelSelectionStrategy | string | false | Configure how new model is selected when the retraining policy runs. | |
| name | string | true | maxLength: 512 |
Name of the retraining policy. |
| projectOptions | ProjectOptions | false | Options for projects used to build new models. | |
| projectOptionsStrategy | string | false | Configure the project option strategy used for modeling. | |
| timeSeriesOptions | TimeSeriesOptions | false | Time Series project option used to build new models. | |
| trigger | Trigger | false | Retraining policy trigger. | |
| useCaseId | string,null | false | The ID of the use case to be used in this policy. |
Enumerated Values¶
| Property | Value |
|---|---|
| action | [create_challenger, create_model_package, model_replacement] |
| featureListStrategy | [informative_features, same_as_champion] |
| modelSelectionStrategy | [autopilot_recommended, same_blueprint, same_hyperparameters, custom_job] |
| projectOptionsStrategy | [same_as_champion, override_champion, custom] |
RetrainingPolicyListResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of retraining policies.",
"items": {
"properties": {
"action": {
"description": "Configure the action to take on the resultant new model.",
"enum": [
"create_challenger",
"create_model_package",
"model_replacement"
],
"type": "string"
},
"autopilotOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"blendBestModels": {
"description": "Blend best models during Autopilot run. This option is not supported in SHAP-only mode.",
"type": "boolean"
},
"mode": {
"description": "The autopilot mode.",
"enum": [
"auto",
"comprehensive",
"quick"
],
"type": "string"
},
"runLeakageRemovedFeatureList": {
"description": "Run Autopilot on Leakage Removed feature list (if exists).",
"type": "boolean"
},
"scoringCodeOnly": {
"description": "Keep only models that can be converted to scorable java code during Autopilot run.",
"type": "boolean"
},
"shapOnlyMode": {
"description": "Include only models with SHAP value support.",
"type": "boolean"
}
},
"type": "object"
},
"customJob": {
"description": "The ID, schedule, and last run for the custom job.",
"properties": {
"id": {
"description": "The ID of the custom job associated with the policy.",
"maxLength": 24,
"type": "string"
},
"lastRun": {
"description": "The ISO-8601 timestamp of when the custom job was last run.",
"maxLength": 256,
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the custom job run.",
"type": [
"string",
"null"
]
}
},
"required": [
"lastRun",
"status"
],
"type": "object",
"x-versionadded": "v2.37"
},
"description": {
"description": "Description of the retraining policy.",
"type": [
"string",
"null"
]
},
"featureListStrategy": {
"description": "Configure the feature list strategy used for modeling.",
"enum": [
"informative_features",
"same_as_champion"
],
"type": "string"
},
"id": {
"description": "ID of the retraining policy.",
"type": "string"
},
"latestRun": {
"description": "Latest run of the retraining policy.",
"properties": {
"challengerId": {
"description": "ID of the challenger created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"errorMessage": {
"description": "Error message of the retraining policy run.",
"type": [
"string",
"null"
]
},
"finishTime": {
"description": "Finish time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the retraining policy run.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"description": "ID of the model package created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "ID of the project created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"registeredModelId": {
"description": "ID of the registered model associated with model package created from this retraining policy run",
"type": [
"string",
"null"
]
},
"startTime": {
"description": "Start time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the retraining policy run.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case associated with the model package created from this retraining policy run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"challengerId",
"errorMessage",
"finishTime",
"id",
"modelPackageId",
"projectId",
"registeredModelId",
"startTime",
"status"
],
"type": "object"
},
"modelSelectionStrategy": {
"description": "Configure how new model is selected when the retraining policy runs.",
"enum": [
"autopilot_recommended",
"same_blueprint",
"same_hyperparameters",
"custom_job"
],
"type": "string"
},
"name": {
"description": "Name of the retraining policy.",
"type": "string"
},
"projectOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"cvMethod": {
"description": "The partitioning method for projects used to build new models.",
"enum": [
"RandomCV",
"StratifiedCV"
],
"type": "string"
},
"holdoutPct": {
"default": null,
"description": "The percentage of dataset to assign to holdout set in projects used to build new models.",
"maximum": 98,
"minimum": 0,
"type": [
"number",
"null"
]
},
"metric": {
"default": null,
"description": "The model selection metric in projects used to build new models.",
"enum": [
"Accuracy",
"AUC",
"Balanced Accuracy",
"FVE Binomial",
"Gini Norm",
"Kolmogorov-Smirnov",
"LogLoss",
"Rate@Top5%",
"Rate@Top10%",
"TPR",
"FPR",
"TNR",
"PPV",
"NPV",
"F1",
"MCC",
"FVE Gamma",
"FVE Poisson",
"FVE Tweedie",
"Gamma Deviance",
"MAE",
"MAPE",
"Poisson Deviance",
"R Squared",
"RMSE",
"RMSLE",
"Tweedie Deviance",
null
],
"type": [
"string",
"null"
]
},
"reps": {
"default": null,
"description": "The number of cross validation folds to use for projects used to build new models.",
"maximum": 50,
"minimum": 2,
"type": [
"integer",
"null"
]
},
"validationPct": {
"default": null,
"description": "The percentage of dataset to assign to validation set in projects used to build new models.",
"maximum": 99,
"minimum": 1,
"type": [
"number",
"null"
]
},
"validationType": {
"description": "The validation type for projects used to build new models.",
"enum": [
"CV",
"TVH"
],
"type": "string"
}
},
"type": "object"
},
"projectOptionsStrategy": {
"description": "Configure the project option strategy used for modeling.",
"enum": [
"same_as_champion",
"override_champion",
"custom"
],
"type": "string"
},
"timeSeriesOptions": {
"description": "Time Series project option used to build new models.",
"properties": {
"calendarId": {
"description": "The ID of the calendar to be used in this project.",
"type": [
"string",
"null"
]
},
"differencingMethod": {
"description": "For time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems `simple` and `seasonal` are not allowed. Parameter `periodicities` must be specified if `seasonal` is chosen. Defaults to `auto`.",
"enum": [
"auto",
"none",
"simple",
"seasonal"
],
"type": [
"string",
"null"
]
},
"exponentiallyWeightedMovingAlpha": {
"description": "Discount factor (alpha) used for exponentially weighted moving features",
"exclusiveMinimum": 0,
"maximum": 1,
"type": [
"number",
"null"
]
},
"periodicities": {
"description": "A list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter 'differencing_method' will default to 'seasonal' if not provided or 'auto'.",
"items": {
"properties": {
"timeSteps": {
"description": "The number of time steps.",
"minimum": 0,
"type": "integer"
},
"timeUnit": {
"description": "The time unit or `ROW` if windowsBasisUnit is `ROW`",
"enum": [
"MILLISECOND",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"WEEK",
"MONTH",
"QUARTER",
"YEAR",
"ROW"
],
"type": "string"
}
},
"required": [
"timeSteps",
"timeUnit"
],
"type": "object"
},
"type": "array"
},
"treatAsExponential": {
"description": "For time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems `always` is not allowed. Defaults to `auto`.",
"enum": [
"auto",
"never",
"always"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"trigger": {
"description": "Retraining policy trigger.",
"properties": {
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"minIntervalBetweenRuns": {
"description": "Minimal interval between policy runs in ISO 8601 duration string.",
"type": [
"string",
"null"
]
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "The date(s) of the month that the job will run. Allowed values are either ``[1 ... 31]`` or ``[\"*\"]`` for all days of the month. This field is additive with ``dayOfWeek``, meaning the job will run both on the date(s) defined in this field and the day specified by ``dayOfWeek`` (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If ``dayOfMonth`` is set to ``[\"*\"]`` and ``dayOfWeek`` is defined, the scheduler will trigger on every day of the month that matches ``dayOfWeek`` (for example, Tuesday the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are ignored.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week that the job will run. Allowed values are ``[0 .. 6]``, where (Sunday=0), or ``[\"*\"]``, for all days of the week. Strings, either 3-letter abbreviations or the full name of the day, can be used interchangeably (e.g., \"sunday\", \"Sunday\", \"sun\", or \"Sun\", all map to ``[0]``. This field is additive with ``dayOfMonth``, meaning the job will run both on the date specified by ``dayOfMonth`` and the day defined in this field.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "The month(s) of the year that the job will run. Allowed values are either ``[1 ... 12]`` or ``[\"*\"]`` for all months of the year. Strings, either 3-letter abbreviations or the full name of the month, can be used interchangeably (e.g., \"jan\" or \"october\"). Months that are not compatible with ``dayOfMonth`` are ignored, for example ``{\"dayOfMonth\": [31], \"month\":[\"feb\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"statusDeclinesToFailing": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to failing.",
"type": "boolean"
},
"statusDeclinesToWarning": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to warning.",
"type": "boolean"
},
"statusStillInDecline": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status still in decline.",
"type": [
"boolean",
"null"
]
},
"type": {
"description": "Type of retraining policy trigger.",
"enum": [
"schedule",
"data_drift_decline",
"accuracy_decline",
"custom_job",
null
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"useCase": {
"description": "The use case to link the retrained model to.",
"properties": {
"id": {
"description": "ID of the use case.",
"type": "string"
},
"name": {
"description": "Name of the use case.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object",
"x-versionadded": "v2.37"
}
},
"required": [
"action",
"autopilotOptions",
"description",
"id",
"latestRun",
"modelSelectionStrategy",
"name",
"projectOptions",
"trigger"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | Number of items returned on this page. | |
| data | [RetrainingPolicyRetrieve] | true | List of retraining policies. | |
| next | string,null(uri) | true | URL pointing to the next page (if null, there is no next page). | |
| previous | string,null(uri) | true | URL pointing to the previous page (if null, there is no previous page). | |
| totalCount | integer | true | The total number of items across all pages. |
RetrainingPolicyRetrieve
{
"properties": {
"action": {
"description": "Configure the action to take on the resultant new model.",
"enum": [
"create_challenger",
"create_model_package",
"model_replacement"
],
"type": "string"
},
"autopilotOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"blendBestModels": {
"description": "Blend best models during Autopilot run. This option is not supported in SHAP-only mode.",
"type": "boolean"
},
"mode": {
"description": "The autopilot mode.",
"enum": [
"auto",
"comprehensive",
"quick"
],
"type": "string"
},
"runLeakageRemovedFeatureList": {
"description": "Run Autopilot on Leakage Removed feature list (if exists).",
"type": "boolean"
},
"scoringCodeOnly": {
"description": "Keep only models that can be converted to scorable java code during Autopilot run.",
"type": "boolean"
},
"shapOnlyMode": {
"description": "Include only models with SHAP value support.",
"type": "boolean"
}
},
"type": "object"
},
"customJob": {
"description": "The ID, schedule, and last run for the custom job.",
"properties": {
"id": {
"description": "The ID of the custom job associated with the policy.",
"maxLength": 24,
"type": "string"
},
"lastRun": {
"description": "The ISO-8601 timestamp of when the custom job was last run.",
"maxLength": 256,
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the custom job run.",
"type": [
"string",
"null"
]
}
},
"required": [
"lastRun",
"status"
],
"type": "object",
"x-versionadded": "v2.37"
},
"description": {
"description": "Description of the retraining policy.",
"type": [
"string",
"null"
]
},
"featureListStrategy": {
"description": "Configure the feature list strategy used for modeling.",
"enum": [
"informative_features",
"same_as_champion"
],
"type": "string"
},
"id": {
"description": "ID of the retraining policy.",
"type": "string"
},
"latestRun": {
"description": "Latest run of the retraining policy.",
"properties": {
"challengerId": {
"description": "ID of the challenger created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"errorMessage": {
"description": "Error message of the retraining policy run.",
"type": [
"string",
"null"
]
},
"finishTime": {
"description": "Finish time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the retraining policy run.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"description": "ID of the model package created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "ID of the project created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"registeredModelId": {
"description": "ID of the registered model associated with model package created from this retraining policy run",
"type": [
"string",
"null"
]
},
"startTime": {
"description": "Start time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the retraining policy run.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case associated with the model package created from this retraining policy run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"challengerId",
"errorMessage",
"finishTime",
"id",
"modelPackageId",
"projectId",
"registeredModelId",
"startTime",
"status"
],
"type": "object"
},
"modelSelectionStrategy": {
"description": "Configure how new model is selected when the retraining policy runs.",
"enum": [
"autopilot_recommended",
"same_blueprint",
"same_hyperparameters",
"custom_job"
],
"type": "string"
},
"name": {
"description": "Name of the retraining policy.",
"type": "string"
},
"projectOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"cvMethod": {
"description": "The partitioning method for projects used to build new models.",
"enum": [
"RandomCV",
"StratifiedCV"
],
"type": "string"
},
"holdoutPct": {
"default": null,
"description": "The percentage of dataset to assign to holdout set in projects used to build new models.",
"maximum": 98,
"minimum": 0,
"type": [
"number",
"null"
]
},
"metric": {
"default": null,
"description": "The model selection metric in projects used to build new models.",
"enum": [
"Accuracy",
"AUC",
"Balanced Accuracy",
"FVE Binomial",
"Gini Norm",
"Kolmogorov-Smirnov",
"LogLoss",
"Rate@Top5%",
"Rate@Top10%",
"TPR",
"FPR",
"TNR",
"PPV",
"NPV",
"F1",
"MCC",
"FVE Gamma",
"FVE Poisson",
"FVE Tweedie",
"Gamma Deviance",
"MAE",
"MAPE",
"Poisson Deviance",
"R Squared",
"RMSE",
"RMSLE",
"Tweedie Deviance",
null
],
"type": [
"string",
"null"
]
},
"reps": {
"default": null,
"description": "The number of cross validation folds to use for projects used to build new models.",
"maximum": 50,
"minimum": 2,
"type": [
"integer",
"null"
]
},
"validationPct": {
"default": null,
"description": "The percentage of dataset to assign to validation set in projects used to build new models.",
"maximum": 99,
"minimum": 1,
"type": [
"number",
"null"
]
},
"validationType": {
"description": "The validation type for projects used to build new models.",
"enum": [
"CV",
"TVH"
],
"type": "string"
}
},
"type": "object"
},
"projectOptionsStrategy": {
"description": "Configure the project option strategy used for modeling.",
"enum": [
"same_as_champion",
"override_champion",
"custom"
],
"type": "string"
},
"timeSeriesOptions": {
"description": "Time Series project option used to build new models.",
"properties": {
"calendarId": {
"description": "The ID of the calendar to be used in this project.",
"type": [
"string",
"null"
]
},
"differencingMethod": {
"description": "For time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems `simple` and `seasonal` are not allowed. Parameter `periodicities` must be specified if `seasonal` is chosen. Defaults to `auto`.",
"enum": [
"auto",
"none",
"simple",
"seasonal"
],
"type": [
"string",
"null"
]
},
"exponentiallyWeightedMovingAlpha": {
"description": "Discount factor (alpha) used for exponentially weighted moving features",
"exclusiveMinimum": 0,
"maximum": 1,
"type": [
"number",
"null"
]
},
"periodicities": {
"description": "A list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter 'differencing_method' will default to 'seasonal' if not provided or 'auto'.",
"items": {
"properties": {
"timeSteps": {
"description": "The number of time steps.",
"minimum": 0,
"type": "integer"
},
"timeUnit": {
"description": "The time unit or `ROW` if windowsBasisUnit is `ROW`",
"enum": [
"MILLISECOND",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"WEEK",
"MONTH",
"QUARTER",
"YEAR",
"ROW"
],
"type": "string"
}
},
"required": [
"timeSteps",
"timeUnit"
],
"type": "object"
},
"type": "array"
},
"treatAsExponential": {
"description": "For time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems `always` is not allowed. Defaults to `auto`.",
"enum": [
"auto",
"never",
"always"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"trigger": {
"description": "Retraining policy trigger.",
"properties": {
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"minIntervalBetweenRuns": {
"description": "Minimal interval between policy runs in ISO 8601 duration string.",
"type": [
"string",
"null"
]
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "The date(s) of the month that the job will run. Allowed values are either ``[1 ... 31]`` or ``[\"*\"]`` for all days of the month. This field is additive with ``dayOfWeek``, meaning the job will run both on the date(s) defined in this field and the day specified by ``dayOfWeek`` (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If ``dayOfMonth`` is set to ``[\"*\"]`` and ``dayOfWeek`` is defined, the scheduler will trigger on every day of the month that matches ``dayOfWeek`` (for example, Tuesday the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are ignored.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week that the job will run. Allowed values are ``[0 .. 6]``, where (Sunday=0), or ``[\"*\"]``, for all days of the week. Strings, either 3-letter abbreviations or the full name of the day, can be used interchangeably (e.g., \"sunday\", \"Sunday\", \"sun\", or \"Sun\", all map to ``[0]``. This field is additive with ``dayOfMonth``, meaning the job will run both on the date specified by ``dayOfMonth`` and the day defined in this field.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "The month(s) of the year that the job will run. Allowed values are either ``[1 ... 12]`` or ``[\"*\"]`` for all months of the year. Strings, either 3-letter abbreviations or the full name of the month, can be used interchangeably (e.g., \"jan\" or \"october\"). Months that are not compatible with ``dayOfMonth`` are ignored, for example ``{\"dayOfMonth\": [31], \"month\":[\"feb\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"statusDeclinesToFailing": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to failing.",
"type": "boolean"
},
"statusDeclinesToWarning": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to warning.",
"type": "boolean"
},
"statusStillInDecline": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status still in decline.",
"type": [
"boolean",
"null"
]
},
"type": {
"description": "Type of retraining policy trigger.",
"enum": [
"schedule",
"data_drift_decline",
"accuracy_decline",
"custom_job",
null
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"useCase": {
"description": "The use case to link the retrained model to.",
"properties": {
"id": {
"description": "ID of the use case.",
"type": "string"
},
"name": {
"description": "Name of the use case.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object",
"x-versionadded": "v2.37"
}
},
"required": [
"action",
"autopilotOptions",
"description",
"id",
"latestRun",
"modelSelectionStrategy",
"name",
"projectOptions",
"trigger"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| action | string | true | Configure the action to take on the resultant new model. | |
| autopilotOptions | AutopilotOptions | true | Options for projects used to build new models. | |
| customJob | CustomRetrainingJob | false | The ID, schedule, and last run for the custom job. | |
| description | string,null | true | Description of the retraining policy. | |
| featureListStrategy | string | false | Configure the feature list strategy used for modeling. | |
| id | string | true | ID of the retraining policy. | |
| latestRun | RetrainingPolicyRunRetrieve | true | Latest run of the retraining policy. | |
| modelSelectionStrategy | string | true | Configure how new model is selected when the retraining policy runs. | |
| name | string | true | Name of the retraining policy. | |
| projectOptions | ProjectOptions | true | Options for projects used to build new models. | |
| projectOptionsStrategy | string | false | Configure the project option strategy used for modeling. | |
| timeSeriesOptions | TimeSeriesOptions | false | Time Series project option used to build new models. | |
| trigger | Trigger | true | Retraining policy trigger. | |
| useCase | RetrainingUseCase | false | The use case to link the retrained model to. |
Enumerated Values¶
| Property | Value |
|---|---|
| action | [create_challenger, create_model_package, model_replacement] |
| featureListStrategy | [informative_features, same_as_champion] |
| modelSelectionStrategy | [autopilot_recommended, same_blueprint, same_hyperparameters, custom_job] |
| projectOptionsStrategy | [same_as_champion, override_champion, custom] |
RetrainingPolicyRunListResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of retraining policy runs.",
"items": {
"description": "Latest run of the retraining policy.",
"properties": {
"challengerId": {
"description": "ID of the challenger created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"errorMessage": {
"description": "Error message of the retraining policy run.",
"type": [
"string",
"null"
]
},
"finishTime": {
"description": "Finish time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the retraining policy run.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"description": "ID of the model package created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "ID of the project created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"registeredModelId": {
"description": "ID of the registered model associated with model package created from this retraining policy run",
"type": [
"string",
"null"
]
},
"startTime": {
"description": "Start time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the retraining policy run.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case associated with the model package created from this retraining policy run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"challengerId",
"errorMessage",
"finishTime",
"id",
"modelPackageId",
"projectId",
"registeredModelId",
"startTime",
"status"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | Number of items returned on this page. | |
| data | [RetrainingPolicyRunRetrieve] | true | List of retraining policy runs. | |
| next | string,null(uri) | true | URL pointing to the next page (if null, there is no next page). | |
| previous | string,null(uri) | true | URL pointing to the previous page (if null, there is no previous page). | |
| totalCount | integer | true | The total number of items across all pages. |
RetrainingPolicyRunRetrieve
{
"description": "Latest run of the retraining policy.",
"properties": {
"challengerId": {
"description": "ID of the challenger created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"errorMessage": {
"description": "Error message of the retraining policy run.",
"type": [
"string",
"null"
]
},
"finishTime": {
"description": "Finish time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the retraining policy run.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"description": "ID of the model package created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "ID of the project created from this retraining policy run.",
"type": [
"string",
"null"
]
},
"registeredModelId": {
"description": "ID of the registered model associated with model package created from this retraining policy run",
"type": [
"string",
"null"
]
},
"startTime": {
"description": "Start time of the retraining policy run.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Status of the retraining policy run.",
"type": [
"string",
"null"
]
},
"useCaseId": {
"description": "The ID of the Use Case associated with the model package created from this retraining policy run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"challengerId",
"errorMessage",
"finishTime",
"id",
"modelPackageId",
"projectId",
"registeredModelId",
"startTime",
"status"
],
"type": "object"
}
Latest run of the retraining policy.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| challengerId | string,null | true | ID of the challenger created from this retraining policy run. | |
| errorMessage | string,null | true | Error message of the retraining policy run. | |
| finishTime | string,null(date-time) | true | Finish time of the retraining policy run. | |
| id | string,null | true | ID of the retraining policy run. | |
| modelPackageId | string,null | true | ID of the model package created from this retraining policy run. | |
| projectId | string,null | true | ID of the project created from this retraining policy run. | |
| registeredModelId | string,null | true | ID of the registered model associated with model package created from this retraining policy run | |
| startTime | string,null(date-time) | true | Start time of the retraining policy run. | |
| status | string,null | true | Status of the retraining policy run. | |
| useCaseId | string,null | false | The ID of the Use Case associated with the model package created from this retraining policy run. |
RetrainingPolicyRunUpdate
{
"properties": {
"status": {
"description": "New status of the retraining policy.",
"enum": [
"cancelled"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| status | string | true | New status of the retraining policy. |
Enumerated Values¶
| Property | Value |
|---|---|
| status | cancelled |
RetrainingPolicyUpdate
{
"properties": {
"action": {
"description": "Configure the action to take on the resultant new model.",
"enum": [
"create_challenger",
"create_model_package",
"model_replacement"
],
"type": "string"
},
"autopilotOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"blendBestModels": {
"description": "Blend best models during Autopilot run. This option is not supported in SHAP-only mode.",
"type": "boolean"
},
"mode": {
"description": "The autopilot mode.",
"enum": [
"auto",
"comprehensive",
"quick"
],
"type": "string"
},
"runLeakageRemovedFeatureList": {
"description": "Run Autopilot on Leakage Removed feature list (if exists).",
"type": "boolean"
},
"scoringCodeOnly": {
"description": "Keep only models that can be converted to scorable java code during Autopilot run.",
"type": "boolean"
},
"shapOnlyMode": {
"description": "Include only models with SHAP value support.",
"type": "boolean"
}
},
"type": "object"
},
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"description": {
"description": "Description of the retraining policy.",
"maxLength": 10000,
"type": [
"string",
"null"
]
},
"featureListStrategy": {
"description": "Configure the feature list strategy used for modeling.",
"enum": [
"informative_features",
"same_as_champion"
],
"type": "string"
},
"modelSelectionStrategy": {
"description": "Configure how new model is selected when the retraining policy runs.",
"enum": [
"autopilot_recommended",
"same_blueprint",
"same_hyperparameters",
"custom_job"
],
"type": "string"
},
"name": {
"description": "Name of the retraining policy.",
"maxLength": 512,
"type": "string"
},
"projectOptions": {
"description": "Options for projects used to build new models.",
"properties": {
"cvMethod": {
"description": "The partitioning method for projects used to build new models.",
"enum": [
"RandomCV",
"StratifiedCV"
],
"type": "string"
},
"holdoutPct": {
"default": null,
"description": "The percentage of dataset to assign to holdout set in projects used to build new models.",
"maximum": 98,
"minimum": 0,
"type": [
"number",
"null"
]
},
"metric": {
"default": null,
"description": "The model selection metric in projects used to build new models.",
"enum": [
"Accuracy",
"AUC",
"Balanced Accuracy",
"FVE Binomial",
"Gini Norm",
"Kolmogorov-Smirnov",
"LogLoss",
"Rate@Top5%",
"Rate@Top10%",
"TPR",
"FPR",
"TNR",
"PPV",
"NPV",
"F1",
"MCC",
"FVE Gamma",
"FVE Poisson",
"FVE Tweedie",
"Gamma Deviance",
"MAE",
"MAPE",
"Poisson Deviance",
"R Squared",
"RMSE",
"RMSLE",
"Tweedie Deviance",
null
],
"type": [
"string",
"null"
]
},
"reps": {
"default": null,
"description": "The number of cross validation folds to use for projects used to build new models.",
"maximum": 50,
"minimum": 2,
"type": [
"integer",
"null"
]
},
"validationPct": {
"default": null,
"description": "The percentage of dataset to assign to validation set in projects used to build new models.",
"maximum": 99,
"minimum": 1,
"type": [
"number",
"null"
]
},
"validationType": {
"description": "The validation type for projects used to build new models.",
"enum": [
"CV",
"TVH"
],
"type": "string"
}
},
"type": "object"
},
"projectOptionsStrategy": {
"description": "Configure the project option strategy used for modeling.",
"enum": [
"same_as_champion",
"override_champion",
"custom"
],
"type": "string"
},
"timeSeriesOptions": {
"description": "Time Series project option used to build new models.",
"properties": {
"calendarId": {
"description": "The ID of the calendar to be used in this project.",
"type": [
"string",
"null"
]
},
"differencingMethod": {
"description": "For time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems `simple` and `seasonal` are not allowed. Parameter `periodicities` must be specified if `seasonal` is chosen. Defaults to `auto`.",
"enum": [
"auto",
"none",
"simple",
"seasonal"
],
"type": [
"string",
"null"
]
},
"exponentiallyWeightedMovingAlpha": {
"description": "Discount factor (alpha) used for exponentially weighted moving features",
"exclusiveMinimum": 0,
"maximum": 1,
"type": [
"number",
"null"
]
},
"periodicities": {
"description": "A list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter 'differencing_method' will default to 'seasonal' if not provided or 'auto'.",
"items": {
"properties": {
"timeSteps": {
"description": "The number of time steps.",
"minimum": 0,
"type": "integer"
},
"timeUnit": {
"description": "The time unit or `ROW` if windowsBasisUnit is `ROW`",
"enum": [
"MILLISECOND",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"WEEK",
"MONTH",
"QUARTER",
"YEAR",
"ROW"
],
"type": "string"
}
},
"required": [
"timeSteps",
"timeUnit"
],
"type": "object"
},
"type": "array"
},
"treatAsExponential": {
"description": "For time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems `always` is not allowed. Defaults to `auto`.",
"enum": [
"auto",
"never",
"always"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"trigger": {
"description": "Retraining policy trigger.",
"properties": {
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"minIntervalBetweenRuns": {
"description": "Minimal interval between policy runs in ISO 8601 duration string.",
"type": [
"string",
"null"
]
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "The date(s) of the month that the job will run. Allowed values are either ``[1 ... 31]`` or ``[\"*\"]`` for all days of the month. This field is additive with ``dayOfWeek``, meaning the job will run both on the date(s) defined in this field and the day specified by ``dayOfWeek`` (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If ``dayOfMonth`` is set to ``[\"*\"]`` and ``dayOfWeek`` is defined, the scheduler will trigger on every day of the month that matches ``dayOfWeek`` (for example, Tuesday the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are ignored.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week that the job will run. Allowed values are ``[0 .. 6]``, where (Sunday=0), or ``[\"*\"]``, for all days of the week. Strings, either 3-letter abbreviations or the full name of the day, can be used interchangeably (e.g., \"sunday\", \"Sunday\", \"sun\", or \"Sun\", all map to ``[0]``. This field is additive with ``dayOfMonth``, meaning the job will run both on the date specified by ``dayOfMonth`` and the day defined in this field.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "The month(s) of the year that the job will run. Allowed values are either ``[1 ... 12]`` or ``[\"*\"]`` for all months of the year. Strings, either 3-letter abbreviations or the full name of the month, can be used interchangeably (e.g., \"jan\" or \"october\"). Months that are not compatible with ``dayOfMonth`` are ignored, for example ``{\"dayOfMonth\": [31], \"month\":[\"feb\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"statusDeclinesToFailing": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to failing.",
"type": "boolean"
},
"statusDeclinesToWarning": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to warning.",
"type": "boolean"
},
"statusStillInDecline": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status still in decline.",
"type": [
"boolean",
"null"
]
},
"type": {
"description": "Type of retraining policy trigger.",
"enum": [
"schedule",
"data_drift_decline",
"accuracy_decline",
"custom_job",
null
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"useCaseId": {
"description": "The ID of the use case to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
}
},
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| action | string | false | Configure the action to take on the resultant new model. | |
| autopilotOptions | AutopilotOptions | false | Options for projects used to build new models. | |
| customJobId | string,null | false | The ID of the custom job to be used in this policy. | |
| description | string,null | false | maxLength: 10000 |
Description of the retraining policy. |
| featureListStrategy | string | false | Configure the feature list strategy used for modeling. | |
| modelSelectionStrategy | string | false | Configure how new model is selected when the retraining policy runs. | |
| name | string | false | maxLength: 512 |
Name of the retraining policy. |
| projectOptions | ProjectOptions | false | Options for projects used to build new models. | |
| projectOptionsStrategy | string | false | Configure the project option strategy used for modeling. | |
| timeSeriesOptions | TimeSeriesOptions | false | Time Series project option used to build new models. | |
| trigger | Trigger | false | Retraining policy trigger. | |
| useCaseId | string,null | false | The ID of the use case to be used in this policy. |
Enumerated Values¶
| Property | Value |
|---|---|
| action | [create_challenger, create_model_package, model_replacement] |
| featureListStrategy | [informative_features, same_as_champion] |
| modelSelectionStrategy | [autopilot_recommended, same_blueprint, same_hyperparameters, custom_job] |
| projectOptionsStrategy | [same_as_champion, override_champion, custom] |
RetrainingSettingsRetrieve
{
"properties": {
"dataset": {
"description": "The dataset that will be used as retraining data.",
"properties": {
"id": {
"description": "ID of the retraining dataset.",
"type": "string"
},
"name": {
"description": "Name of the retraining dataset.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"predictionEnvironment": {
"description": "The prediction environment that will be associated with the challengers created by retraining policies.",
"properties": {
"id": {
"description": "ID of the prediction environment.",
"type": "string"
},
"name": {
"description": "Name of the prediction environment.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"retrainingUser": {
"description": "The user scheduled retraining will be performed on behalf of.",
"properties": {
"id": {
"description": "ID of the scheduled retraining user.",
"type": "string"
},
"username": {
"description": "Username of the scheduled retraining user.",
"type": "string"
}
},
"required": [
"id",
"username"
],
"type": "object"
}
},
"required": [
"dataset",
"predictionEnvironment",
"retrainingUser"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dataset | Dataset | true | The dataset that will be used as retraining data. | |
| predictionEnvironment | PredictionEnvironment | true | The prediction environment that will be associated with the challengers created by retraining policies. | |
| retrainingUser | RetrainingUser | true | The user scheduled retraining will be performed on behalf of. |
RetrainingSettingsUpdate
{
"properties": {
"credentialId": {
"description": "ID of the credential used to refresh retraining dataset.",
"type": [
"string",
"null"
]
},
"datasetId": {
"description": "ID of the retraining dataset.",
"type": [
"string",
"null"
]
},
"predictionEnvironmentId": {
"description": "ID of the prediction environment to associate with the challengers created by retraining policies.",
"type": [
"string",
"null"
]
},
"retrainingUserId": {
"description": "ID of the retraining user.",
"type": "string"
}
},
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| credentialId | string,null | false | ID of the credential used to refresh retraining dataset. | |
| datasetId | string,null | false | ID of the retraining dataset. | |
| predictionEnvironmentId | string,null | false | ID of the prediction environment to associate with the challengers created by retraining policies. | |
| retrainingUserId | string | false | ID of the retraining user. |
RetrainingUseCase
{
"description": "The use case to link the retrained model to.",
"properties": {
"id": {
"description": "ID of the use case.",
"type": "string"
},
"name": {
"description": "Name of the use case.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object",
"x-versionadded": "v2.37"
}
The use case to link the retrained model to.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | ID of the use case. | |
| name | string | true | Name of the use case. |
RetrainingUser
{
"description": "The user scheduled retraining will be performed on behalf of.",
"properties": {
"id": {
"description": "ID of the scheduled retraining user.",
"type": "string"
},
"username": {
"description": "Username of the scheduled retraining user.",
"type": "string"
}
},
"required": [
"id",
"username"
],
"type": "object"
}
The user scheduled retraining will be performed on behalf of.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | ID of the scheduled retraining user. | |
| username | string | true | Username of the scheduled retraining user. |
Schedule
{
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "The date(s) of the month that the job will run. Allowed values are either ``[1 ... 31]`` or ``[\"*\"]`` for all days of the month. This field is additive with ``dayOfWeek``, meaning the job will run both on the date(s) defined in this field and the day specified by ``dayOfWeek`` (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If ``dayOfMonth`` is set to ``[\"*\"]`` and ``dayOfWeek`` is defined, the scheduler will trigger on every day of the month that matches ``dayOfWeek`` (for example, Tuesday the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are ignored.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week that the job will run. Allowed values are ``[0 .. 6]``, where (Sunday=0), or ``[\"*\"]``, for all days of the week. Strings, either 3-letter abbreviations or the full name of the day, can be used interchangeably (e.g., \"sunday\", \"Sunday\", \"sun\", or \"Sun\", all map to ``[0]``. This field is additive with ``dayOfMonth``, meaning the job will run both on the date specified by ``dayOfMonth`` and the day defined in this field.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "The month(s) of the year that the job will run. Allowed values are either ``[1 ... 12]`` or ``[\"*\"]`` for all months of the year. Strings, either 3-letter abbreviations or the full name of the month, can be used interchangeably (e.g., \"jan\" or \"october\"). Months that are not compatible with ``dayOfMonth`` are ignored, for example ``{\"dayOfMonth\": [31], \"month\":[\"feb\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
}
The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dayOfMonth | [number,string] | true | maxItems: 31 |
The date(s) of the month that the job will run. Allowed values are either [1 ... 31] or ["*"] for all days of the month. This field is additive with dayOfWeek, meaning the job will run both on the date(s) defined in this field and the day specified by dayOfWeek (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If dayOfMonth is set to ["*"] and dayOfWeek is defined, the scheduler will trigger on every day of the month that matches dayOfWeek (for example, Tuesday the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are ignored. |
| dayOfWeek | [number,string] | true | maxItems: 7 |
The day(s) of the week that the job will run. Allowed values are [0 .. 6], where (Sunday=0), or ["*"], for all days of the week. Strings, either 3-letter abbreviations or the full name of the day, can be used interchangeably (e.g., "sunday", "Sunday", "sun", or "Sun", all map to [0]. This field is additive with dayOfMonth, meaning the job will run both on the date specified by dayOfMonth and the day defined in this field. |
| hour | [number,string] | true | maxItems: 24 |
The hour(s) of the day that the job will run. Allowed values are either ["*"] meaning every hour of the day or [0 ... 23]. |
| minute | [number,string] | true | maxItems: 60 |
The minute(s) of the day that the job will run. Allowed values are either ["*"] meaning every minute of the day or[0 ... 59]. |
| month | [number,string] | true | maxItems: 12 |
The month(s) of the year that the job will run. Allowed values are either [1 ... 12] or ["*"] for all months of the year. Strings, either 3-letter abbreviations or the full name of the month, can be used interchangeably (e.g., "jan" or "october"). Months that are not compatible with dayOfMonth are ignored, for example {"dayOfMonth": [31], "month":["feb"]}. |
TimeSeriesOptions
{
"description": "Time Series project option used to build new models.",
"properties": {
"calendarId": {
"description": "The ID of the calendar to be used in this project.",
"type": [
"string",
"null"
]
},
"differencingMethod": {
"description": "For time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems `simple` and `seasonal` are not allowed. Parameter `periodicities` must be specified if `seasonal` is chosen. Defaults to `auto`.",
"enum": [
"auto",
"none",
"simple",
"seasonal"
],
"type": [
"string",
"null"
]
},
"exponentiallyWeightedMovingAlpha": {
"description": "Discount factor (alpha) used for exponentially weighted moving features",
"exclusiveMinimum": 0,
"maximum": 1,
"type": [
"number",
"null"
]
},
"periodicities": {
"description": "A list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter 'differencing_method' will default to 'seasonal' if not provided or 'auto'.",
"items": {
"properties": {
"timeSteps": {
"description": "The number of time steps.",
"minimum": 0,
"type": "integer"
},
"timeUnit": {
"description": "The time unit or `ROW` if windowsBasisUnit is `ROW`",
"enum": [
"MILLISECOND",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"WEEK",
"MONTH",
"QUARTER",
"YEAR",
"ROW"
],
"type": "string"
}
},
"required": [
"timeSteps",
"timeUnit"
],
"type": "object"
},
"type": "array"
},
"treatAsExponential": {
"description": "For time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems `always` is not allowed. Defaults to `auto`.",
"enum": [
"auto",
"never",
"always"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
}
Time Series project option used to build new models.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| calendarId | string,null | false | The ID of the calendar to be used in this project. | |
| differencingMethod | string,null | false | For time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems simple and seasonal are not allowed. Parameter periodicities must be specified if seasonal is chosen. Defaults to auto. |
|
| exponentiallyWeightedMovingAlpha | number,null | false | maximum: 1 |
Discount factor (alpha) used for exponentially weighted moving features |
| periodicities | [Periodicity] | false | A list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter 'differencing_method' will default to 'seasonal' if not provided or 'auto'. | |
| treatAsExponential | string,null | false | For time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems always is not allowed. Defaults to auto. |
Enumerated Values¶
| Property | Value |
|---|---|
| differencingMethod | [auto, none, simple, seasonal] |
| treatAsExponential | [auto, never, always] |
Trigger
{
"description": "Retraining policy trigger.",
"properties": {
"customJobId": {
"description": "The ID of the custom job to be used in this policy.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.37"
},
"minIntervalBetweenRuns": {
"description": "Minimal interval between policy runs in ISO 8601 duration string.",
"type": [
"string",
"null"
]
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "The date(s) of the month that the job will run. Allowed values are either ``[1 ... 31]`` or ``[\"*\"]`` for all days of the month. This field is additive with ``dayOfWeek``, meaning the job will run both on the date(s) defined in this field and the day specified by ``dayOfWeek`` (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If ``dayOfMonth`` is set to ``[\"*\"]`` and ``dayOfWeek`` is defined, the scheduler will trigger on every day of the month that matches ``dayOfWeek`` (for example, Tuesday the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are ignored.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week that the job will run. Allowed values are ``[0 .. 6]``, where (Sunday=0), or ``[\"*\"]``, for all days of the week. Strings, either 3-letter abbreviations or the full name of the day, can be used interchangeably (e.g., \"sunday\", \"Sunday\", \"sun\", or \"Sun\", all map to ``[0]``. This field is additive with ``dayOfMonth``, meaning the job will run both on the date specified by ``dayOfMonth`` and the day defined in this field.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "The month(s) of the year that the job will run. Allowed values are either ``[1 ... 12]`` or ``[\"*\"]`` for all months of the year. Strings, either 3-letter abbreviations or the full name of the month, can be used interchangeably (e.g., \"jan\" or \"october\"). Months that are not compatible with ``dayOfMonth`` are ignored, for example ``{\"dayOfMonth\": [31], \"month\":[\"feb\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"statusDeclinesToFailing": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to failing.",
"type": "boolean"
},
"statusDeclinesToWarning": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to warning.",
"type": "boolean"
},
"statusStillInDecline": {
"description": "Identifies when trigger type is based on deployment a health status, whether the policy will run when health status still in decline.",
"type": [
"boolean",
"null"
]
},
"type": {
"description": "Type of retraining policy trigger.",
"enum": [
"schedule",
"data_drift_decline",
"accuracy_decline",
"custom_job",
null
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
Retraining policy trigger.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customJobId | string,null | false | The ID of the custom job to be used in this policy. | |
| minIntervalBetweenRuns | string,null | false | Minimal interval between policy runs in ISO 8601 duration string. | |
| schedule | Schedule | false | The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False. | |
| statusDeclinesToFailing | boolean | false | Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to failing. | |
| statusDeclinesToWarning | boolean | false | Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to warning. | |
| statusStillInDecline | boolean,null | false | Identifies when trigger type is based on deployment a health status, whether the policy will run when health status still in decline. | |
| type | string | true | Type of retraining policy trigger. |
Enumerated Values¶
| Property | Value |
|---|---|
| type | [schedule, data_drift_decline, accuracy_decline, custom_job, null] |