Skip to content

Click in-app to access the full platform documentation for your version of DataRobot.

Models

This page outlines the operations, endpoints, parameters, and example requests and responses for the Models.

GET /api/v2/customInferenceImages/{imageId}/featureImpact/

Retrieve feature impact scores for features in a custom inference model image.

.. minversion:: v2.23 DEPRECATED: please use version route instead: GET /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/featureImpact/

This route is a counterpart of a corresponding endpoint for native models: GET /api/v2/projects/{projectId}/models/{modelId}/featureImpact/

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customInferenceImages/{imageId}/featureImpact/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
imageId path string true ID of the image of the custom inference model to retrieve feature impact from.

Example responses

200 Response

{
  "count": 0,
  "featureImpacts": [
    {
      "featureName": "string",
      "impactNormalized": 1,
      "impactUnnormalized": 0,
      "redundantWith": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "ranRedundancyDetection": true,
  "rowCount": 0,
  "shapBased": true
}

Responses

Status Meaning Description Schema
200 OK Custom model feature impact returned. FeatureImpactResponse
404 Not Found No feature impact data found for custom model. None
422 Unprocessable Entity Cannot retrieve feature impact scores: (1) if custom model is not an inference model, (2) if training data is not assigned, (3) if feature impact job is in progress for custom model. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customInferenceImages/{imageId}/featureImpact/

Add a request to calculate feature impact for a custom inference model image to the queue.

.. minversion:: v2.23 DEPRECATED: please use version route instead: POST /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/featureImpact/

This route is a counterpart of a corresponding endpoint for native models: POST /api/v2/projects/{projectId}/models/{modelId}/featureImpact/

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/customInferenceImages/{imageId}/featureImpact/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "rowCount": 10
}

Parameters

Name In Type Required Description
imageId path string true ID of the image of the custom inference model to submit feature impact job for.
body body FeatureImpactCreatePayload false none

Example responses

202 Response

{
  "statusId": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Feature impact request has been successfully submitted. FeatureImpactCreateResponse
404 Not Found If feature impact has already been submitted. The response will include jobId property which can be used for tracking its progress. None
422 Unprocessable Entity If job cannot be submitted because of invalid input or model state: (1) if image id does not correspond to a custom inference model, (2) if training data is not yet assigned or assignment is in progress, (3) if the rowCount exceeds the minimum or maximum value for this model's training data. None

Response Headers

Status Header Type Format Description
202 Location string Contains a url for tracking job status: GET /api/v2/status/{statusId}/.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModelDeployments/

List of model deployments for user sorted by creation time descending.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModelDeployments/?offset=0&limit=100 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true This many results will be skipped.
limit query integer true At most this many results are returned.
customModelIds query any false List of ID's of the custom model which model deployments will be retrieved.
environmentIds query any false List of ID's of the execution environment which model deployments will be retrieved.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "customModel": {
        "id": "string",
        "name": "string"
      },
      "customModelImageId": "string",
      "customModelVersion": {
        "id": "string",
        "label": "string"
      },
      "deployed": "string",
      "deployedBy": "string",
      "executionEnvironment": {
        "id": "string",
        "name": "string"
      },
      "executionEnvironmentVersion": {
        "id": "string",
        "label": "string"
      },
      "id": "string",
      "imageType": "customModelImage",
      "label": "string",
      "status": "archived",
      "testingStatus": "not_tested"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK OK. CustomModelDeploymentListResponse
400 Bad Request Query parameters are invalid. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModelLimits/

Retrieve custom model resource limits the user has access to.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModelLimits/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Example responses

200 Response

{
  "desiredCustomModelContainerSize": 134217728,
  "maxCustomModelContainerSize": 134217728,
  "maxCustomModelReplicasPerDeployment": 0,
  "maxCustomModelTestingParallelUsers": 0
}

Responses

Status Meaning Description Schema
200 OK OK. CustomModelResourceLimits

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModelTests/

Retrieve the testing history for a model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModelTests/?offset=0&limit=1000&customModelId=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true This many results will be skipped.
limit query integer true At most this many results are returned.
maximumMemory query integer false The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed
networkEgressPolicy query string false Network egress policy.
desiredMemory query integer false The amount of memory that is expected to be allocated by the custom model.
replicas query integer false A fixed number of replicas that will be set for the given custom-model.
requiresHa query boolean false Require all custom model replicas to be deployed on different Kubernetes nodes for predictions fault tolerance.
customModelId query string true ID of the Custom Model to retrieve testing history for.

Enumerated Values

Parameter Value
networkEgressPolicy NONE
networkEgressPolicy DR_API_ACCESS
networkEgressPolicy PUBLIC

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "completedAt": "string",
      "created": "string",
      "createdBy": "string",
      "customModel": {
        "id": "string",
        "name": "string"
      },
      "customModelImageId": "string",
      "customModelVersion": {
        "id": "string",
        "label": "string"
      },
      "datasetId": "string",
      "datasetVersionId": "string",
      "desiredMemory": 134217728,
      "executionEnvironment": {
        "id": "string",
        "name": "string"
      },
      "executionEnvironmentVersion": {
        "id": "string",
        "label": "string"
      },
      "id": "string",
      "imageType": "customModelImage",
      "maximumMemory": 134217728,
      "networkEgressPolicy": "NONE",
      "overallStatus": "not_tested",
      "replicas": 0,
      "requiresHa": true,
      "testingStatus": {
        "errorCheck": {
          "message": "string",
          "status": "not_tested"
        },
        "longRunningService": {
          "message": "string",
          "status": "not_tested"
        },
        "nullValueImputation": {
          "message": "string",
          "status": "not_tested"
        },
        "sideEffects": {
          "message": "string",
          "status": "not_tested"
        }
      }
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK OK. CustomModelTestsListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customModelTests/

Test a custom inference model. This will start a job to check that the custom model can make predictions against the supplied dataset without breaking.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/customModelTests/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "configuration": {
    "errorCheck": "fail",
    "longRunningService": "fail",
    "nullValueImputation": "skip",
    "sideEffects": "skip"
  },
  "customModelId": "string",
  "customModelVersionId": "string",
  "datasetId": "string",
  "datasetVersionId": "string",
  "desiredMemory": 134217728,
  "environmentId": "string",
  "environmentVersionId": "string",
  "maximumMemory": 134217728,
  "networkEgressPolicy": "NONE",
  "replicas": 0,
  "requiresHa": true
}

Parameters

Name In Type Required Description
body body CustomModelTests false none

Example responses

202 Response

