DMM Public APIs

GET /v0/models/list_models

Returns the list of models registered in DMM

Example request:

GET /v0/models/list_models HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    A list of models

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    [
        {
            "id": "string",
            "name": "string",
            "modelType": "string",
            "modelVersion": "string",
            "description": "string",
            "createdOn": 1.0,
            "modelAuthor": "string"
        }
    ]
    

POST /v0/models/register_model

Registers the model on DMM with the given model config

Example request:

POST /v0/models/register_model HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dataType": "string",
    "dataColumns": [
        {
            "name": "string",
            "valueType": "categorical",
            "isFeature": true,
            "isPrediction": true,
            "isRowIdentifier": true,
            "isGroundTruth": true,
            "isPredictionProbability": true,
            "isSampleWeight": true,
            "isTimestamp": true
        }
    ],
    "dataLocation": "string",
    "modelType": "classification",
    "modelMetadata": {
        "name": "string",
        "modelVersion": "string",
        "dateCreated": "string",
        "dataset": "string",
        "description": "string",
        "author": "string"
    }
}
Status Codes
  • 200 OK

    returns the model

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "id": "string",
        "name": "string",
        "modelType": "string",
        "modelVersion": "string",
        "description": "string",
        "createdOn": 1.0,
        "modelAuthor": "string"
    }
    

DELETE /v0/models/{model_id}

Removes the model from DMM’s model registry

Parameters
  • model_id (string) –

Status Codes
  • 200 OK

    Returns true is deleted successfully

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "status": "success"
    }
    

PUT /v0/models/{model_id}/add_predictions

Adds predition data to a registered model

Parameters
  • model_id (string) –

Example request:

PUT /v0/models/{model_id}/add_predictions HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dataColumns": [
        {
            "name": "string",
            "valueType": "categorical",
            "isFeature": true,
            "isPrediction": true,
            "isRowIdentifier": true,
            "isGroundTruth": true,
            "isPredictionProbability": true,
            "isSampleWeight": true,
            "isTimestamp": true
        }
    ],
    "dataLocation": "string"
}
Status Codes
  • 200 OK

    returns the model

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "status": "success"
    }
    

PUT /v0/models/{model_id}/add_ground_truths

Adds ground truth data to a registered model

Parameters
  • model_id (string) –

Example request:

PUT /v0/models/{model_id}/add_ground_truths HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "dataColumns": [
        {
            "name": "string",
            "isGroundTruth": true,
            "valueType": "categorical",
            "forPredictionOutput": "string"
        }
    ],
    "dataLocation": "string"
}
Status Codes
  • 200 OK

    returns the model

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "status": "success"
    }