Deployments
This page outlines the operations, endpoints, parameters, and example requests and responses for the Deployments.
GET /api/v2/deletedDeployments/
List deleted deployments.Only available as part of an enterprise (on-prem) installation. Requires a CAN_DELETE_APP_PROJECTS permission to execute.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deletedDeployments/?offset= 0 & limit = 20 \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
offset
query
integer
true
The number of deleted deployments to skip.
limit
query
integer
true
The number of deleted deployments to return.
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"deletedAt" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"label" : "string"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deletedDeployments/
Permanently erase data for deleted deployments. Only available as part of an on-premise or private/hybrid cloud deployment. Requires a CAN_DELETE_APP_PROJECTS permission to execute.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deletedDeployments/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"action" : "PermanentlyErase" ,
"deploymentIds" : [
"string"
]
}
Parameters
Responses
Status
Meaning
Description
Schema
202
Accepted
Job submitted. See Location header.
None
Status
Header
Type
Format
Description
202
Location
string
URL for tracking deployment permanently erase job status.
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/
List deployments a user can view.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/?offset= 0 & limit = 20 \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
offset
query
integer
true
The number of deployments to skip. Defaults to 0.
limit
query
integer
true
The number of deployments (greater than zero, max 100) to return. Defaults to 20.
orderBy
query
string
false
The order to sort the deployments.Defaults to order by deployment last prediction timestamp in descending order.
search
query
string
false
Case insensitive search against deployment's label and description.
serviceHealth
query
array[string]
false
Filters deployments by their service health status.
modelHealth
query
array[string]
false
Filters deployments by their model health status.
accuracyHealth
query
array[string]
false
Filters deployments by their accuracy health status.
role
query
string
false
Filter deployments to only those that the authenticated user has the specified role for.
status
query
array[string]
false
Filters deployments by their status
importance
query
array[string]
false
Filters deployments by their importance
lastPredictionTimestampStart
query
string(date-time)
false
Only include deployments that have had a prediction request on or after the specified timestamp.
lastPredictionTimestampEnd
query
string(date-time)
false
Only include deployments that have had a prediction request before the specified timestamp.
predictionUsageDailyAvgGreaterThan
query
integer
false
only include deployments that have had more than the specified number of predictions per day on average over the past week.
predictionUsageDailyAvgLessThan
query
integer
false
Only include deployments that have had fewer than the specified number of predictions per day on average over the past week.
defaultPredictionServerId
query
array[string]
false
Filter deployments to those whose default prediction server has the specified id.
buildEnvironmentType
query
array[string]
false
Filter deployments based on the type of their current model's build environment type.
executionEnvironmentType
query
array[string]
false
Filter deployments based on the type of their execution environment.
predictionEnvironmentPlatform
query
array[string]
false
Filter deployments based on prediction environment platform
hasDecisionFlow
query
string
false
Filter deployments based if it is a decision flow
createdByMe
query
string
false
Filter deployments to those created by the current user.
Enumerated Values
Parameter
Value
orderBy
[label
, -label
, serviceHealth
, -serviceHealth
, modelHealth
, -modelHealth
, accuracyHealth
, -accuracyHealth
, recentPredictions
, -recentPredictions
, lastPredictionTimestamp
, -lastPredictionTimestamp
, currentModelDeployedTimestamp
, -currentModelDeployedTimestamp
, createdAtTimestamp
, -createdAtTimestamp
, importance
, -importance
, fairnessHealth
, -fairnessHealth
, customMetricsHealth
, -customMetricsHealth
, actualsTimelinessHealth
, -actualsTimelinessHealth
, predictionsTimelinessHealth
, -predictionsTimelinessHealth
]
serviceHealth
[failing
, not_started
, passing
, unavailable
, unknown
, warning
]
modelHealth
[failing
, not_started
, passing
, unavailable
, unknown
, warning
]
accuracyHealth
[failing
, not_started
, passing
, unavailable
, unknown
, warning
]
role
[OWNER
, USER
]
status
[active
, archived
, errored
, inactive
, launching
, replacingModel
, stopping
]
importance
[CRITICAL
, HIGH
, MODERATE
, LOW
]
buildEnvironmentType
[DataRobot
, Python
, R
, Java
, Julia
, Legacy
, Other
]
executionEnvironmentType
[datarobot
, external
]
predictionEnvironmentPlatform
[aws
, gcp
, azure
, onPremise
, datarobot
, datarobotServerless
, openShift
, other
, snowflake
]
hasDecisionFlow
[false
, False
, true
, True
]
createdByMe
[false
, False
, true
, True
]
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"accuracyHealth" : {
"endDate" : "2019-08-24T14:15:22Z" ,
"message" : "string" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
},
"approvalStatus" : "PENDING" ,
"capabilities" : {
"supportsAutomaticActuals" : true ,
"supportsChallengerModels" : true ,
"supportsFeatureDriftTracking" : true ,
"supportsFeatureTypeInfoValidation" : true ,
"supportsHumilityRecommendedRules" : true ,
"supportsHumilityRules" : true ,
"supportsHumilityRulesDefaultCalculations" : true ,
"supportsModelReplacement" : true ,
"supportsPortablePredictionServer" : true ,
"supportsPredictionIntervals" : true ,
"supportsPredictionWarning" : true ,
"supportsRetraining" : true ,
"supportsScoringCodeDownload" : true ,
"supportsSecondaryDatasets" : true ,
"supportsSegmentedAnalysisDriftAndAccuracy" : true ,
"supportsShapBasedPredictionExplanations" : true ,
"supportsTargetDriftTracking" : true
},
"createdAt" : "2019-08-24T14:15:22Z" ,
"defaultPredictionServer" : {
"datarobot-key" : "string" ,
"id" : "string" ,
"url" : "string"
},
"description" : "string" ,
"governance" : {
"approvalStatus" : "PENDING" ,
"hasOpenedChangeRequests" : true
},
"hasError" : true ,
"id" : "string" ,
"importance" : "CRITICAL" ,
"label" : "string" ,
"model" : {
"buildEnvironmentType" : "string" ,
"customModelImage" : {
"customModelId" : "string" ,
"customModelName" : "string" ,
"customModelVersionId" : "string" ,
"customModelVersionLabel" : "string" ,
"executionEnvironmentId" : "string" ,
"executionEnvironmentName" : "string" ,
"executionEnvironmentVersionId" : "string" ,
"executionEnvironmentVersionLabel" : "string"
},
"decisionFlowId" : "string" ,
"decisionFlowVersionId" : "string" ,
"deployedAt" : "2019-08-24T14:15:22Z" ,
"hasDecisionFlow" : true ,
"id" : "string" ,
"isDeprecated" : true ,
"projectId" : "string" ,
"projectName" : "string" ,
"targetName" : "string" ,
"targetType" : "string" ,
"type" : "string" ,
"unstructuredModelKind" : true ,
"unsupervisedMode" : true ,
"unsupervisedType" : "anomaly"
},
"modelHealth" : {
"endDate" : "2019-08-24T14:15:22Z" ,
"message" : "string" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
},
"modelPackage" : {
"id" : "string" ,
"name" : "string" ,
"registeredModelId" : "string"
},
"modelPackageInitialDownload" : {
"timestamp" : "2019-08-24T14:15:22Z"
},
"openedChangeRequests" : [
"string"
],
"owners" : {
"count" : 0 ,
"preview" : [
{
"email" : "string" ,
"firstName" : "string" ,
"id" : "string" ,
"lastName" : "string"
}
]
},
"permissions" : [
"CAN_ADD_CHALLENGERS"
],
"predictionEnvironment" : {
"id" : "string" ,
"isManagedByManagementAgent" : true ,
"name" : "string" ,
"platform" : "aws" ,
"plugin" : "string" ,
"supportedModelFormats" : [
"datarobot"
]
},
"predictionUsage" : {
"dailyRates" : [
0
],
"lastTimestamp" : "2019-08-24T14:15:22Z"
},
"scoringCodeInitialDownload" : {
"timestamp" : "2019-08-24T14:15:22Z"
},
"serviceHealth" : {
"endDate" : "2019-08-24T14:15:22Z" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
},
"settings" : {
"batchMonitoringEnabled" : true ,
"humbleAiEnabled" : true ,
"predictionIntervalsEnabled" : true ,
"predictionWarningEnabled" : true
},
"status" : "active" ,
"tags" : [
{
"id" : "string" ,
"name" : "string" ,
"value" : "string"
}
],
"userProvidedId" : "string"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/fromLearningModel/
Create a deployment from a DataRobot model.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/fromLearningModel/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"defaultPredictionServerId" : "string" ,
"description" : null ,
"grantInitialDeploymentRolesFromProject" : true ,
"importance" : "CRITICAL" ,
"label" : "string" ,
"modelId" : "string" ,
"predictionThreshold" : 1 ,
"status" : "active"
}
Parameters
Example responses
202 Response
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/deployments/{deploymentId}/
Delete a deployment.
Code samples
# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/deployments/{ deploymentId} / \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
ignoreManagementAgent
query
string
false
Do not wait for management agent to delete the deployment first.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
ignoreManagementAgent
[false
, False
, true
, True
]
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/
Retrieve a deployment.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} / \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"accuracyHealth" : {
"endDate" : "2019-08-24T14:15:22Z" ,
"message" : "string" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
},
"approvalStatus" : "PENDING" ,
"capabilities" : {
"supportsAutomaticActuals" : true ,
"supportsChallengerModels" : true ,
"supportsFeatureDriftTracking" : true ,
"supportsFeatureTypeInfoValidation" : true ,
"supportsHumilityRecommendedRules" : true ,
"supportsHumilityRules" : true ,
"supportsHumilityRulesDefaultCalculations" : true ,
"supportsModelReplacement" : true ,
"supportsPortablePredictionServer" : true ,
"supportsPredictionIntervals" : true ,
"supportsPredictionWarning" : true ,
"supportsRetraining" : true ,
"supportsScoringCodeDownload" : true ,
"supportsSecondaryDatasets" : true ,
"supportsSegmentedAnalysisDriftAndAccuracy" : true ,
"supportsShapBasedPredictionExplanations" : true ,
"supportsTargetDriftTracking" : true
},
"createdAt" : "2019-08-24T14:15:22Z" ,
"defaultPredictionServer" : {
"datarobot-key" : "string" ,
"id" : "string" ,
"url" : "string"
},
"description" : "string" ,
"governance" : {
"approvalStatus" : "PENDING" ,
"hasOpenedChangeRequests" : true
},
"hasError" : true ,
"id" : "string" ,
"importance" : "CRITICAL" ,
"label" : "string" ,
"model" : {
"buildEnvironmentType" : "string" ,
"customModelImage" : {
"customModelId" : "string" ,
"customModelName" : "string" ,
"customModelVersionId" : "string" ,
"customModelVersionLabel" : "string" ,
"executionEnvironmentId" : "string" ,
"executionEnvironmentName" : "string" ,
"executionEnvironmentVersionId" : "string" ,
"executionEnvironmentVersionLabel" : "string"
},
"decisionFlowId" : "string" ,
"decisionFlowVersionId" : "string" ,
"deployedAt" : "2019-08-24T14:15:22Z" ,
"hasDecisionFlow" : true ,
"id" : "string" ,
"isDeprecated" : true ,
"projectId" : "string" ,
"projectName" : "string" ,
"targetName" : "string" ,
"targetType" : "string" ,
"type" : "string" ,
"unstructuredModelKind" : true ,
"unsupervisedMode" : true ,
"unsupervisedType" : "anomaly"
},
"modelHealth" : {
"endDate" : "2019-08-24T14:15:22Z" ,
"message" : "string" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
},
"modelPackage" : {
"id" : "string" ,
"name" : "string" ,
"registeredModelId" : "string"
},
"modelPackageInitialDownload" : {
"timestamp" : "2019-08-24T14:15:22Z"
},
"openedChangeRequests" : [
"string"
],
"owners" : {
"count" : 0 ,
"preview" : [
{
"email" : "string" ,
"firstName" : "string" ,
"id" : "string" ,
"lastName" : "string"
}
]
},
"permissions" : [
"CAN_ADD_CHALLENGERS"
],
"predictionEnvironment" : {
"id" : "string" ,
"isManagedByManagementAgent" : true ,
"name" : "string" ,
"platform" : "aws" ,
"plugin" : "string" ,
"supportedModelFormats" : [
"datarobot"
]
},
"predictionUsage" : {
"dailyRates" : [
0
],
"lastTimestamp" : "2019-08-24T14:15:22Z"
},
"scoringCodeInitialDownload" : {
"timestamp" : "2019-08-24T14:15:22Z"
},
"serviceHealth" : {
"endDate" : "2019-08-24T14:15:22Z" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
},
"settings" : {
"batchMonitoringEnabled" : true ,
"humbleAiEnabled" : true ,
"predictionIntervalsEnabled" : true ,
"predictionWarningEnabled" : true
},
"status" : "active" ,
"tags" : [
{
"id" : "string" ,
"name" : "string" ,
"value" : "string"
}
],
"userProvidedId" : "string"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/
Update a deployment's label and description.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} / \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"description" : "string" ,
"importance" : "CRITICAL" ,
"label" : "string"
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
DeploymentUpdate
false
none
Responses
Status
Meaning
Description
Schema
204
No Content
Deployment successfully updated
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/accuracy/
Retrieve accuracy metric for a certain time period.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /accuracy/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
end
query
string(date-time)
false
End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
modelId
query
string
false
The id of the model for which metrics are being retrieved.
batchId
query
any
false
The id of the batch for which metrics are being retrieved.
segmentAttribute
query
string
false
The name of the segment on which segment analysis is being performed.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
targetClasses
query
string
false
Comma separated list of target classes to filter out response
targetClass
query
any
false
Target class to filter out results.
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"batchIds" : [
"string"
],
"metrics" : "\n {\"metrics\": {\n \"LogLoss\": {\n \"baselineValue\": 0.454221484838069,\n \"value\": 0.880778024500618,\n \"percentChange\": -93.91\n },\n \"AUC\": {\n \"baselineValue\": 0.8690358459556535,\n \"value\": 0.5294117647058824,\n \"percentChange\": -39.08\n },\n \"Kolmogorov-Smirnov\": {\n \"baselineValue\": 0.5753202944706626,\n \"value\": 0.4117647058823529,\n \"percentChange\": -28.43\n },\n \"Rate@Top10%\": {\n \"baselineValue\": 0.9603223806571606,\n \"value\": 1.0,\n \"percentChange\": 4.13\n },\n \"Gini Norm\": {\n \"baselineValue\": 0.7380716919113071,\n \"value\": 0.05882352941176472,\n \"percentChange\": -92.03\n }\n }\n " ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"segmentAttribute" : "string" ,
"segmentValue" : "" ,
"targetClasses" : "string"
}
Responses
Status
Meaning
Description
Schema
200
OK
Deployment accuracy metrics are retrieved.
AccuracyResponse
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/accuracyOverBatch/
Retrieve accuracy metric baseline, and metric value calculated for each batch.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /accuracyOverBatch/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
segmentAttribute
query
string
false
The name of the segment on which segment analysis is being performed.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
modelId
query
string
false
The id of the model for which metrics are being retrieved.
batchId
query
any
false
The id of the batch for which metrics are being retrieved.
metric
query
string
false
Accuracy metric being requested.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
metric
[AUC
, Accuracy
, Balanced Accuracy
, F1
, FPR
, FVE Binomial
, FVE Gamma
, FVE Poisson
, FVE Tweedie
, Gamma Deviance
, Gini Norm
, Kolmogorov-Smirnov
, LogLoss
, MAE
, MAPE
, MCC
, NPV
, PPV
, Poisson Deviance
, R Squared
, RMSE
, RMSLE
, Rate@Top10%
, Rate@Top5%
, TNR
, TPR
, Tweedie Deviance
]
Example responses
200 Response
{
"baselines" : [
{
"metric" : "string" ,
"modelId" : "string" ,
"perClass" : [
{
"className" : "string" ,
"value" : 0
}
],
"sampleSize" : 0 ,
"value" : 0
}
],
"buckets" : [
{
"batchId" : "string" ,
"batchName" : "string" ,
"metric" : "string" ,
"modelId" : "string" ,
"perClass" : [
{
"className" : "string" ,
"value" : 0
}
],
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"value" : 0
}
]
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/accuracyOverTime/
Retrieve accuracy metric baseline, and metric value calculated for each time bucket dividing a longer time period.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /accuracyOverTime/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
end
query
string(date-time)
false
End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
bucketSize
query
string(duration)
false
The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time.
modelId
query
any
false
The id of the models for which metrics are being retrieved.
metric
query
string
false
Name of the metric.
segmentAttribute
query
string
false
The name of the segment on which segment analysis is being performed.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
targetClasses
query
string
false
List of target classes to filter out response
targetClass
query
any
false
Target class to filter out results.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
metric
[AUC
, Accuracy
, Balanced Accuracy
, F1
, FPR
, FVE Binomial
, FVE Gamma
, FVE Multinomial
, FVE Poisson
, FVE Tweedie
, Gamma Deviance
, Gini Norm
, Kolmogorov-Smirnov
, LogLoss
, MAD
, MAE
, MAPE
, MCC
, NPV
, PPV
, Poisson Deviance
, R Squared
, RMSE
, RMSLE
, Rate@Top10%
, Rate@Top5%
, TNR
, TPR
, Tweedie Deviance
]
Example responses
200 Response
{
"baseline" : {
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"value" : 0 ,
"valuePerClass" : "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
},
"baselines" : [
{
"modelId" : "string" ,
"perClass" : [
{
"className" : "string" ,
"value" : 0
}
],
"sampleSize" : 0 ,
"value" : 0
}
],
"buckets" : [
{
"modelId" : "string" ,
"perClass" : [
{
"className" : "string" ,
"value" : 0
}
],
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"value" : 0 ,
"valuePerClass" : "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
}
],
"metric" : "AUC" ,
"modelId" : "string" ,
"segmentAttribute" : "string" ,
"segmentValue" : "" ,
"summary" : {
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"value" : 0 ,
"valuePerClass" : "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/actuals/fromDataset/
Submit actuals values for processing using catalog item. Submission of actuals is limited to 10,000,000 actuals per hour. For time series deployments, total actuals = number of actuals * number of forecast distances. For example, submitting 10 actuals for a deployment with 50 forecast distances = 500 total actuals. For multiclass deployments, a similar calculation is made where total actuals = number of actuals * number of classes. For example, submitting 10 actuals for a deployment with 20 classes = 200 actuals.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /actuals/fromDataset/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"actualValueColumn" : "string" ,
"associationIdColumn" : "string" ,
"datasetId" : "string" ,
"datasetVersionId" : "string" ,
"keepActualsWithoutPredictions" : true ,
"password" : "string" ,
"timestampColumn" : "string" ,
"user" : "string" ,
"wasActedOnColumn" : "string"
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
DeploymentDatasetCreate
false
none
Responses
Status
Meaning
Description
Schema
202
Accepted
Submitted successfully. See Location header.
None
422
Unprocessable Entity
Unable to process the Actuals submission request.
None
429
Too Many Requests
The number of actuals uploaded this hour exceeds the limit of 10000000 rows.
None
Status
Header
Type
Format
Description
202
Location
string
URL for tracking async job status.
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/actuals/fromJSON/
Submit actuals values for processing. Values are not processed immediately and may take some time to propagate through deployment systems. Submission of actuals is limited to 10,000,000 actuals per hour. For time series deployments, total actuals = number of actuals * number of forecast distances. For example, submitting 10 actuals for a deployment with 50 forecast distances = 500 total actuals. For multiclass deployments, a similar calculation is made where total actuals = number of actuals * number of classes. For example, submitting 10 actuals for a deployment with 20 classes = 200 actuals.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /actuals/fromJSON/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"data" : [
{
"actualValue" : 0 ,
"associationId" : "string" ,
"timestamp" : "2019-08-24T14:15:22Z" ,
"wasActedOn" : true
}
],
"keepActualsWithoutPredictions" : true
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
DeploymentActuals
false
none
Responses
Status
Meaning
Description
Schema
202
Accepted
Submitted successfully. See Location header.
None
422
Unprocessable Entity
Unable to process the Actuals submission request.
None
429
Too Many Requests
The number of actuals uploaded this hour exceeds the limit of 10000000 rows.
None
Status
Header
Type
Format
Description
202
Location
string
URL for tracking async job status.
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/actualsDataExports/
Retrieve a list of asynchronous actuals data exports.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /actualsDataExports/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
offset
query
integer
false
Offset this number of objects to retrieve.
limit
query
integer
false
At most this number of objects to retrieve.
status
query
string
false
An actuals data export state overwrite value.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
status
[CANCELLED
, CREATED
, FAILED
, SCHEDULED
, SUCCEEDED
]
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"data" : [
{
"id" : "string" ,
"name" : "string"
}
],
"error" : {
"message" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"onlyMatchedPredictions" : true ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"status" : "CANCELLED"
}
],
"next" : "string" ,
"previous" : "string" ,
"totalCount" : 0
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/actualsDataExports/
Create a deployment actuals data export.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /actualsDataExports/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"end" : "2019-08-24T14:15:22Z" ,
"modelId" : "string" ,
"onlyMatchedPredictions" : true ,
"start" : "2019-08-24T14:15:22Z"
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
ActualsExportCreatePayload
false
none
Example responses
202 Response
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"data" : [
{
"id" : "string" ,
"name" : "string"
}
],
"error" : {
"message" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"onlyMatchedPredictions" : true ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"status" : "CANCELLED"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/
Delete an actual export.
Code samples
# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/deployments/{ deploymentId} /actualsDataExports/{ exportId} / \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
ID of the deployment.
exportId
path
string
true
ID of the actuals data export job.
Responses
Status
Meaning
Description
Schema
204
No Content
An actual export was successfully deleted.
None
403
Forbidden
User does not have permission to delete an actual export.
None
404
Not Found
Actual export was 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}/actualsDataExports/{exportId}/
Retrieve a single actuals data export.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /actualsDataExports/{ exportId} / \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
ID of the deployment.
exportId
path
string
true
ID of the actuals data export job.
Example responses
200 Response
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"data" : [
{
"id" : "string" ,
"name" : "string"
}
],
"error" : {
"message" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"onlyMatchedPredictions" : true ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"status" : "CANCELLED"
}
Responses
Status
Meaning
Description
Schema
200
OK
A given actuals data export user can view is retrieved.
ActualsDataExportEntity
403
Forbidden
User does not have permission to access a particular deployment or actuals data export.
None
404
Not Found
Resource 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}/actualsDataExports/{exportId}/
Update actuals data export.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /actualsDataExports/{ exportId} / \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"status" : "CANCELLED"
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
ID of the deployment.
exportId
path
string
true
ID of the actuals data export job.
body
body
ActualsDataUpdate
false
none
Example responses
204 Response
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"data" : [
{
"id" : "string" ,
"name" : "string"
}
],
"error" : {
"message" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"onlyMatchedPredictions" : true ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"status" : "CANCELLED"
}
Responses
Status
Meaning
Description
Schema
204
No Content
Actuals data export updated.
ActualsDataExportEntity
403
Forbidden
User does not have permission to update the actuals data export.
None
404
Not Found
Requested resource does not exist or the user does not have permission to view it.
None
422
Unprocessable Entity
Unable to process the actuals data export update.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/batchServiceStats/
Retrieve all deployment service health metrics over a set of batches.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /batchServiceStats/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
executionTimeQuantile
query
number
false
Quantile for executionTime metric.
responseTimeQuantile
query
number
false
Quantile for responseTime metric.
slowRequestsThreshold
query
integer
false
Threshold for slowRequests metric.
segmentAttribute
query
string
false
The name of a segment attribute used for segment analysis.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
batchId
query
any
false
The id of the batch for which metrics are being retrieved.
modelId
query
string
false
The id of the model for which metrics are being retrieved.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
segmentAttribute
[DataRobot-Consumer
, DataRobot-Remote-IP
, DataRobot-Host-IP
]
Example responses
200 Response
{
"batches" : [
{
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
}
],
"metrics" : {
"cacheHitRatio" : 0 ,
"executionTime" : 0 ,
"numConsumers" : 0 ,
"responseTime" : 0 ,
"serverErrorRate" : 0 ,
"slowRequests" : 0 ,
"totalPredictions" : 0 ,
"totalRequests" : 0 ,
"userErrorRate" : 0
},
"segmentAttribute" : "string" ,
"segmentValue" : ""
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/capabilities/
Retrieve the capabilities for the deployment.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /capabilities/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"data" : [
{
"messages" : [
"string"
],
"name" : "string" ,
"supported" : true
}
]
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/challengerPredictions/
Score main model prediction requests against challenger model requests.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /challengerPredictions/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"timestamp" : "2019-08-24T14:15:22Z"
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
ChallengerScore
false
none
Responses
Status
Meaning
Description
Schema
202
Accepted
Job submitted. See Location header.
None
422
Unprocessable Entity
Unable to process the challenger scoring request.
None
429
Too Many Requests
Another challenger scoring job is running. See the Location header to track the running job.
None
Status
Header
Type
Format
Description
202
Location
string
URL to poll to track challenger scoring progress.
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/challengerReplaySettings/
Retrieve challenger replay settings.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /challengerReplaySettings/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"enabled" : true ,
"schedule" : {
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/challengerReplaySettings/
Update challenger replay settings.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /challengerReplaySettings/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"enabled" : true ,
"schedule" : {
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
}
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
ChallengersReplaySettings
false
none
Responses
Status
Meaning
Description
Schema
200
OK
Challenger replay settings updated.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/challengers/
List challenger models for deployment.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /challengers/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"data" : [
{
"id" : "string" ,
"model" : {
"datasetName" : "string" ,
"description" : "string" ,
"executionType" : "string" ,
"id" : "string" ,
"isDeprecated" : true ,
"name" : "string" ,
"projectId" : "string" ,
"projectName" : "string"
},
"modelPackage" : {
"id" : "string" ,
"name" : "string" ,
"registeredModelId" : "string"
},
"name" : "string" ,
"predictionEnvironment" : {
"id" : "string" ,
"name" : "string"
}
}
]
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/challengers/
Create new challenger model.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /challengers/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"modelPackageId" : "string" ,
"name" : "string" ,
"predictionEnvironmentId" : "string"
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
ChallengerCreate
false
none
Responses
Status
Meaning
Description
Schema
202
Accepted
Job submitted successfully. See Location header.
None
422
Unprocessable Entity
Unable to process the challenger creation request.
None
Status
Header
Type
Format
Description
202
Location
string
URL to poll to track challenger creation has finished.
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/deployments/{deploymentId}/challengers/{challengerId}/
Delete challenger model.
Code samples
# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/deployments/{ deploymentId} /challengers/{ challengerId} / \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
challengerId
path
string
true
Unique identifier of the challenger.
Responses
Status
Meaning
Description
Schema
204
No Content
Model successfully deleted.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/challengers/{challengerId}/
Retrieve challenger model.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /challengers/{ challengerId} / \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
challengerId
path
string
true
Unique identifier of the challenger.
Example responses
200 Response
{
"id" : "string" ,
"model" : {
"datasetName" : "string" ,
"description" : "string" ,
"executionType" : "string" ,
"id" : "string" ,
"isDeprecated" : true ,
"name" : "string" ,
"projectId" : "string" ,
"projectName" : "string"
},
"modelPackage" : {
"id" : "string" ,
"name" : "string" ,
"registeredModelId" : "string"
},
"name" : "string" ,
"predictionEnvironment" : {
"id" : "string" ,
"name" : "string"
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/challengers/{challengerId}/
Update challenger model.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /challengers/{ challengerId} / \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"name" : "string" ,
"predictionEnvironmentId" : "string"
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
challengerId
path
string
true
Unique identifier of the challenger.
body
body
ChallengerUpdate
false
none
Example responses
200 Response
{
"id" : "string" ,
"model" : {
"datasetName" : "string" ,
"description" : "string" ,
"executionType" : "string" ,
"id" : "string" ,
"isDeprecated" : true ,
"name" : "string" ,
"projectId" : "string" ,
"projectName" : "string"
},
"modelPackage" : {
"id" : "string" ,
"name" : "string" ,
"registeredModelId" : "string"
},
"name" : "string" ,
"predictionEnvironment" : {
"id" : "string" ,
"name" : "string"
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/championModelPackage/
Retrieve information about the champion model package
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /championModelPackage/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"buildStatus" : "inProgress" ,
"capabilities" : {
"supportsAutomaticActuals" : true ,
"supportsChallengerModels" : true ,
"supportsFeatureDriftTracking" : true ,
"supportsHumilityRecommendedRules" : true ,
"supportsHumilityRules" : true ,
"supportsHumilityRulesDefaultCalculations" : true ,
"supportsPredictionWarning" : true ,
"supportsRetraining" : true ,
"supportsScoringCodeDownload" : true ,
"supportsSecondaryDatasets" : true ,
"supportsSegmentedAnalysisDriftAndAccuracy" : true ,
"supportsShapBasedPredictionExplanations" : true ,
"supportsTargetDriftTracking" : true
},
"datasets" : {
"baselineSegmentedBy" : [
"string"
],
"datasetName" : "string" ,
"holdoutDataCatalogId" : "string" ,
"holdoutDataCatalogVersionId" : "string" ,
"holdoutDatasetName" : "string" ,
"targetHistogramBaseline" : "predictions" ,
"trainingDataCatalogId" : "string" ,
"trainingDataCatalogVersionId" : "string" ,
"trainingDataSize" : 0
},
"id" : "string" ,
"importMeta" : {
"containsFearPipeline" : true ,
"containsFeaturelists" : true ,
"containsLeaderboardMeta" : true ,
"containsProjectMeta" : true ,
"creatorFullName" : "string" ,
"creatorId" : "string" ,
"creatorUsername" : "string" ,
"dateCreated" : "string" ,
"originalFileName" : "string"
},
"isArchived" : true ,
"isDeprecated" : true ,
"mlpkgFileContents" : {
"allTimeSeriesPredictionIntervals" : true
},
"modelDescription" : {
"buildEnvironmentType" : "DataRobot" ,
"description" : "string" ,
"location" : "string" ,
"modelCreatedAt" : "string" ,
"modelCreatorEmail" : "string" ,
"modelCreatorId" : null ,
"modelCreatorName" : "string" ,
"modelName" : "string"
},
"modelExecutionType" : "dedicated" ,
"modelId" : "string" ,
"modelKind" : {
"isAnomalyDetectionModel" : true ,
"isCombinedModel" : true ,
"isDecisionFlow" : true ,
"isFeatureDiscovery" : true ,
"isMultiseries" : true ,
"isTimeSeries" : true ,
"isUnsupervisedLearning" : true
},
"name" : "string" ,
"sourceMeta" : {
"decisionFlowId" : "string" ,
"decisionFlowVersionId" : "string" ,
"environmentUrl" : "http://example.com" ,
"fips_140_2Enabled" : true ,
"projectCreatedAt" : "string" ,
"projectCreatorEmail" : "string" ,
"projectCreatorId" : null ,
"projectCreatorName" : "string" ,
"projectId" : "string" ,
"projectName" : "string" ,
"scoringCode" : {
"dataRobotPredictionVersion" : "string" ,
"location" : "local_leaderboard"
},
"useCaseDetails" : {
"createdAt" : "string" ,
"creatorEmail" : "string" ,
"creatorId" : "string" ,
"creatorName" : "string" ,
"id" : "string" ,
"name" : "string"
}
},
"target" : {
"classCount" : 0 ,
"classNames" : [
"string"
],
"name" : "string" ,
"predictionProbabilitiesColumn" : "string" ,
"predictionThreshold" : 1 ,
"type" : "Binary"
},
"timeseries" : {
"datetimeColumnFormat" : "string" ,
"datetimeColumnName" : "string" ,
"effectiveFeatureDerivationWindowEnd" : 0 ,
"effectiveFeatureDerivationWindowStart" : 0 ,
"featureDerivationWindowEnd" : 0 ,
"featureDerivationWindowStart" : 0 ,
"forecastDistanceColumnName" : "string" ,
"forecastDistances" : [
0
],
"forecastDistancesTimeUnit" : "MICROSECOND" ,
"forecastPointColumnName" : "string" ,
"isCrossSeries" : true ,
"isNewSeriesSupport" : true ,
"isTraditionalTimeSeries" : true ,
"seriesColumnName" : "string"
},
"updatedBy" : {
"email" : "string" ,
"id" : "string" ,
"name" : "string"
},
"userProvidedId" : "string"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetrics/
Retrieve a list of custom metrics.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /customMetrics/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
offset
query
integer
false
Offset this number of objects to retrieve
limit
query
integer
false
At most this number of objects to retrieve
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"baselineValues" : [
{
"value" : 0
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"displayChart" : true ,
"id" : "string" ,
"isModelSpecific" : true ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timeStep" : "hour" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
],
"next" : "string" ,
"previous" : "string" ,
"totalCount" : 0
}
Responses
Status
Meaning
Description
Schema
200
OK
Success
MetricListResponse
403
Forbidden
User does not have permission to access a particular deployment or create a custom metric.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/customMetrics/
Create a deployment custom metric.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /customMetrics/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"baselineValues" : [],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timeStep" : "hour" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
MetricCreatePayload
false
none
Example responses
201 Response
{
"baselineValues" : [
{
"value" : 0
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"displayChart" : true ,
"id" : "string" ,
"isModelSpecific" : true ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timeStep" : "hour" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
Responses
Status
Meaning
Description
Schema
201
Created
Custom metric is successfully created.
MetricEntity
403
Forbidden
User does not have permission to create a custom metric.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/
Delete a custom metric.
Code samples
# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/deployments/{ deploymentId} /customMetrics/{ customMetricId} / \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
ID of the deployment
customMetricId
path
string
true
ID of the custom metric
Responses
Status
Meaning
Description
Schema
204
No Content
A custom metric was successfully deleted.
None
403
Forbidden
User does not have permission to delete a custom metric.
None
404
Not Found
Custom metric was 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}/customMetrics/{customMetricId}/
Retrieve a single custom metric metadata.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /customMetrics/{ customMetricId} / \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
ID of the deployment
customMetricId
path
string
true
ID of the custom metric
Example responses
200 Response
{
"baselineValues" : [
{
"value" : 0
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"displayChart" : true ,
"id" : "string" ,
"isModelSpecific" : true ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timeStep" : "hour" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
Responses
Status
Meaning
Description
Schema
200
OK
A given custom metric metadata.
MetricEntity
403
Forbidden
User does not have permission to access a particular deployment or custom metric metadata.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/
Update given custom metric settings.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /customMetrics/{ customMetricId} / \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"baselineValues" : [
{
"value" : 0
}
],
"batch" : {
"columnName" : "string"
},
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
ID of the deployment
customMetricId
path
string
true
ID of the custom metric
body
body
MetricUpdatePayload
false
none
Example responses
200 Response
{
"baselineValues" : [
{
"value" : 0
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"displayChart" : true ,
"id" : "string" ,
"isModelSpecific" : true ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timeStep" : "hour" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
Responses
Status
Meaning
Description
Schema
200
OK
Custom metric settings updated.
MetricEntity
403
Forbidden
User does not have permission to update the custom metric.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/batchSummary/
Retrieve the summary of deployment batch custom metric.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /customMetrics/{ customMetricId} /batchSummary/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period.
end
query
string(date-time)
false
End of the period to retrieve monitoring stats, defaults to the next top of the hour from now.
modelPackageId
query
string
false
The model package ID of related champion/challenger to retrieve custom metric values for.
modelId
query
string
false
The model ID of related champion/challenger to retrieve custom metric values for.
batchId
query
any
false
The id of the batch for which metrics are being retrieved.
deploymentId
path
string
true
ID of the deployment
customMetricId
path
string
true
ID of the custom metric
Example responses
200 Response
{
"metric" : {
"baselineValue" : 0 ,
"id" : "string" ,
"name" : "string" ,
"percentChange" : 0 ,
"sampleCount" : 0 ,
"value" : 0
}
}
Responses
Status
Meaning
Description
Schema
200
OK
Summary retrieved successfully.
CustomMetricBatchSummary
403
Forbidden
User does not have permission to read the custom metric summary.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/fromDataset/
Upload custom metric values from dataset.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /customMetrics/{ customMetricId} /fromDataset/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"associationId" : {
"columnName" : "string"
},
"batch" : {
"columnName" : "string"
},
"datasetId" : "string" ,
"modelId" : null ,
"modelPackageId" : null ,
"sampleCount" : {
"columnName" : "string"
},
"segments" : [
{
"column" : "string" ,
"name" : "string" ,
"value" : "string"
}
],
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"value" : {
"columnName" : "string"
}
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
ID of the deployment
customMetricId
path
string
true
ID of the custom metric
body
body
MetricValuesFromDatasetPayload
false
none
Responses
Status
Meaning
Description
Schema
202
Accepted
Custom metric values import started
None
403
Forbidden
User does not have permission to import custom metric values.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/fromJSON/
Upload custom metric values from JSON.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /customMetrics/{ customMetricId} /fromJSON/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"buckets" : [
{
"sampleSize" : 1 ,
"timestamp" : "2019-08-24T14:15:22Z" ,
"value" : 0
}
],
"dryRun" : false ,
"modelId" : null ,
"modelPackageId" : null
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
ID of the deployment
customMetricId
path
string
true
ID of the custom metric
body
body
MetricValuesFromJSONPayload
false
none
Example responses
202 Response
{
"baselineValues" : [
{
"value" : 0
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"displayChart" : true ,
"id" : "string" ,
"isModelSpecific" : true ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timeStep" : "hour" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
Responses
Status
Meaning
Description
Schema
202
Accepted
Custom metric values import started
MetricEntity
403
Forbidden
User does not have permission to import custom metric values.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/summary/
Retrieve the summary of deployment custom metric.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /customMetrics/{ customMetricId} /summary/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period.
end
query
string(date-time)
false
End of the period to retrieve monitoring stats, defaults to the next top of the hour from now.
modelPackageId
query
string
false
The model package ID of related champion/challenger to retrieve custom metric values for.
modelId
query
string
false
The model ID of related champion/challenger to retrieve custom metric values for.
batchId
query
any
false
The id of the batch for which metrics are being retrieved.
deploymentId
path
string
true
ID of the deployment
customMetricId
path
string
true
ID of the custom metric
Example responses
200 Response
{
"metric" : {
"baselineValue" : 0 ,
"id" : "string" ,
"name" : "string" ,
"percentChange" : 0 ,
"sampleCount" : 0 ,
"value" : 0
},
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
}
}
Responses
Status
Meaning
Description
Schema
200
OK
Summary retrieved successfully.
CustomMetricSummary
403
Forbidden
User does not have permission to read the custom metric summary.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/valuesOverBatch/
Retrieve custom metric values over batch.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /customMetrics/{ customMetricId} /valuesOverBatch/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
modelPackageId
query
string
false
The model package ID of related champion/challenger to retrieve batch custom metric values for.
modelId
query
string
false
The model ID of related champion/challenger to retrieve batch custom metric values for.
batchId
query
any
false
The id of the batch for which metrics are being retrieved.
deploymentId
path
string
true
ID of the deployment
customMetricId
path
string
true
ID of the custom metric
Example responses
200 Response
{
"buckets" : [
{
"batch" : {
"createdAt" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"lastPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
},
"sampleSize" : 0 ,
"value" : 0
}
],
"metric" : {
"baselineValues" : [
{
"value" : 0
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"displayChart" : true ,
"id" : "string" ,
"isModelSpecific" : true ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timeStep" : "hour" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/valuesOverTime/
Retrieve custom metric values over time.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /customMetrics/{ customMetricId} /valuesOverTime/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period.
end
query
string(date-time)
false
End of the period to retrieve monitoring stats, defaults to the next top of the hour from now.
modelPackageId
query
string
false
The model package ID of related champion/challenger to retrieve custom metric values for.
modelId
query
string
false
The model ID of related champion/challenger to retrieve custom metric values for.
bucketSize
query
string(duration)
false
Time duration of a bucket, default to seven days.
deploymentId
path
string
true
ID of the deployment
customMetricId
path
string
true
ID of the custom metric
Example responses
200 Response
{
"buckets" : [
{
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"value" : 0
}
],
"metric" : {
"baselineValues" : [
{
"value" : 0
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"displayChart" : true ,
"id" : "string" ,
"isModelSpecific" : true ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timeStep" : "hour" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
},
"summary" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetricsBatchSummary/
Retrieve the bulk summary of deployment batch custom metrics.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /customMetricsBatchSummary/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period.
end
query
string(date-time)
false
End of the period to retrieve monitoring stats, defaults to the next top of the hour from now.
modelPackageId
query
string
false
The model package ID of related champion/challenger to retrieve custom metric values for.
modelId
query
string
false
The model ID of related champion/challenger to retrieve custom metric values for.
batchId
query
any
false
The id of the batch for which metrics are being retrieved.
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetricsSummary/
Retrieve the bulk summary of deployment custom metrics.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /customMetricsSummary/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period.
end
query
string(date-time)
false
End of the period to retrieve monitoring stats, defaults to the next top of the hour from now.
modelPackageId
query
string
false
The model package ID of related champion/challenger to retrieve custom metric values for.
modelId
query
string
false
The model ID of related champion/challenger to retrieve custom metric values for.
batchId
query
any
false
The id of the batch for which metrics are being retrieved.
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"details" : {
"earliestDate" : "2019-08-24T14:15:22Z" ,
"latestDate" : "2019-08-24T14:15:22Z"
},
"metrics" : [],
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
}
}
Responses
Status
Meaning
Description
Schema
200
OK
Bulk summary retrieved successfully.
CustomMetricsBulkSummary
403
Forbidden
User does not have permission to read the custom metrics summary.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/fairnessScoresOverTime/
Retrieve fairness scores for all features, or for different classes of a single feature changes over a specific time period.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /fairnessScoresOverTime/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
end
query
string(date-time)
false
End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
bucketSize
query
string
false
Time duration of buckets
modelId
query
string
false
The ID of the model to retrieve the statistics for.
fairnessMetric
query
string
false
The name of the fairness metric to compute fairness over time.
protectedFeature
query
string
false
Name of the protected feature. When present, will return per class fairness score of the protected feature, otherwise returning fairness score of all protected features.
orderBy
query
string
false
The type of FairnessScore to order the response by.
includePrivilegedClass
query
string
false
Always include privileged class in response.
onlyStatisticallySignificant
query
string
false
Include only statistically significant attributes.
limit
query
integer
false
Max number of features in response.
offset
query
integer
false
Number of features to offset in response.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
bucketSize
[PT1H
, P1D
, P7D
, P1M
]
fairnessMetric
[proportionalParity
, equalParity
, favorableClassBalance
, unfavorableClassBalance
, trueUnfavorableRateParity
, trueFavorableRateParity
, favorablePredictiveValueParity
, unfavorablePredictiveValueParity
]
orderBy
[absoluteFairnessScore
, relativeFairnessScore
, -absoluteFairnessScore
, -relativeFairnessScore
]
includePrivilegedClass
[false
, False
, true
, True
]
onlyStatisticallySignificant
[false
, False
, true
, True
]
Example responses
200 Response
{
"buckets" : [
{
"metricName" : "proportionalParity" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"scores" : [
{
"absoluteValue" : 0 ,
"classesCount" : 0 ,
"healthyClassesCount" : 0 ,
"healthyCount" : 0 ,
"isStatisticallySignificant" : true ,
"label" : "string" ,
"message" : "string" ,
"privilegedClass" : "string" ,
"sampleSize" : 0 ,
"totalCount" : 1 ,
"value" : 1
}
]
}
],
"fairnessThreshold" : 1 ,
"favorableTargetOutcome" : true ,
"modelId" : "string" ,
"modelPackageId" : "string" ,
"protectedFeature" : "string" ,
"summary" : {
"metricName" : "proportionalParity" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"scores" : [
{
"absoluteValue" : 0 ,
"classesCount" : 0 ,
"healthyClassesCount" : 0 ,
"healthyCount" : 0 ,
"isStatisticallySignificant" : true ,
"label" : "string" ,
"message" : "string" ,
"privilegedClass" : "string" ,
"sampleSize" : 0 ,
"totalCount" : 1 ,
"value" : 1
}
]
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/featureDrift/
Retrieve drift scores for features of the deployment.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /featureDrift/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
end
query
string(date-time)
false
End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
modelId
query
string
false
ID of the model in the deployment. If not set, defaults to the deployment current model.
metric
query
string
false
Name of the metric used to calculate the drift. Can be one of psi, kl_divergence, dissimilarity, hellinger, and js_divergence. Defaults to psi.
offset
query
integer
false
The number of features to skip, defaults to 0.
limit
query
integer
false
The number of features to return, defaults to 25.
segmentAttribute
query
string
false
The name of a segment attribute used for segment analysis.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
batchId
query
any
false
The id of the batch for which metrics are being retrieved.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
metric
[psi
, kl_divergence
, dissimilarity
, hellinger
, js_divergence
]
Example responses
200 Response
{
"batchId" : [],
"count" : 0 ,
"data" : [
{
"baselineSampleSize" : 0 ,
"driftScore" : 0 ,
"featureImpact" : 0 ,
"name" : "string" ,
"sampleSize" : 0 ,
"type" : "numeric"
}
],
"metric" : "psi" ,
"modelId" : "string" ,
"next" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"previous" : "string" ,
"segmentAttribute" : "string" ,
"segmentValue" : "string"
}
Responses
Status
Meaning
Description
Schema
200
OK
Features drift over specified time period retrieved.
FeatureDriftResponse
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/featureDriftOverBatch/
Retrieve drift over batch info for a feature of the deployment.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /featureDriftOverBatch/?featureNames= string \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
segmentAttribute
query
string
false
The name of the segment on which segment analysis is being performed.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
batchId
query
any
false
The id of the batch for which metrics are being retrieved.
featureNames
query
any
true
List of feature names, limited to two per request.
driftMetric
query
string
false
The metric used to calculate data drift scores.
modelId
query
string
false
The id of the model for which metrics are being retrieved.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
driftMetric
[psi
, kl_divergence
, dissimilarity
, hellinger
, js_divergence
]
Example responses
200 Response
{
"buckets" : [
{
"baselineSampleSize" : 0 ,
"batch" : {
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
},
"driftScore" : 0 ,
"featureImpact" : 0 ,
"featureName" : "string" ,
"sampleSize" : 0
}
],
"driftMetric" : "psi"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/featureDriftOverTime/
Retrieve drift over time info for a feature of the deployment.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /featureDriftOverTime/?featureNames= string \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
end
query
string(date-time)
false
End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
bucketSize
query
string(duration)
false
The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time.
modelId
query
string
false
The id of the model for which the features drift is being retrieved.
featureNames
query
any
true
List of feature names, limited to two per request.
metric
query
string
false
Name of the metric used to calculate the drift. Can be one of psi, kl_divergence, dissimilarity, hellinger, and js_divergence. Defaults to psi.
segmentAttribute
query
string
false
The name of the segment on which segment analysis is being performed.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
metric
[psi
, kl_divergence
, dissimilarity
, hellinger
, js_divergence
]
Example responses
200 Response
{
"buckets" : [
{
"baselineSampleSize" : 0 ,
"driftScore" : 0 ,
"featureImpact" : 0 ,
"featureName" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0
}
],
"features" : [
{
"featureName" : "string" ,
"featureType" : "numeric"
}
],
"metric" : "string" ,
"summaries" : [
{
"featureImpact" : 0 ,
"featureName" : "string"
}
]
}
Responses
Status
Meaning
Description
Schema
200
OK
Feature drift over time info of the deployment retrieved.
FeatureDriftOverTimeResponse
400
Bad Request
Request invalid, refer to messages for detail.
None
403
Forbidden
Model Deployments and/or Monitoring are not enabled.
None
404
Not Found
Either the deployment does not exist or user does not have permission to view the deployment.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/features/
Retrieve features contained within the universe dataset associated with a specific deployment. By default, this returns all raw features required for predictions.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /features/?offset= 0 & limit = 50 \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
offset
query
integer
true
The number of features to skip, defaults to 0.
limit
query
integer
true
The number of features to return, defaults to 0.
includeNonPredictionFeatures
query
string
false
When True will return all raw features in the universe dataset associated with the deployment, and when False will return only those raw features used to make predictions on the deployment.
forSegmentedAnalysis
query
string
false
When True, features returned will be filtered to those usable for segmented analysis.
search
query
string
false
Case insensitive search against names of the deployment's features.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
includeNonPredictionFeatures
[false
, False
, true
, True
]
forSegmentedAnalysis
[false
, False
, true
, True
]
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"dateFormat" : "string" ,
"featureType" : "string" ,
"importance" : 0 ,
"knownInAdvance" : true ,
"name" : "string"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/healthSettings/
Retrieve deployment health settings.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /healthSettings/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"accuracy" : {
"batchCount" : "1" ,
"failingThreshold" : 0 ,
"measurement" : "percent" ,
"metric" : "AUC" ,
"warningThreshold" : 0
},
"actualsTimeliness" : {
"enabled" : true ,
"expectedFrequency" : "string"
},
"customMetrics" : {
"failingConditions" : [
{
"compareOperator" : "lt" ,
"metricId" : "string" ,
"threshold" : 0
}
],
"warningConditions" : [
{
"compareOperator" : "lt" ,
"metricId" : "string" ,
"threshold" : 0
}
]
},
"dataDrift" : {
"batchCount" : "1" ,
"driftThreshold" : 1 ,
"excludedFeatures" : [
"string"
],
"highImportanceFailingCount" : 1 ,
"highImportanceWarningCount" : 1 ,
"importanceThreshold" : 1 ,
"lowImportanceFailingCount" : 1 ,
"lowImportanceWarningCount" : 1 ,
"starredFeatures" : [
"string"
],
"timeInterval" : "T2H"
},
"fairness" : {
"protectedClassFailingCount" : 1 ,
"protectedClassWarningCount" : 1
},
"predictionsTimeliness" : {
"enabled" : true ,
"expectedFrequency" : "string"
},
"service" : {
"batchCount" : "1"
}
}
Responses
Status
Meaning
Description
Schema
200
OK
Deployment health settings.
HealthSettings
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/healthSettings/
Update deployment health settings.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /healthSettings/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"accuracy" : {
"batchCount" : "1" ,
"failingThreshold" : 0 ,
"measurement" : "percent" ,
"metric" : "AUC" ,
"warningThreshold" : 0
},
"actualsTimeliness" : {
"enabled" : true ,
"expectedFrequency" : "string"
},
"customMetrics" : {
"failingConditions" : [
{
"compareOperator" : "lt" ,
"metricId" : "string" ,
"threshold" : 0
}
],
"warningConditions" : [
{
"compareOperator" : "lt" ,
"metricId" : "string" ,
"threshold" : 0
}
]
},
"dataDrift" : {
"batchCount" : "1" ,
"driftThreshold" : 1 ,
"excludedFeatures" : [
"string"
],
"highImportanceFailingCount" : 1 ,
"highImportanceWarningCount" : 1 ,
"importanceThreshold" : 1 ,
"lowImportanceFailingCount" : 1 ,
"lowImportanceWarningCount" : 1 ,
"starredFeatures" : [
"string"
],
"timeInterval" : "T2H"
},
"fairness" : {
"protectedClassFailingCount" : 1 ,
"protectedClassWarningCount" : 1
},
"predictionsTimeliness" : {
"enabled" : true ,
"expectedFrequency" : "string"
},
"service" : {
"batchCount" : "1"
}
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
HealthSettings
false
none
Responses
Status
Meaning
Description
Schema
200
OK
Updated deployment health settings.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/healthSettings/defaults/
Retrieve default deployment health settings.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /healthSettings/defaults/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"accuracy" : {
"batchCount" : "1" ,
"failingThreshold" : 0 ,
"measurement" : "percent" ,
"metric" : "AUC" ,
"warningThreshold" : 0
},
"actualsTimeliness" : {
"enabled" : true ,
"expectedFrequency" : "string"
},
"customMetrics" : {
"failingConditions" : [
{
"compareOperator" : "lt" ,
"metricId" : "string" ,
"threshold" : 0
}
],
"warningConditions" : [
{
"compareOperator" : "lt" ,
"metricId" : "string" ,
"threshold" : 0
}
]
},
"dataDrift" : {
"batchCount" : "1" ,
"driftThreshold" : 1 ,
"excludedFeatures" : [
"string"
],
"highImportanceFailingCount" : 1 ,
"highImportanceWarningCount" : 1 ,
"importanceThreshold" : 1 ,
"lowImportanceFailingCount" : 1 ,
"lowImportanceWarningCount" : 1 ,
"starredFeatures" : [
"string"
],
"timeInterval" : "T2H"
},
"fairness" : {
"protectedClassFailingCount" : 1 ,
"protectedClassWarningCount" : 1
},
"predictionsTimeliness" : {
"enabled" : true ,
"expectedFrequency" : "string"
},
"service" : {
"batchCount" : "1"
}
}
Responses
Status
Meaning
Description
Schema
200
OK
Default deployment health settings.
HealthSettings
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/humilityStats/
Retrieve humility rule service triggers statistics overview.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /humilityStats/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
end
query
string(date-time)
false
End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
bucketSize
query
string(duration)
false
The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time.
modelId
query
string
false
The id of the model for which metrics are being retrieved.
segmentAttribute
query
string
false
The name of a segment attribute used for segment analysis.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
segmentAttribute
[DataRobot-Consumer
, DataRobot-Remote-IP
, DataRobot-Host-IP
]
Example responses
200 Response
{
"data" : [
{
"ruleId" : "string" ,
"ruleName" : "string" ,
"value" : 0
}
],
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"segmentAttribute" : "string" ,
"segmentValue" : ""
}
Responses
Status
Meaning
Description
Schema
200
OK
Humility service health statistics overview retrieved.
HumilityStatsResponse
403
Forbidden
Model Deployments and/or Monitoring are not enabled.
None
404
Not Found
Either the deployment does not exist or user does not have permission to view the deployment.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/humilityStatsOverTime/
Retrieve humility service statistics over time.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /humilityStatsOverTime/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
end
query
string(date-time)
false
End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
bucketSize
query
string(duration)
false
The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time.
modelId
query
string
false
The id of the model for which metrics are being retrieved.
segmentAttribute
query
string
false
The name of a segment attribute used for segment analysis.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
segmentAttribute
[DataRobot-Consumer
, DataRobot-Remote-IP
, DataRobot-Host-IP
]
Example responses
200 Response
{
"buckets" : [
{
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"values" : [
{
"ruleId" : "string" ,
"ruleName" : "string" ,
"value" : 0
}
]
}
],
"modelId" : "string" ,
"segmentAttribute" : "string" ,
"segmentValue" : "" ,
"summary" : {
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"values" : [
{
"ruleId" : "string" ,
"ruleName" : "string" ,
"value" : 0
}
]
}
}
Responses
Status
Meaning
Description
Schema
200
OK
Humility statistics for deployment retrieved.
HumilityStatsOverTimeResponse
403
Forbidden
Model Deployments and/or Monitoring are not enabled.
None
404
Not Found
Either the deployment does not exist or user does not have permission to view the deployment.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/model/
Replace the model used to make predictions for the deployment.
A validation process will be performed to make sure the new model is eligible as a replacement. If the validation fails, the model replacement will not occur.The Model Replacement Validation endpoint can be used to confirm the new model is eligible as a replacement.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /model/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"modelId" : "string" ,
"modelPackageId" : "string" ,
"reason" : "ACCURACY"
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
ModelReplacementSubmission
false
none
Example responses
202 Response
{
"checks" : {
"combinedModelSegments" : {
"message" : "string" ,
"status" : "failing"
},
"containsTrackedSegmentAttributes" : {
"message" : "string" ,
"status" : "failing"
},
"driftTracking" : {
"message" : "string" ,
"status" : "failing"
},
"featureDataTypes" : {
"message" : "string" ,
"status" : "failing"
},
"features" : {
"message" : "string" ,
"status" : "failing"
},
"humilityRules" : {
"message" : "string" ,
"status" : "failing"
},
"modelCanBeDeployed" : {
"message" : "string" ,
"status" : "failing"
},
"modelStatus" : {
"message" : "string" ,
"status" : "failing"
},
"notCurrentModel" : {
"message" : "string" ,
"status" : "failing"
},
"permission" : {
"message" : "string" ,
"status" : "failing"
},
"predictionIntervals" : {
"message" : "string" ,
"status" : "failing"
},
"predictionReady" : {
"message" : "string" ,
"status" : "failing"
},
"seriesType" : {
"message" : "string" ,
"status" : "failing"
},
"supported" : {
"message" : "string" ,
"status" : "failing"
},
"target" : {
"message" : "string" ,
"status" : "failing"
},
"targetClasses" : {
"message" : "string" ,
"status" : "failing"
},
"targetType" : {
"message" : "string" ,
"status" : "failing"
},
"timeSeriesCompatibility" : {
"message" : "string" ,
"status" : "failing"
},
"validChallenger" : {
"message" : "string" ,
"status" : "failing"
}
},
"message" : "string" ,
"status" : "failing"
}
Responses
Status
Header
Type
Format
Description
202
Location
string
A url that can be polled to check the status.
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/model/secondaryDatasetConfiguration/
Retrieve the secondary datasets configuration used by a deployed Feature discovery model.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /model/secondaryDatasetConfiguration/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"created" : "2019-08-24T14:15:22Z" ,
"creatorFullName" : "string" ,
"creatorUserId" : "string" ,
"credentialIds" : [
{
"catalogVersionId" : "string" ,
"credentialId" : "string" ,
"url" : "string"
}
],
"featurelistId" : "string" ,
"isDefault" : true ,
"isDeleted" : true ,
"name" : "string" ,
"projectId" : "string" ,
"secondaryDatasetConfigId" : "string" ,
"secondaryDatasets" : [
{
"catalogId" : "string" ,
"catalogVersionId" : "string" ,
"identifier" : "string" ,
"snapshotPolicy" : "specified"
}
]
}
Responses
Status
Meaning
Description
Schema
200
OK
Secondary datasets configuration.
SecondaryDatasetConfigResponse
404
Not Found
Deployment or secondary datasets configuration cannot be found for the deployed model.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/model/secondaryDatasetConfiguration/
Update the secondary datasets configuration used by the deployed feature discovery model.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /model/secondaryDatasetConfiguration/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"credentialsIds" : [
{
"catalogVersionId" : "string" ,
"credentialId" : "string" ,
"url" : "string"
}
],
"secondaryDatasetConfigId" : "string"
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
SecondaryDatasetConfigUpdate
false
none
Responses
Status
Meaning
Description
Schema
204
No Content
Secondary Datasets Configuration updated successfully.
None
403
Forbidden
Invalid credentials for secondary datasets configuration.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/model/secondaryDatasetConfigurationHistory/
List all the secondary datasets configuration used by a given Feature Discovery deployment
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /model/secondaryDatasetConfigurationHistory/?offset= 0 & limit = 100 \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
offset
query
integer
true
Number of items to skip. Defaults to 0 if not provided.
limit
query
integer
true
Number of items to return, defaults to 100 if not provided.
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"configId" : "string" ,
"configName" : "string" ,
"updated" : "string" ,
"username" : "string"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/model/validation/
Validate that a model can be used to replace the current model of the deployment.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /model/validation/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"modelId" : "string" ,
"modelPackageId" : "string"
}
Parameters
Example responses
200 Response
{
"checks" : {
"combinedModelSegments" : {
"message" : "string" ,
"status" : "failing"
},
"containsTrackedSegmentAttributes" : {
"message" : "string" ,
"status" : "failing"
},
"driftTracking" : {
"message" : "string" ,
"status" : "failing"
},
"featureDataTypes" : {
"message" : "string" ,
"status" : "failing"
},
"features" : {
"message" : "string" ,
"status" : "failing"
},
"humilityRules" : {
"message" : "string" ,
"status" : "failing"
},
"modelCanBeDeployed" : {
"message" : "string" ,
"status" : "failing"
},
"modelStatus" : {
"message" : "string" ,
"status" : "failing"
},
"notCurrentModel" : {
"message" : "string" ,
"status" : "failing"
},
"permission" : {
"message" : "string" ,
"status" : "failing"
},
"predictionIntervals" : {
"message" : "string" ,
"status" : "failing"
},
"predictionReady" : {
"message" : "string" ,
"status" : "failing"
},
"seriesType" : {
"message" : "string" ,
"status" : "failing"
},
"supported" : {
"message" : "string" ,
"status" : "failing"
},
"target" : {
"message" : "string" ,
"status" : "failing"
},
"targetClasses" : {
"message" : "string" ,
"status" : "failing"
},
"targetType" : {
"message" : "string" ,
"status" : "failing"
},
"timeSeriesCompatibility" : {
"message" : "string" ,
"status" : "failing"
},
"validChallenger" : {
"message" : "string" ,
"status" : "failing"
}
},
"message" : "string" ,
"status" : "failing"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/monitoringBatchLimits/
Get the limits related to monitoring batches.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /monitoringBatchLimits/ \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
Responses
Status
Meaning
Description
Schema
200
OK
none
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/monitoringBatches/
List monitoring batches in a deployment.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /monitoringBatches/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
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.
createdBy
query
string
false
ID of the user who created a batch.
search
query
string
false
Search by matching batch name in a case-insensitive manner or exact match of batch ID.
orderBy
query
string
false
Order of the returning batches.
createdAfter
query
string(date-time)
false
Filter for batches created after the given time
createdBefore
query
string(date-time)
false
Filter for batches created before the given time
startAfter
query
string(date-time)
false
Filter for batches with a start time after the given time
endBefore
query
string(date-time)
false
Filter for batches with an end time before the given time
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
orderBy
[name
, -name
, createdAt
, -createdAt
, earliestPredictionTimestamp
, -earliestPredictionTimestamp
, latestPredictionTimestamp
, -latestPredictionTimestamp
]
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"batchPredictionJobId" : "string" ,
"batchPredictionJobStatus" : "INITIALIZING" ,
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string" ,
"name" : "string"
},
"description" : "string" ,
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"externalContextUrl" : "http://example.com" ,
"id" : "string" ,
"isLocked" : true ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"predictionsCount" : 0 ,
"serviceHealth" : {
"message" : "string" ,
"status" : "string"
}
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/monitoringBatches/
Create a monitoring batch for a deployment.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /monitoringBatches/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"batchName" : "string" ,
"description" : "string" ,
"externalContextUrl" : "http://example.com" ,
"isLocked" : true
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
MonitoringBatchCreateUpdate
false
none
Example responses
200 Response
{
"batchPredictionJobId" : "string" ,
"batchPredictionJobStatus" : "INITIALIZING" ,
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string" ,
"name" : "string"
},
"description" : "string" ,
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"externalContextUrl" : "http://example.com" ,
"id" : "string" ,
"isLocked" : true ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"predictionsCount" : 0 ,
"serviceHealth" : {
"message" : "string" ,
"status" : "string"
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/
Delete a monitoring batch in a deployment.
Code samples
# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/deployments/{ deploymentId} /monitoringBatches/{ monitoringBatchId} / \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
monitoringBatchId
path
string
true
ID of the monitoring batch.
Responses
Status
Meaning
Description
Schema
200
OK
none
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/
Retrieve a monitoring batch in a deployment.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /monitoringBatches/{ monitoringBatchId} / \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
monitoringBatchId
path
string
true
ID of the monitoring batch.
Example responses
200 Response
{
"batchPredictionJobId" : "string" ,
"batchPredictionJobStatus" : "INITIALIZING" ,
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string" ,
"name" : "string"
},
"description" : "string" ,
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"externalContextUrl" : "http://example.com" ,
"id" : "string" ,
"isLocked" : true ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"predictionsCount" : 0 ,
"serviceHealth" : {
"message" : "string" ,
"status" : "string"
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/
Update a monitoring batch in a deployment.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /monitoringBatches/{ monitoringBatchId} / \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"batchName" : "string" ,
"description" : "string" ,
"externalContextUrl" : "http://example.com" ,
"isLocked" : true
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
monitoringBatchId
path
string
true
ID of the monitoring batch.
body
body
MonitoringBatchCreateUpdate
false
none
Example responses
200 Response
{
"batchPredictionJobId" : "string" ,
"batchPredictionJobStatus" : "INITIALIZING" ,
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string" ,
"name" : "string"
},
"description" : "string" ,
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"externalContextUrl" : "http://example.com" ,
"id" : "string" ,
"isLocked" : true ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"predictionsCount" : 0 ,
"serviceHealth" : {
"message" : "string" ,
"status" : "string"
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/
List information about models that have data in a monitoring batch.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /monitoringBatches/{ monitoringBatchId} /models/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
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.
modelId
query
string
false
ID of the model associated with a batch.
deploymentId
path
string
true
Unique identifier of the deployment.
monitoringBatchId
path
string
true
ID of the monitoring batch.
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"batchId" : "string" ,
"endTime" : "2019-08-24T14:15:22Z" ,
"modelId" : "string" ,
"predictionsCount" : 0 ,
"startTime" : "2019-08-24T14:15:22Z"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/{modelId}/
Get information about a model that has data in a monitoring batch.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /monitoringBatches/{ monitoringBatchId} /models/{ modelId} / \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
monitoringBatchId
path
string
true
ID of the monitoring batch.
modelId
path
string
true
ID of the model.
Example responses
200 Response
{
"batchId" : "string" ,
"endTime" : "2019-08-24T14:15:22Z" ,
"modelId" : "string" ,
"predictionsCount" : 0 ,
"startTime" : "2019-08-24T14:15:22Z"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/{modelId}/
Update information about model data in a batch.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /monitoringBatches/{ monitoringBatchId} /models/{ modelId} / \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"endTime" : "2019-08-24T14:15:22Z" ,
"startTime" : "2019-08-24T14:15:22Z"
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
monitoringBatchId
path
string
true
ID of the monitoring batch.
modelId
path
string
true
ID of the model.
body
body
MonitoringBatchModelUpdate
false
none
Responses
Status
Meaning
Description
Schema
200
OK
none
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/monitoringDataDeletions/
Delete deployment monitoring data.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /monitoringDataDeletions/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"end" : "2019-08-24T14:15:22Z" ,
"modelId" : "string" ,
"start" : "2019-08-24T14:15:22Z"
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
MonitoringDataDeletePayload
false
none
Responses
Status
Meaning
Description
Schema
200
OK
none
None
404
Not Found
Deployment or model 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}/onDemandReports/
Add report to execution queue.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /onDemandReports/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
ScheduledReportOnDemmand
false
none
Responses
Status
Meaning
Description
Schema
200
OK
Scheduled report job was addded to execution.
None
Status
Header
Type
Format
Description
200
Location
string
URL to poll to track report generation has finished.
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionDataExports/
A list of asynchronous prediction data exports.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /predictionDataExports/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
offset
query
integer
false
Specifies the number of rows to skip before starting to return rows from the query.
limit
query
integer
false
Specifies the number of rows to return after the offset.
status
query
string
false
A prediction data export processing state.
modelId
query
string
false
Id of model used for prediction data export.
batch
query
string
false
If true, returns just the exports associated with batches. If false, just the real-time ones. If not provided, returns both real-time and batch exports.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
status
[CANCELLED
, CREATED
, FAILED
, SCHEDULED
, SUCCEEDED
]
batch
[false
, False
, true
, True
]
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"augmentationType" : "NO_AUGMENTATION" ,
"batches" : [
{
"batchId" : "string" ,
"batchName" : "string"
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : "string" ,
"data" : [
{
"id" : "string" ,
"name" : "string"
}
],
"error" : {
"message" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"status" : "CANCELLED"
}
],
"next" : "string" ,
"previous" : "string" ,
"totalCount" : 0
}
Responses
Status
Meaning
Description
Schema
200
OK
The prediction data exports.
PredictionExportListResponse
403
Forbidden
User does not have permission to access a particular deployment.
None
404
Not Found
Resource not found.
None
422
Unprocessable Entity
Unable to process the prediction data exports list retrieval due to invalid parameter values.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/predictionDataExports/
Create a deployment prediction data export.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /predictionDataExports/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"augmentationType" : "NO_AUGMENTATION" ,
"batchIds" : [
"string"
],
"end" : "2019-08-24T14:15:22Z" ,
"modelId" : "string" ,
"start" : "2019-08-24T14:15:22Z"
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
ExportCreatePayload
false
none
Example responses
202 Response
{
"augmentationType" : "NO_AUGMENTATION" ,
"batches" : [
{
"batchId" : "string" ,
"batchName" : "string"
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : "string" ,
"data" : [
{
"id" : "string" ,
"name" : "string"
}
],
"error" : {
"message" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"status" : "CANCELLED"
}
Responses
Status
Meaning
Description
Schema
202
Accepted
Prediction data export successfully created.
ExportEntity
403
Forbidden
User does not have permission to create a prediction data export.
None
404
Not Found
Resource not found.
None
422
Unprocessable Entity
Unable to process the prediction data export creation request.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionDataExports/{exportId}/
Retrieve a single prediction data export.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /predictionDataExports/{ exportId} / \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
exportId
path
string
true
Unique identifier of the export.
Example responses
200 Response
{
"augmentationType" : "NO_AUGMENTATION" ,
"batches" : [
{
"batchId" : "string" ,
"batchName" : "string"
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : "string" ,
"data" : [
{
"id" : "string" ,
"name" : "string"
}
],
"error" : {
"message" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"status" : "CANCELLED"
}
Responses
Status
Meaning
Description
Schema
200
OK
A given prediction data export user can view is retrieved.
ExportEntity
403
Forbidden
User does not have permission to access a particular deployment or prediction data export.
None
404
Not Found
Resource 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}/predictionDataExports/{exportId}/
Update prediction data export.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /predictionDataExports/{ exportId} / \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"status" : "CANCELLED"
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
exportId
path
string
true
Unique identifier of the export.
body
body
PredictionDataUpdate
false
none
Example responses
204 Response
{
"augmentationType" : "NO_AUGMENTATION" ,
"batches" : [
{
"batchId" : "string" ,
"batchName" : "string"
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : "string" ,
"data" : [
{
"id" : "string" ,
"name" : "string"
}
],
"error" : {
"message" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"status" : "CANCELLED"
}
Responses
Status
Meaning
Description
Schema
204
No Content
Prediction data export successfully updated.
ExportEntity
403
Forbidden
User does not have permission to update a prediction data export.
None
404
Not Found
Requested resource does not exist or the user does not have permission to view it.
None
422
Unprocessable Entity
Unable to process the prediction data export update.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/predictionInputs/fromDataset/
Assigns prediction dataset to the external deployment to enable the analysis of historical model performance. Multiple datasets containing historical predictions for the external deployment can be uploaded. This requires one request for each dataset. For a regression deployment, predictions can be either an int or float. For a classification (binary/multiclass) deployment, predictions must be lists with each list containing probabilities for each class.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /predictionInputs/fromDataset/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"datasetId" : "string" ,
"datasetVersionId" : "string"
}
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
PredictionDatasetAssignment
false
none
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionResults/
Retrieve predictions results of the deployment.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /predictionResults/ \
-H "Accept: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
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.
modelId
query
string
false
The id of the model for which prediction results are being retrieved.
start
query
string(date-time)
false
Start of the period for which prediction results are being retrieved.
end
query
string(date-time)
false
End of the period for which prediction results are being retrieved.
batchId
query
any
false
The id of the batch for which prediction results are being retrieved.
actualsPresent
query
boolean
false
Filters predictions results to only those who have actuals present or with missing actuals.
deploymentId
path
string
true
Unique identifier of the deployment.
Accept
header
string
false
Requested MIME type for the returned data
Enumerated Values
Parameter
Value
Accept
[application/json
, text/csv
]
Example responses
200 Response
{
"associationIdColumnNames" : [
"string"
],
"count" : 0 ,
"data" : [
{
"actual" : 0 ,
"associationId" : "string" ,
"forecastDistance" : 0 ,
"modelId" : "string" ,
"predicted" : 0 ,
"timestamp" : "2019-08-24T14:15:22Z"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com"
}
Responses
Status
Meaning
Description
Schema
200
OK
none
string
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionsOverBatch/
Retrieve metrics about predictions, such as row count, mean predicted value, mean probabilities, and class distribution, over batches.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /predictionsOverBatch/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
segmentAttribute
query
string
false
The name of the segment on which segment analysis is being performed.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
batchId
query
any
false
The id of the batch for which metrics are being retrieved.
modelId
query
string
false
The id of the model for which metrics are being retrieved.
includePercentiles
query
string
false
Include percentiles in the response, only applicable to deployments with binary classification and regression target.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
includePercentiles
[false
, False
, true
, True
]
Example responses
200 Response
{
"baselines" : [
{
"classDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanPredictedValue" : 0 ,
"meanProbabilities" : [
{
"className" : "string" ,
"value" : 0
}
],
"modelId" : "string" ,
"percentiles" : [
{
"percent" : 0 ,
"value" : 0
}
],
"predictionsWarningCount" : 0 ,
"rowCount" : 0
}
],
"buckets" : [
{
"batch" : {
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
},
"classDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanPredictedValue" : 0 ,
"meanProbabilities" : [
{
"className" : "string" ,
"value" : 0
}
],
"percentiles" : [
{
"percent" : 0 ,
"value" : 0
}
],
"predictionsWarningCount" : 0 ,
"rowCount" : 0
}
],
"segmentAttribute" : "string" ,
"segmentValue" : ""
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionsOverTime/
Retrieve metrics about predictions, such as row count, mean predicted value, mean probabilities, and class distribution, over a specific time range.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /predictionsOverTime/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
end
query
string(date-time)
false
End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
bucketSize
query
string
false
Time duration of buckets
segmentAttribute
query
string
false
The name of the segment on which segment analysis is being performed.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
modelId
query
any
false
The id of the models for which metrics are being retrieved.
targetClass
query
any
false
Target class to filter out results.
includePercentiles
query
string
false
Include percentiles in the response, only applicable to deployments with binary classification and regression target.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
bucketSize
[PT1H
, P1D
, P7D
, P1M
]
includePercentiles
[false
, False
, true
, True
]
Example responses
200 Response
{
"baselines" : [
{
"classDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanPredictedValue" : 0 ,
"meanProbabilities" : [
{
"className" : "string" ,
"value" : 0
}
],
"modelId" : "string" ,
"percentiles" : [
{
"percent" : 0 ,
"value" : 0
}
],
"predictionsWarningCount" : 0 ,
"rowCount" : 0
}
],
"buckets" : [
{
"classDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanPredictedValue" : 0 ,
"meanProbabilities" : [
{
"className" : "string" ,
"value" : 0
}
],
"modelId" : "string" ,
"percentiles" : [
{
"percent" : 0 ,
"value" : 0
}
],
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"predictionsWarningCount" : 0 ,
"rowCount" : 0
}
],
"segmentAttribute" : "string" ,
"segmentValue" : ""
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionsVsActualsOverBatch/
Retrieve metrics about predictions and actuals, such as mean predicted & actual value, predicted & actual class distribution, over a specific set of batches.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /predictionsVsActualsOverBatch/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
segmentAttribute
query
string
false
The name of the segment on which segment analysis is being performed.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
modelId
query
string
false
The id of the model for which metrics are being retrieved.
batchId
query
any
false
The id of the batch for which metrics are being retrieved.
targetClass
query
any
false
Target class to filter out results.
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"baselines" : [
{
"actualClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanActualValue" : 0 ,
"meanPredictedValue" : 0 ,
"modelId" : "string" ,
"predictedClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"rowCountTotal" : 0 ,
"rowCountWithActual" : 0
}
],
"buckets" : [
{
"actualClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"batchId" : "string" ,
"batchName" : "string" ,
"meanActualValue" : 0 ,
"meanPredictedValue" : 0 ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"predictedClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"rowCountTotal" : 0 ,
"rowCountWithActual" : 0
}
],
"segmentAttribute" : "string" ,
"segmentValue" : ""
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionsVsActualsOverTime/
Retrieve metrics about predictions and actuals, such as mean predicted & actual value, predicted & actual class distribution, over a specific time range.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /predictionsVsActualsOverTime/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
end
query
string(date-time)
false
End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
bucketSize
query
string
false
Time duration of buckets
segmentAttribute
query
string
false
The name of the segment on which segment analysis is being performed.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
modelId
query
any
false
The id of the models for which metrics are being retrieved.
targetClass
query
any
false
Target class to filter out results.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
bucketSize
[PT1H
, P1D
, P7D
, P1M
]
Example responses
200 Response
{
"baselines" : [
{
"actualClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanActualValue" : 0 ,
"meanPredictedValue" : 0 ,
"modelId" : "string" ,
"predictedClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"rowCountTotal" : 0 ,
"rowCountWithActual" : 0
}
],
"buckets" : [
{
"actualClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanActualValue" : 0 ,
"meanPredictedValue" : 0 ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"predictedClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"rowCountTotal" : 0 ,
"rowCountWithActual" : 0
}
],
"segmentAttribute" : "string" ,
"segmentValue" : "" ,
"summary" : {
"rowCountTotal" : 0 ,
"rowCountWithActual" : 0
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/retrainingPolicies/
Retrieve a list of deployment retraining policies.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /retrainingPolicies/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
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
{
"count" : 0 ,
"data" : [
{
"action" : "create_challenger" ,
"autopilotOptions" : {
"blendBestModels" : true ,
"mode" : "auto" ,
"runLeakageRemovedFeatureList" : true ,
"scoringCodeOnly" : true ,
"shapOnlyMode" : true
},
"description" : "string" ,
"featureListStrategy" : "informative_features" ,
"id" : "string" ,
"latestRun" : {
"challengerId" : "string" ,
"errorMessage" : "string" ,
"finishTime" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"modelPackageId" : "string" ,
"projectId" : "string" ,
"registeredModelId" : "string" ,
"startTime" : "2019-08-24T14:15:22Z" ,
"status" : "string"
},
"modelSelectionStrategy" : "autopilot_recommended" ,
"name" : "string" ,
"projectOptions" : {
"cvMethod" : "RandomCV" ,
"holdoutPct" : null ,
"metric" : "Accuracy" ,
"reps" : null ,
"validationPct" : null ,
"validationType" : "CV"
},
"projectOptionsStrategy" : "same_as_champion" ,
"timeSeriesOptions" : {
"calendarId" : "string" ,
"differencingMethod" : "auto" ,
"exponentiallyWeightedMovingAlpha" : 0 ,
"periodicities" : [
{
"timeSteps" : 0 ,
"timeUnit" : "MILLISECOND"
}
],
"treatAsExponential" : "auto"
},
"trigger" : {
"minIntervalBetweenRuns" : "string" ,
"schedule" : {
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
},
"statusDeclinesToFailing" : true ,
"statusDeclinesToWarning" : true ,
"statusStillInDecline" : true ,
"type" : "schedule"
}
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
Responses
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.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /retrainingPolicies/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"action" : "create_challenger" ,
"autopilotOptions" : {
"blendBestModels" : true ,
"mode" : "auto" ,
"runLeakageRemovedFeatureList" : true ,
"scoringCodeOnly" : true ,
"shapOnlyMode" : true
},
"description" : null ,
"featureListStrategy" : "informative_features" ,
"modelSelectionStrategy" : "autopilot_recommended" ,
"name" : "string" ,
"projectOptions" : {
"cvMethod" : "RandomCV" ,
"holdoutPct" : null ,
"metric" : "Accuracy" ,
"reps" : null ,
"validationPct" : null ,
"validationType" : "CV"
},
"projectOptionsStrategy" : "same_as_champion" ,
"timeSeriesOptions" : {
"calendarId" : "string" ,
"differencingMethod" : "auto" ,
"exponentiallyWeightedMovingAlpha" : 0 ,
"periodicities" : [
{
"timeSteps" : 0 ,
"timeUnit" : "MILLISECOND"
}
],
"treatAsExponential" : "auto"
},
"trigger" : {
"minIntervalBetweenRuns" : "string" ,
"schedule" : {
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
},
"statusDeclinesToFailing" : true ,
"statusDeclinesToWarning" : true ,
"statusStillInDecline" : true ,
"type" : "schedule"
}
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
RetrainingPolicyCreate
false
none
Example responses
200 Response
{
"action" : "create_challenger" ,
"autopilotOptions" : {
"blendBestModels" : true ,
"mode" : "auto" ,
"runLeakageRemovedFeatureList" : true ,
"scoringCodeOnly" : true ,
"shapOnlyMode" : true
},
"description" : "string" ,
"featureListStrategy" : "informative_features" ,
"id" : "string" ,
"latestRun" : {
"challengerId" : "string" ,
"errorMessage" : "string" ,
"finishTime" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"modelPackageId" : "string" ,
"projectId" : "string" ,
"registeredModelId" : "string" ,
"startTime" : "2019-08-24T14:15:22Z" ,
"status" : "string"
},
"modelSelectionStrategy" : "autopilot_recommended" ,
"name" : "string" ,
"projectOptions" : {
"cvMethod" : "RandomCV" ,
"holdoutPct" : null ,
"metric" : "Accuracy" ,
"reps" : null ,
"validationPct" : null ,
"validationType" : "CV"
},
"projectOptionsStrategy" : "same_as_champion" ,
"timeSeriesOptions" : {
"calendarId" : "string" ,
"differencingMethod" : "auto" ,
"exponentiallyWeightedMovingAlpha" : 0 ,
"periodicities" : [
{
"timeSteps" : 0 ,
"timeUnit" : "MILLISECOND"
}
],
"treatAsExponential" : "auto"
},
"trigger" : {
"minIntervalBetweenRuns" : "string" ,
"schedule" : {
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
},
"statusDeclinesToFailing" : true ,
"statusDeclinesToWarning" : true ,
"statusStillInDecline" : true ,
"type" : "schedule"
}
}
Responses
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.
Code samples
# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/deployments/{ deploymentId} /retrainingPolicies/{ retrainingPolicyId} / \
-H "Authorization: Bearer {access-token}"
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.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /retrainingPolicies/{ retrainingPolicyId} / \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
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
{
"action" : "create_challenger" ,
"autopilotOptions" : {
"blendBestModels" : true ,
"mode" : "auto" ,
"runLeakageRemovedFeatureList" : true ,
"scoringCodeOnly" : true ,
"shapOnlyMode" : true
},
"description" : "string" ,
"featureListStrategy" : "informative_features" ,
"id" : "string" ,
"latestRun" : {
"challengerId" : "string" ,
"errorMessage" : "string" ,
"finishTime" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"modelPackageId" : "string" ,
"projectId" : "string" ,
"registeredModelId" : "string" ,
"startTime" : "2019-08-24T14:15:22Z" ,
"status" : "string"
},
"modelSelectionStrategy" : "autopilot_recommended" ,
"name" : "string" ,
"projectOptions" : {
"cvMethod" : "RandomCV" ,
"holdoutPct" : null ,
"metric" : "Accuracy" ,
"reps" : null ,
"validationPct" : null ,
"validationType" : "CV"
},
"projectOptionsStrategy" : "same_as_champion" ,
"timeSeriesOptions" : {
"calendarId" : "string" ,
"differencingMethod" : "auto" ,
"exponentiallyWeightedMovingAlpha" : 0 ,
"periodicities" : [
{
"timeSteps" : 0 ,
"timeUnit" : "MILLISECOND"
}
],
"treatAsExponential" : "auto"
},
"trigger" : {
"minIntervalBetweenRuns" : "string" ,
"schedule" : {
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
},
"statusDeclinesToFailing" : true ,
"statusDeclinesToWarning" : true ,
"statusStillInDecline" : true ,
"type" : "schedule"
}
}
Responses
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.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /retrainingPolicies/{ retrainingPolicyId} / \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"action" : "create_challenger" ,
"autopilotOptions" : {
"blendBestModels" : true ,
"mode" : "auto" ,
"runLeakageRemovedFeatureList" : true ,
"scoringCodeOnly" : true ,
"shapOnlyMode" : true
},
"description" : "string" ,
"featureListStrategy" : "informative_features" ,
"modelSelectionStrategy" : "autopilot_recommended" ,
"name" : "string" ,
"projectOptions" : {
"cvMethod" : "RandomCV" ,
"holdoutPct" : null ,
"metric" : "Accuracy" ,
"reps" : null ,
"validationPct" : null ,
"validationType" : "CV"
},
"projectOptionsStrategy" : "same_as_champion" ,
"timeSeriesOptions" : {
"calendarId" : "string" ,
"differencingMethod" : "auto" ,
"exponentiallyWeightedMovingAlpha" : 0 ,
"periodicities" : [
{
"timeSteps" : 0 ,
"timeUnit" : "MILLISECOND"
}
],
"treatAsExponential" : "auto"
},
"trigger" : {
"minIntervalBetweenRuns" : "string" ,
"schedule" : {
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
},
"statusDeclinesToFailing" : true ,
"statusDeclinesToWarning" : true ,
"statusStillInDecline" : true ,
"type" : "schedule"
}
}
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
{
"action" : "create_challenger" ,
"autopilotOptions" : {
"blendBestModels" : true ,
"mode" : "auto" ,
"runLeakageRemovedFeatureList" : true ,
"scoringCodeOnly" : true ,
"shapOnlyMode" : true
},
"description" : "string" ,
"featureListStrategy" : "informative_features" ,
"id" : "string" ,
"latestRun" : {
"challengerId" : "string" ,
"errorMessage" : "string" ,
"finishTime" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"modelPackageId" : "string" ,
"projectId" : "string" ,
"registeredModelId" : "string" ,
"startTime" : "2019-08-24T14:15:22Z" ,
"status" : "string"
},
"modelSelectionStrategy" : "autopilot_recommended" ,
"name" : "string" ,
"projectOptions" : {
"cvMethod" : "RandomCV" ,
"holdoutPct" : null ,
"metric" : "Accuracy" ,
"reps" : null ,
"validationPct" : null ,
"validationType" : "CV"
},
"projectOptionsStrategy" : "same_as_champion" ,
"timeSeriesOptions" : {
"calendarId" : "string" ,
"differencingMethod" : "auto" ,
"exponentiallyWeightedMovingAlpha" : 0 ,
"periodicities" : [
{
"timeSteps" : 0 ,
"timeUnit" : "MILLISECOND"
}
],
"treatAsExponential" : "auto"
},
"trigger" : {
"minIntervalBetweenRuns" : "string" ,
"schedule" : {
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
},
"statusDeclinesToFailing" : true ,
"statusDeclinesToWarning" : true ,
"statusStillInDecline" : true ,
"type" : "schedule"
}
}
Responses
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.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /retrainingPolicies/{ retrainingPolicyId} /runs/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
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
{
"count" : 0 ,
"data" : [
{
"challengerId" : "string" ,
"errorMessage" : "string" ,
"finishTime" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"modelPackageId" : "string" ,
"projectId" : "string" ,
"registeredModelId" : "string" ,
"startTime" : "2019-08-24T14:15:22Z" ,
"status" : "string"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
Responses
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.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /retrainingPolicies/{ retrainingPolicyId} /runs/ \
-H "Authorization: Bearer {access-token}"
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.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /retrainingPolicies/{ retrainingPolicyId} /runs/{ runId} / \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
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
{
"challengerId" : "string" ,
"errorMessage" : "string" ,
"finishTime" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"modelPackageId" : "string" ,
"projectId" : "string" ,
"registeredModelId" : "string" ,
"startTime" : "2019-08-24T14:15:22Z" ,
"status" : "string"
}
Responses
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.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /retrainingPolicies/{ retrainingPolicyId} /runs/{ runId} / \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"status" : "cancelled"
}
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
{
"challengerId" : "string" ,
"errorMessage" : "string" ,
"finishTime" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"modelPackageId" : "string" ,
"projectId" : "string" ,
"registeredModelId" : "string" ,
"startTime" : "2019-08-24T14:15:22Z" ,
"status" : "string"
}
Responses
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.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /retrainingSettings/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"dataset" : {
"id" : "string" ,
"name" : "string"
},
"predictionEnvironment" : {
"id" : "string" ,
"name" : "string"
},
"retrainingUser" : {
"id" : "string" ,
"username" : "string"
}
}
Responses
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.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /retrainingSettings/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"credentialId" : "string" ,
"datasetId" : "string" ,
"predictionEnvironmentId" : "string" ,
"retrainingUserId" : "string"
}
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
GET /api/v2/deployments/{deploymentId}/scoringCode/
Retrieve Scoring Code of the current deployed model for making predictions outside of a DataRobot prediction server.
You need the "Scoring Code" feature enabled to use this route.
By default, returns a compiled executable JAR that can be executed locally to calculate model predictions, or it can be used as a library for a Java application. Execute it with the '--help` parameters to learn how to use it as a command-line utility.
See model API documentation at https://javadoc.io/doc/com.datarobot/datarobot-prediction/latest/index.html to be able to use it inside an existing Java application.
With sourceCode query parameter set to 'true', returns a source code archive that can be used to review internal calculations of the model.
This JAR is NOT executable.
See "https://docs.datarobot.com/en/docs/predictions/port-pred/scoring-code/index.html" documentation in DataRobot application for more information.
Note
Cannot retrieve source code if agent is included.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /scoringCode/ \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
sourceCode
query
string
false
Whether source code or binary of the Scoring Code will be retrieved
includeAgent
query
string
false
Whether the Scoring code retrieved will include tracking agent
includePe
query
string
false
Please use includePredictionExplanations parameter instead
includePredictionExplanations
query
string
false
Whether the Scoring Code retrieved will include prediction explanations
includePredictionIntervals
query
string
false
Whether the Scoring Code retrieved will include prediction intervals
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
sourceCode
[false
, False
, true
, True
]
includeAgent
[false
, False
, true
, True
]
includePe
[false
, False
, true
, True
]
includePredictionExplanations
[false
, False
, true
, True
]
includePredictionIntervals
[false
, False
, true
, True
]
Responses
Status
Meaning
Description
Schema
200
OK
JAR file
None
Status
Header
Type
Format
Description
200
Content-Disposition
string
Indicating the content is supposed to be downloaded as an attachment
200
Content-Type
string
application/java-archive
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/scoringCodeBuilds/
Build Java package containing Scoring Code with agent integration.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /scoringCodeBuilds/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"includeAgent" : true ,
"includePredictionExplanations" : true ,
"includePredictionIntervals" : true
}
Parameters
Responses
Status
Meaning
Description
Schema
200
OK
none
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/serviceStats/
Retrieve all deployment service health metrics over a single period of time.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /serviceStats/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
end
query
string(date-time)
false
End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
executionTimeQuantile
query
number
false
Quantile for executionTime metric.
responseTimeQuantile
query
number
false
Quantile for responseTime metric.
slowRequestsThreshold
query
integer
false
Threshold for slowRequests metric.
segmentAttribute
query
string
false
The name of a segment attribute used for segment analysis.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
modelId
query
string
false
The id of the model for which metrics are being retrieved.
monitoringType
query
string
false
The monitoring type for which segment attributes and segment values are being retrieved. Can be one of three options which corresponds to a deployment monitoring tab
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
segmentAttribute
[DataRobot-Consumer
, DataRobot-Remote-IP
, DataRobot-Host-IP
]
monitoringType
[serviceHealth
, dataDrift
, accuracy
, humility
, batchServiceHealth
, batchDataDrift
, batchAccuracy
, customMetrics
, batchCustomMetrics
]
Example responses
200 Response
{
"metrics" : {
"cacheHitRatio" : 0 ,
"executionTime" : 0 ,
"medianLoad" : 0 ,
"numConsumers" : 0 ,
"peakLoad" : 0 ,
"responseTime" : 0 ,
"serverErrorRate" : 0 ,
"slowRequests" : 0 ,
"totalPredictions" : 0 ,
"totalRequests" : 0 ,
"userErrorRate" : 0
},
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"segmentAttribute" : "string" ,
"segmentValue" : ""
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/serviceStatsOverBatch/
Retrieve values for one single deployment service health metric over batch.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /serviceStatsOverBatch/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
segmentAttribute
query
string
false
The name of a segment attribute used for segment analysis.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
batchId
query
any
false
The id of the batch for which metrics are being retrieved.
modelId
query
string
false
The id of the model for which metrics are being retrieved.
metric
query
string
false
A service health metric.
quantile
query
number
false
Quantile for executionTime and responseTime metrics
threshold
query
integer
false
Threshold for slowQueries metric.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
segmentAttribute
[DataRobot-Consumer
, DataRobot-Remote-IP
, DataRobot-Host-IP
]
metric
[totalPredictions
, totalRequests
, slowRequests
, executionTime
, responseTime
, userErrorRate
, serverErrorRate
, numConsumers
, cacheHitRatio
]
Example responses
200 Response
{
"buckets" : [
{
"batch" : {
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
},
"value" : 0
}
],
"metric" : "string" ,
"segmentAttribute" : "string" ,
"segmentValue" : ""
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/serviceStatsOverTime/
Retrieve values for one single deployment service health metric over time.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /serviceStatsOverTime/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
end
query
string(date-time)
false
End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
bucketSize
query
string(duration)
false
The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time.
metric
query
string
false
Name of the metric. See below for a list of supported metrics.
quantile
query
number
false
A quantile for resulting data, used if metric
is executionTime
or responseTime
, defaults to 0.5.
threshold
query
integer
false
A threshold for filtering results, used if metric
is slowQueries
, defaults to 1000.
segmentAttribute
query
string
false
The name of a segment attribute used for segment analysis.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
modelId
query
string
false
The id of the model for which metrics are being retrieved.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
metric
[totalPredictions
, totalRequests
, slowRequests
, executionTime
, responseTime
, userErrorRate
, serverErrorRate
, numConsumers
, cacheHitRatio
, medianLoad
, peakLoad
]
segmentAttribute
[DataRobot-Consumer
, DataRobot-Remote-IP
, DataRobot-Host-IP
]
Example responses
200 Response
{
"buckets" : [
{
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"value" : 0
}
],
"metric" : "string" ,
"modelId" : "string" ,
"segmentAttribute" : "string" ,
"segmentValue" : "" ,
"summary" : {
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"value" : 0
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/settings/
Retrieve deployment settings.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /settings/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"associationId" : {
"columnNames" : [
"string"
],
"requiredInPredictionRequests" : true
},
"automaticActuals" : {
"enabled" : true
},
"biasAndFairness" : {
"fairnessMetricsSet" : "proportionalParity" ,
"fairnessThreshold" : 1 ,
"preferableTargetValue" : true ,
"protectedFeatures" : [
"string"
]
},
"challengerModels" : {
"enabled" : true
},
"featureDrift" : {
"enabled" : true
},
"humility" : {
"enabled" : true
},
"predictionIntervals" : {
"enabled" : true ,
"percentiles" : [
0
]
},
"predictionWarning" : {
"customBoundaries" : {
"lower" : 0 ,
"upper" : 0
},
"enabled" : true
},
"predictionsByForecastDate" : {
"columnName" : "string" ,
"datetimeFormat" : "string" ,
"enabled" : true
},
"predictionsDataCollection" : {
"enabled" : true
},
"segmentAnalysis" : {
"attributes" : [
"string"
],
"enabled" : true
},
"targetDrift" : {
"enabled" : true
}
}
Responses
Status
Meaning
Description
Schema
200
OK
The deployment settings
DeploymentSettingsResponse
404
Not Found
Either the deployment does not exist or the user does not have permission to view the deployment.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/settings/
Updates deployment settings.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /settings/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"associationId" : {
"columnNames" : [
"string"
],
"requiredInPredictionRequests" : true
},
"automaticActuals" : {
"enabled" : true
},
"biasAndFairness" : {
"fairnessMetricsSet" : "proportionalParity" ,
"fairnessThreshold" : 1 ,
"preferableTargetValue" : true ,
"protectedFeatures" : [
"string"
]
},
"challengerModels" : {
"enabled" : true
},
"featureDrift" : {
"enabled" : true
},
"humility" : {
"enabled" : true
},
"predictionIntervals" : {
"enabled" : true ,
"percentiles" : [
0
]
},
"predictionWarning" : {
"customBoundaries" : {
"lower" : 0 ,
"upper" : 0
},
"enabled" : true
},
"predictionsByForecastDate" : {
"columnName" : "string" ,
"datetimeFormat" : "string" ,
"enabled" : true
},
"predictionsDataCollection" : {
"enabled" : true
},
"segmentAnalysis" : {
"attributes" : [
"string"
],
"enabled" : true
},
"targetDrift" : {
"enabled" : true
}
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
DeploymentSettingsUpdate
false
none
Responses
Status
Meaning
Description
Schema
202
Accepted
Job submitted. See Location header.
None
403
Forbidden
User can view deployment but does not have permission to update settings.
None
404
Not Found
Either the deployment does not exist or the user does not have permission to view the deployment.
None
409
Conflict
The proposed settings changes are invalid and would result in a logical conflict.
None
422
Unprocessable Entity
The provided settings changes could not be processed.
None
Status
Header
Type
Format
Description
202
Location
string
url
the location to poll for settings update status
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/sharedRoles/
Get a list of users, groups and organizations who have access to this deployment and their roles.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /sharedRoles/?offset= 0 & limit = 10 \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
id
query
string
false
Only return roles for a user, group or organization with this identifier.
offset
query
integer
true
This many results will be skipped
limit
query
integer
true
At most this many results are returned
name
query
string
false
Only return roles for a user, group or organization with this name.
shareRecipientType
query
string
false
List access controls for recipients with this type.
deploymentId
path
string
true
The deployment ID.
Enumerated Values
Parameter
Value
shareRecipientType
[user
, group
, organization
]
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"id" : "string" ,
"name" : "string" ,
"role" : "ADMIN" ,
"shareRecipientType" : "user"
}
],
"next" : "string" ,
"previous" : "string" ,
"totalCount" : 0
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/sharedRoles/
Set roles for users on this model deployment.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /sharedRoles/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
{
"operation" : "updateRoles" ,
"roles" : [
{
"canShare" : true ,
"role" : "string" ,
"shareRecipientType" : "user" ,
"username" : "string"
}
]
}
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
The deployment ID.
body
body
SharedRolesUpdateWithGrant
false
none
Responses
Status
Meaning
Description
Schema
204
No Content
Roles updated successfully.
None
409
Conflict
The request would leave the project without an owner.
None
422
Unprocessable Entity
One of the users in the request does not exist, or the request is otherwise invalid
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/status/
Change deployment status.
Code samples
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{ deploymentId} /status/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
body
body
DeploymentStatusUpdate
false
none
Responses
Status
Meaning
Description
Schema
202
Accepted
Job submitted. See Location header.
None
409
Conflict
Deployment is already in process of status change or already in requested status.
None
422
Unprocessable Entity
Deployment status change request could not be processed.
None
Status
Header
Type
Format
Description
202
Location
string
URL for tracking async job status.
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/targetDrift/
Retrieve target drift data.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /targetDrift/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
end
query
string(date-time)
false
End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
modelId
query
string
false
An ID of the model in the deployment. If not set, defaults to the deployment current model.
metric
query
string
false
Metric used to calculate drift score.
segmentAttribute
query
string
false
The name of a segment attribute used for segment analysis.
segmentValue
query
string
false
The value of the segmentAttribute
to segment on.
batchId
query
any
false
The id of the batch for which metrics are being retrieved.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
metric
[psi
, kl_divergence
, dissimilarity
, hellinger
, js_divergence
]
Example responses
200 Response
{
"baselineSampleSize" : 0 ,
"batchId" : [],
"driftScore" : 0 ,
"metric" : "psi" ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"segmentAttribute" : "string" ,
"segmentValue" : "" ,
"targetName" : "string" ,
"type" : "numeric"
}
Responses
Status
Meaning
Description
Schema
200
OK
Target drift over specified time period retrieved.
TargetDriftResponse
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/trainingDataExports/
A list of successful training data exports.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /trainingDataExports/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
offset
query
integer
false
Specifies the number of rows to skip before starting to return rows from the query.
limit
query
integer
false
Specifies the number of rows to return after the offset.
modelId
query
string
false
Id of model used for training data export.
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : "string" ,
"data" : {
"id" : "string" ,
"name" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"modelPackageId" : "string"
}
],
"next" : "string" ,
"previous" : "string" ,
"totalCount" : 0
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/trainingDataExports/
Create a deployment training data export.
Code samples
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{ deploymentId} /trainingDataExports/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}"
Body parameter
Parameters
Responses
Status
Meaning
Description
Schema
202
Accepted
Training data export successfully enqueued.
None
403
Forbidden
User does not have permission to create a training data export.
None
404
Not Found
Resource not found.
None
422
Unprocessable Entity
Unable to process the training data export request.
None
Status
Header
Type
Format
Description
202
Location
string
URL to poll to get status of job that waits for the training data export to finish
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/trainingDataExports/{exportId}/
Retrieve a single training data export details.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{ deploymentId} /trainingDataExports/{ exportId} / \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
deploymentId
path
string
true
Unique identifier of the deployment.
exportId
path
string
true
Unique identifier of the export.
Example responses
200 Response
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : "string" ,
"data" : {
"id" : "string" ,
"name" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"modelPackageId" : "string"
}
Responses
Status
Meaning
Description
Schema
200
OK
A given training data export user can view is retrieved.
TrainingDataExportEntity
403
Forbidden
User does not have permission to access a particular deployment or training data export.
None
404
Not Found
Resource not found.
None
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/predictionServers/
List prediction servers available for a user.
Code samples
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/predictionServers/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name
In
Type
Required
Description
offset
query
integer
false
This many results will be skipped.
limit
query
integer
false
At most this many results are returned.
Example responses
200 Response
{
"count" : 0 ,
"data" : [
{
"batchPredictions" : {
"processing" : 0 ,
"queued" : 0
},
"datarobot-key" : "string" ,
"id" : "string" ,
"url" : "string"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas
AccessControlV2
{
"id" : "string" ,
"name" : "string" ,
"role" : "ADMIN" ,
"shareRecipientType" : "user"
}
Properties
Name
Type
Required
Restrictions
Description
id
string
true
The identifier of the recipient.
name
string
true
The name of the recipient.
role
string
true
The role of the recipient on this entity.
shareRecipientType
string
true
The type of the recipient.
Enumerated Values
Property
Value
role
[ADMIN
, CONSUMER
, DATA_SCIENTIST
, EDITOR
, OBSERVER
, OWNER
, READ_ONLY
, READ_WRITE
, USER
]
shareRecipientType
[user
, group
, organization
]
AccuracyBatchBaselineBucket
{
"metric" : "string" ,
"modelId" : "string" ,
"perClass" : [
{
"className" : "string" ,
"value" : 0
}
],
"sampleSize" : 0 ,
"value" : 0
}
Properties
Name
Type
Required
Restrictions
Description
metric
string
true
Name of the metric.
modelId
string
false
The id of the model for which metrics are being retrieved.
perClass
[AccuracyPerClass ]
false
Accuracy metric for selected classes.
sampleSize
integer
true
Number of rows used to calculate the metric.
value
number¦null
true
Accuracy metric value.
AccuracyBatchBucket
{
"batchId" : "string" ,
"batchName" : "string" ,
"metric" : "string" ,
"modelId" : "string" ,
"perClass" : [
{
"className" : "string" ,
"value" : 0
}
],
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"value" : 0
}
Properties
Name
Type
Required
Restrictions
Description
batchId
string
true
ID of the batch.
batchName
string
true
Name of the batch.
metric
string
true
Name of the metric.
modelId
string
false
The id of the model for which metrics are being retrieved.
perClass
[AccuracyPerClass ]
false
Accuracy metric for selected classes.
period
BatchPeriod
true
Time period of the batch.
sampleSize
integer
true
Number of rows used to calculate the metric.
value
number¦null
true
Accuracy metric value.
AccuracyHealth
{
"batchCount" : "1" ,
"failingThreshold" : 0 ,
"measurement" : "percent" ,
"metric" : "AUC" ,
"warningThreshold" : 0
}
Properties
Name
Type
Required
Restrictions
Description
batchCount
string
false
Number of recent batches used to compute accuracy health status, only applicable to deployments with batch monitoring enabled.
failingThreshold
number¦null
false
Threshold for failing status.
measurement
string¦null
false
Measurement for calculating accuracy health status.
metric
string¦null
false
Metric used for calculating accuracy health status.
warningThreshold
number¦null
false
Threshold for warning status.
Enumerated Values
Property
Value
batchCount
[1
, 5
, 10
, 50
, 100
, 1000
, 10000
]
measurement
[percent
, value
]
metric
[AUC
, Accuracy
, Balanced Accuracy
, F1
, FPR
, FVE Binomial
, FVE Gamma
, FVE Multinomial
, FVE Poisson
, FVE Tweedie
, Gamma Deviance
, Gini Norm
, Kolmogorov-Smirnov
, LogLoss
, MAE
, MAPE
, MCC
, NPV
, PPV
, Poisson Deviance
, R Squared
, RMSE
, RMSLE
, Rate@Top10%
, Rate@Top5%
, TNR
, TPR
, Tweedie Deviance
]
AccuracyLegacyTimeBucket
{
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"value" : 0 ,
"valuePerClass" : "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
}
Properties
Name
Type
Required
Restrictions
Description
period
TimeRange
true
Start and end of the bucket's queried period, null if bucket is calculated on training data.
sampleSize
integer¦null
true
Number of predictions used to calculate the metric.
value
number¦null
true
Value of the metric, null if no value.
valuePerClass
object¦null
false
A dict keyed by class names with metric calculated for specific classes as values, if targetClass is set. Deprecated and to be removed in v2.35, use perClass instead.
AccuracyOverBatchResponse
{
"baselines" : [
{
"metric" : "string" ,
"modelId" : "string" ,
"perClass" : [
{
"className" : "string" ,
"value" : 0
}
],
"sampleSize" : 0 ,
"value" : 0
}
],
"buckets" : [
{
"batchId" : "string" ,
"batchName" : "string" ,
"metric" : "string" ,
"modelId" : "string" ,
"perClass" : [
{
"className" : "string" ,
"value" : 0
}
],
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"value" : 0
}
]
}
Properties
Name
Type
Required
Restrictions
Description
baselines
[AccuracyBatchBaselineBucket ]
true
Accuracy metric training baseline.
buckets
[AccuracyBatchBucket ]
true
Accuracy metric for batches that are requested, with non-existing batches omitted.
AccuracyOverTimeResponse
{
"baseline" : {
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"value" : 0 ,
"valuePerClass" : "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
},
"baselines" : [
{
"modelId" : "string" ,
"perClass" : [
{
"className" : "string" ,
"value" : 0
}
],
"sampleSize" : 0 ,
"value" : 0
}
],
"buckets" : [
{
"modelId" : "string" ,
"perClass" : [
{
"className" : "string" ,
"value" : 0
}
],
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"value" : 0 ,
"valuePerClass" : "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
}
],
"metric" : "AUC" ,
"modelId" : "string" ,
"segmentAttribute" : "string" ,
"segmentValue" : "" ,
"summary" : {
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"value" : 0 ,
"valuePerClass" : "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
}
}
Properties
Name
Type
Required
Restrictions
Description
baseline
AccuracyLegacyTimeBucket
true
A bucket object containing metric info calculated on training baseline. Deprecated and to be removed in v2.35, use baselines field instead.
baselines
[AccuracyTimeBaselineBucket ]
true
Accuracy metric training baseline.
buckets
[AccuracyTimeBucket ]
true
Accuracy metric for requested models and time buckets.
metric
string
true
The metric being retrieved.
modelId
string
false
The id of the model for which metrics are being retrieved. Deprecated and to be removed in v2.35, use modelId in each baseline or bucket object.
segmentAttribute
string¦null
false
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
The value of the segmentAttribute
to segment on.
summary
AccuracyLegacyTimeBucket
true
A bucket object containing metric info calculated. Deprecated and to be removed in v2.35, use summaries field with includeSummaries query param to get accuracy metrics computed over the whole time range.
Enumerated Values
Property
Value
metric
[AUC
, Accuracy
, Balanced Accuracy
, F1
, FPR
, FVE Binomial
, FVE Gamma
, FVE Multinomial
, FVE Poisson
, FVE Tweedie
, Gamma Deviance
, Gini Norm
, Kolmogorov-Smirnov
, LogLoss
, MAE
, MAPE
, MCC
, NPV
, PPV
, Poisson Deviance
, R Squared
, RMSE
, RMSLE
, Rate@Top10%
, Rate@Top5%
, TNR
, TPR
, Tweedie Deviance
]
AccuracyPerClass
{
"className" : "string" ,
"value" : 0
}
Properties
Name
Type
Required
Restrictions
Description
className
string
true
Name of the class.
value
number¦null
true
Value of the metric.
AccuracyResponse
{
"batchIds" : [
"string"
],
"metrics" : "\n {\"metrics\": {\n \"LogLoss\": {\n \"baselineValue\": 0.454221484838069,\n \"value\": 0.880778024500618,\n \"percentChange\": -93.91\n },\n \"AUC\": {\n \"baselineValue\": 0.8690358459556535,\n \"value\": 0.5294117647058824,\n \"percentChange\": -39.08\n },\n \"Kolmogorov-Smirnov\": {\n \"baselineValue\": 0.5753202944706626,\n \"value\": 0.4117647058823529,\n \"percentChange\": -28.43\n },\n \"Rate@Top10%\": {\n \"baselineValue\": 0.9603223806571606,\n \"value\": 1.0,\n \"percentChange\": 4.13\n },\n \"Gini Norm\": {\n \"baselineValue\": 0.7380716919113071,\n \"value\": 0.05882352941176472,\n \"percentChange\": -92.03\n }\n }\n " ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"segmentAttribute" : "string" ,
"segmentValue" : "" ,
"targetClasses" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
batchIds
[string]
false
ID of the batches used to calculate accuracy metrics.
metrics
object
true
Accuracy metrics of the deployment, keyed by metric names, each value is a metric
object with detail on a single metric. For classification deployments: - LogLoss - AUC - Kolmogorov - Smirnov - Gini Norm - Rate @ Top10 % For regression deployments: - RMSE - MAE - Gamma Deviance - Tweedie Deviance - R Squared
modelId
string
false
The id of the model for which metrics are being retrieved.
period
TimeRange
false
Time Range used to calculate accuracy metrics.
segmentAttribute
string¦null
false
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
The value of the segmentAttribute
to segment on.
targetClasses
string¦null
false
Target classes provided in the request.
AccuracyTimeBaselineBucket
{
"modelId" : "string" ,
"perClass" : [
{
"className" : "string" ,
"value" : 0
}
],
"sampleSize" : 0 ,
"value" : 0
}
Properties
Name
Type
Required
Restrictions
Description
modelId
string
false
The id of the model for which metrics are being retrieved.
perClass
[AccuracyPerClass ]
false
Accuracy metric values for selected classes, only available for multiclass deployments.
sampleSize
integer
true
Number of rows used to calculate the metric.
value
number¦null
true
Accuracy metric value.
AccuracyTimeBucket
{
"modelId" : "string" ,
"perClass" : [
{
"className" : "string" ,
"value" : 0
}
],
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"value" : 0 ,
"valuePerClass" : "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
}
Properties
Name
Type
Required
Restrictions
Description
modelId
string
false
The id of the model for which metrics are being retrieved.
perClass
[AccuracyPerClass ]
false
Accuracy metric values for selected classes, only available for multiclass deployments.
period
TimeRange
true
Time period of the bucket.
sampleSize
integer
true
Number of rows used to calculate the metric.
value
number¦null
true
Accuracy metric value.
valuePerClass
object¦null
false
A dict keyed by class names with metric calculated for specific classes as values, if targetClass is set. Deprecated and to be removed in v2.35, use perClass instead.
Actual
{
"actualValue" : 0 ,
"associationId" : "string" ,
"timestamp" : "2019-08-24T14:15:22Z" ,
"wasActedOn" : true
}
Properties
Name
Type
Required
Restrictions
Description
actualValue
any
true
The actual value of a prediction. Will be numeric for regression models and a string label for classification models.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
integer
false
none
or
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
or
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
continued
Name
Type
Required
Restrictions
Description
associationId
string
true
maxLength: 128
A unique identifier used with a predicted row.
timestamp
string(date-time)¦null
false
The datetime when actual values were obtained, formatted according to RFC3339.
wasActedOn
boolean¦null
false
Indicates if the prediction was acted on in a way that could have affected the actual outcome. For example, if a hospital patient is predicted to be readmitted in 30 days, extra procedures or new medication might be given to mitigate this problem, influencing the actual outcome of the prediction.
ActualClassDistribution
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
Properties
Name
Type
Required
Restrictions
Description
className
string
true
Name of the class.
count
integer
true
Count of actual rows labeled with a class in the bucket.
percent
number
true
Percent of actual rows labeled with a class in the bucket.
ActualsCreatedBy
Properties
Name
Type
Required
Restrictions
Description
id
string
true
The ID of user who created actuals data export.
ActualsDataEntry
{
"id" : "string" ,
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
id
string
true
The ID of an entry.
name
string
true
A name of an entry.
ActualsDataExportEntity
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"data" : [
{
"id" : "string" ,
"name" : "string"
}
],
"error" : {
"message" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"onlyMatchedPredictions" : true ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"status" : "CANCELLED"
}
Properties
Name
Type
Required
Restrictions
Description
createdAt
string(date-time)
true
Actuals data export creation timestamp.
createdBy
ActualsCreatedBy
true
The user that created actuals data export.
data
[ActualsDataEntry ]¦null
false
An actuals data export collected data entries. Available only when status is SUCCEEDED.
error
ActualsError
false
Error description. Appears when actuals data export job failed (status is FAILED).
id
string
true
The ID of the actuals data export.
modelId
string
true
The ID of the model (or null if not specified).
onlyMatchedPredictions
boolean
false
If true, exports actuals with matching predictions only.
period
ActualsDataTimeRange
true
An actuals data time range definition.
status
string
true
An actuals data export processing state.
Enumerated Values
Property
Value
status
[CANCELLED
, CREATED
, FAILED
, SCHEDULED
, SUCCEEDED
]
ActualsDataTimeRange
{
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
end
string(date-time)
true
End of the period of actuals data to collect.
start
string(date-time)
true
Start of the period of actuals data to collect.
ActualsDataUpdate
{
"status" : "CANCELLED"
}
Properties
Name
Type
Required
Restrictions
Description
status
string
false
An actuals data export state overwrite value.
Enumerated Values
Property
Value
status
CANCELLED
ActualsError
Properties
Name
Type
Required
Restrictions
Description
message
string
true
A human readable error message describing failure cause.
ActualsExportCreatePayload
{
"end" : "2019-08-24T14:15:22Z" ,
"modelId" : "string" ,
"onlyMatchedPredictions" : true ,
"start" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
end
string(date-time)
true
End of the period of actuals data to collect.
modelId
string
false
The ID of the model.
onlyMatchedPredictions
boolean
false
If true, exports actuals with matching predictions only.
start
string(date-time)
true
Start of the period of actuals data to collect.
ActualsExportListResponse
{
"count" : 0 ,
"data" : [
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"data" : [
{
"id" : "string" ,
"name" : "string"
}
],
"error" : {
"message" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"onlyMatchedPredictions" : true ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"status" : "CANCELLED"
}
],
"next" : "string" ,
"previous" : "string" ,
"totalCount" : 0
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
true
minimum: 0
Number of paginated entries.
data
[ActualsDataExportEntity ]
true
A list of asynchronous actuals data exports.
next
string¦null
true
URL to the next page, or null if there is no such page.
previous
string¦null
true
URL to the previous page, or null if there is no such page
totalCount
integer
true
minimum: 0
Total number of entries.
AssociationID
{
"columnNames" : [
"string"
],
"requiredInPredictionRequests" : true
}
Properties
Name
Type
Required
Restrictions
Description
columnNames
[string]¦null
true
Indicates the columns that will be used to associate actuals with predictions.
requiredInPredictionRequests
boolean
true
Indicates whether the association ID is required in prediction requests.
AssociationIDUpdate
{
"columnNames" : [
"string"
],
"requiredInPredictionRequests" : true
}
Properties
Name
Type
Required
Restrictions
Description
columnNames
[string]¦null
false
maxItems: 1 minItems: 1
List of column names used to represent an association id. Currently, exactly one column name may be provided.
requiredInPredictionRequests
boolean
false
Whether or not association id values are required in each prediction request for this deployment. Note that you may not change an association ID's column names after they have been set and predictions including those columns have been made
AutomatiActuals
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
Indicates whether automatic actuals is enabled for the deployment.
AutopilotOptions
{
"blendBestModels" : true ,
"mode" : "auto" ,
"runLeakageRemovedFeatureList" : true ,
"scoringCodeOnly" : true ,
"shapOnlyMode" : true
}
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
]
Batch
{
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
earliestPredictionTimestamp
string(date-time)
true
Earliest prediction timestamp of a batch.
id
string
true
Batch ID.
latestPredictionTimestamp
string(date-time)¦null
true
Latest prediction timestamp of a batch.
name
string
true
Batch name.
BatchField
{
"columnName" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
columnName
string¦null
true
Column name
BatchPeriod
{
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
end
string(date-time)¦null
true
End time of the bucket
start
string(date-time)¦null
true
Start time of the bucket
BatchPredictionStatus
{
"processing" : 0 ,
"queued" : 0
}
Properties
Name
Type
Required
Restrictions
Description
processing
integer
true
minimum: 0
Number of jobs processing
queued
integer
true
minimum: 0
Number of jobs queued
BiasAndFairness
{
"fairnessMetricsSet" : "proportionalParity" ,
"fairnessThreshold" : 1 ,
"preferableTargetValue" : true ,
"protectedFeatures" : [
"string"
]
}
Properties
Name
Type
Required
Restrictions
Description
fairnessMetricsSet
string
true
A set of fairness metrics to use for calculating fairness.
fairnessThreshold
number
true
maximum: 1 minimum: 0
Threshold value of the fairness metric.
preferableTargetValue
any
true
A target value that should be treated as a positive outcome for the prediction.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
or
Name
Type
Required
Restrictions
Description
» anonymous
integer
false
none
or
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
continued
Name
Type
Required
Restrictions
Description
protectedFeatures
[string]
true
maxItems: 10 minItems: 1
A list of feature to mark as protected for Bias and Fairness measurement.
Enumerated Values
Property
Value
fairnessMetricsSet
[proportionalParity
, equalParity
, predictionBalance
, trueFavorableAndUnfavorableRateParity
, favorableAndUnfavorablePredictiveValueParity
]
BucketBatch
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"lastPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
createdAt
string(date-time)
true
Timestamp when the batch was created.
id
string
true
DataRobot assigned ID of the batch.
lastPredictionTimestamp
string(date-time)
false
Timestamp when the latest prediction request of the batch was made
name
string
true
User provided name of the batch.
ChallengerCreate
{
"modelPackageId" : "string" ,
"name" : "string" ,
"predictionEnvironmentId" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
modelPackageId
string
true
ID of the model package to add as a challenger.
name
string
true
maxLength: 512
Human-readable name for the challenger.
predictionEnvironmentId
string
false
ID of the Prediction Environment the challenger should use. If prediction environments are enabled, this is required
ChallengerListResponse
{
"data" : [
{
"id" : "string" ,
"model" : {
"datasetName" : "string" ,
"description" : "string" ,
"executionType" : "string" ,
"id" : "string" ,
"isDeprecated" : true ,
"name" : "string" ,
"projectId" : "string" ,
"projectName" : "string"
},
"modelPackage" : {
"id" : "string" ,
"name" : "string" ,
"registeredModelId" : "string"
},
"name" : "string" ,
"predictionEnvironment" : {
"id" : "string" ,
"name" : "string"
}
}
]
}
Properties
Name
Type
Required
Restrictions
Description
data
[ChallengerResponse ]
true
List of challengers.
ChallengerResponse
{
"id" : "string" ,
"model" : {
"datasetName" : "string" ,
"description" : "string" ,
"executionType" : "string" ,
"id" : "string" ,
"isDeprecated" : true ,
"name" : "string" ,
"projectId" : "string" ,
"projectName" : "string"
},
"modelPackage" : {
"id" : "string" ,
"name" : "string" ,
"registeredModelId" : "string"
},
"name" : "string" ,
"predictionEnvironment" : {
"id" : "string" ,
"name" : "string"
}
}
Properties
Name
Type
Required
Restrictions
Description
id
string
true
ID of the challenger.
model
ModelResponse
true
Model of the challenger.
modelPackage
ModelPackageResponse
true
modelPackage of the challenger.
name
string
true
Name of the challenger.
predictionEnvironment
PredictionEnvironmentResponse
false
Prediction environment used by the challenger
ChallengerScore
{
"timestamp" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
timestamp
string(date-time)
false
The date and time in ISO8601 format, challenger models will be scored on data starting from deployment creation until timestamp. If not specified UTC current time is used.
ChallengerUpdate
{
"name" : "string" ,
"predictionEnvironmentId" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
name
string
false
maxLength: 512
Human-readable name for the challenger.
predictionEnvironmentId
string
false
ID of the Prediction Environment the challenger should use.
Challengers
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
Indicates whether challenger models are enabled for the deployment.
ChallengersReplaySettings
{
"enabled" : true ,
"schedule" : {
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
}
}
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
false
Identifies whether scheduled replay is enabled.
schedule
Schedule
false
Schedule settings
ClassDistribution
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
Properties
Name
Type
Required
Restrictions
Description
className
string
true
Name of the class
count
integer
true
Count of rows labeled with a class in the bucket
percent
number
true
Percent of rows labeled with a class in the bucket
CustomBoundaries
{
"lower" : 0 ,
"upper" : 0
}
Properties
Name
Type
Required
Restrictions
Description
lower
number
true
All predictions less than provided value are considered anomalous.
upper
number
true
All predictions greater than provided value are considered anomalous.
CustomMetricBatchSummary
{
"metric" : {
"baselineValue" : 0 ,
"id" : "string" ,
"name" : "string" ,
"percentChange" : 0 ,
"sampleCount" : 0 ,
"value" : 0
}
}
Properties
Name
Type
Required
Restrictions
Description
metric
MetricSummary
true
Summary of the custom metric.
CustomMetricCondition
{
"compareOperator" : "lt" ,
"metricId" : "string" ,
"threshold" : 0
}
Properties
Name
Type
Required
Restrictions
Description
compareOperator
string
true
Defines how custom metric value is compared against the threshold.
metricId
string
true
Custom metric ID.
threshold
number
true
Threshold value used to determine if the condition is met.
Enumerated Values
Property
Value
compareOperator
[lt
, lte
, gt
, gte
]
CustomMetricDetails
{
"earliestDate" : "2019-08-24T14:15:22Z" ,
"latestDate" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
earliestDate
string(date-time)¦null
true
The earliest date of the custom metrics values.
latestDate
string(date-time)¦null
true
The latest date of the custom metrics values.
CustomMetricSegmentDataset
{
"column" : "string" ,
"name" : "string" ,
"value" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
column
string
false
Name of the column that contains segment values.
name
string
true
Name of the segment on which segment analysis is being performed.
value
string
false
Value of the segment attribute to segment on.
CustomMetricSummary
{
"metric" : {
"baselineValue" : 0 ,
"id" : "string" ,
"name" : "string" ,
"percentChange" : 0 ,
"sampleCount" : 0 ,
"value" : 0
},
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
}
}
Properties
Name
Type
Required
Restrictions
Description
metric
MetricSummary
true
Summary of the custom metric.
period
MetricPeriodBucket
true
A time period defined by a start and end time.
CustomMetricsBulkBatchSummary
Properties
Name
Type
Required
Restrictions
Description
metrics
[MetricSummary ]
true
maxItems: 10
Custom metrics summaries.
CustomMetricsBulkSummary
{
"details" : {
"earliestDate" : "2019-08-24T14:15:22Z" ,
"latestDate" : "2019-08-24T14:15:22Z"
},
"metrics" : [],
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
}
}
Properties
Name
Type
Required
Restrictions
Description
details
CustomMetricDetails
true
Additional information related to custom metrics.
metrics
[MetricSummary ]
true
maxItems: 10
Custom metrics summaries.
period
MetricPeriodBucket
true
A time period defined by a start and end time.
CustomMetricsHealth
{
"failingConditions" : [
{
"compareOperator" : "lt" ,
"metricId" : "string" ,
"threshold" : 0
}
],
"warningConditions" : [
{
"compareOperator" : "lt" ,
"metricId" : "string" ,
"threshold" : 0
}
]
}
Properties
Name
Type
Required
Restrictions
Description
failingConditions
[CustomMetricCondition ]
false
maxItems: 25
Conditions for failing status.
warningConditions
[CustomMetricCondition ]
false
maxItems: 25
Conditions for warning status.
DataDriftHealth
{
"batchCount" : "1" ,
"driftThreshold" : 1 ,
"excludedFeatures" : [
"string"
],
"highImportanceFailingCount" : 1 ,
"highImportanceWarningCount" : 1 ,
"importanceThreshold" : 1 ,
"lowImportanceFailingCount" : 1 ,
"lowImportanceWarningCount" : 1 ,
"starredFeatures" : [
"string"
],
"timeInterval" : "T2H"
}
Properties
Name
Type
Required
Restrictions
Description
batchCount
string
false
Number of recent batches used to compute data drift health status, only applicable to deployments with batch monitoring enabled.
driftThreshold
number
false
maximum: 1 minimum: 0
The drift metric threshold above which the feature is considered as drifted.
excludedFeatures
[string]
false
maxItems: 100
Features that are excluded from data drift status consideration.
highImportanceFailingCount
integer¦null
false
minimum: 1
Threshold of drifted high importance feature count for failing status.
highImportanceWarningCount
integer¦null
false
minimum: 1
Threshold of drifted high importance feature count for warning status.
importanceThreshold
number
false
maximum: 1 minimum: 0
The feature importance threshold above which the feature is considered as important.
lowImportanceFailingCount
integer¦null
false
minimum: 1
Threshold of drifted low importance feature count for failing status.
lowImportanceWarningCount
integer¦null
false
minimum: 1
Threshold of drifted low importance feature count for warning status.
starredFeatures
[string]
false
maxItems: 100
Features that are deemed to be of high importance, regardless of how their feature importance values compare against the threshold.
timeInterval
string
false
Time duration used to compute data drift health status, only applicable to deployments with batch monitoring disabled.
Enumerated Values
Property
Value
batchCount
[1
, 5
, 10
, 50
, 100
, 1000
, 10000
]
timeInterval
[T2H
, P1D
, P7D
, P30D
, P90D
, P180D
, P365D
, ALL
]
Dataset
{
"id" : "string" ,
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
id
string
true
ID of the retraining dataset.
name
string
true
Name of the retraining dataset.
DatasetsCredential
{
"catalogVersionId" : "string" ,
"credentialId" : "string" ,
"url" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
catalogVersionId
string
true
ID of the catalog version
credentialId
string
true
ID of the credential store to be used for the given catalog version
url
string¦null
false
The URL of the datasource
DeletedDeploymentListResponse
{
"count" : 0 ,
"data" : [
{
"deletedAt" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"label" : "string"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com"
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
false
Number of items returned on this page.
data
[DeletedDeploymentResponse ]
true
List of deleted deployments.
next
string(uri)¦null
true
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
true
URL pointing to the previous page (if null, there is no previous page).
DeletedDeploymentResponse
{
"deletedAt" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"label" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
deletedAt
string(date-time)
true
The date and time of when the deployment was deleted, in ISO 8601 format.
id
string
true
ID of the deployment.
label
string
true
maxLength: 512
Label of the deployment.
DeploymentAccuracyHealthResponse
{
"endDate" : "2019-08-24T14:15:22Z" ,
"message" : "string" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
}
Properties
Name
Type
Required
Restrictions
Description
endDate
string(date-time)¦null
true
End date of accuracy health period.
message
string
true
A message providing more detail on the status.
startDate
string(date-time)¦null
true
Start date of accuracy health period.
status
string
true
Accuracy health status.
Enumerated Values
Property
Value
status
[failing
, notStarted
, passing
, unavailable
, unknown
, warning
]
DeploymentActuals
{
"data" : [
{
"actualValue" : 0 ,
"associationId" : "string" ,
"timestamp" : "2019-08-24T14:15:22Z" ,
"wasActedOn" : true
}
],
"keepActualsWithoutPredictions" : true
}
Properties
Name
Type
Required
Restrictions
Description
data
[Actual ]
true
minItems: 1
A list of actual
objects that describes actual values. Minimum size of the list is 1 and maximum size is 10000 items. An actual
object has the following schema.
keepActualsWithoutPredictions
boolean
false
Indicates if actual without predictions are kept.
DeploymentCapabilitiesResponse
{
"supportsAutomaticActuals" : true ,
"supportsChallengerModels" : true ,
"supportsFeatureDriftTracking" : true ,
"supportsFeatureTypeInfoValidation" : true ,
"supportsHumilityRecommendedRules" : true ,
"supportsHumilityRules" : true ,
"supportsHumilityRulesDefaultCalculations" : true ,
"supportsModelReplacement" : true ,
"supportsPortablePredictionServer" : true ,
"supportsPredictionIntervals" : true ,
"supportsPredictionWarning" : true ,
"supportsRetraining" : true ,
"supportsScoringCodeDownload" : true ,
"supportsSecondaryDatasets" : true ,
"supportsSegmentedAnalysisDriftAndAccuracy" : true ,
"supportsShapBasedPredictionExplanations" : true ,
"supportsTargetDriftTracking" : true
}
Properties
Name
Type
Required
Restrictions
Description
supportsAutomaticActuals
boolean
false
With this feature enabled, DataRobot infers actual values from time series history data and automatically feeds them back for accuracy estimation.
supportsChallengerModels
boolean
true
If the deployment supports challenger models.
supportsFeatureDriftTracking
boolean
true
If the deployment supports feature drift tracking.
supportsFeatureTypeInfoValidation
boolean
false
If the deployment supports feature type information validation. This will be True for deployments created from imported model packages whose feature data contains feature type information.
supportsHumilityRecommendedRules
boolean
true
If the deployment supports calculating values for humility recommended rules.
supportsHumilityRules
boolean
true
If the deployment supports humble ai.
supportsHumilityRulesDefaultCalculations
boolean
true
If the deployment supports calculating default values for humility rules.
supportsModelReplacement
boolean
true
If the deployment supports model replacement.
supportsPortablePredictionServer
boolean
false
If the deployment supports portable prediction servers. this enables to downloada dedicated model package to be deployed on external prediction environments
supportsPredictionIntervals
boolean
true
if the deployment supports prediction intervals.
supportsPredictionWarning
boolean
true
If the deployment supports prediction warnings.
supportsRetraining
boolean
false
Whether deployment supports retraining.
supportsScoringCodeDownload
boolean
false
If the currently deployed model supports scoring code download.
supportsSecondaryDatasets
boolean
true
If the deployments supports secondary datasets.
supportsSegmentedAnalysisDriftAndAccuracy
boolean
false
If the deployment supports tracking features in training and predictions data for segmented analysis of drift and accuracy.
supportsShapBasedPredictionExplanations
boolean
false
If the currently deployed model supports shap based prediction explanations.
supportsTargetDriftTracking
boolean
true
If the deployment supports target drift tracking.
DeploymentCapabilitiesRetrieveResponse
{
"data" : [
{
"messages" : [
"string"
],
"name" : "string" ,
"supported" : true
}
]
}
Properties
Name
Type
Required
Restrictions
Description
data
[DeploymentCapability ]
true
List of all capabilities.
DeploymentCapability
{
"messages" : [
"string"
],
"name" : "string" ,
"supported" : true
}
Properties
Name
Type
Required
Restrictions
Description
messages
[string]
true
Messages explaining why the capability is supported or not supported.
name
string
true
The name of the capability.
supported
boolean
true
If the capability is supported.
DeploymentCreateFromLearningModel
{
"defaultPredictionServerId" : "string" ,
"description" : null ,
"grantInitialDeploymentRolesFromProject" : true ,
"importance" : "CRITICAL" ,
"label" : "string" ,
"modelId" : "string" ,
"predictionThreshold" : 1 ,
"status" : "active"
}
Properties
Name
Type
Required
Restrictions
Description
defaultPredictionServerId
string
false
ID of the default prediction server for deployment. Required for DataRobot Cloud, must be omitted for Enterprise installations.
description
string¦null
true
maxLength: 10000
A description for the deployment.
grantInitialDeploymentRolesFromProject
boolean
false
If True, initial roles on the deployment will be granted to users who have roles on the project that the deployed model comes from. If False, only the creator of the deployment will be given a role on the deployment. Defaults to True.
importance
string¦null
false
Importance of the deployment. Defaults to LOW when MLOps is enabled, must not be provided when MLOps disabled.
label
string
true
maxLength: 512
A human-readable name for the deployment.
modelId
string
true
ID of the model to be deployed.
predictionThreshold
number
false
maximum: 1 minimum: 0
Prediction threshold used for binary classification. If not specified, model default prediction threshold will be used.
status
string¦null
false
Status of the deployment
Enumerated Values
Property
Value
importance
[CRITICAL
, HIGH
, MODERATE
, LOW
]
status
[active
, inactive
]
DeploymentCreateResponse
Properties
Name
Type
Required
Restrictions
Description
id
string
true
The ID of the created deployment.
DeploymentDatasetCreate
{
"actualValueColumn" : "string" ,
"associationIdColumn" : "string" ,
"datasetId" : "string" ,
"datasetVersionId" : "string" ,
"keepActualsWithoutPredictions" : true ,
"password" : "string" ,
"timestampColumn" : "string" ,
"user" : "string" ,
"wasActedOnColumn" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
actualValueColumn
string
true
Column name that contains actual values.
associationIdColumn
string
true
Column name that contains unique identifiers used with a predicted rows.
datasetId
string
true
The ID of dataset from catalog.
datasetVersionId
string¦null
false
Version of dataset to retrieve.
keepActualsWithoutPredictions
boolean
false
Indicates if actual without predictions are kept.
password
string
false
The password for database authentication.
timestampColumn
string
false
Column name that contain datetime when actual values were obtained.
user
string
false
The username for database authentication.
wasActedOnColumn
string
false
Column name that contains boolean values if any action was made based on predictions data.
DeploymentDefaultPredictionServerResponse
{
"datarobot-key" : "string" ,
"id" : "string" ,
"url" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
datarobot-key
string
true
The datarobot-key
header used in requests to this prediction server.
id
string¦null
true
ID of the prediction server for the deployment.
url
string
true
URL of the prediction server.
DeploymentGovernanceResponse
{
"approvalStatus" : "PENDING" ,
"hasOpenedChangeRequests" : true
}
Properties
Name
Type
Required
Restrictions
Description
approvalStatus
string
true
Status to show whether the deployment was approved or not. It also shows up as a part of metadata within the prediction response.
hasOpenedChangeRequests
boolean
true
If there are change request related to this deployment with PENDING
status.
Enumerated Values
Property
Value
approvalStatus
[PENDING
, APPROVED
]
DeploymentListResponse
{
"count" : 0 ,
"data" : [
{
"accuracyHealth" : {
"endDate" : "2019-08-24T14:15:22Z" ,
"message" : "string" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
},
"approvalStatus" : "PENDING" ,
"capabilities" : {
"supportsAutomaticActuals" : true ,
"supportsChallengerModels" : true ,
"supportsFeatureDriftTracking" : true ,
"supportsFeatureTypeInfoValidation" : true ,
"supportsHumilityRecommendedRules" : true ,
"supportsHumilityRules" : true ,
"supportsHumilityRulesDefaultCalculations" : true ,
"supportsModelReplacement" : true ,
"supportsPortablePredictionServer" : true ,
"supportsPredictionIntervals" : true ,
"supportsPredictionWarning" : true ,
"supportsRetraining" : true ,
"supportsScoringCodeDownload" : true ,
"supportsSecondaryDatasets" : true ,
"supportsSegmentedAnalysisDriftAndAccuracy" : true ,
"supportsShapBasedPredictionExplanations" : true ,
"supportsTargetDriftTracking" : true
},
"createdAt" : "2019-08-24T14:15:22Z" ,
"defaultPredictionServer" : {
"datarobot-key" : "string" ,
"id" : "string" ,
"url" : "string"
},
"description" : "string" ,
"governance" : {
"approvalStatus" : "PENDING" ,
"hasOpenedChangeRequests" : true
},
"hasError" : true ,
"id" : "string" ,
"importance" : "CRITICAL" ,
"label" : "string" ,
"model" : {
"buildEnvironmentType" : "string" ,
"customModelImage" : {
"customModelId" : "string" ,
"customModelName" : "string" ,
"customModelVersionId" : "string" ,
"customModelVersionLabel" : "string" ,
"executionEnvironmentId" : "string" ,
"executionEnvironmentName" : "string" ,
"executionEnvironmentVersionId" : "string" ,
"executionEnvironmentVersionLabel" : "string"
},
"decisionFlowId" : "string" ,
"decisionFlowVersionId" : "string" ,
"deployedAt" : "2019-08-24T14:15:22Z" ,
"hasDecisionFlow" : true ,
"id" : "string" ,
"isDeprecated" : true ,
"projectId" : "string" ,
"projectName" : "string" ,
"targetName" : "string" ,
"targetType" : "string" ,
"type" : "string" ,
"unstructuredModelKind" : true ,
"unsupervisedMode" : true ,
"unsupervisedType" : "anomaly"
},
"modelHealth" : {
"endDate" : "2019-08-24T14:15:22Z" ,
"message" : "string" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
},
"modelPackage" : {
"id" : "string" ,
"name" : "string" ,
"registeredModelId" : "string"
},
"modelPackageInitialDownload" : {
"timestamp" : "2019-08-24T14:15:22Z"
},
"openedChangeRequests" : [
"string"
],
"owners" : {
"count" : 0 ,
"preview" : [
{
"email" : "string" ,
"firstName" : "string" ,
"id" : "string" ,
"lastName" : "string"
}
]
},
"permissions" : [
"CAN_ADD_CHALLENGERS"
],
"predictionEnvironment" : {
"id" : "string" ,
"isManagedByManagementAgent" : true ,
"name" : "string" ,
"platform" : "aws" ,
"plugin" : "string" ,
"supportedModelFormats" : [
"datarobot"
]
},
"predictionUsage" : {
"dailyRates" : [
0
],
"lastTimestamp" : "2019-08-24T14:15:22Z"
},
"scoringCodeInitialDownload" : {
"timestamp" : "2019-08-24T14:15:22Z"
},
"serviceHealth" : {
"endDate" : "2019-08-24T14:15:22Z" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
},
"settings" : {
"batchMonitoringEnabled" : true ,
"humbleAiEnabled" : true ,
"predictionIntervalsEnabled" : true ,
"predictionWarningEnabled" : true
},
"status" : "active" ,
"tags" : [
{
"id" : "string" ,
"name" : "string" ,
"value" : "string"
}
],
"userProvidedId" : "string"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
false
Number of items returned on this page.
data
[DeploymentRetrieveResponse ]
true
List of deployments.
next
string(uri)¦null
true
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
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.
DeploymentModelCustomModelImageResponse
{
"customModelId" : "string" ,
"customModelName" : "string" ,
"customModelVersionId" : "string" ,
"customModelVersionLabel" : "string" ,
"executionEnvironmentId" : "string" ,
"executionEnvironmentName" : "string" ,
"executionEnvironmentVersionId" : "string" ,
"executionEnvironmentVersionLabel" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
customModelId
string
true
ID of the custom model.
customModelName
string
true
Name of the custom model.
customModelVersionId
string
true
ID of the custom model version.
customModelVersionLabel
string
true
Label of the custom model version.
executionEnvironmentId
string
true
ID of the execution environment.
executionEnvironmentName
string
true
Name of the execution environment.
executionEnvironmentVersionId
string
true
ID of the execution environment version.
executionEnvironmentVersionLabel
string
true
Label of the execution environment version.
DeploymentModelHealthResponse
{
"endDate" : "2019-08-24T14:15:22Z" ,
"message" : "string" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
}
Properties
Name
Type
Required
Restrictions
Description
endDate
string(date-time)¦null
true
End date of model health period.
message
string
true
A message providing more detail on the status.
startDate
string(date-time)¦null
true
Start date of model health period.
status
string
true
Model health status.
Enumerated Values
Property
Value
status
[failing
, notStarted
, passing
, unavailable
, unknown
, warning
]
DeploymentModelPackageInitialDownloadResponse
{
"timestamp" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
timestamp
string(date-time)¦null
true
Timestamp of the first time model package was downloaded.
DeploymentModelPackageResponse
{
"id" : "string" ,
"name" : "string" ,
"registeredModelId" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
id
string
true
ID of the ModelPackage.
name
string
true
Name of the ModelPackage.
registeredModelId
string¦null
true
The ID of the associated registered model
DeploymentModelResponse
{
"buildEnvironmentType" : "string" ,
"customModelImage" : {
"customModelId" : "string" ,
"customModelName" : "string" ,
"customModelVersionId" : "string" ,
"customModelVersionLabel" : "string" ,
"executionEnvironmentId" : "string" ,
"executionEnvironmentName" : "string" ,
"executionEnvironmentVersionId" : "string" ,
"executionEnvironmentVersionLabel" : "string"
},
"decisionFlowId" : "string" ,
"decisionFlowVersionId" : "string" ,
"deployedAt" : "2019-08-24T14:15:22Z" ,
"hasDecisionFlow" : true ,
"id" : "string" ,
"isDeprecated" : true ,
"projectId" : "string" ,
"projectName" : "string" ,
"targetName" : "string" ,
"targetType" : "string" ,
"type" : "string" ,
"unstructuredModelKind" : true ,
"unsupervisedMode" : true ,
"unsupervisedType" : "anomaly"
}
Properties
Name
Type
Required
Restrictions
Description
buildEnvironmentType
string¦null
false
Build environment type of the current model.
customModelImage
DeploymentModelCustomModelImageResponse
false
Information related to the custom model image of the deployment.
decisionFlowId
string¦null
false
The ID of the decision flow if the deployment has one.
decisionFlowVersionId
string¦null
false
The ID of the decision flow version if the deployment has one.
deployedAt
string(date-time)¦null
false
Timestamp of when current model was deployed.
hasDecisionFlow
boolean
false
True if this deployment contains a Decision Flow
id
string
true
ID of the current model.
isDeprecated
boolean
true
Whether the current model is deprecated model. eg. python2 based model.
projectId
string¦null
false
Project ID of the current model.
projectName
string¦null
true
Project name of the current model.
targetName
string
true
Target name of the current model.
targetType
string
true
Target type of the current model.
type
string
true
Type of the current model.
unstructuredModelKind
boolean
true
Whether the current model is an unstructured model.
unsupervisedMode
boolean
true
Whether the current model's project is unsupervised.
unsupervisedType
string¦null
false
Only valid when unsupervisedMode is True. The type of unsupervised project, anomaly or clustering. If unsupervisedMode, defaults to 'anomaly'.
Enumerated Values
Property
Value
unsupervisedType
[anomaly
, clustering
]
DeploymentOwnerResponse
{
"email" : "string" ,
"firstName" : "string" ,
"id" : "string" ,
"lastName" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
email
string¦null
true
Email address of the owner.
firstName
string¦null
true
First name of the owner.
id
string
true
ID of the owner.
lastName
string¦null
true
Last name of the owner.
DeploymentOwnersResponse
{
"count" : 0 ,
"preview" : [
{
"email" : "string" ,
"firstName" : "string" ,
"id" : "string" ,
"lastName" : "string"
}
]
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
true
Total count of owners.
preview
[DeploymentOwnerResponse ]
true
A list of owner objects.
DeploymentPermanentDelete
{
"action" : "PermanentlyErase" ,
"deploymentIds" : [
"string"
]
}
Properties
Name
Type
Required
Restrictions
Description
action
string
true
Action to perform on these deleted deployments.
deploymentIds
[string]
true
maxItems: 100 minItems: 1
ID of a list of deleted deployments to perform action on.
Enumerated Values
Property
Value
action
PermanentlyErase
DeploymentPredictionEnvironmentResponse
{
"id" : "string" ,
"isManagedByManagementAgent" : true ,
"name" : "string" ,
"platform" : "aws" ,
"plugin" : "string" ,
"supportedModelFormats" : [
"datarobot"
]
}
Properties
Name
Type
Required
Restrictions
Description
id
string¦null
true
ID of the PredictionEnvironment.
isManagedByManagementAgent
boolean
true
True if PredictionEnvironment is using Management Agent.
name
string
true
Name of the PredictionEnvironment.
platform
string
true
Platform of the PredictionEnvironment.
plugin
string¦null
false
Plugin name of the PredictionEnvironment.
supportedModelFormats
[string]
false
maxItems: 4 minItems: 1
Model formats that the PredictionEnvironment supports.
Enumerated Values
Property
Value
platform
[aws
, gcp
, azure
, onPremise
, datarobot
, datarobotServerless
, openShift
, other
, snowflake
]
DeploymentPredictionUsageResponse
{
"dailyRates" : [
0
],
"lastTimestamp" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
dailyRates
[integer]
true
Number of predictions made in the last 7 days.
lastTimestamp
string(date-time)¦null
true
Timestamp of the last prediction request.
DeploymentRetrieveResponse
{
"accuracyHealth" : {
"endDate" : "2019-08-24T14:15:22Z" ,
"message" : "string" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
},
"approvalStatus" : "PENDING" ,
"capabilities" : {
"supportsAutomaticActuals" : true ,
"supportsChallengerModels" : true ,
"supportsFeatureDriftTracking" : true ,
"supportsFeatureTypeInfoValidation" : true ,
"supportsHumilityRecommendedRules" : true ,
"supportsHumilityRules" : true ,
"supportsHumilityRulesDefaultCalculations" : true ,
"supportsModelReplacement" : true ,
"supportsPortablePredictionServer" : true ,
"supportsPredictionIntervals" : true ,
"supportsPredictionWarning" : true ,
"supportsRetraining" : true ,
"supportsScoringCodeDownload" : true ,
"supportsSecondaryDatasets" : true ,
"supportsSegmentedAnalysisDriftAndAccuracy" : true ,
"supportsShapBasedPredictionExplanations" : true ,
"supportsTargetDriftTracking" : true
},
"createdAt" : "2019-08-24T14:15:22Z" ,
"defaultPredictionServer" : {
"datarobot-key" : "string" ,
"id" : "string" ,
"url" : "string"
},
"description" : "string" ,
"governance" : {
"approvalStatus" : "PENDING" ,
"hasOpenedChangeRequests" : true
},
"hasError" : true ,
"id" : "string" ,
"importance" : "CRITICAL" ,
"label" : "string" ,
"model" : {
"buildEnvironmentType" : "string" ,
"customModelImage" : {
"customModelId" : "string" ,
"customModelName" : "string" ,
"customModelVersionId" : "string" ,
"customModelVersionLabel" : "string" ,
"executionEnvironmentId" : "string" ,
"executionEnvironmentName" : "string" ,
"executionEnvironmentVersionId" : "string" ,
"executionEnvironmentVersionLabel" : "string"
},
"decisionFlowId" : "string" ,
"decisionFlowVersionId" : "string" ,
"deployedAt" : "2019-08-24T14:15:22Z" ,
"hasDecisionFlow" : true ,
"id" : "string" ,
"isDeprecated" : true ,
"projectId" : "string" ,
"projectName" : "string" ,
"targetName" : "string" ,
"targetType" : "string" ,
"type" : "string" ,
"unstructuredModelKind" : true ,
"unsupervisedMode" : true ,
"unsupervisedType" : "anomaly"
},
"modelHealth" : {
"endDate" : "2019-08-24T14:15:22Z" ,
"message" : "string" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
},
"modelPackage" : {
"id" : "string" ,
"name" : "string" ,
"registeredModelId" : "string"
},
"modelPackageInitialDownload" : {
"timestamp" : "2019-08-24T14:15:22Z"
},
"openedChangeRequests" : [
"string"
],
"owners" : {
"count" : 0 ,
"preview" : [
{
"email" : "string" ,
"firstName" : "string" ,
"id" : "string" ,
"lastName" : "string"
}
]
},
"permissions" : [
"CAN_ADD_CHALLENGERS"
],
"predictionEnvironment" : {
"id" : "string" ,
"isManagedByManagementAgent" : true ,
"name" : "string" ,
"platform" : "aws" ,
"plugin" : "string" ,
"supportedModelFormats" : [
"datarobot"
]
},
"predictionUsage" : {
"dailyRates" : [
0
],
"lastTimestamp" : "2019-08-24T14:15:22Z"
},
"scoringCodeInitialDownload" : {
"timestamp" : "2019-08-24T14:15:22Z"
},
"serviceHealth" : {
"endDate" : "2019-08-24T14:15:22Z" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
},
"settings" : {
"batchMonitoringEnabled" : true ,
"humbleAiEnabled" : true ,
"predictionIntervalsEnabled" : true ,
"predictionWarningEnabled" : true
},
"status" : "active" ,
"tags" : [
{
"id" : "string" ,
"name" : "string" ,
"value" : "string"
}
],
"userProvidedId" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
accuracyHealth
DeploymentAccuracyHealthResponse
true
Accuracy health of the deployment.
approvalStatus
string
false
Status to show whether the deployment was approved or not. It also shows up as a part of metadata within the prediction response.
capabilities
DeploymentCapabilitiesResponse
true
Capabilities of the deployment.
createdAt
string(date-time)
true
The date and time of when the deployment was created, in ISO 8601 format.
defaultPredictionServer
DeploymentDefaultPredictionServerResponse
true
The prediction server associated with the deployment.
description
string¦null
true
Description of the deployment.
governance
DeploymentGovernanceResponse
false
Deployment governance info.
hasError
boolean
false
Whether the deployment is not operational because it failed to start properly.
id
string
true
The ID of the deployment.
importance
string
false
Shows how important this deployment is.
label
string
true
maxLength: 512
Label of the deployment.
model
DeploymentModelResponse
true
Information related to the current model of the deployment.
modelHealth
DeploymentModelHealthResponse
true
Model health of the deployment.
modelPackage
DeploymentModelPackageResponse
false
Information related to the current ModelPackage.
modelPackageInitialDownload
DeploymentModelPackageInitialDownloadResponse
false
If a model package has been downloaded for this deployment, then this will tell you when it was first downloaded.
openedChangeRequests
[string]
false
An array of the change request IDs related to this deployment that have.
owners
DeploymentOwnersResponse
false
Count and preview of owners of the deployment.
permissions
[string]
true
Permissions that the user making the request has on the deployment.
predictionEnvironment
DeploymentPredictionEnvironmentResponse
false
Information related to the current PredictionEnvironment.
predictionUsage
DeploymentPredictionUsageResponse
true
Prediction usage of the deployment.
scoringCodeInitialDownload
DeploymentScoringCodeInitialDownloadResponse
false
If scoring code has been downloaded for this deployment, then this will tell you when it was first downloaded.
serviceHealth
DeploymentServiceHealthResponse
true
Service health of the deployment.
settings
DeploymentSettingsInfo
true
Settings of the deployment.
status
string
true
Displays current deployment status.
tags
[DeploymentTagRetrieveResponse ]
true
The list of formatted deployment tags.
userProvidedId
string
false
maxLength: 100
A user-provided unique ID associated with a deployment definition in a remote git repository.
Enumerated Values
Property
Value
approvalStatus
[PENDING
, APPROVED
]
importance
[CRITICAL
, HIGH
, MODERATE
, LOW
]
status
[active
, archived
, errored
, inactive
, launching
, replacingModel
, stopping
]
DeploymentScoringCodeInitialDownloadResponse
{
"timestamp" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
timestamp
string(date-time)¦null
true
Timestamp of the first time scoring code was downloaded.
DeploymentSecondaryDataset
{
"catalogId" : "string" ,
"catalogVersionId" : "string" ,
"identifier" : "string" ,
"snapshotPolicy" : "specified"
}
Properties
Name
Type
Required
Restrictions
Description
catalogId
string
true
ID of the catalog item
catalogVersionId
string
true
ID of the catalog version
identifier
string
true
maxLength: 45 minLength: 1 minLength: 1
Short name of this table (used directly as part of generated feature names)
snapshotPolicy
string
true
Policy to use by a dataset while making prediction
Enumerated Values
Property
Value
snapshotPolicy
[specified
, latest
, dynamic
]
DeploymentServiceHealthResponse
{
"endDate" : "2019-08-24T14:15:22Z" ,
"startDate" : "2019-08-24T14:15:22Z" ,
"status" : "failing"
}
Properties
Name
Type
Required
Restrictions
Description
endDate
string(date-time)¦null
true
End date of model service period.
startDate
string(date-time)¦null
true
Start date of service health period.
status
string
true
Service health status.
Enumerated Values
Property
Value
status
[failing
, notStarted
, passing
, unavailable
, unknown
, warning
]
DeploymentSettingsInfo
{
"batchMonitoringEnabled" : true ,
"humbleAiEnabled" : true ,
"predictionIntervalsEnabled" : true ,
"predictionWarningEnabled" : true
}
Properties
Name
Type
Required
Restrictions
Description
batchMonitoringEnabled
boolean
false
if batch monitoring is enabled.
humbleAiEnabled
boolean
false
if humble ai is enabled.
predictionIntervalsEnabled
boolean
false
If prediction intervals are enabled.
predictionWarningEnabled
boolean
false
If prediction warning is enabled.
DeploymentSettingsResponse
{
"associationId" : {
"columnNames" : [
"string"
],
"requiredInPredictionRequests" : true
},
"automaticActuals" : {
"enabled" : true
},
"biasAndFairness" : {
"fairnessMetricsSet" : "proportionalParity" ,
"fairnessThreshold" : 1 ,
"preferableTargetValue" : true ,
"protectedFeatures" : [
"string"
]
},
"challengerModels" : {
"enabled" : true
},
"featureDrift" : {
"enabled" : true
},
"humility" : {
"enabled" : true
},
"predictionIntervals" : {
"enabled" : true ,
"percentiles" : [
0
]
},
"predictionWarning" : {
"customBoundaries" : {
"lower" : 0 ,
"upper" : 0
},
"enabled" : true
},
"predictionsByForecastDate" : {
"columnName" : "string" ,
"datetimeFormat" : "string" ,
"enabled" : true
},
"predictionsDataCollection" : {
"enabled" : true
},
"segmentAnalysis" : {
"attributes" : [
"string"
],
"enabled" : true
},
"targetDrift" : {
"enabled" : true
}
}
Properties
Name
Type
Required
Restrictions
Description
associationId
AssociationID
true
The association ID setting for the deployment.
automaticActuals
AutomatiActuals
false
Automatic actuals setting for the deployment.
biasAndFairness
BiasAndFairness
false
Bias and fairness setting for the deployment.
challengerModels
Challengers
false
Challenger models setting for the deployment.
featureDrift
FeatureDriftSetting
true
The feature drift setting for the deployment.
humility
Humility
false
Humility setting for the deployment.
predictionIntervals
PredictionIntervals
true
The prediction intervals setting for the deployment.
predictionWarning
PredictionWarning
false
The prediction warning setting for the deployment.
predictionsByForecastDate
ForecastDate
false
Forecast date setting for the deployment.
predictionsDataCollection
PredictionsDataCollection
false
The predictions data collection setting for the deployment.
segmentAnalysis
SegmentAnalysis
false
The segment analysis setting for the deployment.
targetDrift
TargetDriftSetting
true
The target drift setting for the deployment.
DeploymentSettingsUpdate
{
"associationId" : {
"columnNames" : [
"string"
],
"requiredInPredictionRequests" : true
},
"automaticActuals" : {
"enabled" : true
},
"biasAndFairness" : {
"fairnessMetricsSet" : "proportionalParity" ,
"fairnessThreshold" : 1 ,
"preferableTargetValue" : true ,
"protectedFeatures" : [
"string"
]
},
"challengerModels" : {
"enabled" : true
},
"featureDrift" : {
"enabled" : true
},
"humility" : {
"enabled" : true
},
"predictionIntervals" : {
"enabled" : true ,
"percentiles" : [
0
]
},
"predictionWarning" : {
"customBoundaries" : {
"lower" : 0 ,
"upper" : 0
},
"enabled" : true
},
"predictionsByForecastDate" : {
"columnName" : "string" ,
"datetimeFormat" : "string" ,
"enabled" : true
},
"predictionsDataCollection" : {
"enabled" : true
},
"segmentAnalysis" : {
"attributes" : [
"string"
],
"enabled" : true
},
"targetDrift" : {
"enabled" : true
}
}
Properties
Name
Type
Required
Restrictions
Description
associationId
AssociationIDUpdate
false
Association id settings for the deployment.
automaticActuals
AutomatiActuals
false
Automatic actuals setting for the deployment.
biasAndFairness
BiasAndFairness
false
Bias and fairness setting for the deployment.
challengerModels
Challengers
false
Challenger models setting for the deployment.
featureDrift
FeatureDriftUpdate
false
Feature drift setting for the deployment.
humility
Humility
false
Humility setting for the deployment.
predictionIntervals
PredictionIntervalsUpdate
false
Prediction intervals setting for the deployment. Requires that the requested interval size is calculated prior to setting in this request.
predictionWarning
PredictionWarningUpdate
false
Prediction warning setting for the deployment.
predictionsByForecastDate
ForecastDate
false
Forecast date setting for the deployment.
predictionsDataCollection
PredictionsDataCollection
false
The predictions data collection setting for the deployment.
segmentAnalysis
SegmentAnalysisUpdate
false
The segment analysis setting for the deployment.
targetDrift
TargetDriftUpdate
false
Target drift setting for the deployment.
DeploymentStatusUpdate
Properties
Name
Type
Required
Restrictions
Description
status
string
true
Status that deployment should be transition in.
Enumerated Values
Property
Value
status
[active
, inactive
]
DeploymentTagRetrieveResponse
{
"id" : "string" ,
"name" : "string" ,
"value" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
id
string
true
The ID of the tag.
name
string
true
maxLength: 50
The name of the tag.
value
string
true
maxLength: 50
The value of the tag.
DeploymentUpdate
{
"description" : "string" ,
"importance" : "CRITICAL" ,
"label" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
description
string¦null
false
maxLength: 10000
A description for the deployment.
importance
string
false
Shows how important this deployment is.
label
string¦null
false
maxLength: 512
A human-readable name for the deployment.
Enumerated Values
Property
Value
importance
[CRITICAL
, HIGH
, MODERATE
, LOW
]
DeploymentsScoringCodeBuildPayload
{
"includeAgent" : true ,
"includePredictionExplanations" : true ,
"includePredictionIntervals" : true
}
Properties
Name
Type
Required
Restrictions
Description
includeAgent
boolean
false
Whether the Scoring Code built will include tracking agent
includePredictionExplanations
boolean
false
Whether the Scoring Code built will include prediction explanations
includePredictionIntervals
boolean
false
Whether the Scoring Code built will include prediction intervals
DriftBatch
{
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
earliestPredictionTimestamp
string(date-time)
true
Earliest prediction timestamp of a batch.
id
string
true
Batch ID.
latestPredictionTimestamp
string(date-time)¦null
true
Latest prediction timestamp of a batch.
name
string
true
Batch name.
ExportCreatePayload
{
"augmentationType" : "NO_AUGMENTATION" ,
"batchIds" : [
"string"
],
"end" : "2019-08-24T14:15:22Z" ,
"modelId" : "string" ,
"start" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
augmentationType
string¦null
false
Indicates if prediction data is augmented with actuals or metrics
batchIds
[string]¦null
false
maxItems: 100 minItems: 1
IDs of batches to export. Null for real-time data exports.
end
string(date-time)
true
End of the period of prediction data to collect.
modelId
string
false
The ID of the model.
start
string(date-time)
true
Start of the period of prediction data to collect.
Enumerated Values
Property
Value
augmentationType
[NO_AUGMENTATION
, ACTUALS_AND_METRICS
]
ExportEntity
{
"augmentationType" : "NO_AUGMENTATION" ,
"batches" : [
{
"batchId" : "string" ,
"batchName" : "string"
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : "string" ,
"data" : [
{
"id" : "string" ,
"name" : "string"
}
],
"error" : {
"message" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"status" : "CANCELLED"
}
Properties
Name
Type
Required
Restrictions
Description
augmentationType
string¦null
false
Indicates if prediction data is augmented with actuals or metrics
batches
[PredictionDataBatch ]¦null
false
maxItems: 100 minItems: 1
Metadata associated with exported batch.
createdAt
string(date-time)
true
Prediction data export creation timestamp.
createdBy
string
true
The user that created prediction data export.
data
[PredictionDataEntry ]¦null
false
A prediction data export collected data entries. Available only when status is SUCCEEDED.
error
ExportError
false
Error description. Appears when prediction data export job failed (status is FAILED).
id
string
true
The ID of the prediction data export.
modelId
string
true
The ID of the model (or null if not specified).
period
PredictionDataTimeRange
true
A prediction data time range definition.
status
string
true
A prediction data export processing state.
Enumerated Values
Property
Value
augmentationType
[NO_AUGMENTATION
, ACTUALS_AND_METRICS
]
status
[CANCELLED
, CREATED
, FAILED
, SCHEDULED
, SUCCEEDED
]
ExportError
Properties
Name
Type
Required
Restrictions
Description
message
string
true
A human readable error message describing failure cause.
FairnessHealth
{
"protectedClassFailingCount" : 1 ,
"protectedClassWarningCount" : 1
}
Properties
Name
Type
Required
Restrictions
Description
protectedClassFailingCount
integer
false
minimum: 1
Number of protected class below fairness threshold for failing status.
protectedClassWarningCount
integer
false
minimum: 1
Number of protected class below fairness threshold for warning status.
FairnessOverTimeBucket
{
"metricName" : "proportionalParity" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"scores" : [
{
"absoluteValue" : 0 ,
"classesCount" : 0 ,
"healthyClassesCount" : 0 ,
"healthyCount" : 0 ,
"isStatisticallySignificant" : true ,
"label" : "string" ,
"message" : "string" ,
"privilegedClass" : "string" ,
"sampleSize" : 0 ,
"totalCount" : 1 ,
"value" : 1
}
]
}
Properties
Name
Type
Required
Restrictions
Description
metricName
string
true
Name of the metric.
period
TimeRange
true
Time range for which fairness over time is computed.
scores
[FairnessOverTimeScore ]
true
List of per-feature fairness details.
Enumerated Values
Property
Value
metricName
[proportionalParity
, equalParity
, favorableClassBalance
, unfavorableClassBalance
, trueUnfavorableRateParity
, trueFavorableRateParity
, favorablePredictiveValueParity
, unfavorablePredictiveValueParity
]
FairnessOverTimeResponse
{
"buckets" : [
{
"metricName" : "proportionalParity" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"scores" : [
{
"absoluteValue" : 0 ,
"classesCount" : 0 ,
"healthyClassesCount" : 0 ,
"healthyCount" : 0 ,
"isStatisticallySignificant" : true ,
"label" : "string" ,
"message" : "string" ,
"privilegedClass" : "string" ,
"sampleSize" : 0 ,
"totalCount" : 1 ,
"value" : 1
}
]
}
],
"fairnessThreshold" : 1 ,
"favorableTargetOutcome" : true ,
"modelId" : "string" ,
"modelPackageId" : "string" ,
"protectedFeature" : "string" ,
"summary" : {
"metricName" : "proportionalParity" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"scores" : [
{
"absoluteValue" : 0 ,
"classesCount" : 0 ,
"healthyClassesCount" : 0 ,
"healthyCount" : 0 ,
"isStatisticallySignificant" : true ,
"label" : "string" ,
"message" : "string" ,
"privilegedClass" : "string" ,
"sampleSize" : 0 ,
"totalCount" : 1 ,
"value" : 1
}
]
}
}
Properties
Name
Type
Required
Restrictions
Description
buckets
[FairnessOverTimeBucket ]
true
Per bucket summary.
fairnessThreshold
number
true
maximum: 1 minimum: 0
Threshold used to compute fairness results.
favorableTargetOutcome
any
true
Preferable class of target.
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
integer
false
none
continued
Name
Type
Required
Restrictions
Description
modelId
string
true
Model Id for which fairness is computed.
modelPackageId
string
true
Model package Id.
protectedFeature
string
false
Name of the protected feature.
summary
FairnessOverTimeBucket
true
Summary of per feature fairness.
FairnessOverTimeScore
{
"absoluteValue" : 0 ,
"classesCount" : 0 ,
"healthyClassesCount" : 0 ,
"healthyCount" : 0 ,
"isStatisticallySignificant" : true ,
"label" : "string" ,
"message" : "string" ,
"privilegedClass" : "string" ,
"sampleSize" : 0 ,
"totalCount" : 1 ,
"value" : 1
}
Properties
Name
Type
Required
Restrictions
Description
absoluteValue
number
false
Absolute fairness score.
classesCount
integer
false
Count of occurences of the class within the data the fairness is calculated on.
healthyClassesCount
integer
false
Count of statistically significant classes above fairness threshold.
healthyCount
integer
false
minimum: 0
Total number of classes with fairness score above the threshold.
isStatisticallySignificant
boolean
false
Class is statistically significant.
label
string
false
Name of the feature.
message
string
false
Explanation message.
privilegedClass
string
false
Name of the privileged class (the one with the highest fairness score) within the feature.
sampleSize
integer
false
minimum: 0 (exclusive)
Sample size used for fairness status calculation
totalCount
integer
false
minimum: 1
Total number of classes.
value
number
false
maximum: 1 minimum: 0
Fairness score in relation to the privileged class fairness score.
Feature
{
"dateFormat" : "string" ,
"featureType" : "string" ,
"importance" : 0 ,
"knownInAdvance" : true ,
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
dateFormat
string¦null
true
The date format string for how this feature was interpreted.
featureType
string¦null
true
Feature type.
importance
number¦null
true
Numeric measure of the relationship strength between the feature and target (independent of model or other features).
knownInAdvance
boolean
true
Whether the feature was selected as known in advance in a time-series model, false for non-time-series models.
name
string
true
Feature name.
FeatureDrift
{
"baselineSampleSize" : 0 ,
"driftScore" : 0 ,
"featureImpact" : 0 ,
"name" : "string" ,
"sampleSize" : 0 ,
"type" : "numeric"
}
Properties
Name
Type
Required
Restrictions
Description
baselineSampleSize
integer
true
The sample size of the training data.
driftScore
number¦null
true
The drift score for this feature.
featureImpact
number
true
The feature impact score for this feature.
name
string
true
The name of the feature.
sampleSize
integer
true
The number of predictions used to compute the drift score.
type
string
true
Type of the feature.
Enumerated Values
Property
Value
type
[numeric
, categorical
, text
]
FeatureDriftOverBatchBucket
{
"baselineSampleSize" : 0 ,
"batch" : {
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
},
"driftScore" : 0 ,
"featureImpact" : 0 ,
"featureName" : "string" ,
"sampleSize" : 0
}
Properties
Name
Type
Required
Restrictions
Description
baselineSampleSize
integer
true
The sample size in the baseline used to calculate drift score.
batch
DriftBatch
true
Info of the batch associated with the bucket.
driftScore
number¦null
true
Drift score of the feature.
featureImpact
number
true
The feature impact score of the feature.
featureName
string
true
Feature name.
sampleSize
integer
true
The sample size in the batch used to calculate drift score.
FeatureDriftOverBatchResponse
{
"buckets" : [
{
"baselineSampleSize" : 0 ,
"batch" : {
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
},
"driftScore" : 0 ,
"featureImpact" : 0 ,
"featureName" : "string" ,
"sampleSize" : 0
}
],
"driftMetric" : "psi"
}
Properties
Name
Type
Required
Restrictions
Description
buckets
[FeatureDriftOverBatchBucket ]
true
A list of buckets to display feature drift over batch.
driftMetric
string
false
The metric used to calculate data drift scores.
Enumerated Values
Property
Value
driftMetric
[psi
, kl_divergence
, dissimilarity
, hellinger
, js_divergence
]
FeatureDriftOverTimeBucket
{
"baselineSampleSize" : 0 ,
"driftScore" : 0 ,
"featureImpact" : 0 ,
"featureName" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0
}
Properties
Name
Type
Required
Restrictions
Description
baselineSampleSize
integer
true
The sample size of the training data used during model creation
driftScore
number¦null
true
The aggregated drift score for the target.
featureImpact
number
true
The feature impact score of the feature.
featureName
string
true
Name of the feature.
period
TimeRange
true
Time range for which feature drift is computed.
sampleSize
integer
true
The sample size in the query period used to calculate drift score.
FeatureDriftOverTimeFeature
{
"featureName" : "string" ,
"featureType" : "numeric"
}
Properties
Name
Type
Required
Restrictions
Description
featureName
string
true
Name of the requested feature.
featureType
string
true
Data type of the requested feature.
Enumerated Values
Property
Value
featureType
[numeric
, categorical
, text
]
FeatureDriftOverTimeResponse
{
"buckets" : [
{
"baselineSampleSize" : 0 ,
"driftScore" : 0 ,
"featureImpact" : 0 ,
"featureName" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0
}
],
"features" : [
{
"featureName" : "string" ,
"featureType" : "numeric"
}
],
"metric" : "string" ,
"summaries" : [
{
"featureImpact" : 0 ,
"featureName" : "string"
}
]
}
Properties
Name
Type
Required
Restrictions
Description
buckets
[FeatureDriftOverTimeBucket ]
true
A list of aggregated drift scores by feature over a given period.
features
[FeatureDriftOverTimeFeature ]
true
A list of the requested features and their feature type.
metric
string
true
Name of requested metric.
summaries
[FeatureDriftOverTimeSummary ]
true
A list of aggregated drift scores by feature over a given period.
FeatureDriftOverTimeSummary
{
"featureImpact" : 0 ,
"featureName" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
featureImpact
number
true
The feature impact score of the feature.
featureName
string
true
Name of the feature.
FeatureDriftResponse
{
"batchId" : [],
"count" : 0 ,
"data" : [
{
"baselineSampleSize" : 0 ,
"driftScore" : 0 ,
"featureImpact" : 0 ,
"name" : "string" ,
"sampleSize" : 0 ,
"type" : "numeric"
}
],
"metric" : "psi" ,
"modelId" : "string" ,
"next" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"previous" : "string" ,
"segmentAttribute" : "string" ,
"segmentValue" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
batchId
any
false
The id of the batch for which metrics are being retrieved.
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
[string]
false
maxItems: 25
none
continued
Name
Type
Required
Restrictions
Description
count
integer
false
The number of items returned on this page.
data
[FeatureDrift ]
true
An array [DriftObject], each in the form described below
metric
string
false
Metric used to calculate drift score.
modelId
string
true
The id of the model for which the features drift is being retrieved.
next
string¦null
false
A URL pointing to the next page (if null, there is no next page)
period
TimeRange
false
An object with the keys "start" and "end" defining the period to retrieve features drift.
previous
string¦null
false
A URL pointing to the previous page (if null, there is no previous page)
segmentAttribute
string¦null
false
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
The value of the segmentAttribute
to segment on.
Enumerated Values
Property
Value
metric
[psi
, kl_divergence
, dissimilarity
, hellinger
, js_divergence
]
FeatureDriftSetting
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
Indicates whether feature drift tracking is enabled for this deployment.
FeatureDriftUpdate
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
True if feature drift tracking is enabled for this deployment, false if otherwise.
FeatureListResponse
{
"count" : 0 ,
"data" : [
{
"dateFormat" : "string" ,
"featureType" : "string" ,
"importance" : 0 ,
"knownInAdvance" : true ,
"name" : "string"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com"
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
false
Number of items returned on this page.
data
[Feature ]
true
An array of dataset details.
next
string(uri)¦null
true
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
true
URL pointing to the previous page (if null, there is no previous page).
ForecastDate
{
"columnName" : "string" ,
"datetimeFormat" : "string" ,
"enabled" : true
}
Properties
Name
Type
Required
Restrictions
Description
columnName
string¦null
false
The column name in prediction datasets to be used as forecast date
datetimeFormat
string¦null
false
The datetime format of the forecast date column in prediction datasets.
enabled
boolean
true
Indicates whether predictions by forecast dates is enabled for the deployment.
GrantAccessControlWithIdWithGrant
{
"canShare" : true ,
"id" : "string" ,
"role" : "string" ,
"shareRecipientType" : "user"
}
Properties
Name
Type
Required
Restrictions
Description
canShare
boolean
false
Whether the org/group/user should be able to share with others.If true, the org/group/user will be able to grant any role up to and includingtheir own to other orgs/groups/user. If role
is NO_ROLE
canShare
is ignored.
id
string
true
The ID of the recipient.
role
string
true
The role of the recipient on this entity. One of OWNER, USER, OBSERVER.
shareRecipientType
string
true
Describes the recipient type, either user, group, or organization.
Enumerated Values
Property
Value
shareRecipientType
[user
, group
, organization
]
GrantAccessControlWithUsernameWithGrant
{
"canShare" : true ,
"role" : "string" ,
"shareRecipientType" : "user" ,
"username" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
canShare
boolean
false
Whether the org/group/user should be able to share with others.If true, the org/group/user will be able to grant any role up to and includingtheir own to other orgs/groups/user. If role
is NO_ROLE
canShare
is ignored.
role
string
true
The role of the recipient on this entity. One of OWNER, USER, OBSERVER.
shareRecipientType
string
true
Describes the recipient type, either user, group, or organization.
username
string
true
Username of the user to update the access role for.
Enumerated Values
Property
Value
shareRecipientType
[user
, group
, organization
]
HealthSettings
{
"accuracy" : {
"batchCount" : "1" ,
"failingThreshold" : 0 ,
"measurement" : "percent" ,
"metric" : "AUC" ,
"warningThreshold" : 0
},
"actualsTimeliness" : {
"enabled" : true ,
"expectedFrequency" : "string"
},
"customMetrics" : {
"failingConditions" : [
{
"compareOperator" : "lt" ,
"metricId" : "string" ,
"threshold" : 0
}
],
"warningConditions" : [
{
"compareOperator" : "lt" ,
"metricId" : "string" ,
"threshold" : 0
}
]
},
"dataDrift" : {
"batchCount" : "1" ,
"driftThreshold" : 1 ,
"excludedFeatures" : [
"string"
],
"highImportanceFailingCount" : 1 ,
"highImportanceWarningCount" : 1 ,
"importanceThreshold" : 1 ,
"lowImportanceFailingCount" : 1 ,
"lowImportanceWarningCount" : 1 ,
"starredFeatures" : [
"string"
],
"timeInterval" : "T2H"
},
"fairness" : {
"protectedClassFailingCount" : 1 ,
"protectedClassWarningCount" : 1
},
"predictionsTimeliness" : {
"enabled" : true ,
"expectedFrequency" : "string"
},
"service" : {
"batchCount" : "1"
}
}
Properties
Name
Type
Required
Restrictions
Description
accuracy
AccuracyHealth
false
Accuracy health status setting.
actualsTimeliness
TimelinessSettings
false
Actuals timeliness health setting.
customMetrics
CustomMetricsHealth
false
Custom metrics health status setting.
dataDrift
DataDriftHealth
false
Data drift health status setting.
fairness
FairnessHealth
false
Fairness health status setting. Only available if deployment supports fairness.
predictionsTimeliness
TimelinessSettings
false
Predictions timeliness health setting.
service
ServiceHealth
false
Service health status setting.
Humility
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
Indicates whether humility rules are enabled for the deployment.
HumilityStatsBucket
{
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"values" : [
{
"ruleId" : "string" ,
"ruleName" : "string" ,
"value" : 0
}
]
}
Properties
Name
Type
Required
Restrictions
Description
period
TimeRange
true
An object with the keys "start" and "end" defining the period.
values
[HumilityStatsRule ]
true
Rules response objects.
HumilityStatsOverTimeResponse
{
"buckets" : [
{
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"values" : [
{
"ruleId" : "string" ,
"ruleName" : "string" ,
"value" : 0
}
]
}
],
"modelId" : "string" ,
"segmentAttribute" : "string" ,
"segmentValue" : "" ,
"summary" : {
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"values" : [
{
"ruleId" : "string" ,
"ruleName" : "string" ,
"value" : 0
}
]
}
}
Properties
Name
Type
Required
Restrictions
Description
buckets
[HumilityStatsBucket ]
true
An array of bucket
objects, representing service health stats of the deployment over time
modelId
string
false
The id of the model for which metrics are being retrieved.
segmentAttribute
string¦null
false
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
The value of the segmentAttribute
to segment on.
summary
HumilityStatsBucket
true
A bucket
object covering whole start
/end
time range
HumilityStatsResponse
{
"data" : [
{
"ruleId" : "string" ,
"ruleName" : "string" ,
"value" : 0
}
],
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"segmentAttribute" : "string" ,
"segmentValue" : ""
}
Properties
Name
Type
Required
Restrictions
Description
data
[HumilityStatsRule ]
true
metrics rules
modelId
string
false
The id of the model for which metrics are being retrieved.
period
TimeRange
true
An object with the keys "start" and "end" defining the period.
segmentAttribute
string¦null
false
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
The value of the segmentAttribute
to segment on.
HumilityStatsRule
{
"ruleId" : "string" ,
"ruleName" : "string" ,
"value" : 0
}
Properties
Name
Type
Required
Restrictions
Description
ruleId
string
true
Id of the humility rule.
ruleName
string
true
Name of the rule.
value
integer
true
Number of times the rule was triggered.
MeanProbability
{
"className" : "string" ,
"value" : 0
}
Properties
Name
Type
Required
Restrictions
Description
className
string
true
Name of the class
value
number
true
Mean predicted probability for a class for all rows in the bucket
MetricBaselineValue
Properties
Name
Type
Required
Restrictions
Description
value
number
true
A reference value in given metric units.
MetricCreatePayload
{
"baselineValues" : [],
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"isModelSpecific" : true ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timeStep" : "hour" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
Properties
Name
Type
Required
Restrictions
Description
baselineValues
[MetricBaselineValue ]
true
maxItems: 5
Baseline values
description
string
false
maxLength: 1000
A description of the custom metric.
directionality
string
true
Directionality of the custom metric.
isModelSpecific
boolean
true
Determines whether the metric is related to the model or deployment.
name
string
true
Name of the custom metric.
sampleCount
SampleCountField
false
Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
timeStep
string
true
Custom metric time bucket size.
timestamp
MetricTimestampSpoofing
false
A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
type
string
true
Type (and aggregation character) of a metric.
units
string
true
Units or Y Label of given custom metric.
value
ValueField
false
A custom metric value source when reading values from columnar dataset like a file.
Enumerated Values
Property
Value
directionality
[higherIsBetter
, lowerIsBetter
]
timeStep
hour
type
[average
, gauge
, sum
]
MetricCreatedBy
Properties
Name
Type
Required
Restrictions
Description
id
string
true
The ID of user who created custom metric.
MetricEntity
{
"baselineValues" : [
{
"value" : 0
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"displayChart" : true ,
"id" : "string" ,
"isModelSpecific" : true ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timeStep" : "hour" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
Properties
Name
Type
Required
Restrictions
Description
baselineValues
[MetricBaselineValue ]
true
maxItems: 5
Baseline values
createdAt
string(date-time)
true
Custom metric creation timestamp.
createdBy
MetricCreatedBy
true
The user that created custom metric.
description
string
false
maxLength: 1000
A description of the custom metric.
directionality
string
true
Directionality of the custom metric.
displayChart
boolean
false
Indicates if UI should show chart by default.
id
string
true
The ID of the custom metric.
isModelSpecific
boolean
true
Determines whether the metric is related to the model or deployment.
name
string
true
Name of the custom metric.
sampleCount
SampleCountField
false
Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
timeStep
string
true
Custom metric time bucket size.
timestamp
MetricTimestampSpoofing
false
A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
type
string
true
Type (and aggregation character) of a metric.
units
string
true
Units or Y Label of given custom metric.
value
ValueField
false
A custom metric value source when reading values from columnar dataset like a file.
Enumerated Values
Property
Value
directionality
[higherIsBetter
, lowerIsBetter
]
timeStep
hour
type
[average
, gauge
, sum
]
{
"sampleSize" : 1 ,
"timestamp" : "2019-08-24T14:15:22Z" ,
"value" : 0
}
Properties
Name
Type
Required
Restrictions
Description
sampleSize
integer
false
Custom metric value sample size.
timestamp
string(date-time)¦null
false
Value timestamp.
value
number
true
Custom metric value to ingest.
MetricListResponse
{
"count" : 0 ,
"data" : [
{
"baselineValues" : [
{
"value" : 0
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"displayChart" : true ,
"id" : "string" ,
"isModelSpecific" : true ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timeStep" : "hour" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
],
"next" : "string" ,
"previous" : "string" ,
"totalCount" : 0
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
true
minimum: 0
Number of paginated entries.
data
[MetricEntity ]
true
A list of custom metrics.
next
string¦null
true
URL to the next page, or null if there is no such page
previous
string¦null
true
URL to the previous page, or null if there is no such page
totalCount
integer
true
minimum: 0
Total number of entries.
MetricPeriodBucket
{
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
end
string(date-time)
true
End of the bucket.
start
string(date-time)
true
Start of the bucket.
MetricSummary
{
"baselineValue" : 0 ,
"id" : "string" ,
"name" : "string" ,
"percentChange" : 0 ,
"sampleCount" : 0 ,
"value" : 0
}
Properties
Name
Type
Required
Restrictions
Description
baselineValue
number¦null
true
Baseline value.
id
string
true
The ID of the custom metric.
name
string
true
Name of the custom metric.
percentChange
number¦null
true
Percentage change of the baseline over its baseline.
sampleCount
integer¦null
true
Number of samples used to calculate the aggregated value.
value
number¦null
true
Aggregated value of the custom metric.
MetricTimestampSpoofing
{
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
}
Properties
Name
Type
Required
Restrictions
Description
columnName
string¦null
false
Column name
timeFormat
string¦null
false
Format
Enumerated Values
Property
Value
timeFormat
[%m/%d/%Y
, %m/%d/%y
, %d/%m/%y
, %m-%d-%Y
, %m-%d-%y
, %Y/%m/%d
, %Y-%m-%d
, %Y-%m-%d %H:%M:%S
, %Y/%m/%d %H:%M:%S
, %Y.%m.%d %H:%M:%S
, %Y-%m-%d %H:%M
, %Y/%m/%d %H:%M
, %y/%m/%d
, %y-%m-%d
, %y-%m-%d %H:%M:%S
, %y.%m.%d %H:%M:%S
, %y/%m/%d %H:%M:%S
, %y-%m-%d %H:%M
, %y.%m.%d %H:%M
, %y/%m/%d %H:%M
, %m/%d/%Y %H:%M
, %m/%d/%y %H:%M
, %d/%m/%Y %H:%M
, %d/%m/%y %H:%M
, %m-%d-%Y %H:%M
, %m-%d-%y %H:%M
, %d-%m-%Y %H:%M
, %d-%m-%y %H:%M
, %m.%d.%Y %H:%M
, %m/%d.%y %H:%M
, %d.%m.%Y %H:%M
, %d.%m.%y %H:%M
, %m/%d/%Y %H:%M:%S
, %m/%d/%y %H:%M:%S
, %m-%d-%Y %H:%M:%S
, %m-%d-%y %H:%M:%S
, %m.%d.%Y %H:%M:%S
, %m.%d.%y %H:%M:%S
, %d/%m/%Y %H:%M:%S
, %d/%m/%y %H:%M:%S
, %Y-%m-%d %H:%M:%S.%f
, %y-%m-%d %H:%M:%S.%f
, %Y-%m-%dT%H:%M:%S.%fZ
, %y-%m-%dT%H:%M:%S.%fZ
, %Y-%m-%dT%H:%M:%S.%f
, %y-%m-%dT%H:%M:%S.%f
, %Y-%m-%dT%H:%M:%S
, %y-%m-%dT%H:%M:%S
, %Y-%m-%dT%H:%M:%SZ
, %y-%m-%dT%H:%M:%SZ
, %Y.%m.%d %H:%M:%S.%f
, %y.%m.%d %H:%M:%S.%f
, %Y.%m.%dT%H:%M:%S.%fZ
, %y.%m.%dT%H:%M:%S.%fZ
, %Y.%m.%dT%H:%M:%S.%f
, %y.%m.%dT%H:%M:%S.%f
, %Y.%m.%dT%H:%M:%S
, %y.%m.%dT%H:%M:%S
, %Y.%m.%dT%H:%M:%SZ
, %y.%m.%dT%H:%M:%SZ
, %Y%m%d
, %m %d %Y %H %M %S
, %m %d %y %H %M %S
, %H:%M
, %M:%S
, %H:%M:%S
, %Y %m %d %H %M %S
, %y %m %d %H %M %S
, %Y %m %d
, %y %m %d
, %d/%m/%Y
, %Y-%d-%m
, %y-%d-%m
, %Y/%d/%m %H:%M:%S.%f
, %Y/%d/%m %H:%M:%S.%fZ
, %Y/%m/%d %H:%M:%S.%f
, %Y/%m/%d %H:%M:%S.%fZ
, %y/%d/%m %H:%M:%S.%f
, %y/%d/%m %H:%M:%S.%fZ
, %y/%m/%d %H:%M:%S.%f
, %y/%m/%d %H:%M:%S.%fZ
, %m.%d.%Y
, %m.%d.%y
, %d.%m.%y
, %d.%m.%Y
, %Y.%m.%d
, %Y.%d.%m
, %y.%m.%d
, %y.%d.%m
, %Y-%m-%d %I:%M:%S %p
, %Y/%m/%d %I:%M:%S %p
, %Y.%m.%d %I:%M:%S %p
, %Y-%m-%d %I:%M %p
, %Y/%m/%d %I:%M %p
, %y-%m-%d %I:%M:%S %p
, %y.%m.%d %I:%M:%S %p
, %y/%m/%d %I:%M:%S %p
, %y-%m-%d %I:%M %p
, %y.%m.%d %I:%M %p
, %y/%m/%d %I:%M %p
, %m/%d/%Y %I:%M %p
, %m/%d/%y %I:%M %p
, %d/%m/%Y %I:%M %p
, %d/%m/%y %I:%M %p
, %m-%d-%Y %I:%M %p
, %m-%d-%y %I:%M %p
, %d-%m-%Y %I:%M %p
, %d-%m-%y %I:%M %p
, %m.%d.%Y %I:%M %p
, %m/%d.%y %I:%M %p
, %d.%m.%Y %I:%M %p
, %d.%m.%y %I:%M %p
, %m/%d/%Y %I:%M:%S %p
, %m/%d/%y %I:%M:%S %p
, %m-%d-%Y %I:%M:%S %p
, %m-%d-%y %I:%M:%S %p
, %m.%d.%Y %I:%M:%S %p
, %m.%d.%y %I:%M:%S %p
, %d/%m/%Y %I:%M:%S %p
, %d/%m/%y %I:%M:%S %p
, %Y-%m-%d %I:%M:%S.%f %p
, %y-%m-%d %I:%M:%S.%f %p
, %Y-%m-%dT%I:%M:%S.%fZ %p
, %y-%m-%dT%I:%M:%S.%fZ %p
, %Y-%m-%dT%I:%M:%S.%f %p
, %y-%m-%dT%I:%M:%S.%f %p
, %Y-%m-%dT%I:%M:%S %p
, %y-%m-%dT%I:%M:%S %p
, %Y-%m-%dT%I:%M:%SZ %p
, %y-%m-%dT%I:%M:%SZ %p
, %Y.%m.%d %I:%M:%S.%f %p
, %y.%m.%d %I:%M:%S.%f %p
, %Y.%m.%dT%I:%M:%S.%fZ %p
, %y.%m.%dT%I:%M:%S.%fZ %p
, %Y.%m.%dT%I:%M:%S.%f %p
, %y.%m.%dT%I:%M:%S.%f %p
, %Y.%m.%dT%I:%M:%S %p
, %y.%m.%dT%I:%M:%S %p
, %Y.%m.%dT%I:%M:%SZ %p
, %y.%m.%dT%I:%M:%SZ %p
, %m %d %Y %I %M %S %p
, %m %d %y %I %M %S %p
, %I:%M %p
, %I:%M:%S %p
, %Y %m %d %I %M %S %p
, %y %m %d %I %M %S %p
, %Y/%d/%m %I:%M:%S.%f %p
, %Y/%d/%m %I:%M:%S.%fZ %p
, %Y/%m/%d %I:%M:%S.%f %p
, %Y/%m/%d %I:%M:%S.%fZ %p
, %y/%d/%m %I:%M:%S.%f %p
, %y/%d/%m %I:%M:%S.%fZ %p
, %y/%m/%d %I:%M:%S.%f %p
, %y/%m/%d %I:%M:%S.%fZ %p
]
MetricUpdatePayload
{
"baselineValues" : [
{
"value" : 0
}
],
"batch" : {
"columnName" : "string"
},
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
Properties
Name
Type
Required
Restrictions
Description
baselineValues
[MetricBaselineValue ]
false
maxItems: 5
Baseline values
batch
BatchField
false
A custom metric batch ID source when reading values from columnar dataset like a file.
description
string
false
maxLength: 1000
A description of the custom metric.
directionality
string
false
Directionality of the custom metric.
name
string
false
Name of the custom metric.
sampleCount
SampleCountField
false
Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
timestamp
MetricTimestampSpoofing
false
A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
type
string
false
Type (and aggregation character) of a metric.
units
string
false
Units or Y Label of given custom metric.
value
ValueField
false
A custom metric value source when reading values from columnar dataset like a file.
Enumerated Values
Property
Value
directionality
[higherIsBetter
, lowerIsBetter
]
type
[average
, gauge
, sum
]
MetricValuesFromDatasetPayload
{
"associationId" : {
"columnName" : "string"
},
"batch" : {
"columnName" : "string"
},
"datasetId" : "string" ,
"modelId" : null ,
"modelPackageId" : null ,
"sampleCount" : {
"columnName" : "string"
},
"segments" : [
{
"column" : "string" ,
"name" : "string" ,
"value" : "string"
}
],
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"value" : {
"columnName" : "string"
}
}
Properties
Name
Type
Required
Restrictions
Description
associationId
BatchField
false
Points to a custom metric associationId column, for saving predictions feedback.
batch
BatchField
false
A custom metric batch ID source when reading values from columnar dataset like a file.
datasetId
string
true
Dataset ID to process.
modelId
string¦null
false
For a model metric: the ID of the model of related champion/challenger to update the metric values.For a deployment metric: the ID of the model is not needed.
modelPackageId
string¦null
false
For a model metric: the ID of the model package of related champion/challenger to update the metric values.For a deployment metric: the ID of the model package is not needed.
sampleCount
SampleCountField
false
Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
segments
[CustomMetricSegmentDataset ]
false
maxItems: 10 minItems: 1
A list of segments for a custom metric used in segmented analysis.
timestamp
MetricTimestampSpoofing
false
A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
value
ValueField
false
A custom metric value source when reading values from columnar dataset like a file.
MetricValuesFromJSONPayload
{
"buckets" : [
{
"sampleSize" : 1 ,
"timestamp" : "2019-08-24T14:15:22Z" ,
"value" : 0
}
],
"dryRun" : false ,
"modelId" : null ,
"modelPackageId" : null
}
Properties
Name
Type
Required
Restrictions
Description
buckets
[MetricInputValueBucket ]
true
maxItems: 10000
A list of timestamped buckets with custom metric values.
dryRun
boolean
true
Determines whether the data is sent to the modmon or not.
modelId
string¦null
false
For a model metric: the ID of the model of related champion/challenger to update the metric values.For a deployment metric: the ID of the model is not needed.
modelPackageId
string¦null
false
For a model metric: the ID of the model package of related champion/challenger to update the metric values.For a deployment metric: the ID of the model package is not needed.
MetricValuesOverBatchBucket
{
"batch" : {
"createdAt" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"lastPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
},
"sampleSize" : 0 ,
"value" : 0
}
Properties
Name
Type
Required
Restrictions
Description
batch
BucketBatch
true
Describes a batch associated with the bucket.
sampleSize
integer¦null
true
Total number of values aggregated in the bucket.
value
number¦null
true
Aggregated custom metric value in the bucket.
MetricValuesOverBatchResponse
{
"buckets" : [
{
"batch" : {
"createdAt" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"lastPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
},
"sampleSize" : 0 ,
"value" : 0
}
],
"metric" : {
"baselineValues" : [
{
"value" : 0
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"displayChart" : true ,
"id" : "string" ,
"isModelSpecific" : true ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timeStep" : "hour" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
}
}
Properties
Name
Type
Required
Restrictions
Description
buckets
[MetricValuesOverBatchBucket ]
true
maxItems: 100
A list of bucketed batches and the custom metric values aggregated over that batches.
metric
MetricEntity
true
A custom metric definition.
MetricValuesOverTimeBucket
{
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"value" : 0
}
Properties
Name
Type
Required
Restrictions
Description
period
MetricPeriodBucket
true
A time period defined by a start and end time
sampleSize
integer¦null
true
Total number of values aggregated in the bucket.
value
number¦null
true
Aggregated custom metric value in the bucket.
MetricValuesOverTimeResponse
{
"buckets" : [
{
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"value" : 0
}
],
"metric" : {
"baselineValues" : [
{
"value" : 0
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string"
},
"description" : "string" ,
"directionality" : "higherIsBetter" ,
"displayChart" : true ,
"id" : "string" ,
"isModelSpecific" : true ,
"name" : "string" ,
"sampleCount" : {
"columnName" : "string"
},
"timeStep" : "hour" ,
"timestamp" : {
"columnName" : "string" ,
"timeFormat" : "%m/%d/%Y"
},
"type" : "average" ,
"units" : "string" ,
"value" : {
"columnName" : "string"
}
},
"summary" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
}
}
Properties
MetricValuesOverTimeSummary
{
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
end
string(date-time)
true
End of the retrieval range.
start
string(date-time)
true
Start of the retrieval range.
MlpkgFileContents
{
"allTimeSeriesPredictionIntervals" : true
}
Properties
Name
Type
Required
Restrictions
Description
allTimeSeriesPredictionIntervals
boolean¦null
false
Whether .mlpkg contains TS prediction intervals computed for all percentiles
ModelPackageCapabilities
{
"supportsAutomaticActuals" : true ,
"supportsChallengerModels" : true ,
"supportsFeatureDriftTracking" : true ,
"supportsHumilityRecommendedRules" : true ,
"supportsHumilityRules" : true ,
"supportsHumilityRulesDefaultCalculations" : true ,
"supportsPredictionWarning" : true ,
"supportsRetraining" : true ,
"supportsScoringCodeDownload" : true ,
"supportsSecondaryDatasets" : true ,
"supportsSegmentedAnalysisDriftAndAccuracy" : true ,
"supportsShapBasedPredictionExplanations" : true ,
"supportsTargetDriftTracking" : true
}
Properties
Name
Type
Required
Restrictions
Description
supportsAutomaticActuals
boolean
false
Whether inferring actual values from time series history data and automatically feeding them back for accuracy estimation is supported by this model package.
supportsChallengerModels
boolean
true
Whether Challenger Models are supported by this model package.
supportsFeatureDriftTracking
boolean
true
Whether Feature Drift is supported by this model package.
supportsHumilityRecommendedRules
boolean
true
Whether calculating values for recommended Humility Rules is supported by this model package.
supportsHumilityRules
boolean
true
Whether Humility Rules are supported by this model package.
supportsHumilityRulesDefaultCalculations
boolean
true
Whether calculating default values for Humility Rules is supported by this model package.
supportsPredictionWarning
boolean
true
Whether Prediction Warnings are supported by this model package.
supportsRetraining
boolean
false
Whether deployment supports retraining.
supportsScoringCodeDownload
boolean
false
Whether scoring code download is supported by this model package.
supportsSecondaryDatasets
boolean
true
If the deployments supports secondary datasets.
supportsSegmentedAnalysisDriftAndAccuracy
boolean
true
Whether tracking features in training and predictions data for segmented analysis is supported by this model package.
supportsShapBasedPredictionExplanations
boolean
true
Whether shap-based prediction explanations are supported by this model package.
supportsTargetDriftTracking
boolean
true
Whether Target Drift is supported by this model package.
ModelPackageDatasets
{
"baselineSegmentedBy" : [
"string"
],
"datasetName" : "string" ,
"holdoutDataCatalogId" : "string" ,
"holdoutDataCatalogVersionId" : "string" ,
"holdoutDatasetName" : "string" ,
"targetHistogramBaseline" : "predictions" ,
"trainingDataCatalogId" : "string" ,
"trainingDataCatalogVersionId" : "string" ,
"trainingDataSize" : 0
}
Properties
Name
Type
Required
Restrictions
Description
baselineSegmentedBy
[string]¦null
true
Names of categorical features by which the training baseline was segmented. This allows for deployment prediction requests to be segmented by those same features. Segmenting the training baseline by these features allows for users to perform segmented analysis of Data Drift and Accuracy, and to compare the same subset of training and scoring data based on the selected segment attribute and segment value.
datasetName
string¦null
true
Name of dataset used to train the model
holdoutDataCatalogId
string¦null
true
ID for holdout data (returned from uploading a data set)
holdoutDataCatalogVersionId
string¦null
true
Version ID for holdout data (returned from uploading a data set)
holdoutDatasetName
string¦null
true
Name of dataset used for model holdout
targetHistogramBaseline
string
false
Values used to establish the training baseline
trainingDataCatalogId
string¦null
true
ID for training data (returned from uploading a data set)
trainingDataCatalogVersionId
string¦null
true
Version ID for training data (returned from uploading a data set)
trainingDataSize
integer
false
Number of rows in training data (used by DR models)
Enumerated Values
Property
Value
targetHistogramBaseline
[predictions
, actuals
]
{
"containsFearPipeline" : true ,
"containsFeaturelists" : true ,
"containsLeaderboardMeta" : true ,
"containsProjectMeta" : true ,
"creatorFullName" : "string" ,
"creatorId" : "string" ,
"creatorUsername" : "string" ,
"dateCreated" : "string" ,
"originalFileName" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
containsFearPipeline
boolean¦null
false
Exists for imported models only, indicates thatmodel package contains file with fear pipeline.
containsFeaturelists
boolean¦null
false
Exists for imported models only, indicates thatmodel package contains file with featurelists.
containsLeaderboardMeta
boolean¦null
false
Exists for imported models only, indicates thatmodel package contains file with leaderboard meta.
containsProjectMeta
boolean¦null
false
Exists for imported models only, indicates thatmodel package contains file with project meta.
creatorFullName
string¦null
true
Full name of the person who created this model package
creatorId
string
true
User ID of the person who created this Model Package
creatorUsername
string
true
Username of the person who created this model package
dateCreated
string
true
When this Model Package was created
originalFileName
string¦null
true
Exists for imported models only, the original file name that was uploaded
ModelPackageModelDescription
{
"buildEnvironmentType" : "DataRobot" ,
"description" : "string" ,
"location" : "string" ,
"modelCreatedAt" : "string" ,
"modelCreatorEmail" : "string" ,
"modelCreatorId" : null ,
"modelCreatorName" : "string" ,
"modelName" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
buildEnvironmentType
string
true
build environment type of the model
description
string¦null
true
a description of the model
location
string¦null
true
location of the model
modelCreatedAt
string¦null
false
time when the model was created
modelCreatorEmail
string¦null
false
email of the user who created the model
modelCreatorId
string¦null
false
ID of the creator of the model
modelCreatorName
string¦null
false
name of the user who created the model
modelName
string
false
model name
Enumerated Values
Property
Value
buildEnvironmentType
[DataRobot
, Python
, R
, Java
, Other
]
ModelPackageModelKind
{
"isAnomalyDetectionModel" : true ,
"isCombinedModel" : true ,
"isDecisionFlow" : true ,
"isFeatureDiscovery" : true ,
"isMultiseries" : true ,
"isTimeSeries" : true ,
"isUnsupervisedLearning" : true
}
Properties
Name
Type
Required
Restrictions
Description
isAnomalyDetectionModel
boolean
true
true if this is an anomaly detection model
isCombinedModel
boolean
true
true if model is a combined model
isDecisionFlow
boolean
true
true if this is a decision flow
isFeatureDiscovery
boolean
true
true if this model uses the Feature Discovery feature
isMultiseries
boolean
true
true if model is multiseries
isTimeSeries
boolean
true
true if model is time series
isUnsupervisedLearning
boolean
true
true if model used unsupervised learning
ModelPackageResponse
{
"id" : "string" ,
"name" : "string" ,
"registeredModelId" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
id
string
true
ID of the model package.
name
string
true
Type of the current model.
registeredModelId
string¦null
false
ID of the associated registered model
ModelPackageRetrieveResponseBase
{
"buildStatus" : "inProgress" ,
"capabilities" : {
"supportsAutomaticActuals" : true ,
"supportsChallengerModels" : true ,
"supportsFeatureDriftTracking" : true ,
"supportsHumilityRecommendedRules" : true ,
"supportsHumilityRules" : true ,
"supportsHumilityRulesDefaultCalculations" : true ,
"supportsPredictionWarning" : true ,
"supportsRetraining" : true ,
"supportsScoringCodeDownload" : true ,
"supportsSecondaryDatasets" : true ,
"supportsSegmentedAnalysisDriftAndAccuracy" : true ,
"supportsShapBasedPredictionExplanations" : true ,
"supportsTargetDriftTracking" : true
},
"datasets" : {
"baselineSegmentedBy" : [
"string"
],
"datasetName" : "string" ,
"holdoutDataCatalogId" : "string" ,
"holdoutDataCatalogVersionId" : "string" ,
"holdoutDatasetName" : "string" ,
"targetHistogramBaseline" : "predictions" ,
"trainingDataCatalogId" : "string" ,
"trainingDataCatalogVersionId" : "string" ,
"trainingDataSize" : 0
},
"id" : "string" ,
"importMeta" : {
"containsFearPipeline" : true ,
"containsFeaturelists" : true ,
"containsLeaderboardMeta" : true ,
"containsProjectMeta" : true ,
"creatorFullName" : "string" ,
"creatorId" : "string" ,
"creatorUsername" : "string" ,
"dateCreated" : "string" ,
"originalFileName" : "string"
},
"isArchived" : true ,
"isDeprecated" : true ,
"mlpkgFileContents" : {
"allTimeSeriesPredictionIntervals" : true
},
"modelDescription" : {
"buildEnvironmentType" : "DataRobot" ,
"description" : "string" ,
"location" : "string" ,
"modelCreatedAt" : "string" ,
"modelCreatorEmail" : "string" ,
"modelCreatorId" : null ,
"modelCreatorName" : "string" ,
"modelName" : "string"
},
"modelExecutionType" : "dedicated" ,
"modelId" : "string" ,
"modelKind" : {
"isAnomalyDetectionModel" : true ,
"isCombinedModel" : true ,
"isDecisionFlow" : true ,
"isFeatureDiscovery" : true ,
"isMultiseries" : true ,
"isTimeSeries" : true ,
"isUnsupervisedLearning" : true
},
"name" : "string" ,
"sourceMeta" : {
"decisionFlowId" : "string" ,
"decisionFlowVersionId" : "string" ,
"environmentUrl" : "http://example.com" ,
"fips_140_2Enabled" : true ,
"projectCreatedAt" : "string" ,
"projectCreatorEmail" : "string" ,
"projectCreatorId" : null ,
"projectCreatorName" : "string" ,
"projectId" : "string" ,
"projectName" : "string" ,
"scoringCode" : {
"dataRobotPredictionVersion" : "string" ,
"location" : "local_leaderboard"
},
"useCaseDetails" : {
"createdAt" : "string" ,
"creatorEmail" : "string" ,
"creatorId" : "string" ,
"creatorName" : "string" ,
"id" : "string" ,
"name" : "string"
}
},
"target" : {
"classCount" : 0 ,
"classNames" : [
"string"
],
"name" : "string" ,
"predictionProbabilitiesColumn" : "string" ,
"predictionThreshold" : 1 ,
"type" : "Binary"
},
"timeseries" : {
"datetimeColumnFormat" : "string" ,
"datetimeColumnName" : "string" ,
"effectiveFeatureDerivationWindowEnd" : 0 ,
"effectiveFeatureDerivationWindowStart" : 0 ,
"featureDerivationWindowEnd" : 0 ,
"featureDerivationWindowStart" : 0 ,
"forecastDistanceColumnName" : "string" ,
"forecastDistances" : [
0
],
"forecastDistancesTimeUnit" : "MICROSECOND" ,
"forecastPointColumnName" : "string" ,
"isCrossSeries" : true ,
"isNewSeriesSupport" : true ,
"isTraditionalTimeSeries" : true ,
"seriesColumnName" : "string"
},
"updatedBy" : {
"email" : "string" ,
"id" : "string" ,
"name" : "string"
},
"userProvidedId" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
buildStatus
string¦null
false
Model package build status
capabilities
ModelPackageCapabilities
true
Capabilities of the current model package.
datasets
ModelPackageDatasets
true
dataset information for the model package
id
string
true
ID of the Model package
importMeta
ModelPackageImportMeta
true
Information from when this Model Package was first saved
isArchived
boolean
true
Whether the model package is permanently archived (cannot be used in deployment or replacement)
isDeprecated
boolean
true
Whether the model package is deprecated. eg. python2 models are deprecated.
mlpkgFileContents
MlpkgFileContents
false
Information about the content of .mlpkg artifact
modelDescription
ModelPackageModelDescription
true
model description information for the model package
modelExecutionType
string
true
Type of model package. dedicated
(native DataRobot models) and custom_inference_model
(user added inference models) both execute on DataRobot prediction servers, external
do not
modelId
string
true
ID of the model
modelKind
ModelPackageModelKind
true
Model attribute information
name
string
true
Model package name
sourceMeta
ModelPackageSourceMeta
true
Meta information from where this model was generated
target
ModelPackageTarget
true
target information for the model package
timeseries
ModelPackageTimeseries
true
time series information for the model package
updatedBy
UserMetadata
true
Information on the user who last modified the registered model
userProvidedId
string
false
A user-provided unique ID associated with the given custom inference model.
Enumerated Values
Property
Value
buildStatus
[inProgress
, complete
, failed
]
modelExecutionType
[dedicated
, custom_inference_model
, external
]
{
"dataRobotPredictionVersion" : "string" ,
"location" : "local_leaderboard"
}
Properties
Name
Type
Required
Restrictions
Description
dataRobotPredictionVersion
string¦null
true
DataRobot prediction API version for the scoring code
location
string¦null
true
Location of the scoring code
Enumerated Values
Property
Value
location
[local_leaderboard
, mlpkg
]
{
"decisionFlowId" : "string" ,
"decisionFlowVersionId" : "string" ,
"environmentUrl" : "http://example.com" ,
"fips_140_2Enabled" : true ,
"projectCreatedAt" : "string" ,
"projectCreatorEmail" : "string" ,
"projectCreatorId" : null ,
"projectCreatorName" : "string" ,
"projectId" : "string" ,
"projectName" : "string" ,
"scoringCode" : {
"dataRobotPredictionVersion" : "string" ,
"location" : "local_leaderboard"
},
"useCaseDetails" : {
"createdAt" : "string" ,
"creatorEmail" : "string" ,
"creatorId" : "string" ,
"creatorName" : "string" ,
"id" : "string" ,
"name" : "string"
}
}
Properties
Name
Type
Required
Restrictions
Description
decisionFlowId
string¦null
true
The ID of the flow associated with this model package
decisionFlowVersionId
string¦null
true
The version ID of the flow associated with this model package
environmentUrl
string(uri)¦null
true
If available, URL of the source model
fips_140_2Enabled
boolean
false
true if the model was built with FIPS-140-2
projectCreatedAt
string¦null
false
If available, time when the project was created
projectCreatorEmail
string¦null
false
If available, email of the user who created the project
projectCreatorId
string¦null
false
If available, ID of the creator of the project
projectCreatorName
string¦null
false
If available, name of the user who created the project
projectId
string¦null
true
If available, the project id used for this model
projectName
string¦null
true
If available, the project name for this model
scoringCode
ModelPackageScoringCodeMeta
true
If available, information about the model's scoring code
useCaseDetails
UseCaseDetails
false
Details of the use-case associated to this registered model version
ModelPackageTarget
{
"classCount" : 0 ,
"classNames" : [
"string"
],
"name" : "string" ,
"predictionProbabilitiesColumn" : "string" ,
"predictionThreshold" : 1 ,
"type" : "Binary"
}
Properties
Name
Type
Required
Restrictions
Description
classCount
integer¦null
true
minimum: 0
Number of classes for classification models.
classNames
[string]¦null
true
maxItems: 100
Class names for prediction results. When target type is Binary, two class names are returned. The first element is the minority (positive) class and the second element is the majority (negative) class. Limited to 100 returned for Multiclass.
name
string
true
name of the target column
predictionProbabilitiesColumn
string¦null
true
Field or column name containing prediction probabilities
predictionThreshold
number¦null
true
maximum: 1 minimum: 0
Prediction threshold used for binary classification models
type
string
true
Target type of the model.
Enumerated Values
Property
Value
type
[Binary
, Regression
, Multiclass
, Multilabel
, TextGeneration
]
ModelPackageTimeseries
{
"datetimeColumnFormat" : "string" ,
"datetimeColumnName" : "string" ,
"effectiveFeatureDerivationWindowEnd" : 0 ,
"effectiveFeatureDerivationWindowStart" : 0 ,
"featureDerivationWindowEnd" : 0 ,
"featureDerivationWindowStart" : 0 ,
"forecastDistanceColumnName" : "string" ,
"forecastDistances" : [
0
],
"forecastDistancesTimeUnit" : "MICROSECOND" ,
"forecastPointColumnName" : "string" ,
"isCrossSeries" : true ,
"isNewSeriesSupport" : true ,
"isTraditionalTimeSeries" : true ,
"seriesColumnName" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
datetimeColumnFormat
string¦null
true
Date format for forecast date and forecast point column
datetimeColumnName
string¦null
true
Name of the forecast date column
effectiveFeatureDerivationWindowEnd
integer¦null
true
maximum: 0
Same concept as featureDerivationWindowEnd
which is chosen by the user and based on the initial sampled data from the eda sample. When the dataset goes through aim, the pipeline reads the full dataset and figures out the "real" FDW (i.e., the effective FDW). For most models, eFDW is approximately the same as the FDW.
effectiveFeatureDerivationWindowStart
integer¦null
true
maximum: 0
Same concept as featureDerivationWindowStart
which is chosen by the user and based on the initial sampled data from the eda sample. When the dataset goes through aim, the pipeline reads the full dataset and figures out the "real" FDW (i.e., the effective FDW). For most models, eFDW is approximately the same as the FDW.
featureDerivationWindowEnd
integer¦null
true
maximum: 0
Negative number or zero defining how many time units of the forecast distances time unit into the past relative to the forecast point the feature derivation window should end.
featureDerivationWindowStart
integer¦null
true
maximum: 0
Negative number or zero defining how many time units of the forecast distances time unit into the past relative to the forecast point the feature derivation window should begin.
forecastDistanceColumnName
string¦null
true
Name of the forecast distance column
forecastDistances
[integer]¦null
true
List of integer forecast distances
forecastDistancesTimeUnit
string¦null
true
The time unit of forecast distances
forecastPointColumnName
string¦null
true
Name of the forecast point column
isCrossSeries
boolean¦null
true
true if the model is cross-series.
isNewSeriesSupport
boolean¦null
true
true if the model is optimized to support new series.
isTraditionalTimeSeries
boolean¦null
true
true if the model is traditional time series.
seriesColumnName
string¦null
true
Name of the series column in case of multi-series date
Enumerated Values
Property
Value
forecastDistancesTimeUnit
[MICROSECOND
, MILLISECOND
, SECOND
, MINUTE
, HOUR
, DAY
, WEEK
, MONTH
, QUARTER
, YEAR
]
ModelReplacementSubmission
{
"modelId" : "string" ,
"modelPackageId" : "string" ,
"reason" : "ACCURACY"
}
Properties
Name
Type
Required
Restrictions
Description
modelId
string
false
ID of the model used to replace deployment's champion model. Required if modelPackageId is not provided.
modelPackageId
string
false
ID of the model package used to replace deployment's champion model. Required if modelId is not provided.
reason
string
true
Reason for the model replacement.
Enumerated Values
Property
Value
reason
[ACCURACY
, DATA_DRIFT
, ERRORS
, SCHEDULED_REFRESH
, SCORING_SPEED
, DEPRECATION
, OTHER
]
ModelReplacementValidationRequest
{
"modelId" : "string" ,
"modelPackageId" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
modelId
string
false
ID of the model used to replace deployment's champion model. Required if modelPackageId is not provided.
modelPackageId
string
false
ID of the model package used to replace deployment's champion model. Required if modelId is not provided.
ModelReplacementValidationResponse
{
"checks" : {
"combinedModelSegments" : {
"message" : "string" ,
"status" : "failing"
},
"containsTrackedSegmentAttributes" : {
"message" : "string" ,
"status" : "failing"
},
"driftTracking" : {
"message" : "string" ,
"status" : "failing"
},
"featureDataTypes" : {
"message" : "string" ,
"status" : "failing"
},
"features" : {
"message" : "string" ,
"status" : "failing"
},
"humilityRules" : {
"message" : "string" ,
"status" : "failing"
},
"modelCanBeDeployed" : {
"message" : "string" ,
"status" : "failing"
},
"modelStatus" : {
"message" : "string" ,
"status" : "failing"
},
"notCurrentModel" : {
"message" : "string" ,
"status" : "failing"
},
"permission" : {
"message" : "string" ,
"status" : "failing"
},
"predictionIntervals" : {
"message" : "string" ,
"status" : "failing"
},
"predictionReady" : {
"message" : "string" ,
"status" : "failing"
},
"seriesType" : {
"message" : "string" ,
"status" : "failing"
},
"supported" : {
"message" : "string" ,
"status" : "failing"
},
"target" : {
"message" : "string" ,
"status" : "failing"
},
"targetClasses" : {
"message" : "string" ,
"status" : "failing"
},
"targetType" : {
"message" : "string" ,
"status" : "failing"
},
"timeSeriesCompatibility" : {
"message" : "string" ,
"status" : "failing"
},
"validChallenger" : {
"message" : "string" ,
"status" : "failing"
}
},
"message" : "string" ,
"status" : "failing"
}
Properties
Name
Type
Required
Restrictions
Description
checks
ValidationChecks
true
A more granular explanation of why the replacement model was eligible or ineligible.
message
string
true
Message of the overall validation check.
status
string
true
Status of the overall validation check.
Enumerated Values
Property
Value
status
[failing
, passing
, warning
]
ModelResponse
{
"datasetName" : "string" ,
"description" : "string" ,
"executionType" : "string" ,
"id" : "string" ,
"isDeprecated" : true ,
"name" : "string" ,
"projectId" : "string" ,
"projectName" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
datasetName
string
true
Name of dataset used to train challenger model
description
string
true
Description of the model.
executionType
string
true
Type of the current model.
id
string
true
ID of the current model.
isDeprecated
boolean
true
Whether the current model is deprecated model. eg. python2 based model.
name
string
true
Name of the model.
projectId
string
true
Project ID of the current model.
projectName
string
true
Project name of the current model.
MonitoringBatch
{
"batchPredictionJobId" : "string" ,
"batchPredictionJobStatus" : "INITIALIZING" ,
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string" ,
"name" : "string"
},
"description" : "string" ,
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"externalContextUrl" : "http://example.com" ,
"id" : "string" ,
"isLocked" : true ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"predictionsCount" : 0 ,
"serviceHealth" : {
"message" : "string" ,
"status" : "string"
}
}
Properties
Name
Type
Required
Restrictions
Description
batchPredictionJobId
string¦null
true
ID of the batch prediction job associated with the batch.
batchPredictionJobStatus
string¦null
true
Status of the batch prediction job associated with the batch
createdAt
string(date-time)
true
Creation timestamp of the monitoring batch.
createdBy
MonitoringBatchCreator
true
Creator of the monitoring batch.
description
string¦null
true
Description of the monitoring batch.
earliestPredictionTimestamp
string(date-time)
true
Earliest prediction request timestamp in the monitoring batch.
externalContextUrl
string(uri)¦null
true
External URL associated with the batch.
id
string
true
ID of the monitoring batch.
isLocked
boolean
true
Whether or not predictions can be added to the batch
latestPredictionTimestamp
string(date-time)
true
Latest prediction request timestamp in the monitoring batch.
name
string
true
Name of the monitoring batch.
predictionsCount
integer
true
Count of predictions rows in the monitoring batch.
serviceHealth
MonitoringBatchServiceHealth
true
Service health of the monitoring batch.
Enumerated Values
Property
Value
batchPredictionJobStatus
[INITIALIZING
, RUNNING
, COMPLETED
, ABORTED
, FAILED
]
MonitoringBatchCreateUpdate
{
"batchName" : "string" ,
"description" : "string" ,
"externalContextUrl" : "http://example.com" ,
"isLocked" : true
}
Properties
Name
Type
Required
Restrictions
Description
batchName
string
false
Name of the monitoring batch.
description
string¦null
false
Description of the monitoring batch.
externalContextUrl
string(uri)¦null
false
External URL associated with the batch.
isLocked
boolean¦null
false
Whether or not predictions can be added to the batch
MonitoringBatchCreator
{
"id" : "string" ,
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
id
string
true
ID of the user who created the monitoring batch.
name
string
true
Name of the user who created monitoring batch.
MonitoringBatchListResponse
{
"count" : 0 ,
"data" : [
{
"batchPredictionJobId" : "string" ,
"batchPredictionJobStatus" : "INITIALIZING" ,
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : {
"id" : "string" ,
"name" : "string"
},
"description" : "string" ,
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"externalContextUrl" : "http://example.com" ,
"id" : "string" ,
"isLocked" : true ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"predictionsCount" : 0 ,
"serviceHealth" : {
"message" : "string" ,
"status" : "string"
}
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
false
Number of items returned on this page.
data
[MonitoringBatch ]
true
List of monitoring batches.
next
string(uri)¦null
true
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
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.
MonitoringBatchModel
{
"batchId" : "string" ,
"endTime" : "2019-08-24T14:15:22Z" ,
"modelId" : "string" ,
"predictionsCount" : 0 ,
"startTime" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
batchId
string
true
ID of this monitoring batch.
endTime
string(date-time)
true
Latest time of a prediction on this model in this batch
modelId
string
true
ID of a model with data on this batch
predictionsCount
integer
true
Count of predictions rows on this model in this batch
startTime
string(date-time)
true
Earliest time of a prediction on this model in this batch
MonitoringBatchModelListResponse
{
"count" : 0 ,
"data" : [
{
"batchId" : "string" ,
"endTime" : "2019-08-24T14:15:22Z" ,
"modelId" : "string" ,
"predictionsCount" : 0 ,
"startTime" : "2019-08-24T14:15:22Z"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
false
Number of items returned on this page.
data
[MonitoringBatchModel ]
true
List of models with data on a monitoring batch.
next
string(uri)¦null
true
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
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.
MonitoringBatchModelUpdate
{
"endTime" : "2019-08-24T14:15:22Z" ,
"startTime" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
endTime
string(date-time)
false
Latest time of predictions on this model in this batch.
startTime
string(date-time)
false
Earliest time of predictions on this model in this batch.
MonitoringBatchServiceHealth
{
"message" : "string" ,
"status" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
message
string
true
Monitoring batch service health message.
status
string
true
Monitoring batch service health status.
MonitoringDataDeletePayload
{
"end" : "2019-08-24T14:15:22Z" ,
"modelId" : "string" ,
"start" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
end
string(date-time)¦null
false
End of the period to delete monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
modelId
string
true
The id of the model for which monitoring data are being deleted.
start
string(date-time)¦null
false
Start of the period to delete monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
Percentile
{
"percent" : 0 ,
"value" : 0
}
Properties
Name
Type
Required
Restrictions
Description
percent
number
true
Percent of the percentile
value
number
true
Predicted value or probability at a percentile
Periodicity
{
"timeSteps" : 0 ,
"timeUnit" : "MILLISECOND"
}
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
]
PredictedClassDistribution
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
Properties
Name
Type
Required
Restrictions
Description
className
string
true
Name of the class.
count
integer
true
Count of prediction rows labeled with a class in the bucket.
percent
number
true
Percent of prediction rows labeled with a class in the bucket.
PredictionDataBatch
{
"batchId" : "string" ,
"batchName" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
batchId
string
true
An ID of a batch.
batchName
string
true
A name of a batch.
PredictionDataEntry
{
"id" : "string" ,
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
id
string
true
The ID of the AI Catalog entry.
name
string
true
The name of the AI Catalog entry.
PredictionDataTimeRange
{
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
end
string(date-time)
true
End of the period of prediction data to collect.
start
string(date-time)
true
Start of the period of prediction data to collect.
PredictionDataUpdate
{
"status" : "CANCELLED"
}
Properties
Name
Type
Required
Restrictions
Description
status
string
false
A prediction data export processing state.
Enumerated Values
Property
Value
status
CANCELLED
PredictionDatasetAssignment
{
"datasetId" : "string" ,
"datasetVersionId" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
datasetId
string
true
the ID of the dataset
datasetVersionId
string
false
the ID of the dataset version
PredictionEnvironment
{
"id" : "string" ,
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
id
string
true
ID of the prediction environment.
name
string
true
Name of the prediction environment.
PredictionEnvironmentResponse
{
"id" : "string" ,
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
id
string
true
ID of the prediction environment.
name
string
true
Name of the prediction environment.
PredictionExportListResponse
{
"count" : 0 ,
"data" : [
{
"augmentationType" : "NO_AUGMENTATION" ,
"batches" : [
{
"batchId" : "string" ,
"batchName" : "string"
}
],
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : "string" ,
"data" : [
{
"id" : "string" ,
"name" : "string"
}
],
"error" : {
"message" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"status" : "CANCELLED"
}
],
"next" : "string" ,
"previous" : "string" ,
"totalCount" : 0
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
true
minimum: 0
Number of paginated entries.
data
[ExportEntity ]
true
A list of prediction data exports.
next
string¦null
true
URL to the next page, or null if there is no such page.
previous
string¦null
true
URL to the previous page, or null if there is no such page
totalCount
integer
true
minimum: 0
Total number of entries.
PredictionIntervals
{
"enabled" : true ,
"percentiles" : [
0
]
}
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
Indicates whether prediction intervals are enabled for this deployment.
percentiles
[integer]
false
The percentiles used for this deployment. Currently, we support at most one percentile at a time.
PredictionIntervalsUpdate
{
"enabled" : true ,
"percentiles" : [
0
]
}
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
True if prediction intervals are enabled for this deployment, false if otherwise
percentiles
[integer]
false
if prediction intervals are enabled, the percentiles to use for this deployment. Currently, we support at most one percentile at a time.
PredictionResultResponse
{
"actual" : 0 ,
"associationId" : "string" ,
"forecastDistance" : 0 ,
"modelId" : "string" ,
"predicted" : 0 ,
"timestamp" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
actual
any
true
Actual value of the prediction
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
integer
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
continued
Name
Type
Required
Restrictions
Description
associationId
string
true
Association id of the prediction, which is used to associate a prediction with its actual value and calculate accuracy.
forecastDistance
integer¦null
false
The number of time units this prediction is away from the forecastPoint. The unit of time is determined by the timeUnit of the datetime partition column. For time series models only.
modelId
string
true
ID of the model used to make these predictions
predicted
any
true
Predicted value of the prediction
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
integer
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
continued
Name
Type
Required
Restrictions
Description
timestamp
string(date-time)
true
When the prediction was made.
PredictionResultsListResponse
{
"associationIdColumnNames" : [
"string"
],
"count" : 0 ,
"data" : [
{
"actual" : 0 ,
"associationId" : "string" ,
"forecastDistance" : 0 ,
"modelId" : "string" ,
"predicted" : 0 ,
"timestamp" : "2019-08-24T14:15:22Z"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com"
}
Properties
Name
Type
Required
Restrictions
Description
associationIdColumnNames
[string]¦null
true
List of column names used to represent an association id, which is used to unique identify individual prediction rows.
count
integer
false
Number of items returned on this page.
data
[PredictionResultResponse ]
true
An array of prediction requests.
next
string(uri)¦null
true
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
true
URL pointing to the previous page (if null, there is no previous page).
PredictionServerListResponse
{
"count" : 0 ,
"data" : [
{
"batchPredictions" : {
"processing" : 0 ,
"queued" : 0
},
"datarobot-key" : "string" ,
"id" : "string" ,
"url" : "string"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com"
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
false
Number of items returned on this page.
data
[PredictionServerResponse ]
true
List of prediction servers.
next
string(uri)¦null
true
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
true
URL pointing to the previous page (if null, there is no previous page).
PredictionServerResponse
{
"batchPredictions" : {
"processing" : 0 ,
"queued" : 0
},
"datarobot-key" : "string" ,
"id" : "string" ,
"url" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
batchPredictions
BatchPredictionStatus
true
Batch Prediction status for this instance
datarobot-key
string¦null
true
The datarobot-key
header used in requests to this prediction server.
id
string¦null
true
ID of the prediction server.
url
string
true
URL of the prediction server.
PredictionWarning
{
"customBoundaries" : {
"lower" : 0 ,
"upper" : 0
},
"enabled" : true
}
Properties
Name
Type
Required
Restrictions
Description
customBoundaries
CustomBoundaries
true
Null if default boundaries for the model are used
enabled
boolean
true
Indicates whether prediction warnings are enabled for this deployment.
PredictionWarningUpdate
{
"customBoundaries" : {
"lower" : 0 ,
"upper" : 0
},
"enabled" : true
}
Properties
Name
Type
Required
Restrictions
Description
customBoundaries
CustomBoundaries
false
If omitted, boundaries will not be changed. Null if default boundaries for the model should be used.
enabled
boolean
true
True if prediction warnings are enabled for this deployment, false otherwise.
PredictionsDataCollection
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
Indicates whether incoming prediction requests and results should be stored in record-level storage.
PredictionsOverBatchBucket
{
"batch" : {
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
},
"classDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanPredictedValue" : 0 ,
"meanProbabilities" : [
{
"className" : "string" ,
"value" : 0
}
],
"percentiles" : [
{
"percent" : 0 ,
"value" : 0
}
],
"predictionsWarningCount" : 0 ,
"rowCount" : 0
}
Properties
Name
Type
Required
Restrictions
Description
batch
DriftBatch
true
Info of the batch associated with the bucket.
classDistribution
[ClassDistribution ]¦null
false
Class distribution for all classes in the bucket, only for classification deployments.
meanPredictedValue
number¦null
false
Mean predicted value for all rows in the bucket, only for regression deployments.
meanProbabilities
[MeanProbability ]¦null
false
Mean predicted probabilities for all classes in the bucket, only for classification deployments
percentiles
[Percentile ]¦null
false
Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.
predictionsWarningCount
integer¦null
false
The number of predictions with warning in the bucket
rowCount
integer¦null
true
Number of rows in the bucket.
PredictionsOverBatchResponse
{
"baselines" : [
{
"classDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanPredictedValue" : 0 ,
"meanProbabilities" : [
{
"className" : "string" ,
"value" : 0
}
],
"modelId" : "string" ,
"percentiles" : [
{
"percent" : 0 ,
"value" : 0
}
],
"predictionsWarningCount" : 0 ,
"rowCount" : 0
}
],
"buckets" : [
{
"batch" : {
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
},
"classDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanPredictedValue" : 0 ,
"meanProbabilities" : [
{
"className" : "string" ,
"value" : 0
}
],
"percentiles" : [
{
"percent" : 0 ,
"value" : 0
}
],
"predictionsWarningCount" : 0 ,
"rowCount" : 0
}
],
"segmentAttribute" : "string" ,
"segmentValue" : ""
}
Properties
Name
Type
Required
Restrictions
Description
baselines
[TargetBaseline ]
true
Target baselines
buckets
[PredictionsOverBatchBucket ]
true
Predictions over batch buckets
segmentAttribute
string¦null
false
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
The value of the segmentAttribute
to segment on.
PredictionsOverTimeBucket
{
"classDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanPredictedValue" : 0 ,
"meanProbabilities" : [
{
"className" : "string" ,
"value" : 0
}
],
"modelId" : "string" ,
"percentiles" : [
{
"percent" : 0 ,
"value" : 0
}
],
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"predictionsWarningCount" : 0 ,
"rowCount" : 0
}
Properties
Name
Type
Required
Restrictions
Description
classDistribution
[ClassDistribution ]¦null
false
Class distribution for all classes in the bucket, only for classification deployments.
meanPredictedValue
number¦null
false
Mean predicted value for all rows in the bucket, only for regression deployments.
meanProbabilities
[MeanProbability ]¦null
false
Mean predicted probabilities for all classes in the bucket, only for classification deployments
modelId
string
true
ID of the model
percentiles
[Percentile ]¦null
false
Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.
period
TimeRange
true
Info of the time period associated with the bucket.
predictionsWarningCount
integer¦null
false
The number of predictions with warning in the bucket
rowCount
integer¦null
true
Number of rows in the bucket.
PredictionsOverTimeResponse
{
"baselines" : [
{
"classDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanPredictedValue" : 0 ,
"meanProbabilities" : [
{
"className" : "string" ,
"value" : 0
}
],
"modelId" : "string" ,
"percentiles" : [
{
"percent" : 0 ,
"value" : 0
}
],
"predictionsWarningCount" : 0 ,
"rowCount" : 0
}
],
"buckets" : [
{
"classDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanPredictedValue" : 0 ,
"meanProbabilities" : [
{
"className" : "string" ,
"value" : 0
}
],
"modelId" : "string" ,
"percentiles" : [
{
"percent" : 0 ,
"value" : 0
}
],
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"predictionsWarningCount" : 0 ,
"rowCount" : 0
}
],
"segmentAttribute" : "string" ,
"segmentValue" : ""
}
Properties
Name
Type
Required
Restrictions
Description
baselines
[TargetBaseline ]
true
Target baselines
buckets
[PredictionsOverTimeBucket ]
true
Predictions over time buckets
segmentAttribute
string¦null
false
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
The value of the segmentAttribute
to segment on.
PredictionsVsActualsBaseline
{
"actualClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanActualValue" : 0 ,
"meanPredictedValue" : 0 ,
"modelId" : "string" ,
"predictedClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"rowCountTotal" : 0 ,
"rowCountWithActual" : 0
}
Properties
Name
Type
Required
Restrictions
Description
actualClassDistribution
[ActualClassDistribution ]¦null
false
Class distribution for all actuals in the bucket, only for classification deployments.
meanActualValue
number¦null
false
Mean actual value for all rows in the bucket, only for regression deployments.
meanPredictedValue
number¦null
false
Mean predicted value for all rows in the bucket, only for regression deployments.
modelId
string
true
ID of the model.
predictedClassDistribution
[PredictedClassDistribution ]¦null
false
Class distribution for all rows with actual in the bucket, only for classification deployments.
rowCountTotal
integer
true
Number of rows in the bucket.
rowCountWithActual
integer
true
Number of rows with actual in the bucket.
PredictionsVsActualsBatchBucket
{
"actualClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"batchId" : "string" ,
"batchName" : "string" ,
"meanActualValue" : 0 ,
"meanPredictedValue" : 0 ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"predictedClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"rowCountTotal" : 0 ,
"rowCountWithActual" : 0
}
Properties
Name
Type
Required
Restrictions
Description
actualClassDistribution
[ActualClassDistribution ]¦null
false
Class distribution for all actuals in the bucket, only for classification deployments.
batchId
string
true
ID of the batch.
batchName
string
true
Name of the batch.
meanActualValue
number¦null
false
Mean actual value for all rows in the bucket, only for regression deployments.
meanPredictedValue
number¦null
false
Mean predicted value for all rows in the bucket, only for regression deployments.
modelId
string
true
ID of the model.
period
BatchPeriod
true
Time period of the batch.
predictedClassDistribution
[PredictedClassDistribution ]¦null
false
Class distribution for all rows with actual in the bucket, only for classification deployments.
rowCountTotal
integer
true
Number of rows in the bucket.
rowCountWithActual
integer
true
Number of rows with actual in the bucket.
PredictionsVsActualsOverBatchResponse
{
"baselines" : [
{
"actualClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanActualValue" : 0 ,
"meanPredictedValue" : 0 ,
"modelId" : "string" ,
"predictedClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"rowCountTotal" : 0 ,
"rowCountWithActual" : 0
}
],
"buckets" : [
{
"actualClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"batchId" : "string" ,
"batchName" : "string" ,
"meanActualValue" : 0 ,
"meanPredictedValue" : 0 ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"predictedClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"rowCountTotal" : 0 ,
"rowCountWithActual" : 0
}
],
"segmentAttribute" : "string" ,
"segmentValue" : ""
}
Properties
Name
Type
Required
Restrictions
Description
baselines
[PredictionsVsActualsBaseline ]
true
Predictions vs actuals baselines.
buckets
[PredictionsVsActualsBatchBucket ]
true
Predictions vs actuals buckets.
segmentAttribute
string¦null
false
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
The value of the segmentAttribute
to segment on.
PredictionsVsActualsOverTimeResponse
{
"baselines" : [
{
"actualClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanActualValue" : 0 ,
"meanPredictedValue" : 0 ,
"modelId" : "string" ,
"predictedClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"rowCountTotal" : 0 ,
"rowCountWithActual" : 0
}
],
"buckets" : [
{
"actualClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanActualValue" : 0 ,
"meanPredictedValue" : 0 ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"predictedClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"rowCountTotal" : 0 ,
"rowCountWithActual" : 0
}
],
"segmentAttribute" : "string" ,
"segmentValue" : "" ,
"summary" : {
"rowCountTotal" : 0 ,
"rowCountWithActual" : 0
}
}
Properties
Name
Type
Required
Restrictions
Description
baselines
[PredictionsVsActualsBaseline ]
true
Predictions vs actuals baselines.
buckets
[PredictionsVsActualsTimeBucket ]
true
Predictions vs actuals buckets.
segmentAttribute
string¦null
false
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
The value of the segmentAttribute
to segment on.
summary
PredictionsVsActualsSummaryBucket
true
Predictions vs actuals summary.
PredictionsVsActualsSummaryBucket
{
"rowCountTotal" : 0 ,
"rowCountWithActual" : 0
}
Properties
Name
Type
Required
Restrictions
Description
rowCountTotal
integer
true
Number of rows for all buckets.
rowCountWithActual
integer
true
Number of rows with actual for all buckets.
PredictionsVsActualsTimeBucket
{
"actualClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanActualValue" : 0 ,
"meanPredictedValue" : 0 ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"predictedClassDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"rowCountTotal" : 0 ,
"rowCountWithActual" : 0
}
Properties
Name
Type
Required
Restrictions
Description
actualClassDistribution
[ActualClassDistribution ]¦null
false
Class distribution for all actuals in the bucket, only for classification deployments.
meanActualValue
number¦null
false
Mean actual value for all rows in the bucket, only for regression deployments.
meanPredictedValue
number¦null
false
Mean predicted value for all rows in the bucket, only for regression deployments.
modelId
string
true
ID of the model.
period
BatchPeriod
true
Time period of the bucket.
predictedClassDistribution
[PredictedClassDistribution ]¦null
false
Class distribution for all rows with actual in the bucket, only for classification deployments.
rowCountTotal
integer
true
Number of rows in the bucket.
rowCountWithActual
integer
true
Number of rows with actual in the bucket.
ProjectOptions
{
"cvMethod" : "RandomCV" ,
"holdoutPct" : null ,
"metric" : "Accuracy" ,
"reps" : null ,
"validationPct" : null ,
"validationType" : "CV"
}
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
]
validationType
[CV
, TVH
]
RetrainingPolicyCreate
{
"action" : "create_challenger" ,
"autopilotOptions" : {
"blendBestModels" : true ,
"mode" : "auto" ,
"runLeakageRemovedFeatureList" : true ,
"scoringCodeOnly" : true ,
"shapOnlyMode" : true
},
"description" : null ,
"featureListStrategy" : "informative_features" ,
"modelSelectionStrategy" : "autopilot_recommended" ,
"name" : "string" ,
"projectOptions" : {
"cvMethod" : "RandomCV" ,
"holdoutPct" : null ,
"metric" : "Accuracy" ,
"reps" : null ,
"validationPct" : null ,
"validationType" : "CV"
},
"projectOptionsStrategy" : "same_as_champion" ,
"timeSeriesOptions" : {
"calendarId" : "string" ,
"differencingMethod" : "auto" ,
"exponentiallyWeightedMovingAlpha" : 0 ,
"periodicities" : [
{
"timeSteps" : 0 ,
"timeUnit" : "MILLISECOND"
}
],
"treatAsExponential" : "auto"
},
"trigger" : {
"minIntervalBetweenRuns" : "string" ,
"schedule" : {
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
},
"statusDeclinesToFailing" : true ,
"statusDeclinesToWarning" : true ,
"statusStillInDecline" : true ,
"type" : "schedule"
}
}
Properties
Name
Type
Required
Restrictions
Description
action
string
false
Configure the action to take on the resultant new model.
autopilotOptions
AutopilotOptions
false
Will override the corresponding fields when reusing champion's project options.
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.
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
]
projectOptionsStrategy
[same_as_champion
, override_champion
, custom
]
RetrainingPolicyListResponse
{
"count" : 0 ,
"data" : [
{
"action" : "create_challenger" ,
"autopilotOptions" : {
"blendBestModels" : true ,
"mode" : "auto" ,
"runLeakageRemovedFeatureList" : true ,
"scoringCodeOnly" : true ,
"shapOnlyMode" : true
},
"description" : "string" ,
"featureListStrategy" : "informative_features" ,
"id" : "string" ,
"latestRun" : {
"challengerId" : "string" ,
"errorMessage" : "string" ,
"finishTime" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"modelPackageId" : "string" ,
"projectId" : "string" ,
"registeredModelId" : "string" ,
"startTime" : "2019-08-24T14:15:22Z" ,
"status" : "string"
},
"modelSelectionStrategy" : "autopilot_recommended" ,
"name" : "string" ,
"projectOptions" : {
"cvMethod" : "RandomCV" ,
"holdoutPct" : null ,
"metric" : "Accuracy" ,
"reps" : null ,
"validationPct" : null ,
"validationType" : "CV"
},
"projectOptionsStrategy" : "same_as_champion" ,
"timeSeriesOptions" : {
"calendarId" : "string" ,
"differencingMethod" : "auto" ,
"exponentiallyWeightedMovingAlpha" : 0 ,
"periodicities" : [
{
"timeSteps" : 0 ,
"timeUnit" : "MILLISECOND"
}
],
"treatAsExponential" : "auto"
},
"trigger" : {
"minIntervalBetweenRuns" : "string" ,
"schedule" : {
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
},
"statusDeclinesToFailing" : true ,
"statusDeclinesToWarning" : true ,
"statusStillInDecline" : true ,
"type" : "schedule"
}
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
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(uri)¦null
true
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
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
{
"action" : "create_challenger" ,
"autopilotOptions" : {
"blendBestModels" : true ,
"mode" : "auto" ,
"runLeakageRemovedFeatureList" : true ,
"scoringCodeOnly" : true ,
"shapOnlyMode" : true
},
"description" : "string" ,
"featureListStrategy" : "informative_features" ,
"id" : "string" ,
"latestRun" : {
"challengerId" : "string" ,
"errorMessage" : "string" ,
"finishTime" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"modelPackageId" : "string" ,
"projectId" : "string" ,
"registeredModelId" : "string" ,
"startTime" : "2019-08-24T14:15:22Z" ,
"status" : "string"
},
"modelSelectionStrategy" : "autopilot_recommended" ,
"name" : "string" ,
"projectOptions" : {
"cvMethod" : "RandomCV" ,
"holdoutPct" : null ,
"metric" : "Accuracy" ,
"reps" : null ,
"validationPct" : null ,
"validationType" : "CV"
},
"projectOptionsStrategy" : "same_as_champion" ,
"timeSeriesOptions" : {
"calendarId" : "string" ,
"differencingMethod" : "auto" ,
"exponentiallyWeightedMovingAlpha" : 0 ,
"periodicities" : [
{
"timeSteps" : 0 ,
"timeUnit" : "MILLISECOND"
}
],
"treatAsExponential" : "auto"
},
"trigger" : {
"minIntervalBetweenRuns" : "string" ,
"schedule" : {
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
},
"statusDeclinesToFailing" : true ,
"statusDeclinesToWarning" : true ,
"statusStillInDecline" : true ,
"type" : "schedule"
}
}
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.
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.
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
]
projectOptionsStrategy
[same_as_champion
, override_champion
, custom
]
RetrainingPolicyRunListResponse
{
"count" : 0 ,
"data" : [
{
"challengerId" : "string" ,
"errorMessage" : "string" ,
"finishTime" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"modelPackageId" : "string" ,
"projectId" : "string" ,
"registeredModelId" : "string" ,
"startTime" : "2019-08-24T14:15:22Z" ,
"status" : "string"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com" ,
"totalCount" : 0
}
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(uri)¦null
true
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
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
{
"challengerId" : "string" ,
"errorMessage" : "string" ,
"finishTime" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"modelPackageId" : "string" ,
"projectId" : "string" ,
"registeredModelId" : "string" ,
"startTime" : "2019-08-24T14:15:22Z" ,
"status" : "string"
}
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(date-time)¦null
true
Finish time of the retraining policy run.
id
string
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(date-time)¦null
true
Start time of the retraining policy run.
status
string¦null
true
Status of the retraining policy run.
RetrainingPolicyRunUpdate
{
"status" : "cancelled"
}
Properties
Name
Type
Required
Restrictions
Description
status
string
true
New status of the retraining policy.
Enumerated Values
Property
Value
status
cancelled
RetrainingPolicyUpdate
{
"action" : "create_challenger" ,
"autopilotOptions" : {
"blendBestModels" : true ,
"mode" : "auto" ,
"runLeakageRemovedFeatureList" : true ,
"scoringCodeOnly" : true ,
"shapOnlyMode" : true
},
"description" : "string" ,
"featureListStrategy" : "informative_features" ,
"modelSelectionStrategy" : "autopilot_recommended" ,
"name" : "string" ,
"projectOptions" : {
"cvMethod" : "RandomCV" ,
"holdoutPct" : null ,
"metric" : "Accuracy" ,
"reps" : null ,
"validationPct" : null ,
"validationType" : "CV"
},
"projectOptionsStrategy" : "same_as_champion" ,
"timeSeriesOptions" : {
"calendarId" : "string" ,
"differencingMethod" : "auto" ,
"exponentiallyWeightedMovingAlpha" : 0 ,
"periodicities" : [
{
"timeSteps" : 0 ,
"timeUnit" : "MILLISECOND"
}
],
"treatAsExponential" : "auto"
},
"trigger" : {
"minIntervalBetweenRuns" : "string" ,
"schedule" : {
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
},
"statusDeclinesToFailing" : true ,
"statusDeclinesToWarning" : true ,
"statusStillInDecline" : true ,
"type" : "schedule"
}
}
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.
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.
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
]
projectOptionsStrategy
[same_as_champion
, override_champion
, custom
]
RetrainingSettingsRetrieve
{
"dataset" : {
"id" : "string" ,
"name" : "string"
},
"predictionEnvironment" : {
"id" : "string" ,
"name" : "string"
},
"retrainingUser" : {
"id" : "string" ,
"username" : "string"
}
}
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
{
"credentialId" : "string" ,
"datasetId" : "string" ,
"predictionEnvironmentId" : "string" ,
"retrainingUserId" : "string"
}
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.
RetrainingUser
{
"id" : "string" ,
"username" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
id
string
true
ID of the scheduled retraining user.
username
string
true
Username of the scheduled retraining user.
SampleCountField
{
"columnName" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
columnName
string¦null
true
Column name
Schedule
{
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
}
Properties
Name
Type
Required
Restrictions
Description
dayOfMonth
[anyOf]
true
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.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
or
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
continued
Name
Type
Required
Restrictions
Description
dayOfWeek
[anyOf]
true
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.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
or
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
continued
Name
Type
Required
Restrictions
Description
hour
[anyOf]
true
The hour(s) of the day that the job will run. Allowed values are either ["*"]
meaning every hour of the day or [0 ... 23]
.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
or
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
continued
Name
Type
Required
Restrictions
Description
minute
[anyOf]
true
The minute(s) of the day that the job will run. Allowed values are either ["*"]
meaning every minute of the day or[0 ... 59]
.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
or
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
continued
Name
Type
Required
Restrictions
Description
month
[anyOf]
true
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"]}
.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
or
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
ScheduledReportOnDemmand
Properties
Name
Type
Required
Restrictions
Description
id
string
true
ID of Scheduled report record.
SecondaryDatasetConfigResponse
{
"created" : "2019-08-24T14:15:22Z" ,
"creatorFullName" : "string" ,
"creatorUserId" : "string" ,
"credentialIds" : [
{
"catalogVersionId" : "string" ,
"credentialId" : "string" ,
"url" : "string"
}
],
"featurelistId" : "string" ,
"isDefault" : true ,
"isDeleted" : true ,
"name" : "string" ,
"projectId" : "string" ,
"secondaryDatasetConfigId" : "string" ,
"secondaryDatasets" : [
{
"catalogId" : "string" ,
"catalogVersionId" : "string" ,
"identifier" : "string" ,
"snapshotPolicy" : "specified"
}
]
}
Properties
Name
Type
Required
Restrictions
Description
created
string(date-time)¦null
true
DR-formatted datetime, null for legacy (before DR 6.0) db records
creatorFullName
string¦null
true
Fullname or email of the user created this config. null for legacy (before DR 6.0) db records
creatorUserId
string¦null
true
ID of the user created this config, null for legacy (before DR 6.0) db records
credentialIds
[DatasetsCredential ]¦null
false
List of credentials used by the secondary datasets if the datasets used in the configuration are from datasource
featurelistId
string¦null
true
Id of the feature list
isDefault
boolean
true
Secondary datasets config is default config or not
isDeleted
boolean
true
Secondary datasets config is soft deleted or not
name
string¦null
true
Name of the secondary datasets config
projectId
string¦null
true
ID of the project
secondaryDatasetConfigId
string
true
ID of the secondary datasets configuration
secondaryDatasets
[DeploymentSecondaryDataset ]
false
List of secondary datasets used in the config
SecondaryDatasetConfigUpdate
{
"credentialsIds" : [
{
"catalogVersionId" : "string" ,
"credentialId" : "string" ,
"url" : "string"
}
],
"secondaryDatasetConfigId" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
credentialsIds
[DatasetsCredential ]
false
List of credentials used by the secondary datasets
secondaryDatasetConfigId
string
true
ID of the secondary datasets configuration to be used at the time of prediction
SecondaryDatasetsConfig
{
"configId" : "string" ,
"configName" : "string" ,
"updated" : "string" ,
"username" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
configId
string
true
ID of the secondary datasets configuration
configName
string
true
Name of the secondary datasets config
updated
string
true
Timestamp when configuration was updated on the given deployment
username
string
true
Name of the user who made the update
SecondaryDatasetsConfigListResponse
{
"count" : 0 ,
"data" : [
{
"configId" : "string" ,
"configName" : "string" ,
"updated" : "string" ,
"username" : "string"
}
],
"next" : "http://example.com" ,
"previous" : "http://example.com"
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
true
Number of items
data
[SecondaryDatasetsConfig ]
true
Secondary datasets configuration history.
next
string(uri)¦null
true
URL pointing to the next page (if null, there is no next page)
previous
string(uri)¦null
true
URL pointing to the previous page (if null, there is no previous page)
SegmentAnalysis
{
"attributes" : [
"string"
],
"enabled" : true
}
Properties
Name
Type
Required
Restrictions
Description
attributes
[string]
false
The list of segment attributes selected for tracking.
enabled
boolean
true
Indicates whether service health, drift, and accuracy are tracked for segments of prediction data.
SegmentAnalysisUpdate
{
"attributes" : [
"string"
],
"enabled" : true
}
Properties
Name
Type
Required
Restrictions
Description
attributes
[string]
false
The segment attributes to be tracked. Note that only categorical columns can be specified as tracked segment attributes. The target column may not be specified
enabled
boolean
true
Indicates whether service health, drift, and accuracy are tracked for segments of prediction data.
ServiceHealth
Properties
Name
Type
Required
Restrictions
Description
batchCount
string
true
Number of recent batches used to compute service health status, only applicable to deployments with batch monitoring enabled.
Enumerated Values
Property
Value
batchCount
[1
, 5
, 10
, 50
, 100
, 1000
, 10000
]
ServiceStatsForBatchRetrieveResponse
{
"batches" : [
{
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
}
],
"metrics" : {
"cacheHitRatio" : 0 ,
"executionTime" : 0 ,
"numConsumers" : 0 ,
"responseTime" : 0 ,
"serverErrorRate" : 0 ,
"slowRequests" : 0 ,
"totalPredictions" : 0 ,
"totalRequests" : 0 ,
"userErrorRate" : 0
},
"segmentAttribute" : "string" ,
"segmentValue" : ""
}
Properties
Name
Type
Required
Restrictions
Description
batches
[Batch ]
true
Info of the batches the metric is aggregated on.
metrics
ServiceStatsMetricsForBatch
true
Service health metrics of the deployment
segmentAttribute
string¦null
false
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
The value of the segmentAttribute
to segment on.
ServiceStatsForTimeRangeResponse
{
"metrics" : {
"cacheHitRatio" : 0 ,
"executionTime" : 0 ,
"medianLoad" : 0 ,
"numConsumers" : 0 ,
"peakLoad" : 0 ,
"responseTime" : 0 ,
"serverErrorRate" : 0 ,
"slowRequests" : 0 ,
"totalPredictions" : 0 ,
"totalRequests" : 0 ,
"userErrorRate" : 0
},
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"segmentAttribute" : "string" ,
"segmentValue" : ""
}
Properties
Name
Type
Required
Restrictions
Description
metrics
ServiceStatsMetricsForTimeRange
true
Service health metrics of the deployment
modelId
string
false
The id of the model for which metrics are being retrieved.
period
TimeRange
true
An object with the keys "start" and "end" defining the period.
segmentAttribute
string¦null
false
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
The value of the segmentAttribute
to segment on.
ServiceStatsMetricsForBatch
{
"cacheHitRatio" : 0 ,
"executionTime" : 0 ,
"numConsumers" : 0 ,
"responseTime" : 0 ,
"serverErrorRate" : 0 ,
"slowRequests" : 0 ,
"totalPredictions" : 0 ,
"totalRequests" : 0 ,
"userErrorRate" : 0
}
Properties
Name
Type
Required
Restrictions
Description
cacheHitRatio
number¦null
true
Number of cache hits.
executionTime
number¦null
true
Request execution time at executionTimeQuantile (in milliseconds).
numConsumers
integer¦null
true
Number of unique users performing requests.
responseTime
number¦null
true
Request response time at responseTimeQuantile (in milliseconds).
serverErrorRate
number¦null
true
Ratio of server errors to the total number of requests.
slowRequests
integer¦null
true
Number of requests with response time greater than slowRequestsThreshold
totalPredictions
integer¦null
true
Total number of prediction rows.
totalRequests
integer¦null
true
Total number of prediction requests performed.
userErrorRate
number¦null
true
Ratio of user errors to the total number of requests.
ServiceStatsMetricsForTimeRange
{
"cacheHitRatio" : 0 ,
"executionTime" : 0 ,
"medianLoad" : 0 ,
"numConsumers" : 0 ,
"peakLoad" : 0 ,
"responseTime" : 0 ,
"serverErrorRate" : 0 ,
"slowRequests" : 0 ,
"totalPredictions" : 0 ,
"totalRequests" : 0 ,
"userErrorRate" : 0
}
Properties
Name
Type
Required
Restrictions
Description
cacheHitRatio
number¦null
true
Number of cache hits.
executionTime
number¦null
true
Request execution time at executionTimeQuantile (in milliseconds).
medianLoad
number¦null
true
Median of the request rate (in requests per minute).
numConsumers
integer¦null
true
Number of unique users performing requests.
peakLoad
number¦null
true
Maximum of the request rate (in requests per minute).
responseTime
number¦null
true
Request response time at responseTimeQuantile (in milliseconds).
serverErrorRate
number¦null
true
Ratio of server errors to the total number of requests.
slowRequests
integer¦null
true
Number of requests with response time greater than slowRequestsThreshold
totalPredictions
integer¦null
true
Total number of prediction rows.
totalRequests
integer¦null
true
Total number of prediction requests performed.
userErrorRate
number¦null
true
Ratio of user errors to the total number of requests.
ServiceStatsOverBatchBucket
{
"batch" : {
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
},
"value" : 0
}
Properties
Name
Type
Required
Restrictions
Description
batch
Batch
true
Info of the batch the bucket is associated with.
value
number¦null
true
Value of the metric in the bucket.
ServiceStatsOverBatchResponse
{
"buckets" : [
{
"batch" : {
"earliestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"latestPredictionTimestamp" : "2019-08-24T14:15:22Z" ,
"name" : "string"
},
"value" : 0
}
],
"metric" : "string" ,
"segmentAttribute" : "string" ,
"segmentValue" : ""
}
Properties
Name
Type
Required
Restrictions
Description
buckets
[ServiceStatsOverBatchBucket ]
true
An array of buckets, representing service health stats of the deployment over selected batches.
metric
string
true
Name of the metric requested.
segmentAttribute
string¦null
false
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
The value of the segmentAttribute
to segment on.
ServiceStatsOverTimeBucket
{
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"value" : 0
}
Properties
Name
Type
Required
Restrictions
Description
period
TimeRange
true
An object with the keys "start" and "end" defining the period.
value
number¦null
true
Value of the metric in the bucket. Null if no value
ServiceStatsOverTimeResponse
{
"buckets" : [
{
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"value" : 0
}
],
"metric" : "string" ,
"modelId" : "string" ,
"segmentAttribute" : "string" ,
"segmentValue" : "" ,
"summary" : {
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"value" : 0
}
}
Properties
Name
Type
Required
Restrictions
Description
buckets
[ServiceStatsOverTimeBucket ]
true
An array of bucket, representing service health stats of the deployment over time.
metric
string
true
Name of the metric requested.
modelId
string
false
The id of the model for which metrics are being retrieved.
segmentAttribute
string¦null
false
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
The value of the segmentAttribute
to segment on.
summary
ServiceStatsOverTimeBucket
true
A bucket object covering whole start/end time range
SharedRolesUpdateWithGrant
{
"operation" : "updateRoles" ,
"roles" : [
{
"canShare" : true ,
"role" : "string" ,
"shareRecipientType" : "user" ,
"username" : "string"
}
]
}
Properties
Name
Type
Required
Restrictions
Description
operation
string
true
Name of the action being taken. The only operation is 'updateRoles'.
roles
[oneOf]
true
maxItems: 100 minItems: 1
An array of RoleRequest objects. May contain at most 100 such objects.
oneOf
xor
Enumerated Values
Property
Value
operation
updateRoles
SharingListV2Response
{
"count" : 0 ,
"data" : [
{
"id" : "string" ,
"name" : "string" ,
"role" : "ADMIN" ,
"shareRecipientType" : "user"
}
],
"next" : "string" ,
"previous" : "string" ,
"totalCount" : 0
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
true
The number of items returned.
data
[AccessControlV2 ]
true
The access control list.
next
string¦null
true
URL pointing to the next page.
previous
string¦null
true
URL pointing to the previous page.
totalCount
integer
true
Total number of items matching the condition.
TargetBaseline
{
"classDistribution" : [
{
"className" : "string" ,
"count" : 0 ,
"percent" : 0
}
],
"meanPredictedValue" : 0 ,
"meanProbabilities" : [
{
"className" : "string" ,
"value" : 0
}
],
"modelId" : "string" ,
"percentiles" : [
{
"percent" : 0 ,
"value" : 0
}
],
"predictionsWarningCount" : 0 ,
"rowCount" : 0
}
Properties
Name
Type
Required
Restrictions
Description
classDistribution
[ClassDistribution ]¦null
false
Class distribution for all classes in the bucket, only for classification deployments.
meanPredictedValue
number¦null
false
Mean predicted value for all rows in the bucket, only for regression deployments.
meanProbabilities
[MeanProbability ]¦null
false
Mean predicted probabilities for all classes in the bucket, only for classification deployments
modelId
string
true
ID of the model
percentiles
[Percentile ]¦null
false
Predicted value or positive class predicted probability at specific percentiles in the bucket, only for regression and binary classification deployments.
predictionsWarningCount
integer¦null
false
The number of predictions with warning in the bucket
rowCount
integer¦null
true
Number of rows in the bucket.
TargetDriftResponse
{
"baselineSampleSize" : 0 ,
"batchId" : [],
"driftScore" : 0 ,
"metric" : "psi" ,
"modelId" : "string" ,
"period" : {
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
},
"sampleSize" : 0 ,
"segmentAttribute" : "string" ,
"segmentValue" : "" ,
"targetName" : "string" ,
"type" : "numeric"
}
Properties
Name
Type
Required
Restrictions
Description
baselineSampleSize
integer
true
sample size of the training data.
batchId
any
false
The id of the batch for which metrics are being retrieved.
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
[string]
false
maxItems: 25
none
continued
Name
Type
Required
Restrictions
Description
driftScore
number¦null
true
drift score for the target.
metric
string
false
Metric used to calculate drift score.
modelId
string
true
id of the model for which data drift is being retrieved.
period
TimeRange
false
An object with the keys "start" and "end" defining the period.to retrieve features drift.
sampleSize
integer
true
number of predictions used to compute the drift score.
segmentAttribute
string¦null
false
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
The value of the segmentAttribute
to segment on.
targetName
string
true
name of the target feature.
type
string
true
Type of the feature.
Enumerated Values
Property
Value
metric
[psi
, kl_divergence
, dissimilarity
, hellinger
, js_divergence
]
type
[numeric
, categorical
, text
]
TargetDriftSetting
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
Indicates whether target drift tracking is enabled for this deployment.
TargetDriftUpdate
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
True if target drift tracking is enabled for this deployment, false if otherwise.
TimeRange
{
"end" : "2019-08-24T14:15:22Z" ,
"start" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
end
string(date-time)¦null
false
End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
start
string(date-time)¦null
false
Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z
.
TimeSeriesOptions
{
"calendarId" : "string" ,
"differencingMethod" : "auto" ,
"exponentiallyWeightedMovingAlpha" : 0 ,
"periodicities" : [
{
"timeSteps" : 0 ,
"timeUnit" : "MILLISECOND"
}
],
"treatAsExponential" : "auto"
}
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 minimum: 0 (exclusive)
Discount factor (alpha) used for exponentially weighted moving features
periodicities
[Periodicity ]¦null
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
]
TimelinessSettings
{
"enabled" : true ,
"expectedFrequency" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
false
Indicates if timeliness status is enabled.
expectedFrequency
string
false
Expected frequency for receiving data as an ISO 8601 duration string.
TrainingDataEntry
{
"id" : "string" ,
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
id
string
true
The ID of the AI Catalog entry.
name
string
true
The name of the AI Catalog entry.
TrainingDataExportCreatePayload
Properties
Name
Type
Required
Restrictions
Description
modelId
string¦null
false
(Optional) The ID of the model.
TrainingDataExportEntity
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : "string" ,
"data" : {
"id" : "string" ,
"name" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"modelPackageId" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
createdAt
string(date-time)
true
Training data export creation timestamp.
createdBy
string
true
The user who created training data export.
data
TrainingDataEntry
true
A training data entry.
id
string
true
The ID of the training data export.
modelId
string
true
The ID of the model.
modelPackageId
string
true
The ID of the related model package.
TrainingDataExportListResponse
{
"count" : 0 ,
"data" : [
{
"createdAt" : "2019-08-24T14:15:22Z" ,
"createdBy" : "string" ,
"data" : {
"id" : "string" ,
"name" : "string"
},
"id" : "string" ,
"modelId" : "string" ,
"modelPackageId" : "string"
}
],
"next" : "string" ,
"previous" : "string" ,
"totalCount" : 0
}
Properties
Name
Type
Required
Restrictions
Description
count
integer
true
minimum: 0
Number of paginated entries.
data
[TrainingDataExportEntity ]
true
A list of training data exports.
next
string¦null
true
URL to the next page, or null if there is no such page.
previous
string¦null
true
URL to the previous page, or null if there is no such page
totalCount
integer
true
minimum: 0
Total number of entries.
Trigger
{
"minIntervalBetweenRuns" : "string" ,
"schedule" : {
"dayOfMonth" : [
"*"
],
"dayOfWeek" : [
"*"
],
"hour" : [
"*"
],
"minute" : [
"*"
],
"month" : [
"*"
]
},
"statusDeclinesToFailing" : true ,
"statusDeclinesToWarning" : true ,
"statusStillInDecline" : true ,
"type" : "schedule"
}
Properties
Name
Type
Required
Restrictions
Description
minIntervalBetweenRuns
string¦null
false
Minimal interval between policy runs in ISO 8601 duration string.
schedule
Schedule
false
Crontab schedule of the retraining policy run.
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
, None
]
UseCaseDetails
{
"createdAt" : "string" ,
"creatorEmail" : "string" ,
"creatorId" : "string" ,
"creatorName" : "string" ,
"id" : "string" ,
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
createdAt
string
true
Time when use-case was created
creatorEmail
string¦null
false
Email of the user who created use-case
creatorId
string
true
ID of the creator of the use-case
creatorName
string¦null
false
Name of the user who created use-case
id
string
true
ID of the associated use-case
name
string¦null
false
Name of the use case at the moment of creation
{
"email" : "string" ,
"id" : "string" ,
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
email
string¦null
true
Email of the user
id
string
true
ID of the user
name
string¦null
true
Full name of the user
ValidationCheck
{
"message" : "string" ,
"status" : "failing"
}
Properties
Name
Type
Required
Restrictions
Description
message
string
true
Message of the validation check.
status
string
true
Status of the validation check.
Enumerated Values
Property
Value
status
[failing
, passing
, warning
]
ValidationChecks
{
"combinedModelSegments" : {
"message" : "string" ,
"status" : "failing"
},
"containsTrackedSegmentAttributes" : {
"message" : "string" ,
"status" : "failing"
},
"driftTracking" : {
"message" : "string" ,
"status" : "failing"
},
"featureDataTypes" : {
"message" : "string" ,
"status" : "failing"
},
"features" : {
"message" : "string" ,
"status" : "failing"
},
"humilityRules" : {
"message" : "string" ,
"status" : "failing"
},
"modelCanBeDeployed" : {
"message" : "string" ,
"status" : "failing"
},
"modelStatus" : {
"message" : "string" ,
"status" : "failing"
},
"notCurrentModel" : {
"message" : "string" ,
"status" : "failing"
},
"permission" : {
"message" : "string" ,
"status" : "failing"
},
"predictionIntervals" : {
"message" : "string" ,
"status" : "failing"
},
"predictionReady" : {
"message" : "string" ,
"status" : "failing"
},
"seriesType" : {
"message" : "string" ,
"status" : "failing"
},
"supported" : {
"message" : "string" ,
"status" : "failing"
},
"target" : {
"message" : "string" ,
"status" : "failing"
},
"targetClasses" : {
"message" : "string" ,
"status" : "failing"
},
"targetType" : {
"message" : "string" ,
"status" : "failing"
},
"timeSeriesCompatibility" : {
"message" : "string" ,
"status" : "failing"
},
"validChallenger" : {
"message" : "string" ,
"status" : "failing"
}
}
Properties
Name
Type
Required
Restrictions
Description
combinedModelSegments
ValidationCheck
false
Whether the replacement model has same segments as the current model in case any of them is segmented model.
containsTrackedSegmentAttributes
ValidationCheck
false
Whether the currently tracked segment attributes are contained within the replacement model's universe dataset.
driftTracking
ValidationCheck
false
Whether the replacement model has the necessary info to enable data drift.
featureDataTypes
ValidationCheck
false
Whether the common features of replacement model and current model have the same data types; a warning will be issued if a mismatch is found.
features
ValidationCheck
false
Whether the replacement model and the current model have the same set of features; a warning will be issued if the replacement model has additional features.
humilityRules
ValidationCheck
false
Whether the replacement model is compatible with existing humility rules set up on the deployment
modelCanBeDeployed
ValidationCheck
false
Whether the replacement model can be deployed.
modelStatus
ValidationCheck
false
Whether the replacement model has finished building.
notCurrentModel
ValidationCheck
false
Whether the replacement model is the same as the current model.
permission
ValidationCheck
false
Whether a user has permission to replace the model.
predictionIntervals
ValidationCheck
false
Whether the replacement model supports prediction intervals.
predictionReady
ValidationCheck
false
If deployment is an External deployment and the replacement model is a DataRobot or Custom Model, the deployment will not be able to make predictions. The replacement model package must first be replaced on the external prediction environment.
seriesType
ValidationCheck
false
Whether the replacement model has the same series type name as the current model. For example, multiseries models cannot replace non-multiseries models.
supported
ValidationCheck
false
Whether model replacement is supported by the deployment.
target
ValidationCheck
false
Whether the replacement model has the same target name as the current model.
targetClasses
ValidationCheck
false
Whether the replacement model has the same target class mapping as the current model.
targetType
ValidationCheck
false
Whether the replacement model has the same target type as the current model.For example, a binary classification model cannot replace a regression model.
timeSeriesCompatibility
ValidationCheck
false
Time series models cannot replace non-time-series models, and vice versa.
validChallenger
ValidationCheck
false
Whether the model being replaced can be added as a model challenger if the deployment has challengers enabled.
ValueField
{
"columnName" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
columnName
string¦null
true
Column name
Updated May 17, 2024
Submit
Thanks for your feedback!