{
  "statusId": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Model testing job successfully started. CustomModelAsyncOperationResponse
403 Forbidden No access to use data for testing custom model. None
404 Not Found Custom model or dataset not found. None
422 Unprocessable Entity Custom Model Testing cannot be submitted because of invalid input or model state: (1) if user does not have permission to create legacy conversion environment, (2) testing is already in progress for the custom model, (3) dataset used for testing is not snapshotted,(4) other cases. None

Response Headers

Status Header Type Format Description
202 Location string 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

DELETE /api/v2/customModelTests/{customModelTestId}/

Cancel custom inference model testing.

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/customModelTests/{customModelTestId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
customModelTestId path string true ID of the testing history attempt.

Responses

Status Meaning Description Schema
204 No Content Testing canceled. None
404 Not Found Testing attempt not found. None
409 Conflict Testing attempt has already reached a terminal state. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModelTests/{customModelTestId}/

Retrieve a specific testing history entry for a custom model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModelTests/{customModelTestId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
customModelTestId path string true ID of the testing history attempt.

Example responses

200 Response

{
  "completedAt": "string",
  "created": "string",
  "createdBy": "string",
  "customModel": {
    "id": "string",
    "name": "string"
  },
  "customModelImageId": "string",
  "customModelVersion": {
    "id": "string",
    "label": "string"
  },
  "datasetId": "string",
  "datasetVersionId": "string",
  "desiredMemory": 134217728,
  "executionEnvironment": {
    "id": "string",
    "name": "string"
  },
  "executionEnvironmentVersion": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "imageType": "customModelImage",
  "maximumMemory": 134217728,
  "networkEgressPolicy": "NONE",
  "overallStatus": "not_tested",
  "replicas": 0,
  "requiresHa": true,
  "testingStatus": {
    "errorCheck": {
      "message": "string",
      "status": "not_tested"
    },
    "longRunningService": {
      "message": "string",
      "status": "not_tested"
    },
    "nullValueImputation": {
      "message": "string",
      "status": "not_tested"
    },
    "sideEffects": {
      "message": "string",
      "status": "not_tested"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK OK. CustomModelTestsResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModelTests/{customModelTestId}/log/

Retrieve the logs from a model testing attempt.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModelTests/{customModelTestId}/log/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
customModelTestId path string true ID of the testing history attempt.

Responses

Status Meaning Description Schema
200 OK The log file will be downloaded. None
404 Not Found No testing log found. None

Response Headers

Status Header Type Format Description
200 Content-Disposition string Contains an auto generated filename for this download ("attachment;filename=testing-.log").

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModelTests/{customModelTestId}/tail/

Retrieve the last N lines of logs from a model testing attempt.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModelTests/{customModelTestId}/tail/?lines=100 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
lines query integer true Number of lines from the log to retrieve (1-1000, default 100).
customModelTestId path string true ID of the testing history attempt.

Example responses

200 Response

{
  "log": "string"
}

Responses

Status Meaning Description Schema
200 OK The log tail was retrieved. CustomModelTestsLogTailResponse
400 Bad Request Requested number of lines is invalid. None
404 Not Found The testing history entry cannot be found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModels/

Retrieve metadata for all custom models the user has access to.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModels/?offset=0&limit=1000 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true This many results will be skipped.
limit query integer true At most this many results are returned.
customModelType query string false If "training" specified, only Custom Training Tasks will be returned. If "inference" specified, only Custom Inference Models will be returned. If not specified, all custom models will be returned. After deprecation, only Custom Inference Models will be returned
isDeployed query string false If "true" specified, only deployed custom models will be returned. If "false" specified, only not deployed custom models will be returned. If not specified, all custom models will be returned.
orderBy query string false Sort order which will be applied to custom model list, valid options are "created", "updated". Prefix the attribute name with a dash to sort in descending order, e.g. orderBy="-created". By default, the orderBy parameter is None which will result in custom models being returned in order of creation time descending.
searchFor query string false String to search for occurrence in custom model's description, language and name. Search is case insensitive. If not specified, all custom models will be returned.

Enumerated Values

Parameter Value
customModelType training
customModelType inference
isDeployed false
isDeployed False
isDeployed true
isDeployed True
orderBy created
orderBy -created
orderBy updated
orderBy -updated

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "calibratePredictions": true,
      "classLabels": [
        "string"
      ],
      "created": "string",
      "createdBy": "string",
      "customModelType": "training",
      "deploymentsCount": 0,
      "description": "string",
      "desiredMemory": 134217728,
      "id": "string",
      "language": "string",
      "latestVersion": {
        "baseEnvironmentId": "string",
        "baseEnvironmentVersionId": "string",
        "created": "string",
        "customModelId": "string",
        "dependencies": [
          {
            "constraints": [
              {
                "constraintType": "<",
                "version": "string"
              }
            ],
            "extras": "string",
            "line": "string",
            "lineNumber": 0,
            "packageName": "string"
          }
        ],
        "description": "string",
        "desiredMemory": 134217728,
        "id": "string",
        "isFrozen": true,
        "items": [
          {
            "commitSha": "string",
            "created": "string",
            "fileName": "string",
            "filePath": "string",
            "fileSource": "string",
            "id": "string",
            "ref": "string",
            "repositoryFilePath": "string",
            "repositoryLocation": "string",
            "repositoryName": "string",
            "storagePath": "string",
            "workspaceId": "string"
          }
        ],
        "label": "string",
        "maximumMemory": 134217728,
        "networkEgressPolicy": "NONE",
        "replicas": 0,
        "requiredMetadata": {},
        "requiredMetadataValues": [
          {
            "fieldName": "string",
            "value": "string"
          }
        ],
        "requiresHa": true,
        "versionMajor": 0,
        "versionMinor": 0
      },
      "maximumMemory": 134217728,
      "name": "string",
      "negativeClassLabel": "string",
      "networkEgressPolicy": "NONE",
      "positiveClassLabel": "string",
      "predictionThreshold": 0,
      "replicas": 0,
      "requiresHa": true,
      "supportsAnomalyDetection": true,
      "supportsBinaryClassification": true,
      "supportsRegression": true,
      "targetName": "string",
      "targetType": "Binary",
      "trainingDataAssignmentInProgress": true,
      "trainingDataFileName": "string",
      "trainingDataPartitionColumn": "string",
      "trainingDatasetId": "string",
      "trainingDatasetVersionId": "string",
      "updated": "string",
      "userProvidedId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK OK. CustomModelListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customModels/

Creates a new custom model and returns the newly created metadata record for it.

All custom models must support at least one target type (binaryClassification, regression). Custom inference models can only support a single target type. A regression model is expected to produce predictions that are arbitrary floating-point or integer numbers. A classification model is expected to return predictions with probability scores for each class. For example, a binary classification model might return:

.. code:: Python

{
    positiveClassLabel: probability,
    negativeClassLabel: 1.0 - probability
}

For Custom Inference Models, the file parameter must be either a tarball or zip archive containing, at minimum, a script named start_server.sh. It may contain additional files, including scripts and precompiled binaries as well as data files. start_server.sh may execute these scripts and/or binaries. When this script is executed, it is run as part of an Environment (specified via subsequent API calls), and all included scripts and binaries can take advantage of any programming language interpreters, compilers, libraries, or other tools included in the Environment. start_server.sh must be marked as executable (chmod +x).

When start_server.sh is launched, it must launch and maintain (in the foreground) a Web server that listens on two URLs:

  • GET $URL_PREFIX/ This route must return a 200 response code with an empty body immediately if the server is ready to respond to prediction requests. Otherwise it should either not accept the request, not respond to the request, or return a 503 response code.
  • POST $URL_PREFIX/predict_no_state/ This route must accept as input a JSON object of the form:

    .. code-block:: Python

    {
        'X': {
            'col1': [...col1_data...],
            'col2': [...col2_data...],
            'col3': [...col3_data...],
            ...
        }
    }
    

    The data lists will all be the same length.

    It must return a JSON object of the form:

    .. code-block:: Python

    {
        'predictions': [...predictions data...]
    }
    

    The predictions data must correspond 1:1 to the rows in the input data lists.

    $URL_PREFIX is provided as an environment variable. The Web server process must re-read its value every time the process starts, as it may change. It is an opaque string that is guaranteed to be a valid URL component, but may contain path separators (/).

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/customModels/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "calibratePredictions": "True",
  "classLabels": [
    "string"
  ],
  "customModelType": "training",
  "description": "string",
  "desiredMemory": 134217728,
  "language": "string",
  "maximumMemory": 134217728,
  "name": "string",
  "negativeClassLabel": "string",
  "networkEgressPolicy": "NONE",
  "positiveClassLabel": "string",
  "predictionThreshold": 0.5,
  "replicas": 0,
  "requiresHa": true,
  "supportsBinaryClassification": true,
  "supportsRegression": true,
  "targetName": "string",
  "targetType": "Binary",
  "userProvidedId": "string"
}

Parameters

Name In Type Required Description
body body CustomModelCreate false none

Example responses

201 Response

{
  "calibratePredictions": true,
  "classLabels": [
    "string"
  ],
  "created": "string",
  "createdBy": "string",
  "customModelType": "training",
  "deploymentsCount": 0,
  "description": "string",
  "desiredMemory": 134217728,
  "id": "string",
  "language": "string",
  "latestVersion": {
    "baseEnvironmentId": "string",
    "baseEnvironmentVersionId": "string",
    "created": "string",
    "customModelId": "string",
    "dependencies": [
      {
        "constraints": [
          {
            "constraintType": "<",
            "version": "string"
          }
        ],
        "extras": "string",
        "line": "string",
        "lineNumber": 0,
        "packageName": "string"
      }
    ],
    "description": "string",
    "desiredMemory": 134217728,
    "id": "string",
    "isFrozen": true,
    "items": [
      {
        "commitSha": "string",
        "created": "string",
        "fileName": "string",
        "filePath": "string",
        "fileSource": "string",
        "id": "string",
        "ref": "string",
        "repositoryFilePath": "string",
        "repositoryLocation": "string",
        "repositoryName": "string",
        "storagePath": "string",
        "workspaceId": "string"
      }
    ],
    "label": "string",
    "maximumMemory": 134217728,
    "networkEgressPolicy": "NONE",
    "replicas": 0,
    "requiredMetadata": {},
    "requiredMetadataValues": [
      {
        "fieldName": "string",
        "value": "string"
      }
    ],
    "requiresHa": true,
    "versionMajor": 0,
    "versionMinor": 0
  },
  "maximumMemory": 134217728,
  "name": "string",
  "negativeClassLabel": "string",
  "networkEgressPolicy": "NONE",
  "positiveClassLabel": "string",
  "predictionThreshold": 0,
  "replicas": 0,
  "requiresHa": true,
  "supportsAnomalyDetection": true,
  "supportsBinaryClassification": true,
  "supportsRegression": true,
  "targetName": "string",
  "targetType": "Binary",
  "trainingDataAssignmentInProgress": true,
  "trainingDataFileName": "string",
  "trainingDataPartitionColumn": "string",
  "trainingDatasetId": "string",
  "trainingDatasetVersionId": "string",
  "updated": "string",
  "userProvidedId": "string"
}

Responses

Status Meaning Description Schema
201 Created Created. CustomModelResponse
403 Forbidden Custom model creation is not enabled. None
422 Unprocessable Entity Input parameters are invalid. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customModels/fromCustomModel/

Creates a copy of the provided custom model, including metadata, versions of that model, and uploaded files. Associates the new versions with files owned by the custom model.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/customModels/fromCustomModel/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "customModelId": "string"
}

Parameters

Name In Type Required Description
body body CustomModelCopy false none

Example responses

201 Response

{
  "calibratePredictions": true,
  "classLabels": [
    "string"
  ],
  "created": "string",
  "createdBy": "string",
  "customModelType": "training",
  "deploymentsCount": 0,
  "description": "string",
  "desiredMemory": 134217728,
  "id": "string",
  "language": "string",
  "latestVersion": {
    "baseEnvironmentId": "string",
    "baseEnvironmentVersionId": "string",
    "created": "string",
    "customModelId": "string",
    "dependencies": [
      {
        "constraints": [
          {
            "constraintType": "<",
            "version": "string"
          }
        ],
        "extras": "string",
        "line": "string",
        "lineNumber": 0,
        "packageName": "string"
      }
    ],
    "description": "string",
    "desiredMemory": 134217728,
    "id": "string",
    "isFrozen": true,
    "items": [
      {
        "commitSha": "string",
        "created": "string",
        "fileName": "string",
        "filePath": "string",
        "fileSource": "string",
        "id": "string",
        "ref": "string",
        "repositoryFilePath": "string",
        "repositoryLocation": "string",
        "repositoryName": "string",
        "storagePath": "string",
        "workspaceId": "string"
      }
    ],
    "label": "string",
    "maximumMemory": 134217728,
    "networkEgressPolicy": "NONE",
    "replicas": 0,
    "requiredMetadata": {},
    "requiredMetadataValues": [
      {
        "fieldName": "string",
        "value": "string"
      }
    ],
    "requiresHa": true,
    "versionMajor": 0,
    "versionMinor": 0
  },
  "maximumMemory": 134217728,
  "name": "string",
  "negativeClassLabel": "string",
  "networkEgressPolicy": "NONE",
  "positiveClassLabel": "string",
  "predictionThreshold": 0,
  "replicas": 0,
  "requiresHa": true,
  "supportsAnomalyDetection": true,
  "supportsBinaryClassification": true,
  "supportsRegression": true,
  "targetName": "string",
  "targetType": "Binary",
  "trainingDataAssignmentInProgress": true,
  "trainingDataFileName": "string",
  "trainingDataPartitionColumn": "string",
  "trainingDatasetId": "string",
  "trainingDatasetVersionId": "string",
  "updated": "string",
  "userProvidedId": "string"
}

Responses

Status Meaning Description Schema
201 Created Successfully created copy. CustomModelResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customModels/predictionExplanationsInitialization/

Create a new prediction explanations initialization for custom model. This is a necessary prerequisite for generating prediction explanations.

.. minversion:: v2.23 DEPRECATED please use custom model version route instead: POST /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/predictionExplanationsInitialization/

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/customModels/predictionExplanationsInitialization/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "customModelId": "string",
  "customModelVersionId": "string",
  "environmentId": "string",
  "environmentVersionId": "string"
}

Parameters

Name In Type Required Description
body body CustomModelPredictionExplanations false none

Responses

Status Meaning Description Schema
202 Accepted The request was accepted and will be worked on. None
422 Unprocessable Entity Specified custom model is not valid for prediction explanations. None

Response Headers

Status Header Type Format Description
202 Location string URL to poll to track the prediction explanation initialization has finished.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/customModels/{customModelId}/

Delete a custom model. Only users who have permission to edit custom model can delete it. Only custom models which are not currently deployed or undergoing custom model testing can be deleted. Relevant CustomModelImage will be deleted also.

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/customModels/{customModelId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.

Responses

Status Meaning Description Schema
204 No Content Record deleted. None
409 Conflict This custom model is currently deployed and cannot be deleted. The response body will contain link where those deployments can be retrieved. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModels/{customModelId}/

Retrieve metadata for a custom model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModels/{customModelId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.

Example responses

200 Response

{
  "calibratePredictions": true,
  "classLabels": [
    "string"
  ],
  "created": "string",
  "createdBy": "string",
  "customModelType": "training",
  "deploymentsCount": 0,
  "description": "string",
  "desiredMemory": 134217728,
  "id": "string",
  "language": "string",
  "latestVersion": {
    "baseEnvironmentId": "string",
    "baseEnvironmentVersionId": "string",
    "created": "string",
    "customModelId": "string",
    "dependencies": [
      {
        "constraints": [
          {
            "constraintType": "<",
            "version": "string"
          }
        ],
        "extras": "string",
        "line": "string",
        "lineNumber": 0,
        "packageName": "string"
      }
    ],
    "description": "string",
    "desiredMemory": 134217728,
    "id": "string",
    "isFrozen": true,
    "items": [
      {
        "commitSha": "string",
        "created": "string",
        "fileName": "string",
        "filePath": "string",
        "fileSource": "string",
        "id": "string",
        "ref": "string",
        "repositoryFilePath": "string",
        "repositoryLocation": "string",
        "repositoryName": "string",
        "storagePath": "string",
        "workspaceId": "string"
      }
    ],
    "label": "string",
    "maximumMemory": 134217728,
    "networkEgressPolicy": "NONE",
    "replicas": 0,
    "requiredMetadata": {},
    "requiredMetadataValues": [
      {
        "fieldName": "string",
        "value": "string"
      }
    ],
    "requiresHa": true,
    "versionMajor": 0,
    "versionMinor": 0
  },
  "maximumMemory": 134217728,
  "name": "string",
  "negativeClassLabel": "string",
  "networkEgressPolicy": "NONE",
  "positiveClassLabel": "string",
  "predictionThreshold": 0,
  "replicas": 0,
  "requiresHa": true,
  "supportsAnomalyDetection": true,
  "supportsBinaryClassification": true,
  "supportsRegression": true,
  "targetName": "string",
  "targetType": "Binary",
  "trainingDataAssignmentInProgress": true,
  "trainingDataFileName": "string",
  "trainingDataPartitionColumn": "string",
  "trainingDatasetId": "string",
  "trainingDatasetVersionId": "string",
  "updated": "string",
  "userProvidedId": "string"
}

Responses

Status Meaning Description Schema
200 OK OK. CustomModelResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/customModels/{customModelId}/

Updates metadata for an existing custom model.

All custom models must support at least one target type (binaryClassification, regression). Custom inference models can only support a single target type.

Setting positiveClassLabel and negativeClassLabel to null will set the labels to their default values (1 and 0 for positiveClassLabel and negativeClassLabel, respectively).

Setting positiveClassLabel, negativeClassLabel, 'targetName` is disabled if model has active deployments or assigned training data.

Code samples

# You can also use wget
curl -X PATCH http://10.97.111.38/api/v2/customModels/{customModelId}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "classLabels": [
    "string"
  ],
  "description": "string",
  "desiredMemory": 134217728,
  "language": "string",
  "maximumMemory": 134217728,
  "name": "string",
  "negativeClassLabel": "string",
  "networkEgressPolicy": "NONE",
  "positiveClassLabel": "string",
  "predictionThreshold": 0.5,
  "replicas": 0,
  "requiresHa": true,
  "targetName": "string"
}

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
body body CustomModelUpdate false none

Example responses

201 Response

{
  "calibratePredictions": true,
  "classLabels": [
    "string"
  ],
  "created": "string",
  "createdBy": "string",
  "customModelType": "training",
  "deploymentsCount": 0,
  "description": "string",
  "desiredMemory": 134217728,
  "id": "string",
  "language": "string",
  "latestVersion": {
    "baseEnvironmentId": "string",
    "baseEnvironmentVersionId": "string",
    "created": "string",
    "customModelId": "string",
    "dependencies": [
      {
        "constraints": [
          {
            "constraintType": "<",
            "version": "string"
          }
        ],
        "extras": "string",
        "line": "string",
        "lineNumber": 0,
        "packageName": "string"
      }
    ],
    "description": "string",
    "desiredMemory": 134217728,
    "id": "string",
    "isFrozen": true,
    "items": [
      {
        "commitSha": "string",
        "created": "string",
        "fileName": "string",
        "filePath": "string",
        "fileSource": "string",
        "id": "string",
        "ref": "string",
        "repositoryFilePath": "string",
        "repositoryLocation": "string",
        "repositoryName": "string",
        "storagePath": "string",
        "workspaceId": "string"
      }
    ],
    "label": "string",
    "maximumMemory": 134217728,
    "networkEgressPolicy": "NONE",
    "replicas": 0,
    "requiredMetadata": {},
    "requiredMetadataValues": [
      {
        "fieldName": "string",
        "value": "string"
      }
    ],
    "requiresHa": true,
    "versionMajor": 0,
    "versionMinor": 0
  },
  "maximumMemory": 134217728,
  "name": "string",
  "negativeClassLabel": "string",
  "networkEgressPolicy": "NONE",
  "positiveClassLabel": "string",
  "predictionThreshold": 0,
  "replicas": 0,
  "requiresHa": true,
  "supportsAnomalyDetection": true,
  "supportsBinaryClassification": true,
  "supportsRegression": true,
  "targetName": "string",
  "targetType": "Binary",
  "trainingDataAssignmentInProgress": true,
  "trainingDataFileName": "string",
  "trainingDataPartitionColumn": "string",
  "trainingDatasetId": "string",
  "trainingDatasetVersionId": "string",
  "updated": "string",
  "userProvidedId": "string"
}

Responses

Status Meaning Description Schema
201 Created Created. CustomModelResponse
403 Forbidden Custom inference model modification is not enabled for the user. None
409 Conflict Custom model cannot be updated while it is being validated or some fields cannot be updated after deployment or assigning training data. None
422 Unprocessable Entity Input parameters are invalid. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModels/{customModelId}/accessControl/

Get a list of users who have access to this custom model and their roles on it.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModels/{customModelId}/accessControl/?offset=0&limit=1000 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true This many results will be skipped.
limit query integer true At most this many results are returned.
customModelId path string true ID of the custom model.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "canShare": true,
      "role": "string",
      "userId": "string",
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK A list of users who have access to this custom model and their roles on it. CustomModelAccessControlListResponse
400 Bad Request Both username and userId were specified. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/customModels/{customModelId}/accessControl/

Grant access or update roles for users on this custom model and appropriate learning data. Up to 100 user roles may be set in a single request.

Code samples

# You can also use wget
curl -X PATCH http://10.97.111.38/api/v2/customModels/{customModelId}/accessControl/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "data": [
    {
      "canShare": true,
      "role": "USER",
      "username": "string"
    }
  ]
}

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
body body SharingUpdateOrRemoveWithGrant false none

Example responses

204 Response

{
  "data": [
    {
      "canShare": true,
      "role": "string",
      "userId": "string",
      "username": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
204 No Content Roles updated successfully. CustomModelAccessControlUpdateResponse
409 Conflict The request would leave the custom model 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

GET /api/v2/customModels/{customModelId}/download/

Download the latest item bundle from a custom model as a zip compressed archive.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModels/{customModelId}/download/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
pps query string false Download model version from PPS tab.If "true" specified, model archive includes dependencies install script. If "false" specified, dependencies script is not included. If not specified -> "false" behavior.
customModelId path string true ID of the custom model.

Enumerated Values

Parameter Value
pps false
pps False
pps true
pps True

Responses

Status Meaning Description Schema
200 OK The download succeeded. None

Response Headers

Status Header Type Format Description
200 Content-Disposition string Contains an auto generated filename for this download ("attachment;filename=model--version-.zip").

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/customModels/{customModelId}/trainingData/

Assigns training data from provided dataset to provided Custom Inference Model. For each of custom model's deployments the training data from the specified project is used as baseline, this will enable turning drift tracking on for those deployments.

Code samples

# You can also use wget
curl -X PATCH http://10.97.111.38/api/v2/customModels/{customModelId}/trainingData/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "datasetId": "string",
  "datasetName": "string",
  "datasetVersionId": "string",
  "partitionColumn": "string"
}

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
body body DeprecatedTrainingDataAssignment false none

Responses

Status Meaning Description Schema
202 Accepted The request was accepted and will be worked on. None
409 Conflict Custom model has assigned training data already and is deployed. None
410 Gone The requested Dataset has been deleted. None
422 Unprocessable Entity Dataset ingest must finish before assigning training data or provided dataset is incompatible with the custom model. None

Response Headers

Status Header Type Format Description
202 Location string URL to poll to track the training data assignment has finished.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModels/{customModelId}/versions/

List custom model versions.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModels/{customModelId}/versions/?offset=0&limit=1000 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true This many results will be skipped.
limit query integer true At most this many results are returned.
mainBranchCommitSha query string false Specifies the commit SHA-1 in GitHub repository from the main branch that corresponds to a given custom model version.
customModelId path string true ID of the custom model.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "baseEnvironmentId": "string",
      "baseEnvironmentVersionId": "string",
      "created": "string",
      "customModelId": "string",
      "dependencies": [
        {
          "constraints": [
            {
              "constraintType": "<",
              "version": "string"
            }
          ],
          "extras": "string",
          "line": "string",
          "lineNumber": 0,
          "packageName": "string"
        }
      ],
      "description": "string",
      "desiredMemory": 134217728,
      "id": "string",
      "isFrozen": true,
      "items": [
        {
          "commitSha": "string",
          "created": "string",
          "fileName": "string",
          "filePath": "string",
          "fileSource": "string",
          "id": "string",
          "ref": "string",
          "repositoryFilePath": "string",
          "repositoryLocation": "string",
          "repositoryName": "string",
          "storagePath": "string",
          "workspaceId": "string"
        }
      ],
      "label": "string",
      "maximumMemory": 134217728,
      "networkEgressPolicy": "NONE",
      "replicas": 0,
      "requiredMetadata": {},
      "requiredMetadataValues": [
        {
          "fieldName": "string",
          "value": "string"
        }
      ],
      "requiresHa": true,
      "versionMajor": 0,
      "versionMinor": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK OK. CustomModelVersionListResponse
400 Bad Request Query parameters are invalid. None
422 Unprocessable Entity Input parameters are invalid. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/customModels/{customModelId}/versions/

Create a new custom model version with files added, replaced or deleted. Files from the previous version of a custom models will be used as a basis.

Code samples

# You can also use wget
curl -X PATCH http://10.97.111.38/api/v2/customModels/{customModelId}/versions/ \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

baseEnvironmentId: string
desiredMemory: 134217728
file: string
filePath: string
filesToDelete: string
isMajorUpdate: "false"
maximumMemory: 134217728
networkEgressPolicy: NONE
replicas: 0
requiredMetadata: string
requiredMetadataValues: string
requiresHa: true

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
body body CustomModelVersionCreateFromLatest false none

Example responses

201 Response

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "created": "string",
  "customModelId": "string",
  "dependencies": [
    {
      "constraints": [
        {
          "constraintType": "<",
          "version": "string"
        }
      ],
      "extras": "string",
      "line": "string",
      "lineNumber": 0,
      "packageName": "string"
    }
  ],
  "description": "string",
  "desiredMemory": 134217728,
  "id": "string",
  "isFrozen": true,
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string",
      "storagePath": "string",
      "workspaceId": "string"
    }
  ],
  "label": "string",
  "maximumMemory": 134217728,
  "networkEgressPolicy": "NONE",
  "replicas": 0,
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ],
  "requiresHa": true,
  "versionMajor": 0,
  "versionMinor": 0
}

