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 http://10.97.68.125/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 http://10.97.68.125/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 http://10.97.68.125/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
orderBy
-label
orderBy
serviceHealth
orderBy
-serviceHealth
orderBy
modelHealth
orderBy
-modelHealth
orderBy
accuracyHealth
orderBy
-accuracyHealth
orderBy
recentPredictions
orderBy
-recentPredictions
orderBy
lastPredictionTimestamp
orderBy
-lastPredictionTimestamp
orderBy
currentModelDeployedTimestamp
orderBy
-currentModelDeployedTimestamp
orderBy
createdAtTimestamp
orderBy
-createdAtTimestamp
orderBy
importance
orderBy
-importance
orderBy
fairnessHealth
orderBy
-fairnessHealth
orderBy
customMetricsHealth
orderBy
-customMetricsHealth
serviceHealth
failing
serviceHealth
passing
serviceHealth
unavailable
serviceHealth
unknown
serviceHealth
warning
modelHealth
failing
modelHealth
passing
modelHealth
unavailable
modelHealth
unknown
modelHealth
warning
accuracyHealth
failing
accuracyHealth
passing
accuracyHealth
unavailable
accuracyHealth
unknown
accuracyHealth
warning
role
OWNER
role
USER
status
active
status
archived
status
errored
status
inactive
status
launching
status
replacingModel
status
stopping
importance
CRITICAL
importance
HIGH
importance
MODERATE
importance
LOW
buildEnvironmentType
DataRobot
buildEnvironmentType
Python
buildEnvironmentType
R
buildEnvironmentType
Java
buildEnvironmentType
Julia
buildEnvironmentType
Legacy
buildEnvironmentType
Other
executionEnvironmentType
datarobot
executionEnvironmentType
external
predictionEnvironmentPlatform
aws
predictionEnvironmentPlatform
gcp
predictionEnvironmentPlatform
azure
predictionEnvironmentPlatform
onPremise
predictionEnvironmentPlatform
datarobot
predictionEnvironmentPlatform
openShift
predictionEnvironmentPlatform
other
predictionEnvironmentPlatform
snowflake
hasDecisionFlow
false
hasDecisionFlow
False
hasDecisionFlow
true
hasDecisionFlow
True
createdByMe
false
createdByMe
False
createdByMe
true
createdByMe
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 }, "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" }, "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" : { "humbleAiEnabled" : true , "predictionIntervalsEnabled" : true , "predictionWarningEnabled" : true }, "status" : "active" , "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 http://10.97.68.125/api/v2/deployments/fromLearningModel/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Body parameter
{ "defaultPredictionServerId" : "string" , "description" : null , "importance" : "CRITICAL" , "label" : "string" , "modelId" : "string" , "predictionThreshold" : 1 , "status" : "active" } Parameters
Example responses
200 Response
Responses
Status
Meaning
Description
Schema
200
OK Deployment successfully created
DeploymentCreateResponse
202
Accepted Job submitted. The URL at the Location header can be used to track when the deployment is ready for predictions.
DeploymentCreateResponse
403
Forbidden User does not have permission to create a deployment.
None
409
Conflict User's organization has reached the maximum number of deployments.
None
422
Unprocessable Entity Unable to process the deployment creation request.
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
DELETE /api/v2/deployments/{deploymentId}/
Delete a deployment.
Code samples
# You can also use wget
curl -X DELETE http://10.97.68.125/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
ignoreManagementAgent
False
ignoreManagementAgent
true
ignoreManagementAgent
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 http://10.97.68.125/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 }, "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" }, "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" : { "humbleAiEnabled" : true , "predictionIntervalsEnabled" : true , "predictionWarningEnabled" : true }, "status" : "active" , "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 http://10.97.68.125/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 http://10.97.68.125/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
RFC3339 datetime. Start of time period to retrieve the features drift for. If not set, defaults to 1 week 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
RFC3339 datetime. End of time period to retrieve the features drift for. If not set, defaults to the next top of the hour from now.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.
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
deploymentId
path
string
true
Unique identifier of the deployment.
Example responses
200 Response
{ "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.
AccuracyRetrieveResponse
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}/accuracyOverTime/
Retrieve accuracy over time data for one single metric.
The following metrics can be retrieved.
For classification deployments:
- Accuracy
- AUC
- Balanced Accuracy
- FVE Binomial
- Gini Norm
- Kolmogorov-Smirnov
- LogLoss (default)
- Rate@Top5%
- Rate@Top10%
For regression deployments:
- Gamma Deviance (default)
- FVE Gamma
- FVE Poisson
- FVE Tweedie
- MAD
- MAE
- MAPE
- Poisson Deviance
- R Squared
- RMSE
- RMSLE
- Tweedie Deviance
Code samples
# You can also use wget
curl -X GET http://10.97.68.125/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 metric stats, defaults to 7 days ago from the end of the period.
end
query
string(date-time)
false
End of the period to retrieve metric stats, defaults to the next top of the hour.
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.
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
deploymentId
path
string
true
Unique identifier of the deployment.
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 " }, "buckets" : [ { "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
Status
Meaning
Description
Schema
200
OK Accuracy over time info retrieved.
AccuracyOverTimeResponse
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
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 http://10.97.68.125/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 http://10.97.68.125/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}/capabilities/
Retrieve the capabilities for the deployment.
Code samples
# You can also use wget
curl -X GET http://10.97.68.125/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 http://10.97.68.125/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}/challengers/
List challenger models for deployment.
Code samples
# You can also use wget
curl -X GET http://10.97.68.125/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" }, "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 http://10.97.68.125/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 http://10.97.68.125/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 http://10.97.68.125/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" }, "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 http://10.97.68.125/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" }, "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}/featureDrift/
Retrieve drift scores for features of the deployment.
Code samples
# You can also use wget
curl -X GET http://10.97.68.125/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
RFC3339 datetime. Start of time period to retrieve the features drift for. If not set, defaults to 1 week 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
RFC3339 datetime. End of time period to retrieve the features drift for. If not set, defaults to the next top of the hour from now.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.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
metric
psi
metric
kl_divergence
metric
dissimilarity
metric
hellinger
metric
js_divergence
Example responses
200 Response
{ "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.
DeploymentFeatureDriftResponse
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}/featureDriftOverTime/
Retrieve drift over time info for a feature of the deployment.
Code samples
# You can also use wget
curl -X GET http://10.97.68.125/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
RFC3339 datetime. Start of time period to retrieve the features drift for. If not set, defaults to 1 week 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
RFC3339 datetime. End of time period to retrieve the features drift for. If not set, defaults to the next top of the hour from now.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
metric
kl_divergence
metric
dissimilarity
metric
hellinger
metric
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 } ], "metric" : "string" , "summaries" : [ { "baselineSampleSize" : 0 , "driftScore" : 0 , "featureImpact" : 0 , "featureName" : "string" , "period" : { "end" : "2019-08-24T14:15:22Z" , "start" : "2019-08-24T14:15:22Z" }, "sampleSize" : 0 } ] } Responses
Status
Meaning
Description
Schema
200
OK Feature drift over time info of the deployment retrieved.
FeatureDriftOverTimeRetrieveResponse
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 http://10.97.68.125/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
includeNonPredictionFeatures
False
includeNonPredictionFeatures
true
includeNonPredictionFeatures
True
forSegmentedAnalysis
false
forSegmentedAnalysis
False
forSegmentedAnalysis
true
forSegmentedAnalysis
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}/humilityStats/
Retrieve humility rule service triggers statistics overview.
Code samples
# You can also use wget
curl -X GET http://10.97.68.125/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 service health stats, 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 service health stats, 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 to retrieve service health stats. If provided, only the service health stats for that specific model will be retrieved. If not provided, the service healthstats for the deployment`s current model will be 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
segmentAttribute
DataRobot-Remote-IP
segmentAttribute
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.
HumilityStatsRetrieveResponse
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 http://10.97.68.125/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 service health stats, 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 service health stats, 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 to retrieve service health stats. If provided, only the service health stats for that specific model will be retrieved. If not provided, the service healthstats for the deployment`s current model will be 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
segmentAttribute
DataRobot-Remote-IP
segmentAttribute
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.
HumilityStatsOverTimeRetrieveResponse
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 http://10.97.68.125/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 http://10.97.68.125/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 http://10.97.68.125/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 http://10.97.68.125/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 http://10.97.68.125/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
POST /api/v2/deployments/{deploymentId}/monitoringDataDeletions/
Delete deployment monitoring data.
Code samples
# You can also use wget
curl -X POST http://10.97.68.125/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 http://10.97.68.125/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
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 http://10.97.68.125/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 http://10.97.68.125/api/v2/deployments/{ deploymentId} /predictionResults/ \
-H 'Accept: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Parameters
Name
In
Type
Required
Description
start
query
string(date-time)
false
RFC3339 datetime. Start of time period to retrieve the features drift for. If not set, defaults to 1 week 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
RFC3339 datetime. End of time period to retrieve the features drift for. If not set, defaults to the next top of the hour from now.Note: this field only accepts top of the hour RFC3339 datetime strings For example: 2019-08-01T00:00:00Z.
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.
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
Accept
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
POST /api/v2/deployments/{deploymentId}/predictions/
The route can be used for low-latency (hence synchronous) predictions. Scoring dataset, however, must be up to 50 MB and is limited by comma-delimited CSV and record oriented JSON. All other formats are not supported.
Code samples
# You can also use wget
curl -X POST http://10.97.68.125/api/v2/deployments/{ deploymentId} /predictions/ \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Parameters
Name
In
Type
Required
Description
passthroughColumns
query
array[string]
false
List of columns from a scoring dataset to return in the prediction response. If not specified, no columns will be present in the response. Mutually exclusive with passthroughColumnsSet.
passthroughColumnsSet
query
string
false
If passthroughColumnsSet=all is passed, all columns from the scoring dataset are returned in the prediction response. All other values for this parameter are invalid. Mutually exclusive with passthroughColumns.
maxExplanations
query
any
false
The maximum number of prediction explanations to supply per row of the dataset. The default maxExplanations is 3 when xemp based explanations are requested. The default maxExplanations is all (no limit) when shap based explanations are requested.
maxCodes
query
any
false
Deprecated alias of maxExplanations.
thresholdHigh
query
number
false
The high threshold, above which a prediction must score in order for prediction explanations to be computed for a row in the dataset. If neither thresholdHigh nor thresholdLow is specified, prediction explanations will be computed for all rows. This option is ignored when shap based explanations are requested.
thresholdLow
query
number
false
The lower threshold, below which a prediction must score in order for prediction explanations to be computed for a row in the dataset. If neither thresholdHigh nor thresholdLow is specified, prediction explanations will be computed for all rows. This option is ignored when shap based explanations are requested.
excludeAdjustedPredictions
query
boolean
false
If false, include exposure-adjusted predictions in the response.
forecastPoint
query
string(date-time)
false
The time in the dataset relative to which predictions are generated. If not specified the default value is the value in the row with the latest specified timestamp.
predictionsStartDate
query
string(date-time)
false
The time in the dataset starting from which bulk predictions are generated. Should be defined together with predictionsEndDate. forecastPoint param can not be used if either predictionsStartDate or predictionsEndDate is passed.
predictionsEndDate
query
string(date-time)
false
The time in the dataset until which bulk predictions are generated. Should be defined together with predictionsStartDate. forecastPoint param can not be used if either predictionsStartDate or predictionsEndDate is passed.
relaxKnownInAdvanceFeaturesCheck
query
boolean
false
If true, missing values in the known in advance features are allowed in the forecast window at the prediction time. If omitted or false, missing values are not allowed.
predictionWarningEnabled
query
boolean
false
If true is passed, predictions response will include isOutlierPrediction key for each record with result of outlier check.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
passthroughColumnsSet
all
Example responses
200 Response
{ "data" : [ { "deploymentApprovalStatus" : "PENDING" , "forecastDistance" : 0 , "forecastPoint" : "2019-08-24T14:15:22Z" , "isOutlierPrediction" : true , "passthroughValues" : {}, "prediction" : "string" , "predictionExplanations" : [ { "feature" : "string" , "featureValue" : "string" , "label" : "string" , "qualitativeStrength" : "string" , "strength" : 0 } ], "predictionIntervals" : {}, "predictionThreshold" : 1 , "predictionValues" : [ { "label" : "string" , "value" : 0 } ], "rowId" : 0 , "seriesId" : "string" , "shapExplanationsMetadata" : [ { "baseValue" : 0 , "remainingTotal" : 0 , "warnings" : [ { "maxNormalizedMismatch" : 0 , "mismatchRowCount" : 0 } ] } ], "timestamp" : "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}/retrainingPolicies/
Retrieve a list of deployment retraining policies.
Code samples
# You can also use wget
curl -X GET http://10.97.68.125/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" , "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" : { "schedule" : { "dayOfMonth" : [ "*" ], "dayOfWeek" : [ "*" ], "hour" : [ "*" ], "minute" : [ "*" ], "month" : [ "*" ] }, "statusDeclinesToFailing" : true , "statusDeclinesToWarning" : 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 http://10.97.68.125/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" : { "schedule" : { "dayOfMonth" : [ "*" ], "dayOfWeek" : [ "*" ], "hour" : [ "*" ], "minute" : [ "*" ], "month" : [ "*" ] }, "statusDeclinesToFailing" : true , "statusDeclinesToWarning" : 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" , "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" : { "schedule" : { "dayOfMonth" : [ "*" ], "dayOfWeek" : [ "*" ], "hour" : [ "*" ], "minute" : [ "*" ], "month" : [ "*" ] }, "statusDeclinesToFailing" : true , "statusDeclinesToWarning" : 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 http://10.97.68.125/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 http://10.97.68.125/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" , "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" : { "schedule" : { "dayOfMonth" : [ "*" ], "dayOfWeek" : [ "*" ], "hour" : [ "*" ], "minute" : [ "*" ], "month" : [ "*" ] }, "statusDeclinesToFailing" : true , "statusDeclinesToWarning" : 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 http://10.97.68.125/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" : { "schedule" : { "dayOfMonth" : [ "*" ], "dayOfWeek" : [ "*" ], "hour" : [ "*" ], "minute" : [ "*" ], "month" : [ "*" ] }, "statusDeclinesToFailing" : true , "statusDeclinesToWarning" : 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" , "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" : { "schedule" : { "dayOfMonth" : [ "*" ], "dayOfWeek" : [ "*" ], "hour" : [ "*" ], "minute" : [ "*" ], "month" : [ "*" ] }, "statusDeclinesToFailing" : true , "statusDeclinesToWarning" : 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 http://10.97.68.125/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" , "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 http://10.97.68.125/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 http://10.97.68.125/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" , "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 http://10.97.68.125/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" , "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 http://10.97.68.125/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 http://10.97.68.125/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://app.datarobot.com/docs/predictions/scoring-code/scorecode.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 http://10.97.68.125/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
sourceCode
False
sourceCode
true
sourceCode
True
includeAgent
false
includeAgent
False
includeAgent
true
includeAgent
True
includePe
false
includePe
False
includePe
true
includePe
True
includePredictionExplanations
false
includePredictionExplanations
False
includePredictionExplanations
true
includePredictionExplanations
True
includePredictionIntervals
false
includePredictionIntervals
False
includePredictionIntervals
true
includePredictionIntervals
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 http://10.97.68.125/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 http://10.97.68.125/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
RFC3339 datetime. Start of time period to retrieve the features drift for. If not set, defaults to 1 week 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
RFC3339 datetime. End of time period to retrieve the features drift for. If not set, defaults to the next top of the hour from now.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
segmentAttribute
DataRobot-Remote-IP
segmentAttribute
DataRobot-Host-IP
monitoringType
serviceHealth
monitoringType
dataDrift
monitoringType
accuracy
monitoringType
humility
monitoringType
batchServiceHealth
monitoringType
batchDataDrift
monitoringType
batchAccuracy
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}/serviceStatsOverTime/
Retrieve values for one single deployment service health metric over time.
Code samples
# You can also use wget
curl -X GET http://10.97.68.125/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
RFC3339 datetime. Start of time period to retrieve the features drift for. If not set, defaults to 1 week 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
RFC3339 datetime. End of time period to retrieve the features drift for. If not set, defaults to the next top of the hour from now.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
metric
totalRequests
metric
slowRequests
metric
executionTime
metric
responseTime
metric
userErrorRate
metric
serverErrorRate
metric
numConsumers
metric
cacheHitRatio
metric
medianLoad
metric
peakLoad
segmentAttribute
DataRobot-Consumer
segmentAttribute
DataRobot-Remote-IP
segmentAttribute
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 http://10.97.68.125/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 }, "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 http://10.97.68.125/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 }, "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 http://10.97.68.125/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
shareRecipientType
group
shareRecipientType
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 http://10.97.68.125/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 http://10.97.68.125/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 http://10.97.68.125/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
RFC3339 datetime. Start of time period to retrieve the features drift for. If not set, defaults to 1 week 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
RFC3339 datetime. End of time period to retrieve the features drift for. If not set, defaults to the next top of the hour from now.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.
deploymentId
path
string
true
Unique identifier of the deployment.
Enumerated Values
Parameter
Value
metric
psi
metric
kl_divergence
metric
dissimilarity
metric
hellinger
metric
js_divergence
Example responses
200 Response
{ "baselineSampleSize" : 0 , "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" } Responses
Status
Meaning
Description
Schema
200
OK Target drift over specified time period retrieved.
DeploymentTargetDriftResponse
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/predictionServers/
List prediction servers available for a user.
Code samples
# You can also use wget
curl -X GET http://10.97.68.125/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
none
The identifier of the recipient.
name
string
true
none
The name of the recipient.
role
string
true
none
The role of the recipient on this entity.
shareRecipientType
string
true
none
The type of the recipient.
Enumerated Values
Property
Value
role
ADMIN
role
CONSUMER
role
DATA_SCIENTIST
role
EDITOR
role
OBSERVER
role
OWNER
role
READ_ONLY
role
READ_WRITE
role
USER
shareRecipientType
user
shareRecipientType
group
shareRecipientType
organization
AccuracyOverTimeBucket
{ "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
none
Start and end of the bucket's queried period, null if bucket is calculated on training data.
sampleSize
integer¦null
true
none
Number of predictions used to calculate the metric.
value
number¦null
true
none
Value of the metric, null if no value.
valuePerClass
object¦null
false
none
A dict keyed by class names with metric calculated for specific classes as values, if targetClasses is set.
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 " }, "buckets" : [ { "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
AccuracyOverTimeBucket true
none
A bucket object containing metric info calculated on training baseline.
buckets
[AccuracyOverTimeBucket ]
true
none
A list of bucket objects, each containing metric info calculated by sampling data in a slice of the whole queried period.
metric
string
true
none
The metric being retrieved.
modelId
string
false
none
The id of the model for which metrics are being retrieved.
segmentAttribute
string¦null
false
none
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
none
The value of the segmentAttribute to segment on.
summary
AccuracyOverTimeBucket true
none
A bucket object containing metric info calculated.
Enumerated Values
Property
Value
metric
AUC
metric
Accuracy
metric
Balanced Accuracy
metric
F1
metric
FPR
metric
FVE Binomial
metric
FVE Gamma
metric
FVE Multinomial
metric
FVE Poisson
metric
FVE Tweedie
metric
Gamma Deviance
metric
Gini Norm
metric
Kolmogorov-Smirnov
metric
LogLoss
metric
MAD
metric
MAE
metric
MAPE
metric
MCC
metric
NPV
metric
PPV
metric
Poisson Deviance
metric
R Squared
metric
RMSE
metric
RMSLE
metric
Rate@Top10%
metric
Rate@Top5%
metric
TNR
metric
TPR
metric
Tweedie Deviance
AccuracyRetrieveResponse
{ "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
metrics
object
true
none
Accuracy metrics of the deployment, keyed by metric names,metric object with detail on a single metric.
modelId
string
false
none
The id of the model for which metrics are being retrieved.
period
TimeRange true
none
An object with the keys "start" and "end" defining the period.
segmentAttribute
string¦null
false
none
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
none
The value of the segmentAttribute to segment on.
targetClasses
string¦null
false
none
Target classes provided in the request.
Actual
{ "actualValue" : 0 , "associationId" : "string" , "timestamp" : "2019-08-24T14:15:22Z" , "wasActedOn" : true } Properties
Name
Type
Required
Restrictions
Description
actualValue
any
true
none
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
none
or
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
continued
Name
Type
Required
Restrictions
Description
associationId
string
true
none
A unique identifier used with a predicted row.
timestamp
string(date-time)¦null
false
none
The datetime when actual values were obtained, formatted according to RFC3339.
wasActedOn
boolean¦null
false
none
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.
Properties
None
AssociationID
{ "columnNames" : [ "string" ], "requiredInPredictionRequests" : true } Properties
Name
Type
Required
Restrictions
Description
columnNames
[string]¦null
true
none
Indicates the columns that will be used to associate actuals with predictions.
requiredInPredictionRequests
boolean
true
none
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
none
List of column names used to represent an association id. Currently, exactly one column name may be provided.
requiredInPredictionRequests
boolean
false
none
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
none
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
none
Blend best models during Autopilot run. This option is not supported in SHAP-only mode.
mode
string
false
none
The autopilot mode.
runLeakageRemovedFeatureList
boolean
false
none
Run Autopilot on Leakage Removed feature list (if exists).
scoringCodeOnly
boolean
false
none
Keep only models that can be converted to scorable java code during Autopilot run.
shapOnlyMode
boolean
false
none
Include only models with SHAP value support.
Enumerated Values
Property
Value
mode
auto
mode
comprehensive
mode
quick
BatchPredictionStatus
{ "processing" : 0 , "queued" : 0 } Properties
Name
Type
Required
Restrictions
Description
processing
integer
true
none
Number of jobs processing
queued
integer
true
none
Number of jobs queued
ChallengerCreate
{ "modelPackageId" : "string" , "name" : "string" , "predictionEnvironmentId" : "string" } Properties
Name
Type
Required
Restrictions
Description
modelPackageId
string
true
none
ID of the model package to add as a challenger.
name
string
true
none
Human-readable name for the challenger.
predictionEnvironmentId
string
false
none
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" }, "name" : "string" , "predictionEnvironment" : { "id" : "string" , "name" : "string" } } ] } Properties
Name
Type
Required
Restrictions
Description
data
[ChallengerResponse ]
true
none
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" }, "name" : "string" , "predictionEnvironment" : { "id" : "string" , "name" : "string" } } Properties
Name
Type
Required
Restrictions
Description
id
string
true
none
ID of the challenger.
model
ModelResponse true
none
Model of the challenger.
modelPackage
ModelPackageResponse true
none
modelPackage of the challenger.
name
string
true
none
Name of the challenger.
predictionEnvironment
PredictionEnvironmentResponse false
none
Prediction environment used by the challenger
ChallengerScore
{ "timestamp" : "2019-08-24T14:15:22Z" } Properties
Name
Type
Required
Restrictions
Description
timestamp
string(date-time)
false
none
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
none
Human-readable name for the challenger.
predictionEnvironmentId
string
false
none
ID of the Prediction Environment the challenger should use.
Challengers
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
none
Indicates whether challenger models are enabled for the deployment.
CustomBoundaries
{ "lower" : 0 , "upper" : 0 } Properties
Name
Type
Required
Restrictions
Description
lower
number
true
none
All predictions less than provided value are considered anomalous.
upper
number
true
none
All predictions greater than provided value are considered anomalous.
Dataset
{ "id" : "string" , "name" : "string" } Properties
Name
Type
Required
Restrictions
Description
id
string
true
none
ID of the retraining dataset.
name
string
true
none
Name of the retraining dataset.
DatasetsCredential
{ "catalogVersionId" : "string" , "credentialId" : "string" , "url" : "string" } Properties
Name
Type
Required
Restrictions
Description
catalogVersionId
string
true
none
ID of the catalog version
credentialId
string
true
none
ID of the credential store to be used for the given catalog version
url
string¦null
false
none
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
none
Number of items returned on this page.
data
[DeletedDeploymentResponse ]
true
none
List of deleted deployments.
next
string(uri)¦null
true
none
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
true
none
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
none
The date and time of when the deployment was deleted, in ISO 8601 format.
id
string
true
none
ID of the deployment.
label
string
true
none
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
none
End date of accuracy health period.
message
string
true
none
A message providing more detail on the status.
startDate
string(date-time)¦null
true
none
Start date of accuracy health period.
status
string
true
none
Accuracy health status.
Enumerated Values
Property
Value
status
failing
status
passing
status
unavailable
status
unknown
status
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
none
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
none
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
none
With this feature enabled, DataRobot infers actual values from time series history data and automatically feeds them back for accuracy estimation.
supportsChallengerModels
boolean
true
none
If the deployment supports challenger models.
supportsFeatureDriftTracking
boolean
true
none
If the deployment supports feature drift tracking.
supportsFeatureTypeInfoValidation
boolean
false
none
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
none
If the deployment supports calculating values for humility recommended rules.
supportsHumilityRules
boolean
true
none
If the deployment supports humble ai.
supportsHumilityRulesDefaultCalculations
boolean
true
none
If the deployment supports calculating default values for humility rules.
supportsModelReplacement
boolean
true
none
If the deployment supports model replacement.
supportsPortablePredictionServer
boolean
false
none
If the deployment supports portable prediction servers. this enables to downloada dedicated model package to be deployed on external prediction environments
supportsPredictionIntervals
boolean
true
none
if the deployment supports prediction intervals.
supportsPredictionWarning
boolean
true
none
If the deployment supports prediction warnings.
supportsRetraining
boolean
false
none
Whether deployment supports retraining.
supportsScoringCodeDownload
boolean
false
none
If the currently deployed model supports scoring code download.
supportsSecondaryDatasets
boolean
true
none
If the deployments supports secondary datasets.
supportsSegmentedAnalysisDriftAndAccuracy
boolean
false
none
If the deployment supports tracking features in training and predictions data for segmented analysis of drift and accuracy.
supportsShapBasedPredictionExplanations
boolean
false
none
If the currently deployed model supports shap based prediction explanations.
supportsTargetDriftTracking
boolean
true
none
If the deployment supports target drift tracking.
DeploymentCapabilitiesRetrieveResponse
{ "data" : [ { "messages" : [ "string" ], "name" : "string" , "supported" : true } ] } Properties
Name
Type
Required
Restrictions
Description
data
[DeploymentCapability ]
true
none
List of all capabilities.
DeploymentCapability
{ "messages" : [ "string" ], "name" : "string" , "supported" : true } Properties
Name
Type
Required
Restrictions
Description
messages
[string]
true
none
Messages explaining why the capability is supported or not supported.
name
string
true
none
The name of the capability.
supported
boolean
true
none
If the capability is supported.
DeploymentCreateFromLearningModel
{ "defaultPredictionServerId" : "string" , "description" : null , "importance" : "CRITICAL" , "label" : "string" , "modelId" : "string" , "predictionThreshold" : 1 , "status" : "active" } Properties
Name
Type
Required
Restrictions
Description
defaultPredictionServerId
string
false
none
ID of the default prediction server for deployment. Required for DataRobot Cloud, must be omitted for Enterprise installations.
description
string¦null
true
none
A description for the deployment.
importance
string
false
none
Used only when Model Deployment Approvals Workflow is enabled. The parameter to show how important the deployment is. If Model Deployment Approvals Workflow is enabled and materiality is not specified defaults to MODERATE.
label
string
true
none
A human-readable name for the deployment.
modelId
string
true
none
ID of the model to be deployed.
predictionThreshold
number
false
none
Prediction threshold used for binary classification. If not specified, model default prediction threshold will be used.
status
string¦null
false
none
Status of the deployment
Enumerated Values
Property
Value
importance
CRITICAL
importance
HIGH
importance
MODERATE
importance
LOW
status
active
status
inactive
DeploymentCreateResponse
Properties
Name
Type
Required
Restrictions
Description
id
string
true
none
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
none
Column name that contains actual values.
associationIdColumn
string
true
none
Column name that contains unique identifiers used with a predicted rows.
datasetId
string
true
none
The ID of dataset from catalog.
datasetVersionId
string¦null
false
none
Version of dataset to retrieve.
keepActualsWithoutPredictions
boolean
false
none
Indicates if actual without predictions are kept.
password
string
false
none
The password for database authentication.
timestampColumn
string
false
none
Column name that contain datetime when actual values were obtained.
user
string
false
none
The username for database authentication.
wasActedOnColumn
string
false
none
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
none
The datarobot-key header used in requests to this prediction server.
id
string¦null
true
none
ID of the prediction server for the deployment.
url
string
true
none
URL of the prediction server.
DeploymentFeatureDriftObject
{ "baselineSampleSize" : 0 , "driftScore" : 0 , "featureImpact" : 0 , "name" : "string" , "sampleSize" : 0 , "type" : "numeric" } Properties
Name
Type
Required
Restrictions
Description
baselineSampleSize
integer
true
none
The sample size of the training data.
driftScore
number¦null
true
none
The drift score for this feature.
featureImpact
number
true
none
The feature impact score for this feature.
name
string
true
none
The name of the feature.
sampleSize
integer
true
none
The number of predictions used to compute the drift score.
type
string
true
none
Type of the feature.
Enumerated Values
Property
Value
type
numeric
type
categorical
type
text
DeploymentFeatureDriftResponse
{ "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
count
integer
false
none
The number of items returned on this page.
data
[DeploymentFeatureDriftObject ]
true
none
An array [DriftObject], each in the form described below
metric
string
false
none
Metric used to calculate drift score.
modelId
string
true
none
The id of the model for which the features drift is being retrieved.
next
string¦null
false
none
A URL pointing to the next page (if null, there is no next page)
period
TimeRange true
none
An object with the keys "start" and "end" defining the period to retrieve features drift.
previous
string¦null
false
none
A URL pointing to the previous page (if null, there is no previous page)
segmentAttribute
string¦null
false
none
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
none
The value of the segmentAttribute to segment on.
Enumerated Values
Property
Value
metric
psi
metric
kl_divergence
metric
dissimilarity
metric
hellinger
metric
js_divergence
DeploymentGovernanceResponse
{ "approvalStatus" : "PENDING" , "hasOpenedChangeRequests" : true } Properties
Name
Type
Required
Restrictions
Description
approvalStatus
string
true
none
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
none
If there are change request related to this deployment with PENDING status.
Enumerated Values
Property
Value
approvalStatus
PENDING
approvalStatus
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 }, "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" }, "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" : { "humbleAiEnabled" : true , "predictionIntervalsEnabled" : true , "predictionWarningEnabled" : true }, "status" : "active" , "userProvidedId" : "string" } ], "next" : "http://example.com" , "previous" : "http://example.com" , "totalCount" : 0 } Properties
Name
Type
Required
Restrictions
Description
count
integer
false
none
Number of items returned on this page.
data
[DeploymentRetrieveResponse ]
true
none
List of deployments.
next
string(uri)¦null
true
none
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
true
none
URL pointing to the previous page (if null, there is no previous page).
totalCount
integer
true
none
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
none
ID of the custom model.
customModelName
string
true
none
Name of the custom model.
customModelVersionId
string
true
none
ID of the custom model version.
customModelVersionLabel
string
true
none
Label of the custom model version.
executionEnvironmentId
string
true
none
ID of the execution environment.
executionEnvironmentName
string
true
none
Name of the execution environment.
executionEnvironmentVersionId
string
true
none
ID of the execution environment version.
executionEnvironmentVersionLabel
string
true
none
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
none
End date of model health period.
message
string
true
none
A message providing more detail on the status.
startDate
string(date-time)¦null
true
none
Start date of model health period.
status
string
true
none
Model health status.
Enumerated Values
Property
Value
status
failing
status
passing
status
unavailable
status
unknown
status
warning
DeploymentModelPackageInitialDownloadResponse
{ "timestamp" : "2019-08-24T14:15:22Z" } Properties
Name
Type
Required
Restrictions
Description
timestamp
string(date-time)¦null
true
none
Timestamp of the first time model package was downloaded.
DeploymentModelPackageResponse
{ "id" : "string" , "name" : "string" } Properties
Name
Type
Required
Restrictions
Description
id
string
true
none
ID of the ModelPackage.
name
string
true
none
Name of the ModelPackage.
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
none
Build environment type of the current model.
customModelImage
DeploymentModelCustomModelImageResponse false
none
Information related to the custom model image of the deployment.
decisionFlowId
string¦null
false
none
The ID of the decision flow if the deployment has one.
decisionFlowVersionId
string¦null
false
none
The ID of the decision flow version if the deployment has one.
deployedAt
string(date-time)¦null
false
none
Timestamp of when current model was deployed.
hasDecisionFlow
boolean
false
none
True if this deployment contains a Decision Flow
id
string
true
none
ID of the current model.
isDeprecated
boolean
true
none
Whether the current model is deprecated model. eg. python2 based model.
projectId
string¦null
false
none
Project ID of the current model.
projectName
string¦null
true
none
Project name of the current model.
targetName
string
true
none
Target name of the current model.
targetType
string
true
none
Target type of the current model.
type
string
true
none
Type of the current model.
unstructuredModelKind
boolean
true
none
Whether the current model is an unstructured model.
unsupervisedMode
boolean
true
none
Whether the current model's project is unsupervised.
unsupervisedType
string¦null
false
none
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
unsupervisedType
clustering
DeploymentOwnerResponse
{ "email" : "string" , "firstName" : "string" , "id" : "string" , "lastName" : "string" } Properties
Name
Type
Required
Restrictions
Description
email
string¦null
true
none
Email address of the owner.
firstName
string¦null
true
none
First name of the owner.
id
string
true
none
ID of the owner.
lastName
string¦null
true
none
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
none
Total count of owners.
preview
[DeploymentOwnerResponse ]
true
none
A list of owner objects.
DeploymentPermanentDelete
{ "action" : "PermanentlyErase" , "deploymentIds" : [ "string" ] } Properties
Name
Type
Required
Restrictions
Description
action
string
true
none
Action to perform on these deleted deployments.
deploymentIds
[string]
true
none
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
none
ID of the PredictionEnvironment.
isManagedByManagementAgent
boolean
true
none
True if PredictionEnvironment is using Management Agent.
name
string
true
none
Name of the PredictionEnvironment.
platform
string
true
none
Platform of the PredictionEnvironment.
plugin
string¦null
false
none
Plugin name of the PredictionEnvironment.
supportedModelFormats
[string]
false
none
Model formats that the PredictionEnvironment supports.
Enumerated Values
Property
Value
platform
aws
platform
gcp
platform
azure
platform
onPremise
platform
datarobot
platform
openShift
platform
other
platform
snowflake
DeploymentPredictionUsageResponse
{ "dailyRates" : [ 0 ], "lastTimestamp" : "2019-08-24T14:15:22Z" } Properties
Name
Type
Required
Restrictions
Description
dailyRates
[integer]
true
none
Number of predictions made in the last 7 days.
lastTimestamp
string(date-time)¦null
true
none
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 }, "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" }, "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" : { "humbleAiEnabled" : true , "predictionIntervalsEnabled" : true , "predictionWarningEnabled" : true }, "status" : "active" , "userProvidedId" : "string" } Properties
Name
Type
Required
Restrictions
Description
accuracyHealth
DeploymentAccuracyHealthResponse true
none
Accuracy health of the deployment.
approvalStatus
string
false
none
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
none
Capabilities of the deployment.
createdAt
string(date-time)
true
none
The date and time of when the deployment was created, in ISO 8601 format.
defaultPredictionServer
DeploymentDefaultPredictionServerResponse true
none
The prediction server associated with the deployment.
description
string¦null
true
none
Description of the deployment.
governance
DeploymentGovernanceResponse false
none
Deployment governance info.
id
string
true
none
ID of the deployment.
importance
string
false
none
Shows how important this deployment is.
label
string
true
none
Label of the deployment.
model
DeploymentModelResponse true
none
Information related to the current model of the deployment.
modelHealth
DeploymentModelHealthResponse true
none
Model health of the deployment.
modelPackage
DeploymentModelPackageResponse false
none
Information related to the current ModelPackage.
modelPackageInitialDownload
DeploymentModelPackageInitialDownloadResponse false
none
If a model package has been downloaded for this deployment, then this will tell you when it was first downloaded.
openedChangeRequests
[string]
false
none
An array of the change request IDs related to this deployment that have.
owners
DeploymentOwnersResponse false
none
Count and preview of owners of the deployment.
permissions
[string]
true
none
Permissions that the user making the request has on the deployment.
predictionEnvironment
DeploymentPredictionEnvironmentResponse false
none
Information related to the current PredictionEnvironment.
predictionUsage
DeploymentPredictionUsageResponse true
none
Prediction usage of the deployment.
scoringCodeInitialDownload
DeploymentScoringCodeInitialDownloadResponse false
none
If scoring code has been downloaded for this deployment, then this will tell you when it was first downloaded.
serviceHealth
DeploymentServiceHealthResponse true
none
Service health of the deployment.
settings
DeploymentSettingsInfo true
none
Settings of the deployment.
status
string
true
none
Displays current deployment status.
userProvidedId
string
false
none
A user-provided unique ID associated with a deployment definition in a remote git repository.
Enumerated Values
Property
Value
approvalStatus
PENDING
approvalStatus
APPROVED
importance
CRITICAL
importance
HIGH
importance
MODERATE
importance
LOW
status
active
status
archived
status
errored
status
inactive
status
launching
status
replacingModel
status
stopping
DeploymentScoringCodeInitialDownloadResponse
{ "timestamp" : "2019-08-24T14:15:22Z" } Properties
Name
Type
Required
Restrictions
Description
timestamp
string(date-time)¦null
true
none
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
none
ID of the catalog item
catalogVersionId
string
true
none
ID of the catalog version
identifier
string
true
none
Short name of this table (used directly as part of generated feature names)
snapshotPolicy
string
true
none
Policy to use by a dataset while making prediction
Enumerated Values
Property
Value
snapshotPolicy
specified
snapshotPolicy
latest
snapshotPolicy
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
none
End date of model service period.
startDate
string(date-time)¦null
true
none
Start date of service health period.
status
string
true
none
Service health status.
Enumerated Values
Property
Value
status
failing
status
passing
status
unavailable
status
unknown
status
warning
DeploymentSettingsInfo
{ "humbleAiEnabled" : true , "predictionIntervalsEnabled" : true , "predictionWarningEnabled" : true } Properties
Name
Type
Required
Restrictions
Description
humbleAiEnabled
boolean
false
none
if humble ai is enabled.
predictionIntervalsEnabled
boolean
false
none
If prediction intervals are enabled.
predictionWarningEnabled
boolean
false
none
If prediction warning is enabled.
DeploymentSettingsResponse
{ "associationId" : { "columnNames" : [ "string" ], "requiredInPredictionRequests" : true }, "automaticActuals" : { "enabled" : true }, "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
none
The association ID setting for the deployment.
automaticActuals
AutomatiActuals false
none
Automatic actuals setting for the deployment.
challengerModels
Challengers false
none
Challenger models setting for the deployment.
featureDrift
FeatureDrift true
none
The feature drift setting for the deployment.
humility
Humility false
none
Humility setting for the deployment.
predictionIntervals
PredictionIntervals true
none
The prediction intervals setting for the deployment.
predictionWarning
PredictionWarning false
none
The prediction warning setting for the deployment.
predictionsByForecastDate
ForecastDate false
none
Forecast date setting for the deployment.
predictionsDataCollection
PredictionsDataCollection false
none
The predictions data collection setting for the deployment.
segmentAnalysis
SegmentAnalysis false
none
The segment analysis setting for the deployment.
targetDrift
TargetDrift true
none
The target drift setting for the deployment.
DeploymentSettingsUpdate
{ "associationId" : { "columnNames" : [ "string" ], "requiredInPredictionRequests" : true }, "automaticActuals" : { "enabled" : true }, "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
none
Association id settings for the deployment.
automaticActuals
AutomatiActuals false
none
Automatic actuals setting for the deployment.
challengerModels
Challengers false
none
Challenger models setting for the deployment.
featureDrift
FeatureDriftUpdate false
none
Feature drift setting for the deployment.
humility
Humility false
none
Humility setting for the deployment.
predictionIntervals
PredictionIntervalsUpdate false
none
Prediction intervals setting for the deployment. Requires that the requested interval size is calculated prior to setting in this request.
predictionWarning
PredictionWarningUpdate false
none
Prediction warning setting for the deployment.
predictionsByForecastDate
ForecastDate false
none
Forecast date setting for the deployment.
predictionsDataCollection
PredictionsDataCollection false
none
The predictions data collection setting for the deployment.
segmentAnalysis
SegmentAnalysisUpdate false
none
The segment analysis setting for the deployment.
targetDrift
TargetDriftUpdate false
none
Target drift setting for the deployment.
DeploymentStatusUpdate
Properties
Name
Type
Required
Restrictions
Description
status
string
true
none
Status that deployment should be transition in.
Enumerated Values
Property
Value
status
active
status
inactive
DeploymentTargetDriftResponse
{ "baselineSampleSize" : 0 , "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" } Properties
Name
Type
Required
Restrictions
Description
baselineSampleSize
integer
true
none
sample size of the training data.
driftScore
number¦null
true
none
drift score for the target.
metric
string
false
none
Metric used to calculate drift score.
modelId
string
true
none
id of the model for which data drift is being retrieved.
period
TimeRange true
none
An object with the keys "start" and "end" defining the period.to retrieve features drift.
sampleSize
integer
true
none
number of predictions used to compute the drift score.
segmentAttribute
string¦null
false
none
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
none
The value of the segmentAttribute to segment on.
targetName
string
true
none
name of the target feature.
Enumerated Values
Property
Value
metric
psi
metric
kl_divergence
metric
dissimilarity
metric
hellinger
metric
js_divergence
DeploymentUpdate
{ "description" : "string" , "importance" : "CRITICAL" , "label" : "string" } Properties
Name
Type
Required
Restrictions
Description
description
string¦null
false
none
A description for the deployment.
importance
string
false
none
Shows how important this deployment is.
label
string¦null
false
none
A human-readable name for the deployment.
Enumerated Values
Property
Value
importance
CRITICAL
importance
HIGH
importance
MODERATE
importance
LOW
DeploymentsScoringCodeBuildPayload
{ "includeAgent" : true , "includePredictionExplanations" : true , "includePredictionIntervals" : true } Properties
Name
Type
Required
Restrictions
Description
includeAgent
boolean
false
none
Whether the Scoring Code built will include tracking agent
includePredictionExplanations
boolean
false
none
Whether the Scoring Code built will include prediction explanations
includePredictionIntervals
boolean
false
none
Whether the Scoring Code built will include prediction intervals
Feature
{ "dateFormat" : "string" , "featureType" : "string" , "importance" : 0 , "knownInAdvance" : true , "name" : "string" } Properties
Name
Type
Required
Restrictions
Description
dateFormat
string¦null
true
none
The date format string for how this feature was interpreted.
featureType
string¦null
true
none
Feature type.
importance
number¦null
true
none
Numeric measure of the relationship strength between the feature and target (independent of model or other features).
knownInAdvance
boolean
true
none
Whether the feature was selected as known in advance in a time-series model, false for non-time-series models.
name
string
true
none
Feature name.
FeatureDrift
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
none
Indicates whether feature drift tracking is enabled for this deployment.
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
none
The sample size of the training data used during model creation
driftScore
number¦null
true
none
The aggregated drift score for the target.
featureImpact
number
true
none
The feature impact score of the feature.
featureName
string
true
none
Name of the feature.
period
TimeRange true
none
Time range for which feature drift is computed.
sampleSize
integer
true
none
The sample size in the query period used to calculate drift score.
FeatureDriftOverTimeRetrieveResponse
{ "buckets" : [ { "baselineSampleSize" : 0 , "driftScore" : 0 , "featureImpact" : 0 , "featureName" : "string" , "period" : { "end" : "2019-08-24T14:15:22Z" , "start" : "2019-08-24T14:15:22Z" }, "sampleSize" : 0 } ], "metric" : "string" , "summaries" : [ { "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
buckets
[FeatureDriftOverTimeBucket ]
true
none
A list of aggregated drift scores by feature over a given period.
metric
string
true
none
Name of requested metric.
summaries
[FeatureDriftOverTimeBucket ]
true
none
A list of aggregated drift scores by feature over a given period.
FeatureDriftUpdate
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
none
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
none
Number of items returned on this page.
data
[Feature ]
true
none
An array of dataset details.
next
string(uri)¦null
true
none
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
true
none
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
none
The column name in prediction datasets to be used as forecast date
datetimeFormat
string¦null
false
none
The datetime format of the forecast date column in prediction datasets.
enabled
boolean
true
none
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
none
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
none
The ID of the recipient.
role
string
true
none
The role of the recipient on this entity. One of OWNER, USER, OBSERVER.
shareRecipientType
string
true
none
Describes the recipient type, either user, group, or organization.
Enumerated Values
Property
Value
shareRecipientType
user
shareRecipientType
group
shareRecipientType
organization
GrantAccessControlWithUsernameWithGrant
{ "canShare" : true , "role" : "string" , "shareRecipientType" : "user" , "username" : "string" } Properties
Name
Type
Required
Restrictions
Description
canShare
boolean
false
none
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
none
The role of the recipient on this entity. One of OWNER, USER, OBSERVER.
shareRecipientType
string
true
none
Describes the recipient type, either user, group, or organization.
username
string
true
none
Username of the user to update the access role for.
Enumerated Values
Property
Value
shareRecipientType
user
shareRecipientType
group
shareRecipientType
organization
Humility
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
none
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
none
An object with the keys "start" and "end" defining the period.
values
[HumilityStatsRule ]
true
none
Rules response objects.
HumilityStatsOverTimeRetrieveResponse
{ "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
none
An array of bucket objects, representing service health stats of the deployment over time
modelId
string
false
none
The id of the model for which metrics are being retrieved.
segmentAttribute
string¦null
false
none
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
none
The value of the segmentAttribute to segment on.
summary
HumilityStatsBucket true
none
A bucket object covering whole start/end time range
HumilityStatsRetrieveResponse
{ "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
none
metrics rules
modelId
string
false
none
The id of the model for which metrics are being retrieved.
period
TimeRange true
none
An object with the keys "start" and "end" defining the period.
segmentAttribute
string¦null
false
none
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
none
The value of the segmentAttribute to segment on.
HumilityStatsRule
{ "ruleId" : "string" , "ruleName" : "string" , "value" : 0 } Properties
Name
Type
Required
Restrictions
Description
ruleId
string
true
none
Id of the humility rule.
ruleName
string
true
none
Name of the rule.
value
integer
true
none
Number of times the rule was triggered.
ModelPackageResponse
{ "id" : "string" , "name" : "string" } Properties
Name
Type
Required
Restrictions
Description
id
string
true
none
ID of the model package.
name
string
true
none
Type of the current model.
ModelReplacementSubmission
{ "modelId" : "string" , "modelPackageId" : "string" , "reason" : "ACCURACY" } Properties
Name
Type
Required
Restrictions
Description
modelId
string
false
none
ID of the model used to replace deployment's champion model. Required if modelPackageId is not provided.
modelPackageId
string
false
none
ID of the model package used to replace deployment's champion model. Required if modelId is not provided.
reason
string
true
none
Reason for the model replacement.
Enumerated Values
Property
Value
reason
ACCURACY
reason
DATA_DRIFT
reason
ERRORS
reason
SCHEDULED_REFRESH
reason
SCORING_SPEED
reason
DEPRECATION
reason
OTHER
ModelReplacementValidationRequest
{ "modelId" : "string" , "modelPackageId" : "string" } Properties
Name
Type
Required
Restrictions
Description
modelId
string
false
none
ID of the model used to replace deployment's champion model. Required if modelPackageId is not provided.
modelPackageId
string
false
none
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
none
A more granular explanation of why the replacement model was eligible or ineligible.
message
string
true
none
Message of the overall validation check.
status
string
true
none
Status of the overall validation check.
Enumerated Values
Property
Value
status
failing
status
passing
status
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
none
Name of dataset used to train challenger model
description
string
true
none
Description of the model.
executionType
string
true
none
Type of the current model.
id
string
true
none
ID of the current model.
isDeprecated
boolean
true
none
Whether the current model is deprecated model. eg. python2 based model.
name
string
true
none
Name of the model.
projectId
string
true
none
Project ID of the current model.
projectName
string
true
none
Project name of the current model.
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
none
RFC3339 datetime. End of time period to delete monitoring data.Note: this field only accepts top of the hour RFC3339 datetime strings For example: 2019-08-01T00:00:00Z.
modelId
string
true
none
The id of the model for which monitoring data are being deleted.
start
string(date-time)¦null
false
none
RFC3339 datetime. Start of time period to delete monitoring data.Note: this field only accepts top of the hour RFC3339 datetime strings For example: 2019-08-01T00:00:00Z.
Periodicity
{ "timeSteps" : 0 , "timeUnit" : "MILLISECOND" } Properties
Name
Type
Required
Restrictions
Description
timeSteps
integer
true
none
The number of time steps.
timeUnit
string
true
none
The time unit or ROW if windowsBasisUnit is ROW
Enumerated Values
Property
Value
timeUnit
MILLISECOND
timeUnit
SECOND
timeUnit
MINUTE
timeUnit
HOUR
timeUnit
DAY
timeUnit
WEEK
timeUnit
MONTH
timeUnit
QUARTER
timeUnit
YEAR
timeUnit
ROW
PredictionDatasetAssignment
{ "datasetId" : "string" , "datasetVersionId" : "string" } Properties
Name
Type
Required
Restrictions
Description
datasetId
string
true
none
the ID of the dataset
datasetVersionId
string
false
none
the ID of the dataset version
PredictionEnvironment
{ "id" : "string" , "name" : "string" } Properties
Name
Type
Required
Restrictions
Description
id
string
true
none
ID of the prediction environment.
name
string
true
none
Name of the prediction environment.
PredictionEnvironmentResponse
{ "id" : "string" , "name" : "string" } Properties
Name
Type
Required
Restrictions
Description
id
string
true
none
ID of the prediction environment.
name
string
true
none
Name of the prediction environment.
PredictionExplanationsValues
{ "feature" : "string" , "featureValue" : "string" , "label" : "string" , "qualitativeStrength" : "string" , "strength" : 0 } Properties
Name
Type
Required
Restrictions
Description
feature
string
true
none
The name of the feature contributing to the prediction.
featureValue
any
true
none
The value the feature took on for this row.
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
continued
Name
Type
Required
Restrictions
Description
label
any
true
none
Describes what output was driven by this prediction explanation. For regression projects, it is the name of the target feature. For classification projects, it is the class whose probability increasing would correspond to a positive strength of this prediction explanation.
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
continued
Name
Type
Required
Restrictions
Description
qualitativeStrength
string¦null
true
none
The feature strength as a string, a plus or minus indicator from +++ to ---.
strength
number
false
none
The feature strength as a float.
PredictionIntervals
{ "enabled" : true , "percentiles" : [ 0 ] } Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
none
Indicates whether prediction intervals are enabled for this deployment.
percentiles
[integer]
false
none
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
none
True if prediction intervals are enabled for this deployment, false if otherwise
percentiles
[integer]
false
none
if prediction intervals are enabled, the percentiles to use for this deployment. Currently, we support at most one percentile at a time.
PredictionProxyData
{ "deploymentApprovalStatus" : "PENDING" , "forecastDistance" : 0 , "forecastPoint" : "2019-08-24T14:15:22Z" , "isOutlierPrediction" : true , "passthroughValues" : {}, "prediction" : "string" , "predictionExplanations" : [ { "feature" : "string" , "featureValue" : "string" , "label" : "string" , "qualitativeStrength" : "string" , "strength" : 0 } ], "predictionIntervals" : {}, "predictionThreshold" : 1 , "predictionValues" : [ { "label" : "string" , "value" : 0 } ], "rowId" : 0 , "seriesId" : "string" , "shapExplanationsMetadata" : [ { "baseValue" : 0 , "remainingTotal" : 0 , "warnings" : [ { "maxNormalizedMismatch" : 0 , "mismatchRowCount" : 0 } ] } ], "timestamp" : "2019-08-24T14:15:22Z" } Properties
Name
Type
Required
Restrictions
Description
deploymentApprovalStatus
any
false
none
The approval status of the deployment.
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
continued
Name
Type
Required
Restrictions
Description
forecastDistance
integer
false
none
In the case of time series project, the number of time units this row is away from the forecastPoint. The unit of time is determined by the timeUnit of the datetime partition column.
forecastPoint
string(date-time)
false
none
For time series projects only. The time in the dataset relative to which predictions were generated.
isOutlierPrediction
boolean
false
none
The outlier warning check result.
passthroughValues
AllowExtra false
none
Contains passthrough values from the scoring dataset.
prediction
any
true
none
In the case of a regression, the value predicted for the target in that row. In the case of any classification type, the class of the target which the row is predicted to belong to.
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
continued
Name
Type
Required
Restrictions
Description
predictionExplanations
[PredictionExplanationsValues ]
false
none
Array contains predictionExplanation objects. Will be present only if explanationAlgorithm is not null (prediction explanations were requested).
predictionIntervals
AllowExtra false
none
It contains prediction intervals for time series projects.
predictionThreshold
number
false
none
Threshold used for binary classification in predictions.
predictionValues
[PredictionValues ]
true
none
Array of predictionValue objects for each class.
rowId
integer
true
none
The row in the prediction dataset this prediction corresponds to.
seriesId
string¦null
false
none
The ID of the series value for a multiseries project. For time series projects that are not multiseries this will be a null.
shapExplanationsMetadata
[ShapExplanationsMetadataValues ]
false
none
Array contains prediction explanation metadata.
timestamp
string(date-time)
false
none
The timestamp of this row in the prediction dataset.
Enumerated Values
Property
Value
anonymous PENDING
anonymous APPROVED
PredictionProxyResponse
{ "data" : [ { "deploymentApprovalStatus" : "PENDING" , "forecastDistance" : 0 , "forecastPoint" : "2019-08-24T14:15:22Z" , "isOutlierPrediction" : true , "passthroughValues" : {}, "prediction" : "string" , "predictionExplanations" : [ { "feature" : "string" , "featureValue" : "string" , "label" : "string" , "qualitativeStrength" : "string" , "strength" : 0 } ], "predictionIntervals" : {}, "predictionThreshold" : 1 , "predictionValues" : [ { "label" : "string" , "value" : 0 } ], "rowId" : 0 , "seriesId" : "string" , "shapExplanationsMetadata" : [ { "baseValue" : 0 , "remainingTotal" : 0 , "warnings" : [ { "maxNormalizedMismatch" : 0 , "mismatchRowCount" : 0 } ] } ], "timestamp" : "2019-08-24T14:15:22Z" } ] } Properties
Name
Type
Required
Restrictions
Description
data
[PredictionProxyData ]
false
none
Array contains prediction result objects.
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
none
Actual value of the prediction
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
integer
false
none
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
continued
Name
Type
Required
Restrictions
Description
associationId
string
true
none
Association id of the prediction, which is used to associate a prediction with its actual value and calculate accuracy.
forecastDistance
integer¦null
false
none
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
none
ID of the model used to make these predictions
predicted
any
true
none
Predicted value of the prediction
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
integer
false
none
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
continued
Name
Type
Required
Restrictions
Description
timestamp
string(date-time)
true
none
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
none
List of column names used to represent an association id, which is used to unique identify individual prediction rows.
count
integer
false
none
Number of items returned on this page.
data
[PredictionResultResponse ]
true
none
An array of prediction requests.
next
string(uri)¦null
true
none
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
true
none
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
none
Number of items returned on this page.
data
[PredictionServerResponse ]
true
none
List of prediction servers.
next
string(uri)¦null
true
none
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
true
none
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
none
Batch Prediction status for this instance
datarobot-key
string¦null
true
none
The datarobot-key header used in requests to this prediction server.
id
string¦null
true
none
ID of the prediction server.
url
string
true
none
URL of the prediction server.
PredictionValues
{ "label" : "string" , "value" : 0 } Properties
Name
Type
Required
Restrictions
Description
label
any
true
none
In the case of classification, The label of the class.
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
xor
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
continued
Name
Type
Required
Restrictions
Description
value
number
true
none
In the case of classification, the predicted probability of the class identified by the label.
PredictionWarning
{ "customBoundaries" : { "lower" : 0 , "upper" : 0 }, "enabled" : true } Properties
Name
Type
Required
Restrictions
Description
customBoundaries
CustomBoundaries true
none
Null if default boundaries for the model are used
enabled
boolean
true
none
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
none
If omitted, boundaries will not be changed. Null if default boundaries for the model should be used.
enabled
boolean
true
none
True if prediction warnings are enabled for this deployment, false otherwise.
PredictionsDataCollection
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
none
Indicates whether incoming prediction requests and results should be stored in record-level storage.
ProjectOptions
{ "cvMethod" : "RandomCV" , "holdoutPct" : null , "metric" : "Accuracy" , "reps" : null , "validationPct" : null , "validationType" : "CV" } Properties
Name
Type
Required
Restrictions
Description
cvMethod
string
false
none
The partitioning method for projects used to build new models.
holdoutPct
number¦null
false
none
The percentage of dataset to assign to holdout set in projects used to build new models.
metric
string¦null
false
none
The model selection metric in projects used to build new models.
reps
integer¦null
false
none
The number of cross validation folds to use for projects used to build new models.
validationPct
number¦null
false
none
The percentage of dataset to assign to validation set in projects used to build new models.
validationType
string
false
none
The validation type for projects used to build new models.
Enumerated Values
Property
Value
cvMethod
RandomCV
cvMethod
StratifiedCV
metric
Accuracy
metric
AUC
metric
Balanced Accuracy
metric
FVE Binomial
metric
Gini Norm
metric
Kolmogorov-Smirnov
metric
LogLoss
metric
Rate@Top5%
metric
Rate@Top10%
metric
TPR
metric
FPR
metric
TNR
metric
PPV
metric
NPV
metric
F1
metric
MCC
metric
FVE Gamma
metric
FVE Poisson
metric
FVE Tweedie
metric
Gamma Deviance
metric
MAD
metric
MAE
metric
MAPE
metric
Poisson Deviance
metric
R Squared
metric
RMSE
metric
RMSLE
metric
Tweedie Deviance
validationType
CV
validationType
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" : { "schedule" : { "dayOfMonth" : [ "*" ], "dayOfWeek" : [ "*" ], "hour" : [ "*" ], "minute" : [ "*" ], "month" : [ "*" ] }, "statusDeclinesToFailing" : true , "statusDeclinesToWarning" : true , "type" : "schedule" } } Properties
Name
Type
Required
Restrictions
Description
action
string
false
none
Configure the action to take on the resultant new model.
autopilotOptions
AutopilotOptions false
none
Will override the corresponding fields when reusing champion's project options.
description
string¦null
true
none
Description of the retraining policy.
featureListStrategy
string
false
none
Configure the feature list strategy used for modeling.
modelSelectionStrategy
string
false
none
Configure how new model is selected when the retraining policy runs.
name
string
true
none
Name of the retraining policy.
projectOptions
ProjectOptions false
none
Options for projects used to build new models.
projectOptionsStrategy
string
false
none
Configure the project option strategy used for modeling.
timeSeriesOptions
TimeSeriesOptions false
none
Time Series project option used to build new models.
trigger
Trigger false
none
Retraining policy trigger.
Enumerated Values
Property
Value
action
create_challenger
action
create_model_package
action
model_replacement
featureListStrategy
informative_features
featureListStrategy
same_as_champion
modelSelectionStrategy
autopilot_recommended
modelSelectionStrategy
same_blueprint
modelSelectionStrategy
same_hyperparameters
projectOptionsStrategy
same_as_champion
projectOptionsStrategy
override_champion
projectOptionsStrategy
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" , "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" : { "schedule" : { "dayOfMonth" : [ "*" ], "dayOfWeek" : [ "*" ], "hour" : [ "*" ], "minute" : [ "*" ], "month" : [ "*" ] }, "statusDeclinesToFailing" : true , "statusDeclinesToWarning" : true , "type" : "schedule" } } ], "next" : "http://example.com" , "previous" : "http://example.com" , "totalCount" : 0 } Properties
Name
Type
Required
Restrictions
Description
count
integer
false
none
Number of items returned on this page.
data
[RetrainingPolicyRetrieve ]
true
none
List of retraining policies.
next
string(uri)¦null
true
none
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
true
none
URL pointing to the previous page (if null, there is no previous page).
totalCount
integer
true
none
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" , "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" : { "schedule" : { "dayOfMonth" : [ "*" ], "dayOfWeek" : [ "*" ], "hour" : [ "*" ], "minute" : [ "*" ], "month" : [ "*" ] }, "statusDeclinesToFailing" : true , "statusDeclinesToWarning" : true , "type" : "schedule" } } Properties
Name
Type
Required
Restrictions
Description
action
string
true
none
Configure the action to take on the resultant new model.
autopilotOptions
AutopilotOptions true
none
Options for projects used to build new models.
description
string¦null
true
none
Description of the retraining policy.
featureListStrategy
string
false
none
Configure the feature list strategy used for modeling.
id
string
true
none
ID of the retraining policy.
latestRun
RetrainingPolicyRunRetrieve true
none
Latest run of the retraining policy.
modelSelectionStrategy
string
true
none
Configure how new model is selected when the retraining policy runs.
name
string
true
none
Name of the retraining policy.
projectOptions
ProjectOptions true
none
Options for projects used to build new models.
projectOptionsStrategy
string
false
none
Configure the project option strategy used for modeling.
timeSeriesOptions
TimeSeriesOptions false
none
Time Series project option used to build new models.
trigger
Trigger true
none
Retraining policy trigger.
Enumerated Values
Property
Value
action
create_challenger
action
create_model_package
action
model_replacement
featureListStrategy
informative_features
featureListStrategy
same_as_champion
modelSelectionStrategy
autopilot_recommended
modelSelectionStrategy
same_blueprint
modelSelectionStrategy
same_hyperparameters
projectOptionsStrategy
same_as_champion
projectOptionsStrategy
override_champion
projectOptionsStrategy
custom
RetrainingPolicyRunListResponse
{ "count" : 0 , "data" : [ { "challengerId" : "string" , "errorMessage" : "string" , "finishTime" : "2019-08-24T14:15:22Z" , "id" : "string" , "modelPackageId" : "string" , "projectId" : "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
none
Number of items returned on this page.
data
[RetrainingPolicyRunRetrieve ]
true
none
List of retraining policy runs.
next
string(uri)¦null
true
none
URL pointing to the next page (if null, there is no next page).
previous
string(uri)¦null
true
none
URL pointing to the previous page (if null, there is no previous page).
totalCount
integer
true
none
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" , "startTime" : "2019-08-24T14:15:22Z" , "status" : "string" } Properties
Name
Type
Required
Restrictions
Description
challengerId
string¦null
true
none
ID of the challenger created from this retraining policy run.
errorMessage
string¦null
true
none
Error message of the retraining policy run.
finishTime
string(date-time)¦null
true
none
Finish time of the retraining policy run.
id
string
true
none
ID of the retraining policy run.
modelPackageId
string¦null
true
none
ID of the model package created from this retraining policy run.
projectId
string¦null
true
none
ID of the project created from this retraining policy run.
startTime
string(date-time)¦null
true
none
Start time of the retraining policy run.
status
string¦null
true
none
Status of the retraining policy run.
RetrainingPolicyRunUpdate
{ "status" : "cancelled" } Properties
Name
Type
Required
Restrictions
Description
status
string
true
none
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" : { "schedule" : { "dayOfMonth" : [ "*" ], "dayOfWeek" : [ "*" ], "hour" : [ "*" ], "minute" : [ "*" ], "month" : [ "*" ] }, "statusDeclinesToFailing" : true , "statusDeclinesToWarning" : true , "type" : "schedule" } } Properties
Name
Type
Required
Restrictions
Description
action
string
false
none
Configure the action to take on the resultant new model.
autopilotOptions
AutopilotOptions false
none
Options for projects used to build new models.
description
string¦null
false
none
Description of the retraining policy.
featureListStrategy
string
false
none
Configure the feature list strategy used for modeling.
modelSelectionStrategy
string
false
none
Configure how new model is selected when the retraining policy runs.
name
string
false
none
Name of the retraining policy.
projectOptions
ProjectOptions false
none
Options for projects used to build new models.
projectOptionsStrategy
string
false
none
Configure the project option strategy used for modeling.
timeSeriesOptions
TimeSeriesOptions false
none
Time Series project option used to build new models.
trigger
Trigger false
none
Retraining policy trigger.
Enumerated Values
Property
Value
action
create_challenger
action
create_model_package
action
model_replacement
featureListStrategy
informative_features
featureListStrategy
same_as_champion
modelSelectionStrategy
autopilot_recommended
modelSelectionStrategy
same_blueprint
modelSelectionStrategy
same_hyperparameters
projectOptionsStrategy
same_as_champion
projectOptionsStrategy
override_champion
projectOptionsStrategy
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
none
The dataset that will be used as retraining data.
predictionEnvironment
PredictionEnvironment true
none
The prediction environment that will be associated with the challengers created by retraining policies.
retrainingUser
RetrainingUser true
none
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
none
ID of the credential used to refresh retraining dataset.
datasetId
string¦null
false
none
ID of the retraining dataset.
predictionEnvironmentId
string¦null
false
none
ID of the prediction environment to associate with the challengers created by retraining policies.
retrainingUserId
string¦null
false
none
ID of the retraining user.
RetrainingUser
{ "id" : "string" , "username" : "string" } Properties
Name
Type
Required
Restrictions
Description
id
string
true
none
ID of the scheduled retraining user.
username
string
true
none
Username of the scheduled retraining user.
Schedule
{ "dayOfMonth" : [ "*" ], "dayOfWeek" : [ "*" ], "hour" : [ "*" ], "minute" : [ "*" ], "month" : [ "*" ] } Properties
Name
Type
Required
Restrictions
Description
dayOfMonth
[anyOf]
true
none
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
none
or
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
continued
Name
Type
Required
Restrictions
Description
dayOfWeek
[anyOf]
true
none
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
none
or
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
continued
Name
Type
Required
Restrictions
Description
hour
[anyOf]
true
none
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
none
or
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
continued
Name
Type
Required
Restrictions
Description
minute
[anyOf]
true
none
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
none
or
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
continued
Name
Type
Required
Restrictions
Description
month
[anyOf]
true
none
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
none
or
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
ScheduledReportOnDemmand
Properties
Name
Type
Required
Restrictions
Description
id
string
true
none
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
none
DR-formatted datetime, null for legacy (before DR 6.0) db records
creatorFullName
string¦null
true
none
Fullname or email of the user created this config. null for legacy (before DR 6.0) db records
creatorUserId
string¦null
true
none
ID of the user created this config, null for legacy (before DR 6.0) db records
credentialIds
[DatasetsCredential ]¦null
false
none
List of credentials used by the secondary datasets if the datasets used in the configuration are from datasource
featurelistId
string¦null
true
none
Id of the feature list
isDefault
boolean
true
none
Secondary datasets config is default config or not
isDeleted
boolean
true
none
Secondary datasets config is soft deleted or not
name
string¦null
true
none
Name of the secondary datasets config
projectId
string¦null
true
none
ID of the project
secondaryDatasetConfigId
string
true
none
ID of the secondary datasets configuration
secondaryDatasets
[DeploymentSecondaryDataset ]
false
none
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
none
List of credentials used by the secondary datasets
secondaryDatasetConfigId
string
true
none
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
none
ID of the secondary datasets configuration
configName
string
true
none
Name of the secondary datasets config
updated
string
true
none
Timestamp when configuration was updated on the given deployment
username
string
true
none
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
none
Number of items
data
[SecondaryDatasetsConfig ]
true
none
Secondary datasets configuration history.
next
string(uri)¦null
true
none
URL pointing to the next page (if null, there is no next page)
previous
string(uri)¦null
true
none
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
none
The list of segment attributes selected for tracking.
enabled
boolean
true
none
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
none
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
none
Indicates whether service health, drift, and accuracy are tracked for segments of prediction data.
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
none
Service health metrics of the deployment
modelId
string
false
none
The id of the model for which metrics are being retrieved.
period
TimeRange true
none
An object with the keys "start" and "end" defining the period.
segmentAttribute
string¦null
false
none
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
none
The value of the segmentAttribute to segment on.
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
none
Number of cache hits.
executionTime
number¦null
true
none
Request execution time at executionTimeQuantile (in milliseconds).
medianLoad
number¦null
true
none
Median of the request rate (in requests per minute).
numConsumers
integer¦null
true
none
Number of unique users performing requests.
peakLoad
number¦null
true
none
Maximum of the request rate (in requests per minute).
responseTime
number¦null
true
none
Request response time at responseTimeQuantile (in milliseconds).
serverErrorRate
number¦null
true
none
Ratio of server errors to the total number of requests.
slowRequests
integer¦null
true
none
Number of requests with response time greater than slowRequestsThreshold
totalPredictions
integer¦null
true
none
Total number of prediction rows.
totalRequests
integer¦null
true
none
Total number of prediction requests performed.
userErrorRate
number¦null
true
none
Ratio of user errors to the total number of requests.
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
none
An object with the keys "start" and "end" defining the period.
value
number¦null
true
none
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
none
An array of bucket, representing service health stats of the deployment over time.
metric
string
true
none
Name of the metric requested.
modelId
string
false
none
The id of the model for which metrics are being retrieved.
segmentAttribute
string¦null
false
none
The name of the segment on which segment analysis is being performed.
segmentValue
string¦null
false
none
The value of the segmentAttribute to segment on.
summary
ServiceStatsOverTimeBucket true
none
A bucket object covering whole start/end time range
{ "baseValue" : 0 , "remainingTotal" : 0 , "warnings" : [ { "maxNormalizedMismatch" : 0 , "mismatchRowCount" : 0 } ] } Properties
Name
Type
Required
Restrictions
Description
baseValue
number
true
none
Will be present only ifexplanationAlgorithm = "shap". The model's average prediction over the training data. SHAP values are deviations from the base value.
remainingTotal
number¦null
true
none
Will be present only if explanationAlgorithm = "shap" and maxExplanations is nonzero. The total of SHAP values for features beyond the maxExplanations. This can be identically 0 in all rows, if maxExplanations is greater than the number of features and thus all features are returned.
warnings
[ShapExplanationsWarningsValues ]¦null
true
none
Will be present if explanationAlgorithm was set to "shap" and there were additivity failures during SHAP values calculation.
ShapExplanationsWarningsValues
{ "maxNormalizedMismatch" : 0 , "mismatchRowCount" : 0 } Properties
Name
Type
Required
Restrictions
Description
maxNormalizedMismatch
number
false
none
The maximal relative normalized mismatch value.
mismatchRowCount
integer
false
none
The count of rows for which additivity check failed.
SharedRolesUpdateWithGrant
{ "operation" : "updateRoles" , "roles" : [ { "canShare" : true , "role" : "string" , "shareRecipientType" : "user" , "username" : "string" } ] } Properties
Name
Type
Required
Restrictions
Description
operation
string
true
none
Name of the action being taken. The only operation is 'updateRoles'.
roles
[oneOf]
true
none
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
none
The number of items returned.
data
[AccessControlV2 ]
true
none
The access control list.
next
string¦null
true
none
URL pointing to the next page.
previous
string¦null
true
none
URL pointing to the previous page.
totalCount
integer
true
none
Total number of items matching the condition.
TargetDrift
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
none
Indicates whether target drift tracking is enabled for this deployment.
TargetDriftUpdate
Properties
Name
Type
Required
Restrictions
Description
enabled
boolean
true
none
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
none
RFC3339 datetime. End of time period to retrieve the features drift for. If not set, defaults to the next top of the hour from now.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
none
RFC3339 datetime. Start of time period to retrieve the features drift for. If not set, defaults to 1 week 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
none
The ID of the calendar to be used in this project.
differencingMethod
string¦null
false
none
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
none
Discount factor (alpha) used for exponentially weighted moving features
periodicities
[Periodicity ]¦null
false
none
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
none
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
differencingMethod
none
differencingMethod
simple
differencingMethod
seasonal
treatAsExponential
auto
treatAsExponential
never
treatAsExponential
always
Trigger
{ "schedule" : { "dayOfMonth" : [ "*" ], "dayOfWeek" : [ "*" ], "hour" : [ "*" ], "minute" : [ "*" ], "month" : [ "*" ] }, "statusDeclinesToFailing" : true , "statusDeclinesToWarning" : true , "type" : "schedule" } Properties
Name
Type
Required
Restrictions
Description
schedule
Schedule true
none
Crontab schedule of the retraining policy run.
statusDeclinesToFailing
boolean
true
none
Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to failing.
statusDeclinesToWarning
boolean
true
none
Identifies when trigger type is based on deployment a health status, whether the policy will run when health status declines to warning.
type
string
true
none
Type of retraining policy trigger.
Enumerated Values
Property
Value
type
schedule
type
data_drift_decline
type
accuracy_decline
type
None
ValidationCheck
{ "message" : "string" , "status" : "failing" } Properties
Name
Type
Required
Restrictions
Description
message
string
true
none
Message of the validation check.
status
string
true
none
Status of the validation check.
Enumerated Values
Property
Value
status
failing
status
passing
status
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
none
Whether the replacement model has same segments as the current model in case any of them is segmented model.
containsTrackedSegmentAttributes
ValidationCheck false
none
Whether the currently tracked segment attributes are contained within the replacement model's universe dataset.
driftTracking
ValidationCheck false
none
Whether the replacement model has the necessary info to enable data drift.
featureDataTypes
ValidationCheck false
none
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
none
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
none
Whether the replacement model is compatible with existing humility rules set up on the deployment
modelCanBeDeployed
ValidationCheck false
none
Whether the replacement model can be deployed.
modelStatus
ValidationCheck false
none
Whether the replacement model has finished building.
notCurrentModel
ValidationCheck false
none
Whether the replacement model is the same as the current model.
permission
ValidationCheck false
none
Whether a user has permission to replace the model.
predictionIntervals
ValidationCheck false
none
Whether the replacement model supports prediction intervals.
predictionReady
ValidationCheck false
none
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
none
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
none
Whether model replacement is supported by the deployment.
target
ValidationCheck false
none
Whether the replacement model has the same target name as the current model.
targetClasses
ValidationCheck false
none
Whether the replacement model has the same target class mapping as the current model.
targetType
ValidationCheck false
none
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
none
Time series models cannot replace non-time-series models, and vice versa.
validChallenger
ValidationCheck false
none
Whether the model being replaced can be added as a model challenger if the deployment has challengers enabled.
Updated March 22, 2023
Submit
Thanks for your feedback!