Responses

Status Meaning Description Schema
201 Created Item successfully created. CustomModelVersionResponse
413 Payload Too Large Item or collection of items was too large in size (bytes). None
422 Unprocessable Entity Cannot create the custom task version due to one or more errors. All error responses will have a "message" field and some may have optional fields. The optional fields include: ["errors", "dependencies", "invalidDependencies"] None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customModels/{customModelId}/versions/

Create a new custom model version with attached files if supplied.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/customModels/{customModelId}/versions/ \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

baseEnvironmentId: string
baseEnvironmentVersionId: string
desiredMemory: 134217728
file: string
filePath: string
isMajorUpdate: "false"
maximumMemory: 134217728
networkEgressPolicy: NONE
replicas: 0
requiredMetadata: string
requiredMetadataValues: string
requiresHa: true

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
body body CustomModelVersionCreateWithEnvironmentVersion false none

Example responses

201 Response

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "created": "string",
  "customModelId": "string",
  "dependencies": [
    {
      "constraints": [
        {
          "constraintType": "<",
          "version": "string"
        }
      ],
      "extras": "string",
      "line": "string",
      "lineNumber": 0,
      "packageName": "string"
    }
  ],
  "description": "string",
  "desiredMemory": 134217728,
  "id": "string",
  "isFrozen": true,
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string",
      "storagePath": "string",
      "workspaceId": "string"
    }
  ],
  "label": "string",
  "maximumMemory": 134217728,
  "networkEgressPolicy": "NONE",
  "replicas": 0,
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ],
  "requiresHa": true,
  "versionMajor": 0,
  "versionMinor": 0
}

Responses

Status Meaning Description Schema
201 Created Item successfully created. CustomModelVersionResponse
413 Payload Too Large Item or collection of items was too large in size (bytes). None
422 Unprocessable Entity Cannot create the custom task version due to one or more errors. All error responses will have a "message" field and some may have optional fields. The optional fields include: ["errors", "dependencies", "invalidDependencies"] None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/customModels/{customModelId}/versions/fromRepository/

Create a new custom model version with files added from a remote repository. Files from the previous version of a custom models will be used as a basis.

Code samples

# You can also use wget
curl -X PATCH http://10.97.111.38/api/v2/customModels/{customModelId}/versions/fromRepository/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "baseEnvironmentId": "string",
  "isMajorUpdate": true,
  "ref": "string",
  "repositoryId": "string",
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ],
  "sourcePath": "string"
}

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
body body CustomModelVersionCreateFromRepository false none

Responses

Status Meaning Description Schema
202 Accepted Accepted: request placed to a queue for processing. None
422 Unprocessable Entity Custom Model version cannot be created: (1) input parameters are invalid, (2) if user does not have permission to create legacy conversion environment. None

Response Headers

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/customModels/{customModelId}/versions/fromRepository/

Create a new custom model version with only files added from the specified remote repository.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/customModels/{customModelId}/versions/fromRepository/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "baseEnvironmentId": "string",
  "isMajorUpdate": true,
  "ref": "string",
  "repositoryId": "string",
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ],
  "sourcePath": "string"
}

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
body body CustomModelVersionCreateFromRepository false none

Responses

Status Meaning Description Schema
202 Accepted Accepted: request placed to a queue for processing. None
422 Unprocessable Entity Custom Model version cannot be created: (1) input parameters are invalid, (2) if user does not have permission to create legacy conversion environment. None

Response Headers

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/customModels/{customModelId}/versions/{customModelVersionId}/

Display a requested version of a custom model along with the files attached to it.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModels/{customModelId}/versions/{customModelVersionId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
customModelVersionId path string true ID of the custom model version.

Example responses

200 Response

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "created": "string",
  "customModelId": "string",
  "dependencies": [
    {
      "constraints": [
        {
          "constraintType": "<",
          "version": "string"
        }
      ],
      "extras": "string",
      "line": "string",
      "lineNumber": 0,
      "packageName": "string"
    }
  ],
  "description": "string",
  "desiredMemory": 134217728,
  "id": "string",
  "isFrozen": true,
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string",
      "storagePath": "string",
      "workspaceId": "string"
    }
  ],
  "label": "string",
  "maximumMemory": 134217728,
  "networkEgressPolicy": "NONE",
  "replicas": 0,
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ],
  "requiresHa": true,
  "versionMajor": 0,
  "versionMinor": 0
}

Responses

Status Meaning Description Schema
200 OK OK. CustomModelVersionResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/

Edit metadata of a specific model version.

Code samples

# You can also use wget
curl -X PATCH http://10.97.111.38/api/v2/customModels/{customModelId}/versions/{customModelVersionId}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "description": "string",
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ]
}

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
customModelVersionId path string true ID of the custom model version.
body body CustomModelVersionMetadataUpdate false none

Example responses

200 Response

{
  "baseEnvironmentId": "string",
  "baseEnvironmentVersionId": "string",
  "created": "string",
  "customModelId": "string",
  "dependencies": [
    {
      "constraints": [
        {
          "constraintType": "<",
          "version": "string"
        }
      ],
      "extras": "string",
      "line": "string",
      "lineNumber": 0,
      "packageName": "string"
    }
  ],
  "description": "string",
  "desiredMemory": 134217728,
  "id": "string",
  "isFrozen": true,
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string",
      "storagePath": "string",
      "workspaceId": "string"
    }
  ],
  "label": "string",
  "maximumMemory": 134217728,
  "networkEgressPolicy": "NONE",
  "replicas": 0,
  "requiredMetadata": {},
  "requiredMetadataValues": [
    {
      "fieldName": "string",
      "value": "string"
    }
  ],
  "requiresHa": true,
  "versionMajor": 0,
  "versionMinor": 0
}

Responses

Status Meaning Description Schema
200 OK The edit was successful. CustomModelVersionResponse
404 Not Found Custom model not found or user does not have edit permissions. None
422 Unprocessable Entity Cannot update custom model metadata. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/conversions/

Get the list of custom model conversions that are associated with the given custom model. Alternatively, it can return a single item list of the latest custom model conversion that is associated with the given custom model version.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModels/{customModelId}/versions/{customModelVersionId}/conversions/?offset=0&limit=1000 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true This many results will be skipped.
limit query integer true At most this many results are returned.
isLatest query string false Whether to return only the latest associated custom model conversion or all of the associated ones.
customModelId path string true ID of the custom model.
customModelVersionId path string true ID of the custom model version.

Enumerated Values

Parameter Value
isLatest false
isLatest False
isLatest true
isLatest True

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "conversionInProgress": true,
      "conversionSucceeded": true,
      "created": "string",
      "customModelVersionId": "string",
      "generatedMetadata": {
        "outputColumns": [
          [
            "string"
          ]
        ],
        "outputDatasets": [
          "string"
        ]
      },
      "id": "string",
      "logMessage": "string",
      "mainProgramItemId": "string",
      "shouldStop": false
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none ConversionListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/conversions/

Converts files in the given custom model version to a JAR file.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/customModels/{customModelId}/versions/{customModelVersionId}/conversions/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "mainProgramItemId": "string"
}

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
customModelVersionId path string true ID of the custom model version.
body body ConversionCreateQuery false none

Example responses

202 Response

{
  "conversionId": "string",
  "statusId": "string"
}

Responses

Status Meaning Description Schema
202 Accepted The request was accepted and will be worked on. CustomModelConversionAsyncOperationResponse
422 Unprocessable Entity Input parameters are invalid. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/conversions/{conversionId}/

Stop a running conversion for given model and model version.

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/customModels/{customModelId}/versions/{customModelVersionId}/conversions/{conversionId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
customModelVersionId path string true ID of the custom model version.
conversionId path string true ID of the custom model conversion.

Responses

Status Meaning Description Schema
204 No Content none None
422 Unprocessable Entity The given conversion is not active. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/conversions/{conversionId}/

Get a given custom model conversion.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModels/{customModelId}/versions/{customModelVersionId}/conversions/{conversionId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
customModelVersionId path string true ID of the custom model version.
conversionId path string true ID of the custom model conversion.

Example responses

200 Response

{
  "conversionInProgress": true,
  "conversionSucceeded": true,
  "created": "string",
  "customModelVersionId": "string",
  "generatedMetadata": {
    "outputColumns": [
      [
        "string"
      ]
    ],
    "outputDatasets": [
      "string"
    ]
  },
  "id": "string",
  "logMessage": "string",
  "mainProgramItemId": "string",
  "shouldStop": false
}

Responses

Status Meaning Description Schema
200 OK none ConversionResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/dependencyBuild/

Cancel the custom model version's dependency build.

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/customModels/{customModelId}/versions/{customModelVersionId}/dependencyBuild/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
customModelVersionId path string true ID of the custom model version.

Responses

Status Meaning Description Schema
204 No Content Custom model version's dependency build was cancelled. None
409 Conflict Custom model dependency build has reached a terminal state and cannot be cancelled. None
422 Unprocessable Entity No custom model dependency build started for specified version or dependency image is in use and cannot be deleted None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/dependencyBuild/

Retrieve the custom model version's dependency build status.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModels/{customModelId}/versions/{customModelVersionId}/dependencyBuild/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
customModelVersionId path string true ID of the custom model version.

Example responses

200 Response

{
  "buildEnd": "string",
  "buildLogLocation": "http://example.com",
  "buildStart": "string",
  "buildStatus": "submitted"
}

Responses

Status Meaning Description Schema
200 OK The metadata from the custom model version's dependency build. BaseDependencyBuildMetadataResponse
422 Unprocessable Entity Custom model dependency build has not started. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/dependencyBuild/

Start a custom model version's dependency build. This is required to test, deploy, or train custom models.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/customModels/{customModelId}/versions/{customModelVersionId}/dependencyBuild/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
customModelVersionId path string true ID of the custom model version.

Example responses

202 Response

{
  "buildEnd": "string",
  "buildLogLocation": "http://example.com",
  "buildStart": "string",
  "buildStatus": "submitted"
}

Responses

Status Meaning Description Schema
202 Accepted Custom model version's dependency build has started. BaseDependencyBuildMetadataResponse
422 Unprocessable Entity Custom model dependency build has failed. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/dependencyBuildLog/

Retrieve the custom model version's dependency build log.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModels/{customModelId}/versions/{customModelVersionId}/dependencyBuildLog/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
customModelVersionId path string true ID of the custom model version.

Example responses

200 Response

{
  "data": "string"
}

Responses

Status Meaning Description Schema
200 OK The log file generated during the custom model version's dependency build. DependencyBuildLogResponse
404 Not Found Dependency build is in progress or could not be found. None
422 Unprocessable Entity Custom model dependency build has not started. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/download/

Download a specific item bundle from a custom model as a zip compressed archive.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModels/{customModelId}/versions/{customModelVersionId}/download/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
pps query string false Download model version from PPS tab.If "true" specified, model archive includes dependencies install script. If "false" specified, dependencies script is not included. If not specified -> "false" behavior.
customModelId path string true ID of the custom model.
customModelVersionId path string true ID of the custom model version.

Enumerated Values

Parameter Value
pps false
pps False
pps true
pps True

Responses

Status Meaning Description Schema
200 OK The download succeeded. None

Response Headers

Status Header Type Format Description
200 Content-Disposition string Contains an auto generated filename for this download ("attachment;filename=model--version-.zip").

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/featureImpact/

Retrieve feature impact scores for features in a custom inference model image.

This route is a counterpart of a corresponding endpoint for native models: GET /api/v2/projects/{projectId}/models/{modelId}/featureImpact/

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customModels/{customModelId}/versions/{customModelVersionId}/featureImpact/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
customModelVersionId path string true ID of the custom model version.

Example responses

200 Response

{
  "count": 0,
  "featureImpacts": [
    {
      "featureName": "string",
      "impactNormalized": 1,
      "impactUnnormalized": 0,
      "redundantWith": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "ranRedundancyDetection": true,
  "rowCount": 0,
  "shapBased": true
}

Responses

Status Meaning Description Schema
200 OK Custom model feature impact returned. FeatureImpactResponse
404 Not Found No feature impact data found for custom model. None
422 Unprocessable Entity Cannot retrieve feature impact scores: (1) if custom model is not an inference model, (2) if training data is not assigned, (3) if feature impact job is in progress for custom model. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/featureImpact/

Add a request to calculate feature impact for a custom inference model image to the queue.

This route is a counterpart of a corresponding endpoint for native models: POST /api/v2/projects/{projectId}/models/{modelId}/featureImpact/

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/customModels/{customModelId}/versions/{customModelVersionId}/featureImpact/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "rowCount": 10
}

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
customModelVersionId path string true ID of the custom model version.
body body FeatureImpactCreatePayload false none

Example responses

202 Response

{
  "statusId": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Feature impact request has been successfully submitted. FeatureImpactCreateResponse
404 Not Found If feature impact has already been submitted. The response will include jobId property which can be used for tracking its progress. None
422 Unprocessable Entity If job cannot be submitted because of invalid input or model state: (1) if image id does not correspond to a custom inference model, (2) if training data is not yet assigned or assignment is in progress, (3) if the rowCount exceeds the minimum or maximum value for this model's training data. None

Response Headers

Status Header Type Format Description
202 Location string Contains a url for tracking job status: GET /api/v2/status/{statusId}/.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/predictionExplanationsInitialization/

Create a new prediction explanations initialization for custom model version. This is a necessary prerequisite for generating prediction explanations.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/customModels/{customModelId}/versions/{customModelVersionId}/predictionExplanationsInitialization/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
customModelId path string true ID of the custom model.
customModelVersionId path string true ID of the custom model version.

Responses

Status Meaning Description Schema
202 Accepted The request was accepted and will be worked on. None
422 Unprocessable Entity Specified custom model is not valid for prediction explanations. None

Response Headers

Status Header Type Format Description
202 Location string URL to poll to track the prediction explanation initialization has finished.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/customTrainingBlueprints/

List custom training blueprints.

This route retrieves the metadata for all custom training blueprints a user has access to.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/customTrainingBlueprints/?offset=0&limit=1000 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true This many results will be skipped.
limit query integer true At most this many results are returned.
customModelId query string false List blueprints for a specific model. Default: all.
reverse query string false List blueprints in reverse order.
targetTypes query array[string] false Custom model target types to return.

Enumerated Values

Parameter Value
reverse false
reverse False
reverse true
reverse True
targetTypes Binary
targetTypes Regression
targetTypes Multiclass
targetTypes Anomaly
targetTypes Transform
targetTypes Unstructured

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "createdAt": "string",
      "customModel": {
        "id": "string",
        "name": "string"
      },
      "customModelVersion": {
        "id": "string",
        "label": "string"
      },
      "executionEnvironment": {
        "id": "string",
        "name": "string"
      },
      "executionEnvironmentVersion": {
        "id": "string",
        "label": "string"
      },
      "targetType": "Binary",
      "trainingHistory": [
        {
          "creationDate": "string",
          "lid": "string",
          "pid": "string",
          "projectModelsCount": 0,
          "projectName": "string",
          "targetName": "string"
        }
      ],
      "userBlueprintId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Custom training blueprint list returned. CustomTrainingBlueprintListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/customTrainingBlueprints/

This route creates a blueprint from a custom training estimator with an environment so that it can be trained via blueprint ID.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/customTrainingBlueprints/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "customModelVersionId": "string"
}

Parameters

Name In Type Required Description
body body CustomTrainingBlueprintCreate false none

Example responses

201 Response

{
  "createdAt": "string",
  "customModel": {
    "id": "string",
    "name": "string"
  },
  "customModelVersion": {
    "id": "string",
    "label": "string"
  },
  "executionEnvironment": {
    "id": "string",
    "name": "string"
  },
  "executionEnvironmentVersion": {
    "id": "string",
    "label": "string"
  },
  "targetType": "Binary",
  "trainingHistory": [
    {
      "creationDate": "string",
      "lid": "string",
      "pid": "string",
      "projectModelsCount": 0,
      "projectName": "string",
      "targetName": "string"
    }
  ],
  "userBlueprintId": "string"
}

Responses

Status Meaning Description Schema
201 Created Blueprint successfully created. CustomTrainingBlueprintResponse
404 Not Found Any of the entities in the request cannot be retrieved. None
422 Unprocessable Entity Input parameters are invalid: either the custom model is for inference or no environment version ID was specified and the given environment has no versions. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/modelPackages/

Retrieve the list of model packages a user has access to.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/modelPackages/ \
  -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.
modelId query string false If specified, limit results to model packages for the model with the specified ID.
similarTo query string false Return model packages similar to a given model package ID. If used, will only return model packages that match target.name, target.type, target.classNames (for classification models), modelKind.isTimeSeries, and modelKind.isMultiseries of the specified model package.
forChallenger query boolean false Can be used with similarTo to request similar model packages with the intent to use them as challenger models; for external model packages, instead of returning similar external model packages, similar DataRobot and Custom model packages will be retrieved.
search query string false Provide a term to search for in package name, model name, or description
predictionThreshold query number false Prediction threshold used for binary classification models
imported query boolean false If specified, filter for either imported (true) or non-imported (false) model packages
predictionEnvironmentId query string false Can be used to filter packages by what is supported by the prediction environment
modelKind query any false Return models from the registry that match a specific format.
buildStatus query string false If specified, filter model packages by the build status.

Enumerated Values

Parameter Value
buildStatus inProgress
buildStatus complete
buildStatus failed

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "activeDeploymentCount": 0,
      "buildStatus": "inProgress",
      "capabilities": {
        "supportsAutomaticActuals": true,
        "supportsChallengerModels": true,
        "supportsFeatureDriftTracking": true,
        "supportsHumilityRecommendedRules": true,
        "supportsHumilityRules": true,
        "supportsHumilityRulesDefaultCalculations": true,
        "supportsPredictionWarning": true,
        "supportsRetraining": true,
        "supportsScoringCodeDownload": true,
        "supportsSecondaryDatasets": true,
        "supportsSegmentedAnalysisDriftAndAccuracy": true,
        "supportsShapBasedPredictionExplanations": true,
        "supportsTargetDriftTracking": true
      },
      "datasets": {
        "baselineSegmentedBy": [
          "string"
        ],
        "datasetName": "string",
        "holdoutDataCatalogId": "string",
        "holdoutDatasetName": "string",
        "targetHistogramBaseline": "predictions",
        "trainingDataCatalogId": "string",
        "trainingDataSize": 0
      },
      "id": "string",
      "importMeta": {
        "containsFearPipeline": "string",
        "containsFeaturelists": "string",
        "containsLeaderboardMeta": "string",
        "containsProjectMeta": "string",
        "creatorId": "string",
        "creatorUsername": "string",
        "dateCreated": "string",
        "originalFileName": "string"
      },
      "isArchived": true,
      "isDeprecated": true,
      "modelDescription": {
        "buildEnvironmentType": "DataRobot",
        "description": "string",
        "location": "string",
        "modelName": "string"
      },
      "modelExecutionType": "dedicated",
      "modelId": "string",
      "modelKind": {
        "isAnomalyDetectionModel": true,
        "isCombinedModel": true,
        "isDecisionFlow": true,
        "isFeatureDiscovery": true,
        "isMultiseries": true,
        "isTimeSeries": true,
        "isUnsupervisedLearning": true
      },
      "name": "string",
      "permissions": [
        "string"
      ],
      "sourceMeta": {
        "decisionFlowId": "string",
        "decisionFlowVersionId": "string",
        "environmentUrl": "http://example.com",
        "projectId": "string",
        "projectName": "string",
        "scoringCode": {
          "dataRobotPredictionVersion": "string",
          "location": "local_leaderboard"
        }
      },
      "target": {
        "classCount": 0,
        "classNames": [
          "string"
        ],
        "name": "string",
        "predictionProbabilitiesColumn": "string",
        "predictionThreshold": 1,
        "type": "Binary"
      },
      "timeseries": {
        "datetimeColumnFormat": "string",
        "datetimeColumnName": "string",
        "effectiveFeatureDerivationWindowEnd": 0,
        "effectiveFeatureDerivationWindowStart": 0,
        "featureDerivationWindowEnd": 0,
        "featureDerivationWindowStart": 0,
        "forecastDistanceColumnName": "string",
        "forecastDistances": [
          0
        ],
        "forecastDistancesTimeUnit": "MICROSECOND",
        "forecastPointColumnName": "string",
        "isCrossSeries": true,
        "isNewSeriesSupport": true,
        "isTraditionalTimeSeries": true,
        "seriesColumnName": "string"
      },
      "userProvidedId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none ModelPackageListResponse
400 Bad Request Request invalid, refer to messages for detail. None
403 Forbidden Either MMM Model Packages or New Model Registry are not enabled. None
404 Not Found User permissions problem. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/modelPackages/fromLearningModel/

Create model package from DataRobot model.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/modelPackages/fromLearningModel/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "modelId": "string",
  "name": null,
  "predictionThreshold": 1
}

Parameters

Name In Type Required Description
body body ModelPackageCreateFromLearningModel false none

Responses

Status Meaning Description Schema
201 Created none None
403 Forbidden The user does not have permission to create a Model Package. None
404 Not Found Either the model_id not exist or the user does not have permission to view the model and project. None
422 Unprocessable Entity Unable to process the Model Package creation request. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/modelPackages/{modelPackageId}/

Retrieve info about a model package.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/modelPackages/{modelPackageId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
modelPackageId path string true ID of the model package.

Example responses

200 Response

{
  "activeDeploymentCount": 0,
  "buildStatus": "inProgress",
  "capabilities": {
    "supportsAutomaticActuals": true,
    "supportsChallengerModels": true,
    "supportsFeatureDriftTracking": true,
    "supportsHumilityRecommendedRules": true,
    "supportsHumilityRules": true,
    "supportsHumilityRulesDefaultCalculations": true,
    "supportsPredictionWarning": true,
    "supportsRetraining": true,
    "supportsScoringCodeDownload": true,
    "supportsSecondaryDatasets": true,
    "supportsSegmentedAnalysisDriftAndAccuracy": true,
    "supportsShapBasedPredictionExplanations": true,
    "supportsTargetDriftTracking": true
  },
  "datasets": {
    "baselineSegmentedBy": [
      "string"
    ],
    "datasetName": "string",
    "holdoutDataCatalogId": "string",
    "holdoutDatasetName": "string",
    "targetHistogramBaseline": "predictions",
    "trainingDataCatalogId": "string",
    "trainingDataSize": 0
  },
  "id": "string",
  "importMeta": {
    "containsFearPipeline": "string",
    "containsFeaturelists": "string",
    "containsLeaderboardMeta": "string",
    "containsProjectMeta": "string",
    "creatorId": "string",
    "creatorUsername": "string",
    "dateCreated": "string",
    "originalFileName": "string"
  },
  "isArchived": true,
  "isDeprecated": true,
  "modelDescription": {
    "buildEnvironmentType": "DataRobot",
    "description": "string",
    "location": "string",
    "modelName": "string"
  },
  "modelExecutionType": "dedicated",
  "modelId": "string",
  "modelKind": {
    "isAnomalyDetectionModel": true,
    "isCombinedModel": true,
    "isDecisionFlow": true,
    "isFeatureDiscovery": true,
    "isMultiseries": true,
    "isTimeSeries": true,
    "isUnsupervisedLearning": true
  },
  "name": "string",
  "permissions": [
    "string"
  ],
  "sourceMeta": {
    "decisionFlowId": "string",
    "decisionFlowVersionId": "string",
    "environmentUrl": "http://example.com",
    "projectId": "string",
    "projectName": "string",
    "scoringCode": {
      "dataRobotPredictionVersion": "string",
      "location": "local_leaderboard"
    }
  },
  "target": {
    "classCount": 0,
    "classNames": [
      "string"
    ],
    "name": "string",
    "predictionProbabilitiesColumn": "string",
    "predictionThreshold": 1,
    "type": "Binary"
  },
  "timeseries": {
    "datetimeColumnFormat": "string",
    "datetimeColumnName": "string",
    "effectiveFeatureDerivationWindowEnd": 0,
    "effectiveFeatureDerivationWindowStart": 0,
    "featureDerivationWindowEnd": 0,
    "featureDerivationWindowStart": 0,
    "forecastDistanceColumnName": "string",
    "forecastDistances": [
      0
    ],
    "forecastDistancesTimeUnit": "MICROSECOND",
    "forecastPointColumnName": "string",
    "isCrossSeries": true,
    "isNewSeriesSupport": true,
    "isTraditionalTimeSeries": true,
    "seriesColumnName": "string"
  },
  "userProvidedId": "string"
}

Responses

Status Meaning Description Schema
200 OK none ModelPackageRetrieveResponse
404 Not Found Either the model package does not exist or the user does not have permission to view the model package. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/modelPackages/{modelPackageId}/archive/

Permanently archive a model package. It will no longer be able to be used in new deployments or replacement. It will not be accessible in the model package list api. It will only be accessible at the model package retrieve route for this model package.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/modelPackages/{modelPackageId}/archive/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
modelPackageId path string true ID of the model package.

Responses

Status Meaning Description Schema
204 No Content none None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/modelPackages/{modelPackageId}/capabilities/

Retrieve the capabilities for the model package.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/modelPackages/{modelPackageId}/capabilities/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
modelPackageId path string true ID of the model package.

Example responses

200 Response

{
  "data": [
    {
      "messages": [
        "string"
      ],
      "name": "string",
      "supported": true
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none ModelPackageCapabilitiesRetrieveResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/modelPackages/{modelPackageId}/features/

Retrieve the feature list for given model package.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/modelPackages/{modelPackageId}/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.
orderBy query string false Sort order which will be applied to model package feature list. Prefix the attribute name with a dash to sort in descending order, e.g. "-name".
modelPackageId path string true ID of the model package.

Enumerated Values

Parameter Value
includeNonPredictionFeatures false
includeNonPredictionFeatures False
includeNonPredictionFeatures true
includeNonPredictionFeatures True
forSegmentedAnalysis false
forSegmentedAnalysis False
forSegmentedAnalysis true
forSegmentedAnalysis True
orderBy name
orderBy -name
orderBy importance
orderBy -importance
orderBy featureType
orderBy -featureType
orderBy dateFormat
orderBy -dateFormat
orderBy knownInAdvance
orderBy -knownInAdvance

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

Status Meaning Description Schema
200 OK OK. FeatureListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/modelPackages/{modelPackageId}/sharedRoles/

Get a list of users, groups and organizations who have access to this template and their roles on the template.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/modelPackages/{modelPackageId}/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.
modelPackageId path string true ID of the model package.

Enumerated Values

Parameter Value
shareRecipientType user
shareRecipientType group
shareRecipientType organization

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "USER",
      "shareRecipientType": "user"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK The model package's access control list. SharingListV2Response
404 Not Found Either the Model Package does not exist or the user does not have permissions to view the Model Package. None
422 Unprocessable Entity Both username and userId were specified None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/biasMitigatedModels/

List of bias mitigated models for the selected project.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/biasMitigatedModels/ \
  -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.
parentModelId query string false Retrieve a list of mitigated models for the parent model if specified. Otherwise retrieve a list of all mitigated models for the project.
projectId path string true The project ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "biasMitigationTechnique": "preprocessingReweighing",
      "includeBiasMitigationFeatureAsPredictorVariable": true,
      "modelId": "string",
      "parentModelId": "string",
      "protectedFeature": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Returns Bias Mitigated models results. BiasMitigatedModelsListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/biasMitigatedModels/

Add a request to the queue to train a model with bias mitigation applied. If the job has been previously submitted, the request will return the jobId of the previously submitted job. Use this jobId to check status of the previously submitted job.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/biasMitigatedModels/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "biasMitigationFeature": "string",
  "biasMitigationParentLid": "string",
  "biasMitigationTechnique": "preprocessingReweighing",
  "includeBiasMitigationFeatureAsPredictorVariable": true
}

Parameters

Name In Type Required Description
projectId path string true The project ID
body body BiasMitigationModelCreate false none

Responses

Status Meaning Description Schema
202 Accepted The model training request has been successfully submitted. See Location header. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/biasMitigationFeatureInfo/

Get bias mitigation data quality information for a given projectId and featureName.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/biasMitigationFeatureInfo/?featureName=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
featureName query string true Name of feature for mitigation info.
projectId path string true The project ID

Example responses

200 Response

{
  "messages": [
    {
      "additionalInfo": [
        "string"
      ],
      "messageLevel": "WARNING",
      "messageText": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Dictionary with one entry ("messages") with list of data quality information about a feature. MessagesInfo

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/biasMitigationFeatureInfo/{featureName}/

Submit a job to create bias mitigation data quality information for a given projectId and featureName.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/biasMitigationFeatureInfo/{featureName}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
featureName path string true Name of feature for mitigation info.

Responses

Status Meaning Description Schema
202 Accepted A URI of the newly submitted job in the "Location" header. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/blenderModels/

List all blenders in a project.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/blenderModels/?offset=0&limit=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true This many results will be skipped.
limit query integer true At most this many results are returned. If 0, all results.
projectId path string true The project ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "blenderMethod": "string",
      "blueprintId": "string",
      "featurelistId": "string",
      "featurelistName": "string",
      "id": "string",
      "isFrozen": true,
      "isStarred": true,
      "linkFunction": "string",
      "metrics": "\n        {\n            \"metrics\": {\n                \"RMSE\": {\n                    \"holdout\": 5000,\n                    \"validation\": 5100,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"crossValidation\": 6000,\n                    \"training\": null\n                },\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"crossValidation\": 0.50166,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"training\": null\n                },\n            }\n        }\n",
      "modelCategory": "model",
      "modelFamily": "string",
      "modelIds": [
        "string"
      ],
      "modelNumber": 0,
      "modelType": "string",
      "monotonicDecreasingFeaturelistId": "string",
      "monotonicIncreasingFeaturelistId": "string",
      "parentModelId": "string",
      "predictionThreshold": 1,
      "predictionThresholdReadOnly": true,
      "processes": [
        "string"
      ],
      "projectId": "string",
      "samplePct": 0,
      "supportsComposableMl": true,
      "supportsMonotonicConstraints": true,
      "trainingDuration": "string",
      "trainingEndDate": "2019-08-24T14:15:22Z",
      "trainingRowCount": 0,
      "trainingStartDate": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK A list of all of the blenders in a project. BlenderListResponse
404 Not Found This resource does not exist. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/blenderModels/

Create a blender from other models using a specified blender method. Note: Time Series projects only allow the following blender methods: "AVG", "MED", "FORECAST_DISTANCE_ENET", and "FORECAST_DISTANCE_AVG".

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/blenderModels/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "blenderMethod": "PLS",
  "modelIds": [
    "string"
  ]
}

Parameters

Name In Type Required Description
projectId path string true The project ID
body body BlenderCreate false none

Responses

Status Meaning Description Schema
202 Accepted Model job successfully added to queue. See the Location header. None
404 Not Found This resource does not exist. None
422 Unprocessable Entity Unable to create a blender or request is not supported in this context. None

Response Headers

Status Header Type Format Description
202 Location string url A url that can be polled to check the status of the job.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/blenderModels/blendCheck/

Check if models can be blended.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/blenderModels/blendCheck/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "blenderMethod": "PLS",
  "modelIds": [
    "string"
  ]
}

Parameters

Name In Type Required Description
projectId path string true The project ID
body body BlenderCreate false none

Example responses

200 Response

{
  "blendable": true,
  "reason": "string"
}

Responses

Status Meaning Description Schema
200 OK Information on whether models can be blended and why. BlenderInfoRetrieveResponse
404 Not Found This resource does not exist. None
422 Unprocessable Entity Unable to process request. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/blenderModels/{modelId}/

Retrieve a blender. Blenders are a special type of models, so the response includes all attributes that would be in a response to GET /api/v2/projects/{projectId}/models/{modelId}/ as well as some additional ones.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/blenderModels/{modelId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "blenderMethod": "string",
  "blueprintId": "string",
  "featurelistId": "string",
  "featurelistName": "string",
  "id": "string",
  "isFrozen": true,
  "isStarred": true,
  "linkFunction": "string",
  "metrics": "\n        {\n            \"metrics\": {\n                \"RMSE\": {\n                    \"holdout\": 5000,\n                    \"validation\": 5100,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"crossValidation\": 6000,\n                    \"training\": null\n                },\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"crossValidation\": 0.50166,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"training\": null\n                },\n            }\n        }\n",
  "modelCategory": "model",
  "modelFamily": "string",
  "modelIds": [
    "string"
  ],
  "modelNumber": 0,
  "modelType": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "parentModelId": "string",
  "predictionThreshold": 1,
  "predictionThresholdReadOnly": true,
  "processes": [
    "string"
  ],
  "projectId": "string",
  "samplePct": 0,
  "supportsComposableMl": true,
  "supportsMonotonicConstraints": true,
  "trainingDuration": "string",
  "trainingEndDate": "2019-08-24T14:15:22Z",
  "trainingRowCount": 0,
  "trainingStartDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK The blender model. BlenderRetrieveResponse
404 Not Found Specified blender not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/combinedModels/

Retrieve all existing combined models for this project. .. note::

To retrieve information on the segments for a combined model, retrieve the combined model using [GET /api/v2/projects/{projectId}/combinedModels/{combinedModelId}/][get-apiv2projectsprojectidcombinedmodelscombinedmodelid]

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/combinedModels/ \
  -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.
projectId path string true The project ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "combinedModelId": "string",
      "isActiveCombinedModel": false,
      "modelCategory": "combined",
      "projectId": "string",
      "segmentationTaskId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none CombinedModelListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/combinedModels/{combinedModelId}/

Retrieve an existing combined model. If available, contains information on which champion model is used for each segment.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/combinedModels/{combinedModelId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The ID of the project.
combinedModelId path string true The ID of combined model.

Example responses

200 Response

{
  "combinedModelId": "string",
  "isActiveCombinedModel": false,
  "modelCategory": "combined",
  "projectId": "string",
  "segmentationTaskId": "string",
  "segments": [
    {
      "modelId": "string",
      "projectId": "string",
      "segment": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none CombinedModelResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/combinedModels/{combinedModelId}/segments/

Retrieve Combined Model segments info (name, related project & model details).

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/combinedModels/{combinedModelId}/segments/ \
  -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.
searchSegmentName query string false Case insensitive search against segment name.
projectId path string true The ID of the project.
combinedModelId path string true The ID of combined model.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "autopilotDone": true,
      "holdoutUnlocked": true,
      "isFrozen": true,
      "modelAssignedBy": "string",
      "modelAwardTime": "2019-08-24T14:15:22Z",
      "modelCount": 0,
      "modelIcon": [
        0
      ],
      "modelId": "string",
      "modelMetrics": "\n        {\n            \"metrics\": {\n                \"RMSE\": {\n                    \"holdout\": 5000,\n                    \"validation\": 5100,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"crossValidation\": 6000,\n                    \"training\": null\n                },\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"crossValidation\": 0.50166,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"training\": null\n                },\n            }\n        }\n",
      "modelType": "string",
      "projectId": "string",
      "projectPaused": true,
      "projectStage": "modeling",
      "projectStageDescription": "string",
      "projectStatusError": "string",
      "rowCount": 0,
      "rowPercentage": 0,
      "segment": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none CombinedModelSegmentsPaginatedResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/combinedModels/{combinedModelId}/segments/download/

Download Combined Model segments info (name, related project & model details) as a CSV.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/combinedModels/{combinedModelId}/segments/download/ \
  -H 'Accept: text/csv' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The ID of the project.
combinedModelId path string true The ID of combined model.

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK none string

Response Headers

Status Header Type Format Description
200 Content-Disposition string Contains an auto generated filename for this download.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/

List all the models from a datetime partitioned project.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/ \
  -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.
bulkOperationId query string false the ID of the bulk model operation. If specified, only models submitted in scope of this operation will be shown.
projectId path string true The project ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "backtests": [
        {
          "index": 0,
          "score": 0,
          "status": "COMPLETED",
          "trainingDuration": "string",
          "trainingEndDate": "2019-08-24T14:15:22Z",
          "trainingRowCount": 0,
          "trainingStartDate": "2019-08-24T14:15:22Z"
        }
      ],
      "blueprintId": "string",
      "dataSelectionMethod": "duration",
      "effectiveFeatureDerivationWindowEnd": 0,
      "effectiveFeatureDerivationWindowStart": 0,
      "featurelistId": "string",
      "featurelistName": "string",
      "forecastWindowEnd": 0,
      "forecastWindowStart": 0,
      "holdoutScore": 0,
      "holdoutStatus": "COMPLETED",
      "id": "string",
      "isFrozen": true,
      "isStarred": true,
      "linkFunction": "string",
      "metrics": "\n        {\n            \"metrics\": {\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"backtesting\": 0.50166,\n                    \"backtestingScores\": [0.51206, 0.49436, null, 0.62516],\n                    \"crossValidation\": null\n                },\n                \"RMSE\": {\n                    \"holdout\": null,\n                    \"validation\": 21.0836,\n                    \"backtesting\": 23.361932,\n                    \"backtestingScores\": [0.4403, 0.4213, null, 0.5132],\n                    \"crossValidation\": null\n                }\n            }\n        }\n",
      "modelCategory": "model",
      "modelFamily": "string",
      "modelNumber": 0,
      "modelType": "string",
      "monotonicDecreasingFeaturelistId": "string",
      "monotonicIncreasingFeaturelistId": "string",
      "parentModelId": "string",
      "predictionThreshold": 1,
      "predictionThresholdReadOnly": true,
      "processes": [
        "string"
      ],
      "projectId": "string",
      "samplePct": null,
      "samplingMethod": "random",
      "supportsComposableMl": true,
      "supportsMonotonicConstraints": true,
      "timeWindowSamplePct": 0,
      "trainingDuration": "string",
      "trainingEndDate": "2019-08-24T14:15:22Z",
      "trainingInfo": {
        "holdoutTrainingDuration": "string",
        "holdoutTrainingEndDate": "2019-08-24T14:15:22Z",
        "holdoutTrainingRowCount": 0,
        "holdoutTrainingStartDate": "2019-08-24T14:15:22Z",
        "predictionTrainingDuration": "string",
        "predictionTrainingEndDate": "2019-08-24T14:15:22Z",
        "predictionTrainingRowCount": 0,
        "predictionTrainingStartDate": "2019-08-24T14:15:22Z"
      },
      "trainingRowCount": 0,
      "trainingStartDate": "2019-08-24T14:15:22Z",
      "windowsBasisUnit": "MILLISECOND"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK The datetime partitioned project's models DatetimeModelsResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/datetimeModels/

Train a new datetime model.

All durations and datetimes should be specified in accordance with the :ref:timestamp and duration formatting rules<time_format>.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "blueprintId": "string",
  "featurelistId": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "nClusters": 2,
  "samplingMethod": "random",
  "sourceProjectId": "string",
  "timeWindowSamplePct": 0,
  "trainingDuration": "string",
  "trainingRowCount": 0,
  "useProjectSettings": true
}

Parameters

Name In Type Required Description
projectId path string true The project ID
body body TrainDatetimeModel false none

Example responses

202 Response

{
  "message": "string"
}

Responses

Status Meaning Description Schema
202 Accepted The model has been successfully submitted. DatetimeModelSubmissionResponse
422 Unprocessable Entity There was an error submitting the specified job. See the message field for more details. None

Response Headers

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

POST /api/v2/projects/{projectId}/datetimeModels/fromModel/

Retrain an existing datetime model using a new training period for the model training set (with optional time window sampling) or different feature list.

All durations and datetimes should be specified in accordance with the :ref:timestamp and duration formatting rules<time_format>.

Note that only one of trainingDuration or trainingRowCount or trainingStartDate and trainingEndDate should be specified. If trainingStartDate and trainingEndDate are specified, the source model must be frozen.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/fromModel/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "featurelistId": "string",
  "modelId": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "nClusters": 2,
  "samplingMethod": "random",
  "timeWindowSamplePct": 0,
  "trainingDuration": "string",
  "trainingEndDate": "2019-08-24T14:15:22Z",
  "trainingRowCount": 0,
  "trainingStartDate": "2019-08-24T14:15:22Z",
  "useProjectSettings": true
}

Parameters

Name In Type Required Description
projectId path string true The project ID
body body RetrainDatetimeModel false none

Example responses

202 Response

{
  "message": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Retrain an existing datetime model using a new sample size and/or feature list. DatetimeModelSubmissionResponse
403 Forbidden User does not have permissions to manage models. None
404 Not Found Model with specified modelId doesn't exist, or user does not have access to the project. None
422 Unprocessable Entity Model with specified modelId is deprecated, or it doesn't support retraining with specified parameters. None

Response Headers

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/projects/{projectId}/datetimeModels/{modelId}/

Look up a particular datetime model All durations and datetimes are specified in accordance with :ref:timestamp and duration formatting rules <time_format>.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "backtests": [
    {
      "index": 0,
      "score": 0,
      "status": "COMPLETED",
      "trainingDuration": "string",
      "trainingEndDate": "2019-08-24T14:15:22Z",
      "trainingRowCount": 0,
      "trainingStartDate": "2019-08-24T14:15:22Z"
    }
  ],
  "blueprintId": "string",
  "dataSelectionMethod": "duration",
  "effectiveFeatureDerivationWindowEnd": 0,
  "effectiveFeatureDerivationWindowStart": 0,
  "featurelistId": "string",
  "featurelistName": "string",
  "forecastWindowEnd": 0,
  "forecastWindowStart": 0,
  "holdoutScore": 0,
  "holdoutStatus": "COMPLETED",
  "id": "string",
  "isFrozen": true,
  "isStarred": true,
  "linkFunction": "string",
  "metrics": "\n        {\n            \"metrics\": {\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"backtesting\": 0.50166,\n                    \"backtestingScores\": [0.51206, 0.49436, null, 0.62516],\n                    \"crossValidation\": null\n                },\n                \"RMSE\": {\n                    \"holdout\": null,\n                    \"validation\": 21.0836,\n                    \"backtesting\": 23.361932,\n                    \"backtestingScores\": [0.4403, 0.4213, null, 0.5132],\n                    \"crossValidation\": null\n                }\n            }\n        }\n",
  "modelCategory": "model",
  "modelFamily": "string",
  "modelNumber": 0,
  "modelType": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "parentModelId": "string",
  "predictionThreshold": 1,
  "predictionThresholdReadOnly": true,
  "processes": [
    "string"
  ],
  "projectId": "string",
  "samplePct": null,
  "samplingMethod": "random",
  "supportsComposableMl": true,
  "supportsMonotonicConstraints": true,
  "timeWindowSamplePct": 0,
  "trainingDuration": "string",
  "trainingEndDate": "2019-08-24T14:15:22Z",
  "trainingInfo": {
    "holdoutTrainingDuration": "string",
    "holdoutTrainingEndDate": "2019-08-24T14:15:22Z",
    "holdoutTrainingRowCount": 0,
    "holdoutTrainingStartDate": "2019-08-24T14:15:22Z",
    "predictionTrainingDuration": "string",
    "predictionTrainingEndDate": "2019-08-24T14:15:22Z",
    "predictionTrainingRowCount": 0,
    "predictionTrainingStartDate": "2019-08-24T14:15:22Z"
  },
  "trainingRowCount": 0,
  "trainingStartDate": "2019-08-24T14:15:22Z",
  "windowsBasisUnit": "MILLISECOND"
}

Responses

Status Meaning Description Schema
200 OK Datetime model DatetimeModelDetailsResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/datetimeModels/{modelId}/backtests/

Score all the available backtests of a datetime model.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/backtests/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Responses

Status Meaning Description Schema
202 Accepted Scoring of all the available backtests of a datetime model has been successfully requested. None

Response Headers

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

POST /api/v2/projects/{projectId}/deploymentReadyModels/

Prepare a specific model for deployment. This model will go through the recommendation stages.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/deploymentReadyModels/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "modelId": "string"
}

Parameters

Name In Type Required Description
projectId path string true The project ID
body body PrepareForDeployment false none

Responses

Status Meaning Description Schema
201 Created Start preparing the model for deployment. None
422 Unprocessable Entity An error occurred when submitting the model job None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/eureqaDistributionPlot/{solutionId}/

Retrieve Eureqa model details plot.

Available for classification projects only

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/eureqaDistributionPlot/{solutionId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
solutionId path string true The ID of the solution to return data for.

Example responses

200 Response

{
  "bins": [
    {
      "binEnd": 0,
      "binStart": 0,
      "negatives": 0,
      "positives": 0
    }
  ],
  "complexity": 0,
  "error": 0,
  "errorMetric": "string",
  "eureqaSolutionId": "string",
  "expression": "string",
  "expressionAnnotated": "string",
  "threshold": 0
}

Responses

Status Meaning Description Schema
200 OK Eureqa model details plot. EureqaDistributionDetailResponse
404 Not Found Data was not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/eureqaModelDetail/{solutionId}/

Retrieve Eureqa model details plot.

Available for regression projects only

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/eureqaModelDetail/{solutionId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
solutionId path string true The ID of the solution to return data for.

Example responses

200 Response

{
  "complexity": 0,
  "error": 0,
  "errorMetric": "string",
  "eureqaSolutionId": "string",
  "expression": "string",
  "expressionAnnotated": "string",
  "plotData": [
    {
      "actual": 0,
      "predicted": 0,
      "row": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Eureqa model details plot. EureqaModelDetailResponse
404 Not Found Data was not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/eureqaModels/

Create a new model from an existing eureqa solution.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/eureqaModels/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "parentModelId": "string",
  "solutionId": "string"
}

Parameters

Name In Type Required Description
projectId path string true The project ID
body body EureqaLeaderboardEntryPayload false none

Responses

Status Meaning Description Schema
200 OK Request accepted, creation is underway. None
404 Not Found Data not found. None
422 Unprocessable Entity Model for this solution already exists. None

Response Headers

Status Header Type Format Description
200 Location string The location at which the new model can be retrieved.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/eureqaModels/{modelId}/

Retrieve the pareto front for the specified Eureqa model.

Only the best solution in the pareto front will have a corresponding model initially. Models can be created for other solutions using POST /api/v2/projects/{projectId}/eureqaModels/.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/eureqaModels/{modelId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "errorMetric": "string",
  "hyperparameters": {
    "buildingBlocks": {},
    "errorMetric": "string",
    "maxGenerations": 32,
    "numThreads": 0,
    "priorSolutions": [
      "string"
    ],
    "randomSeed": 0,
    "splitMode": "custom",
    "syncMigrations": true,
    "targetExpressionFormat": "None",
    "targetExpressionString": "string",
    "timeoutSec": 0,
    "trainingFraction": 1,
    "trainingSplitExpr": "string",
    "validationFraction": 1,
    "validationSplitExpr": "string",
    "weightExpr": "string"
  },
  "projectId": "string",
  "solutions": [
    {
      "bestModel": true,
      "complexity": 0,
      "error": 0,
      "eureqaSolutionId": "string",
      "expression": "string",
      "expressionAnnotated": "string"
    }
  ],
  "targetType": "Regression"
}

Responses

Status Meaning Description Schema
200 OK Pareto front for the Eureqa model. ParetoFrontResponse
404 Not Found Data was not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/frozenDatetimeModels/

Train a frozen datetime model. If no training data is specified, the frozen datetime model will be trained on the most recent data using an amount of data that is equivalent to the original model. However, if the equivalent duration does not provide enough rows for training, then the duration will be extended until the minimum is met. Note that this will require the holdout of the project to be unlocked.

All durations and datetimes should be specified in accordance with the :ref:timestamp and duration formatting rules<time_format>.

Note that only one of trainingDuration, trainingRowCount, trainingStartDate and trainingEndDate, or useProjectSettings may be specified.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/frozenDatetimeModels/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "modelId": "string",
  "samplingMethod": "random",
  "timeWindowSamplePct": 0,
  "trainingDuration": "string",
  "trainingEndDate": "2019-08-24T14:15:22Z",
  "trainingRowCount": 0,
  "trainingStartDate": "2019-08-24T14:15:22Z",
  "useProjectSettings": true
}

Parameters

Name In Type Required Description
projectId path string true The project ID
body body TrainDatetimeFrozenModel false none

Example responses

202 Response

{
  "message": "string"
}

Responses

Status Meaning Description Schema
202 Accepted The model has been successfully submitted. DatetimeModelSubmissionResponse
403 Forbidden User does not have permissions to manage models. None
404 Not Found Model with specified modelId does not exist, or user does not have access to the project. None
422 Unprocessable Entity Model with specified modelId is deprecated, or it does not support retraining with specified parameters. None

Response Headers

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/projects/{projectId}/frozenModels/

List all frozen models from a project.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/frozenModels/?offset=0&limit=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true This many results will be skipped.
limit query integer true At most this many results are returned. If 0, all results.
withMetric query string false If specified, the returned models will only have scores for this metric. If not, all metrics will be included.
projectId path string true The project ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "blueprintId": "string",
      "featurelistId": "string",
      "featurelistName": "string",
      "id": "string",
      "isFrozen": true,
      "isStarred": true,
      "linkFunction": "string",
      "metrics": "\n        {\n            \"metrics\": {\n                \"RMSE\": {\n                    \"holdout\": 5000,\n                    \"validation\": 5100,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"crossValidation\": 6000,\n                    \"training\": null\n                },\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"crossValidation\": 0.50166,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"training\": null\n                },\n            }\n        }\n",
      "modelCategory": "model",
      "modelFamily": "string",
      "modelNumber": 0,
      "modelType": "string",
      "monotonicDecreasingFeaturelistId": "string",
      "monotonicIncreasingFeaturelistId": "string",
      "parentModelId": "string",
      "predictionThreshold": 1,
      "predictionThresholdReadOnly": true,
      "processes": [
        "string"
      ],
      "projectId": "string",
      "samplePct": 0,
      "supportsComposableMl": true,
      "supportsMonotonicConstraints": true,
      "trainingDuration": "string",
      "trainingEndDate": "2019-08-24T14:15:22Z",
      "trainingRowCount": 0,
      "trainingStartDate": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK A list of frozen models in the project. FrozenModelListResponse
404 Not Found This resource does not exist. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/frozenModels/

Train a new frozen model with parameters from an existing model. Frozen models use tuning parameters from another model on the leaderboard, allowing them to be retrained on a larger amount of the training data more efficiently. To specify the amount of data to use to train the model, use either samplePct to express a percentage of the rows of the dataset to use or trainingRowCount to express the number of rows to use. If neither samplePct or trainingRowCount is specified, the model will be trained on the maximum available training data that can be used to train an in-memory model. For projects using smart sampling, samplePct and trainingRowCount will be interpreted as a percent or number of rows of the minority class. When configuring retraining sample sizes for models in projects with large row counts, DataRobot recommends requesting sample sizes using integer row counts instead of percentages. This is because percentages map to many actual possible row counts and only one of which is the actual sample size for up to validation. For example, if a project has 199,408 rows and you request a 64% sample size, any number of rows between 126,625 rows and 128,618 rows maps to 64% of the data. Using actual integer row counts (or project.max_training_rows) avoids ambiguity around how many rows of data you want the model to use.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/frozenModels/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "modelId": "string",
  "nClusters": 2,
  "samplePct": 0,
  "trainingRowCount": 0
}

Parameters

Name In Type Required Description
projectId path string true The project ID
body body FrozenModelCreate false none

Responses

Status Meaning Description Schema
204 No Content The frozen model has been successfully submitted. None
404 Not Found This resource does not exist. None
422 Unprocessable Entity Unable to process request. None

Response Headers

Status Header Type Format Description
204 Location string url Contains a url at which the job processing the model can be retrieved as with GET /api/v2/projects/{projectId}/modelJobs/{jobId}/..

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/frozenModels/{modelId}/

Look up a particular frozen model. If model with given ID exists but it's not frozen, returns 404 Not Found.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/frozenModels/{modelId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "blueprintId": "string",
  "featurelistId": "string",
  "featurelistName": "string",
  "id": "string",
  "isFrozen": true,
  "isStarred": true,
  "linkFunction": "string",
  "metrics": "\n        {\n            \"metrics\": {\n                \"RMSE\": {\n                    \"holdout\": 5000,\n                    \"validation\": 5100,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"crossValidation\": 6000,\n                    \"training\": null\n                },\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"crossValidation\": 0.50166,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"training\": null\n                },\n            }\n        }\n",
  "modelCategory": "model",
  "modelFamily": "string",
  "modelNumber": 0,
  "modelType": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "parentModelId": "string",
  "predictionThreshold": 1,
  "predictionThresholdReadOnly": true,
  "processes": [
    "string"
  ],
  "projectId": "string",
  "samplePct": 0,
  "supportsComposableMl": true,
  "supportsMonotonicConstraints": true,
  "trainingDuration": "string",
  "trainingEndDate": "2019-08-24T14:15:22Z",
  "trainingRowCount": 0,
  "trainingStartDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK The frozen model. ModelDetailsResponse
404 Not Found No such frozen model found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/modelJobs/

List modeling jobs.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/modelJobs/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
status query string false If provided, only jobs with the same status will be included in the results; otherwise, queued and inprogress jobs (but not errored jobs) will be returned.
projectId path string true The project ID.

Enumerated Values

Parameter Value
status queue
status inprogress
status error

Example responses

200 Response

[
  {
    "data": [
      {
        "blueprintId": "string",
        "featurelistId": "string",
        "id": "string",
        "isBlocked": true,
        "modelCategory": "model",
        "modelId": "string",
        "modelType": "string",
        "processes": [
          "string"
        ],
        "projectId": "string",
        "samplePct": 0,
        "status": "queue"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK List of modeling jobs. Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ModelingJobListResponse] false none none
» data [ModelJobResponse] true none List of modeling jobs.
»» blueprintId string true none The blueprint used by the model - note that this is not an ObjectId.
»» featurelistId string true none The ID of the featurelist the model is using.
»» id string true none The job ID.
»» isBlocked boolean true none True if a job is waiting for its dependencies to be resolved first.
»» modelCategory string true none Indicates what kind of model this is. Will be combined for combined models.
»» modelId string true none The ID of the model
»» modelType string true none The type of model used by the job.
»» processes [string] true none List of processes the modeling job includes
»» projectId string true none The project the job belongs to.
»» samplePct number true none The percentage of the dataset the job is using.
»» status string true none The status of the job.

Enumerated Values

Property Value
modelCategory model
modelCategory prime
modelCategory blend
status queue
status inprogress
status error
status ABORTED
status COMPLETED

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/projects/{projectId}/modelJobs/{jobId}/

Cancel a modeling job

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/projects/{projectId}/modelJobs/{jobId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID.
jobId path string true The job ID

Responses

Status Meaning Description Schema
204 No Content The job has been successfully cancelled. None
404 Not Found no job with jobId found, or the job has already completed None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/modelJobs/{jobId}/

Look up a particular modeling job

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/modelJobs/{jobId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID.
jobId path string true The job ID

Example responses

200 Response

{
  "blueprintId": "string",
  "featurelistId": "string",
  "id": "string",
  "isBlocked": true,
  "modelCategory": "model",
  "modelId": "string",
  "modelType": "string",
  "processes": [
    "string"
  ],
  "projectId": "string",
  "samplePct": 0,
  "status": "queue"
}

Responses

Status Meaning Description Schema
200 OK A modeling job ModelJobResponse
303 See Other Task is completed, see Location header for the location of a new resource None

Response Headers

Status Header Type Format Description
200 Location string url if a status code 303 was returned, will contain a url at which the completed model can be retrieved`

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/

Lists all the models from a project.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
bulkOperationId query string false The ID of the bulk model operation. If specified, only models submitted in scope of this operation will be shown.
orderBy query string false A comma-separated list of metrics to sort by. If metric is prefixed with a '-', models will be sorted by this metric in descending order, otherwise in ascending order. Valid sorting metrics are metric and samplePct. metric will sort models by metric value selected for this project using validation score. This accounts for the direction of the metric, so -metric will sort in order of decreasing 'goodness', which may be opposite to the natural numerical order. If not specified, -metric will be used.
name query string false If specified, will filter for models with model type matching name
samplePct query number false If specified, will filter for models with matching sample percentage
withMetric query string false If specified, the returned models will only have scores for this metric. If not, all metrics will be included.
isStarred query string false If specified, will filter for models marked as starred.
projectId path string true The project ID.

Enumerated Values

Parameter Value
orderBy metric
orderBy -metric
orderBy samplePct
orderBy -samplePct
isStarred false
isStarred False
isStarred true
isStarred True

Example responses

200 Response

[
  {
    "blueprintId": "string",
    "featurelistId": "string",
    "featurelistName": "string",
    "id": "string",
    "isFrozen": true,
    "isStarred": true,
    "linkFunction": "string",
    "metrics": "\n        {\n            \"metrics\": {\n                \"RMSE\": {\n                    \"holdout\": 5000,\n                    \"validation\": 5100,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"crossValidation\": 6000,\n                    \"training\": null\n                },\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"crossValidation\": 0.50166,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"training\": null\n                },\n            }\n        }\n",
    "modelCategory": "model",
    "modelFamily": "string",
    "modelNumber": 0,
    "modelType": "string",
    "monotonicDecreasingFeaturelistId": "string",
    "monotonicIncreasingFeaturelistId": "string",
    "parentModelId": "string",
    "predictionThreshold": 1,
    "predictionThresholdReadOnly": true,
    "processes": [
      "string"
    ],
    "projectId": "string",
    "samplePct": 0,
    "supportsComposableMl": true,
    "supportsMonotonicConstraints": true,
    "trainingDuration": "string",
    "trainingEndDate": "2019-08-24T14:15:22Z",
    "trainingRowCount": 0,
    "trainingStartDate": "2019-08-24T14:15:22Z"
  }
]

Responses

Status Meaning Description Schema
200 OK The project's models Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ModelDetailsResponse] false none none
» blueprintId string true none the blueprint used to construct the model
» featurelistId string¦null true none the ID of the featurelist used by the model
» featurelistName string¦null true none the name of the featurelist used by the model.If null, the model was trained on multiple feature lists.
» id string true none the ID of the model
» isFrozen boolean true none indicating whether the model is frozen, i.e. uses tuning parameters from a parent model
» isStarred boolean true none whether the model has been starred
» linkFunction string¦null true none the link function the final modeler uses in the blueprint. If no link function exists, returns null
» metrics object true none the performance of the model according to various metrics, where each metric has validation, crossValidation, holdout, and training scores reported, or null if they have not been computed.
» modelCategory string true none indicates what kind of model it is - will be prime for DataRobot Prime models, blend for blender models, and model for all other models
» modelFamily string true none the family model belongs to, e.g. SVM, GMB, etc.
» modelNumber integer¦null true none The model number from the leaderboard.
» modelType string true none identifies the model, e.g. Nystroem Kernel SVM Regressor
» monotonicDecreasingFeaturelistId string¦null true none the ID of the featurelist that defines the set of features with a monotonically decreasing relationship to the target. If null, no such constraints are enforced.
» monotonicIncreasingFeaturelistId string¦null true none the ID of the featurelist that defines the set of features with a monotonically increasing relationship to the target. If null, no such constraints are enforced.
» parentModelId string¦null true none if this model is frozen, this is the ID of the parent model. Otherwise Null.
» predictionThreshold number true none threshold used for binary classification in predictions.
» predictionThresholdReadOnly boolean true none indicates whether modification of a predictions threshold is forbidden. Since v2.22 threshold modification is allowed.
» processes [string]¦null true none list of processes used by the model
» projectId string true none the ID of the project to which the model belongs
» samplePct number¦null true none the percentage of the dataset used in training the model
» supportsComposableMl boolean true none indicates whether this model is supported in Composable ML.
» supportsMonotonicConstraints boolean true none whether this model supports enforcing monotonic constraints
» trainingDuration string¦null true none the duration spanned by the dates in the partition column for the data used to train the model
» trainingEndDate string(date-time)¦null true none the end date of the dates in the partition column for the data used to train the model
» trainingRowCount integer¦null true none The number of rows used to train the model.
» trainingStartDate string(date-time)¦null true none the start date of the dates in the partition column for the data used to train the model

Enumerated Values

Property Value
modelCategory model
modelCategory prime
modelCategory blend

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/

Train a new model. To specify the amount of data to use to train the model, use either samplePct to express a percentage of the rows of the dataset to use or trainingRowCount to express the number of rows to use. If neither samplePct or trainingRowCount is specified, the model will be trained on the maximum available training data that can be used to train an in-memory model. For projects using smart sampling, samplePct and trainingRowCount will be interpreted as a percent or number of rows of the minority class. When configuring retraining sample sizes for models in projects with large row counts, DataRobot recommends requesting sample sizes using integer row counts instead of percentages. This is because percentages map to many actual possible row counts and only one of which is the actual sample size for up to validation. For example, if a project has 199,408 rows and you request a 64% sample size, any number of rows between 126,625 rows and 128,618 rows maps to 64% of the data. Using actual integer row counts (or project.max_training_rows) avoids ambiguity around how many rows of data you want the model to use.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "blueprintId": "string",
  "featurelistId": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "nClusters": 2,
  "samplePct": 0,
  "scoringType": "validation",
  "sourceProjectId": "string",
  "trainingRowCount": 0
}

Parameters

Name In Type Required Description
projectId path string true The project ID.
body body TrainModel false none

Responses

Status Meaning Description Schema
202 Accepted Creation has successfully started. See the Location header. None
422 Unprocessable Entity Could not create new job None

Response Headers

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

POST /api/v2/projects/{projectId}/models/fromModel/

Retrain an existing model using a new sample size and/or feature list.When configuring retraining sample sizes for models in projects with large row counts, DataRobot recommends requesting sample sizes using integer row counts instead of percentages. This is because percentages map to many actual possible row counts and only one of which is the actual sample size for up to validation. For example, if a project has 199,408 rows and you request a 64% sample size, any number of rows between 126,625 rows and 128,618 rows maps to 64% of the data. Using actual integer row counts (or project.max_training_rows) avoids ambiguity around how many rows of data you want the model to use. Note that only one of samplePct or trainingRowCount should be specified.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/fromModel/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "featurelistId": "string",
  "modelId": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "nClusters": 2,
  "samplePct": 0,
  "scoringType": "validation",
  "trainingRowCount": 0
}

Parameters

Name In Type Required Description
projectId path string true The project ID
body body RetrainModel false none

Example responses

202 Response

{
  "message": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Retrain an existing model using a new sample size and/or feature list. ModelRetrainResponse
422 Unprocessable Entity model with specified modelId is deprecated, or it doesn't support retraining using a new sample size and/or feature list None

Response Headers

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

DELETE /api/v2/projects/{projectId}/models/{modelId}/

Delete a model from the leaderboard

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Responses

Status Meaning Description Schema
204 No Content The model has been successfully deleted. None
404 Not Found This resource does not exist. None
422 Unprocessable Entity Unable to process the request. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/

Look up a particular model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "blueprintId": "string",
  "featurelistId": "string",
  "featurelistName": "string",
  "id": "string",
  "isFrozen": true,
  "isStarred": true,
  "linkFunction": "string",
  "metrics": "\n        {\n            \"metrics\": {\n                \"RMSE\": {\n                    \"holdout\": 5000,\n                    \"validation\": 5100,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"crossValidation\": 6000,\n                    \"training\": null\n                },\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"crossValidation\": 0.50166,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"training\": null\n                },\n            }\n        }\n",
  "modelCategory": "model",
  "modelFamily": "string",
  "modelNumber": 0,
  "modelType": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "parentModelId": "string",
  "predictionThreshold": 1,
  "predictionThresholdReadOnly": true,
  "processes": [
    "string"
  ],
  "projectId": "string",
  "samplePct": 0,
  "supportsComposableMl": true,
  "supportsMonotonicConstraints": true,
  "trainingDuration": "string",
  "trainingEndDate": "2019-08-24T14:15:22Z",
  "trainingRowCount": 0,
  "trainingStartDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK The model ModelDetailsResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/projects/{projectId}/models/{modelId}/

Updates a model's attribute(s)

Code samples

# You can also use wget
curl -X PATCH http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "isStarred": true,
  "predictionThreshold": 1
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body ModelUpdate false none

Responses

Status Meaning Description Schema
204 No Content The model has been successfully updated with new attributes. None
404 Not Found This resource does not exist. None
422 Unprocessable Entity Unable to process the request. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/advancedTuning/

Submit a job to make a new version of the model with different advanced tuning parameters. Note: This route currently supports all models other than: OSS, blenders, prime, scaleout, baseline and user-created. Currently, only single-stage models (most simple models) are supported. Blueprints that run multiple steps, for example one step to predict zero vs nonzero and a second step to determine the value of nonzero predictions, are not supported. (:ref:Advanced Tuning documentation <grid_search>). Parameters may be omitted from this endpoint. If a parameter is omitted, its currentValue will be used. To see the possible parameter IDs and constraints on possible values, see GET /api/v2/projects/{projectId}/models/{modelId}/advancedTuning/parameters/.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/advancedTuning/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "tuningDescription": "string",
  "tuningParameters": [
    {
      "parameterId": "string",
      "value": "string"
    }
  ]
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body ModelAdvancedTuning false none

Responses

Status Meaning Description Schema
202 Accepted The job has been successfully submitted. See the Location header. None
403 Forbidden Permission denied creating advanced tuned model None
404 Not Found This resource does not exist. None
413 Payload Too Large Tuning request is too large None
422 Unprocessable Entity Could not create new job. None

Response Headers

Status Header Type Format Description
202 Location string url A url at which the job processing the model can be retrieved.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/advancedTuning/parameters/

Retrieve information about all advanced tuning parameters available for the specified model. Note: This route currently supports all models other than: OSS, blenders, prime, scaleout, baseline and user-created

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/advancedTuning/parameters/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "tuningDescription": "string",
  "tuningParameters": [
    {
      "constraints": {
        "ascii": {
          "supportsGridSearch": true
        },
        "float": {
          "max": 0,
          "min": 0,
          "supportsGridSearch": true
        },
        "floatList": {
          "maxLength": 0,
          "maxVal": 0,
          "minLength": 0,
          "minVal": 0,
          "supportsGridSearch": true
        },
        "int": {
          "max": 0,
          "min": 0,
          "supportsGridSearch": true
        },
        "intList": {
          "maxLength": 0,
          "maxVal": 0,
          "minLength": 0,
          "minVal": 0,
          "supportsGridSearch": true
        },
        "select": {
          "supportsGridSearch": true,
          "values": [
            "string"
          ]
        },
        "selectgrid": {
          "supportsGridSearch": true,
          "values": [
            "string"
          ]
        },
        "unicode": {
          "supportsGridSearch": true
        }
      },
      "currentValue": "string",
      "defaultValue": "string",
      "parameterId": "string",
      "parameterName": "string",
      "taskName": "string",
      "vertexId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK The information about all advanced tuning parameters available for the specified model. AdvancedTuningArgumentsRetrieveResponse
403 Forbidden Permission denied creating advanced tuned model. None
404 Not Found This resource does not exist. None
422 Unprocessable Entity This model does not support advanced tuning. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/clusterNames/

Retrieve all cluster names assigned to an unsupervised cluster model

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/clusterNames/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "clusters": [
    {
      "name": "string",
      "percent": 100
    },
    {
      "name": "string",
      "percent": 100
    }
  ],
  "modelId": "string",
  "projectId": "string"
}

Responses

Status Meaning Description Schema
200 OK Retrieve all cluster names for the model ClusterNamesResponse
404 Not Found Could not find unsupervised clustering model. Possible reasons include: 1. Provided model id points to a model that does not exist in specified project. 2. Provided model has incompatible type. Method requires model to be unsupervised clustering model. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/projects/{projectId}/models/{modelId}/clusterNames/

Update and then retrieve all cluster names assigned to an unsupervised cluster model

Code samples

# You can also use wget
curl -X PATCH http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/clusterNames/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "clusterNameMappings": [
    {
      "currentName": "string",
      "newName": "string"
    }
  ]
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body ClusterNamesUpdateParam false none

Example responses

200 Response

{
  "clusters": [
    {
      "name": "string",
      "percent": 100
    },
    {
      "name": "string",
      "percent": 100
    }
  ],
  "modelId": "string",
  "projectId": "string"
}

Responses

Status Meaning Description Schema
200 OK Update cluster names and then retrieve all cluster names for the model ClusterNamesResponse
404 Not Found Could not find unsupervised clustering model. Possible reasons include: 1. Provided model id points to a model which does not exists in specified project. 2. Provided model has incompatible type. Method requires model to be unsupervised clustering model. None
422 Unprocessable Entity The request cannot be processed. Possible reasons include: 1. Mapping contains invalid current cluster name and referenced cluster was not found. 2. Mapping is invalid as after update, clusters will not be uniquely identifiable by name. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/crossValidation/

Run Cross Validation on a model.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/crossValidation/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body Empty false none

Responses

Status Meaning Description Schema
202 Accepted The model has been successfully submitted. None
422 Unprocessable Entity Unable to process the request. None

Response Headers

Status Header Type Format Description
202 Location string url Contains a url at which the job processing the model can be retrieved

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/crossValidationScores/

    Get Cross Validation scores for each partition in a model.
    .. note:: Individual partition scores are only available for newer models; older models that
              have cross validation score calculated will need to be retrained.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/crossValidationScores/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
metric query string false Set to the name of a metric to only return results for that metric.
partition query number false Set to a value such as 1.0, 2.0 to only return results for the specified partition.
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "cvScores": "\n        {\n            \"cvScores\": {\n                \"FVE Gamma\": {\n                    \"0.0\": 0.24334,\n                    \"1.0\": 0.17757,\n                    \"2.0\": 0.21803,\n                    \"3.0\": 0.20185,\n                    \"4.0\": 0.20576\n                },\n                \"FVE Poisson\": {\n                    \"0.0\": 0.24527,\n                    \"1.0\": 0.22092,\n                    \"2.0\": 0.22451,\n                    \"3.0\": 0.24417,\n                    \"4.0\": 0.21654\n                }\n            }\n        }\n"
}

Responses

Status Meaning Description Schema
200 OK The Cross Validation scores for each partition in a model. CrossValidationRetrieveResponse
404 Not Found Not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/features/

List the features used in a model

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/features/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "aPrioriFeatureNames": [
    "string"
  ],
  "featureNames": [
    "string"
  ],
  "knownInAdvanceFeatureNames": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK The features used in a model. ModelFeatureListResponse
404 Not Found This resource does not exist. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/missingReport/

Retrieve a summary of how the model's subtasks handle missing values Only models built after the missing value report feature was added will have reports, and only models with at least one imputation or encoding task, e.g. ordinal encoding, missing value imputation. Blenders and scaleout models do not support Missing Value reports.

    The report will describe how each feature's missing values were treated, and report how many
    missing values were present in the training data. Features which were not processed by a
    given blueprint task will not mention it: for instance, a categorical feature with many
    unique values may not be considered eligible for processing by a One-Hot Encoding

    Report is collected for those features which are considered eligible by given
    blueprint task. For instance, categorical feature with a lot of unique values may not be
    considered as eligible in One-Hot Encoding task.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/missingReport/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "missingValuesReport": [
    {
      "feature": "string",
      "missingCount": 0,
      "missingPercentage": 1,
      "tasks": {
        "property1": {
          "descriptions": [
            "string"
          ],
          "name": "string"
        },
        "property2": {
          "descriptions": [
            "string"
          ],
          "name": "string"
        }
      },
      "type": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Retrieve a summary of how the model's subtasks handle missing values. MissingReportRetrieve
404 Not Found Could not found missing value report for provided project & model id. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/numIterationsTrained/

Retrieve the actual number of iterations or estimators trained by a tree-based early stopping model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/numIterationsTrained/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "data": [
    {
      "numIterations": 0,
      "stage": "string"
    }
  ],
  "modelId": "string",
  "projectId": "string"
}

Responses

Status Meaning Description Schema
200 OK The number of estimators/iterations trained NumIterationsTrainedResponse
404 Not Found Cannot retrieve early stopping information for this model. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/parameters/

Retrieve model parameters. These are the parameters that appear in the webapp on the Coefficients tab. Note that they are only available for some models.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/parameters/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "derivedFeatures": [
    {
      "coefficient": 0,
      "derivedFeature": "string",
      "originalFeature": "string",
      "stageCoefficients": [
        {
          "coefficient": 0,
          "stage": "string"
        }
      ],
      "transformations": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "type": "string"
    }
  ],
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK The parameters of the model. ModelParametersRetrieveResponse
422 Unprocessable Entity Unable to process the request. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/predictionIntervals/

Retrieve prediction intervals (in descending order) that are already calculated for this model. Note that the project this model belongs to must be a time series project.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/predictionIntervals/ \
  -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.
projectId path string true The project to retrieve prediction intervals for. Must be a time series project.
modelId path string true The model to retrieve prediction intervals for.

Example responses

200 Response

{
  "count": 0,
  "data": [
    0
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Request was successful. PredictionIntervalsListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/predictionIntervals/

Submit a job to calculate prediction intervals for the specified percentiles for this model. Note that the project this model belongs to must be a time series project.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/predictionIntervals/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "percentiles": [
    0
  ]
}

Parameters

Name In Type Required Description
projectId path string true The project to calculate prediction intervals for. Must be a time series project.
modelId path string true The model to calculate prediction intervals for.
body body PredictionIntervalsCreate false none

Example responses

202 Response

{
  "message": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Job was successfully submitted. See Location header. PredictionIntervalsCreateResponse

Response Headers

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/projects/{projectId}/models/{modelId}/primeInfo/

Check if a model can be approximated by DataRobot Prime

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/primeInfo/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true the project the model belongs to
modelId path string true the model to check

Example responses

200 Response

{
  "canMakePrime": true,
  "message": "string",
  "messageId": 0
}

Responses

Status Meaning Description Schema
200 OK none PrimeInfoRetrieveResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/primeRulesets/

List all the rulesets approximating a model

When rulesets are created for the parent model, all of the rulesets are created at once, but not all rulesets have corresponding Prime models (until they are directly requested).

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/primeRulesets/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true the project the model belongs to
modelId path string true the model to find approximating rulesets for

Example responses

200 Response

[
  {
    "modelId": "string",
    "parentModelId": "string",
    "projectId": "string",
    "ruleCount": 0,
    "rulesetId": 0,
    "score": 0
  }
]

Responses

Status Meaning Description Schema
200 OK none Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [PrimeRulesetsListResponse] false none none
» modelId string true none the ID of the Prime model using this ruleset (if it exists) or null
» parentModelId string true none ID of the model this ruleset approximates
» projectId string true none the project this ruleset belongs to
» ruleCount integer true none the number of rules used by this ruleset
» rulesetId integer true none the ID of the ruleset
» score number true none the validation score of the ruleset

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/primeRulesets/

Approximate an existing model on the leaderboard with DataRobot Prime. A request body should be an empty JSON {}

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/primeRulesets/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{}

Parameters

Name In Type Required Description
projectId path string true the project the model to approximate belongs to
modelId path string true the model to approximate
body body PrimeRulesetsCreatePayload false none

Responses

Status Meaning Description Schema
202 Accepted The request was understood and accepted, and is now being worked on. See the Location header None

Response Headers

Status Header Type Format Description
202 Location string url a url that can be polled to check the status of the job

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/scoringCode/

Retrieve Scoring Code for making new predictions from an existing model offline. 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 (https://javadoc.io/doc/com.datarobot/datarobot-prediction/latest/index.html) to be able to use it inside an existing Java application.

With the 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" in DataRobot application for more information.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/scoringCode/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
sourceCode query string false If set to "true", the downloaded JAR file will contain only the source code and will not be executable.
projectId path string true the project that created the model
modelId path string true the model to use

Enumerated Values

Parameter Value
sourceCode false
sourceCode False
sourceCode true
sourceCode True

Responses

Status Meaning Description Schema
200 OK JAR file None

Response Headers

Status Header Type Format Description
200 Content-Disposition string attachment; filename="<"filename">".jar The suggested filename for the scoring code is dynamically generated
200 Content-Type string application/java-archive

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/supportedCapabilities/

Get supported capabilities for a model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/supportedCapabilities/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "eligibleForPrime": true,
  "hasParameters": true,
  "hasWordCloud": true,
  "reasons": {
    "supportsDocumentTextExtractionSampleInsight": "string",
    "supportsImageActivationMaps": "string",
    "supportsImageEmbedding": "string"
  },
  "supportsBlending": true,
  "supportsCodeGeneration": true,
  "supportsDocumentTextExtractionSampleInsight": true,
  "supportsEarlyStopping": true,
  "supportsImageActivationMaps": true,
  "supportsImageEmbedding": true,
  "supportsModelPackageExport": true,
  "supportsModelTrainingMetrics": true,
  "supportsMonotonicConstraints": true,
  "supportsNNVisualizations": true,
  "supportsShap": true
}

Responses

Status Meaning Description Schema
200 OK Successfully returned model capability information. ModelCapabilitiesRetrieveResponse
404 Not Found Resource not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/primeFiles/

List all DataRobot Prime files available for download

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/primeFiles/ \
  -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. To specify no limit, use 0. The default may change and a maximum limit may be imposed without notice.
parentModelId query string false if specified only Prime files approximating the specified parent model will be returned; otherwise all applicable Prime files will be returned.
modelId query string false if specified only Prime files with code used in the specified prime model will be returned; otherwise all applicable Prime files will be returned
projectId path string true the project to list available files for

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "isValid": true,
      "language": "Python",
      "modelId": "string",
      "parentModelId": "string",
      "projectId": "string",
      "rulesetId": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK none PrimeFileListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/primeFiles/

Request creation and validation of source code from a Prime model

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/primeFiles/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "language": "Python",
  "modelId": "string"
}

Parameters

Name In Type Required Description
projectId path string true the project the Prime model belongs to
body body PrimeFileCreate false none

Responses

Status Meaning Description Schema
202 Accepted prime validation job added to queue. See the Location header. None

Response Headers

Status Header Type Format Description
202 Location string url a url that can be polled to check the status of prime validation job

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/primeFiles/{primeFileId}/

Retrieve metadata about a DataRobot Prime file available for download

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/primeFiles/{primeFileId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true the project the file belongs to
primeFileId path string true the file to retrieve

Example responses

200 Response

{
  "id": "string",
  "isValid": true,
  "language": "Python",
  "modelId": "string",
  "parentModelId": "string",
  "projectId": "string",
  "rulesetId": 0
}

Responses

Status Meaning Description Schema
200 OK none PrimeFileResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/primeFiles/{primeFileId}/download/

Download code from an existing Prime file

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/primeFiles/{primeFileId}/download/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true the project the file belongs to
primeFileId path string true the Prime file to download code from

Responses

Status Meaning Description Schema
200 OK The response will contain a file with the executable code from the Prime file None

Response Headers

Status Header Type Format Description
200 Content-Disposition string Will be attachment;filename="<"filename">". The suggested filename will depend on the language Prime file was generated for.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/primeModels/

List all Prime models in a project

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/primeModels/ \
  -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.
projectId path string true the project to list models from

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "blueprintId": "string",
      "featurelistId": "string",
      "featurelistName": "string",
      "id": "string",
      "isFrozen": true,
      "isStarred": true,
      "linkFunction": "string",
      "metrics": "\n        {\n            \"metrics\": {\n                \"RMSE\": {\n                    \"holdout\": 5000,\n                    \"validation\": 5100,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"crossValidation\": 6000,\n                    \"training\": null\n                },\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"crossValidation\": 0.50166,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"training\": null\n                },\n            }\n        }\n",
      "modelCategory": "model",
      "modelFamily": "string",
      "modelNumber": 0,
      "modelType": "string",
      "monotonicDecreasingFeaturelistId": "string",
      "monotonicIncreasingFeaturelistId": "string",
      "parentModelId": "string",
      "predictionThreshold": 1,
      "predictionThresholdReadOnly": true,
      "processes": [
        "string"
      ],
      "projectId": "string",
      "ruleCount": 0,
      "rulesetId": 0,
      "samplePct": 0,
      "score": 0,
      "supportsComposableMl": true,
      "supportsMonotonicConstraints": true,
      "trainingDuration": "string",
      "trainingEndDate": "2019-08-24T14:15:22Z",
      "trainingRowCount": 0,
      "trainingStartDate": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK none PrimeModelListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/primeModels/

Create a Prime model using a particular ruleset.

DataRobot Prime is not available for multiclass projects.

Once rulesets approximating a parent model have been created, using POST /api/v2/projects/(projectId)/models/(modelId)/primeRulesets/, this route will allow creation of a Prime model using one of those rulesets.

Available rulesets can be retrieved via GET /api/v2/projects/(projectId)/models/(modelId)/primeRulesets/.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/primeModels/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "parentModelId": "string",
  "rulesetId": 0
}

Parameters

Name In Type Required Description
projectId path string true the project in which to create the model
body body PrimeModelCreatePayload false none

Responses

Status Meaning Description Schema
202 Accepted Prime model creation job successfully added to queue. See the Location header. None

Response Headers

Status Header Type Format Description
202 Location string url a url that can be polled to check the status of the job

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/primeModels/{modelId}/

Retrieve a Prime model details

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/primeModels/{modelId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true the project to retrieve the model from
modelId path string true the model to retrieve

Example responses

200 Response

{
  "blueprintId": "string",
  "featurelistId": "string",
  "featurelistName": "string",
  "id": "string",
  "isFrozen": true,
  "isStarred": true,
  "linkFunction": "string",
  "metrics": "\n        {\n            \"metrics\": {\n                \"RMSE\": {\n                    \"holdout\": 5000,\n                    \"validation\": 5100,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"crossValidation\": 6000,\n                    \"training\": null\n                },\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"crossValidation\": 0.50166,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"training\": null\n                },\n            }\n        }\n",
  "modelCategory": "model",
  "modelFamily": "string",
  "modelNumber": 0,
  "modelType": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "parentModelId": "string",
  "predictionThreshold": 1,
  "predictionThresholdReadOnly": true,
  "processes": [
    "string"
  ],
  "projectId": "string",
  "ruleCount": 0,
  "rulesetId": 0,
  "samplePct": 0,
  "score": 0,
  "supportsComposableMl": true,
  "supportsMonotonicConstraints": true,
  "trainingDuration": "string",
  "trainingEndDate": "2019-08-24T14:15:22Z",
  "trainingRowCount": 0,
  "trainingStartDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK Prime models are an extension of models, so the response includes all attributes that would be in a response to GET /api/v2/projects/(projectId)/models/(modelId)/ as well as some additional ones. PrimeModelDetailsRetrieveResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/ratingTableModels/

Lists all the models from a project that have rating tables

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/ratingTableModels/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
bulkOperationId query string false The ID of the bulk model operation. If specified, only models submitted in scope of this operation will be shown.
orderBy query string false A comma-separated list of metrics to sort by. If metric is prefixed with a '-', models will be sorted by this metric in descending order, otherwise in ascending order. Valid sorting metrics are metric and samplePct. metric will sort models by metric value selected for this project using validation score. This accounts for the direction of the metric, so -metric will sort in order of decreasing 'goodness', which may be opposite to the natural numerical order. If not specified, -metric will be used.
name query string false If specified, will filter for models with model type matching name
samplePct query number false If specified, will filter for models with matching sample percentage
withMetric query string false If specified, the returned models will only have scores for this metric. If not, all metrics will be included.
isStarred query string false If specified, will filter for models marked as starred.
projectId path string true the project to list models from

Enumerated Values

Parameter Value
orderBy metric
orderBy -metric
orderBy samplePct
orderBy -samplePct
isStarred false
isStarred False
isStarred true
isStarred True

Example responses

200 Response

[
  {
    "blueprintId": "string",
    "featurelistId": "string",
    "featurelistName": "string",
    "id": "string",
    "isFrozen": true,
    "isStarred": true,
    "linkFunction": "string",
    "metrics": "\n        {\n            \"metrics\": {\n                \"RMSE\": {\n                    \"holdout\": 5000,\n                    \"validation\": 5100,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"crossValidation\": 6000,\n                    \"training\": null\n                },\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"crossValidation\": 0.50166,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"training\": null\n                },\n            }\n        }\n",
    "modelCategory": "model",
    "modelFamily": "string",
    "modelNumber": 0,
    "modelType": "string",
    "monotonicDecreasingFeaturelistId": "string",
    "monotonicIncreasingFeaturelistId": "string",
    "parentModelId": "string",
    "predictionThreshold": 1,
    "predictionThresholdReadOnly": true,
    "processes": [
      "string"
    ],
    "projectId": "string",
    "ratingTableId": "string",
    "samplePct": 0,
    "supportsComposableMl": true,
    "supportsMonotonicConstraints": true,
    "trainingDuration": "string",
    "trainingEndDate": "2019-08-24T14:15:22Z",
    "trainingRowCount": 0,
    "trainingStartDate": "2019-08-24T14:15:22Z"
  }
]

Responses

Status Meaning Description Schema
200 OK The response will include a json list of models in the same format as
those from GET /api/v2/projects/(projectId)/ratingTableModels/(modelId)/. Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [RatingTableModelDetailsResponse] false none none
» blueprintId string true none the blueprint used to construct the model
» featurelistId string¦null true none the ID of the featurelist used by the model
» featurelistName string¦null true none the name of the featurelist used by the model.If null, the model was trained on multiple feature lists.
» id string true none the ID of the model
» isFrozen boolean true none indicating whether the model is frozen, i.e. uses tuning parameters from a parent model
» isStarred boolean true none whether the model has been starred
» linkFunction string¦null true none the link function the final modeler uses in the blueprint. If no link function exists, returns null
» metrics object true none the performance of the model according to various metrics, where each metric has validation, crossValidation, holdout, and training scores reported, or null if they have not been computed.
» modelCategory string true none indicates what kind of model it is - will be prime for DataRobot Prime models, blend for blender models, and model for all other models
» modelFamily string true none the family model belongs to, e.g. SVM, GMB, etc.
» modelNumber integer¦null true none The model number from the leaderboard.
» modelType string true none identifies the model, e.g. Nystroem Kernel SVM Regressor
» monotonicDecreasingFeaturelistId string¦null true none the ID of the featurelist that defines the set of features with a monotonically decreasing relationship to the target. If null, no such constraints are enforced.
» monotonicIncreasingFeaturelistId string¦null true none the ID of the featurelist that defines the set of features with a monotonically increasing relationship to the target. If null, no such constraints are enforced.
» parentModelId string¦null true none if this model is frozen, this is the ID of the parent model. Otherwise Null.
» predictionThreshold number true none threshold used for binary classification in predictions.
» predictionThresholdReadOnly boolean true none indicates whether modification of a predictions threshold is forbidden. Since v2.22 threshold modification is allowed.
» processes [string]¦null true none list of processes used by the model
» projectId string true none the ID of the project to which the model belongs
» ratingTableId string true none The rating table ID
» samplePct number¦null true none the percentage of the dataset used in training the model
» supportsComposableMl boolean true none indicates whether this model is supported in Composable ML.
» supportsMonotonicConstraints boolean true none whether this model supports enforcing monotonic constraints
» trainingDuration string¦null true none the duration spanned by the dates in the partition column for the data used to train the model
» trainingEndDate string(date-time)¦null true none the end date of the dates in the partition column for the data used to train the model
» trainingRowCount integer¦null true none The number of rows used to train the model.
» trainingStartDate string(date-time)¦null true none the start date of the dates in the partition column for the data used to train the model

Enumerated Values

Property Value
modelCategory model
modelCategory prime
modelCategory blend

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/ratingTableModels/

Create a new rating table model from a validated rating table record

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/ratingTableModels/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "ratingTableId": "string"
}

Parameters

Name In Type Required Description
projectId path string true the project that owns this data
body body CreateRatingTableModel false none

Responses

Status Meaning Description Schema
202 Accepted the request was understood and accepted, and is now being worked on None

Response Headers

Status Header Type Format Description
202 Location string url a url of an asynchronous operation status object that can be polled to check the status of the job validating the new rating table

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/ratingTableModels/{modelId}/

Look up a particular rating table model

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/ratingTableModels/{modelId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true the project to retrieve the model from
modelId path string true the model to retrieve

Example responses

200 Response

{
  "blueprintId": "string",
  "featurelistId": "string",
  "featurelistName": "string",
  "id": "string",
  "isFrozen": true,
  "isStarred": true,
  "linkFunction": "string",
  "metrics": "\n        {\n            \"metrics\": {\n                \"RMSE\": {\n                    \"holdout\": 5000,\n                    \"validation\": 5100,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"crossValidation\": 6000,\n                    \"training\": null\n                },\n                \"FVE Poisson\": {\n                    \"holdout\": null,\n                    \"validation\": 0.56269,\n                    \"crossValidation\": 0.50166,\n                    \"backtesting\": null,\n                    \"backtestingScores\": null,\n                    \"training\": null\n                },\n            }\n        }\n",
  "modelCategory": "model",
  "modelFamily": "string",
  "modelNumber": 0,
  "modelType": "string",
  "monotonicDecreasingFeaturelistId": "string",
  "monotonicIncreasingFeaturelistId": "string",
  "parentModelId": "string",
  "predictionThreshold": 1,
  "predictionThresholdReadOnly": true,
  "processes": [
    "string"
  ],
  "projectId": "string",
  "ratingTableId": "string",
  "samplePct": 0,
  "supportsComposableMl": true,
  "supportsMonotonicConstraints": true,
  "trainingDuration": "string",
  "trainingEndDate": "2019-08-24T14:15:22Z",
  "trainingRowCount": 0,
  "trainingStartDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK none RatingTableModelDetailsResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/ratingTables/

List RatingTable objects for a project. These contain metadata about the rating table and the location at which the corresponding rating table file can be retrieved.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/ratingTables/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
parentModelId query string false optional. If specified, only rating tables with this parentModelId