Model

List models

Get list of model for provided query and filters

GEThttps://preprod.dev.fiddler.ai/v3/models

Query parameters

Response

200400500

List of models for provided query and filters

Body

application/json

api_versionenum

API version of the response.

3.0

kindenum

Type of response, indicating a paginated response.

PAGINATED

dataobject

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/models', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "version": "v1",
        "organization": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "project": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "input_type": "text",
        "task": "binary_classification",
        "description": "text",
        "artifact_status": "no_model",
        "deleted_at": "2024-09-16T10:26:05.102Z",
        "algorithm": "text",
        "framework": "text",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[e-mail]"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[e-mail]"
        },
        "created_at": "2024-09-16T10:26:05.102Z",
        "updated_at": "2024-09-16T10:26:05.102Z"
      }
    ]
  }
}

Add a new model under a project

Add a new model under a project

POSThttps://preprod.dev.fiddler.ai/v3/models

Body

application/json

name*string

Name of the model

versionstring

Version of the model

project_id*string (uuid)

UUID format unique identifier for the project the model is added in

input_type*ModelInputTypeEnum (enum)

Enumeration of different model input types.

textstructured

task*ModelTaskEnum (enum)

Enumeration of different types of model tasks.

binary_classificationmulticlass_classificationregressionrankingnot_setllm

schema*ModelSchemaObject (object)

Model schema with the details of each column

spec*ModelSpecObject (object)

task_paramsModelTaskParams (object)

xai_paramsXaiParams (object)

XAI parameters set for a model

descriptionnullable string

Description of the model

algorithmnullable string

Model algorithm

frameworknullable string

A string providing information about the software library and version used to train and run this model

event_id_colnullable string

Event id column to be found in published data for the model

event_ts_colnullable string

Timestamp column to be found in published data for the model

event_ts_formatnullable string

Format of the timestamp like datetime, epoch time etc.

Response

200400401403409500

Created model JSON response

Body

application/json

api_versionenum

API version.

3.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataModelDetailResponse (all of)

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/models', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "input_type": "text",
      "task": "binary_classification",
      "schema": {},
      "spec": {}
    }),
});
const data = await response.json();

Response

200400401403409500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "version": "v1",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "input_type": "text",
    "task": "binary_classification",
    "description": "text",
    "artifact_status": "no_model",
    "deleted_at": "2024-09-16T10:26:05.102Z",
    "algorithm": "text",
    "framework": "text",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    },
    "created_at": "2024-09-16T10:26:05.102Z",
    "updated_at": "2024-09-16T10:26:05.102Z",
    "task_params": {
      "binary_classification_threshold": 0,
      "target_class_order": [
        "text"
      ],
      "group_by": "text",
      "class_weights": [
        0
      ],
      "weighted_ref_histograms": false
    },
    "schema": {
      "columns": [
        {
          "id": "text",
          "name": "text",
          "data_type": "int",
          "min": 0,
          "max": 0,
          "categories": [
            "text"
          ],
          "bins": [
            0
          ],
          "replace_with_nulls": [
            "text"
          ]
        }
      ]
    },
    "spec": {
      "inputs": [
        "text"
      ],
      "outputs": [
        "text"
      ],
      "targets": [
        "text"
      ],
      "decisions": [
        "text"
      ],
      "metadata": [
        "text"
      ],
      "custom_features": [
        {
          "type": "FROM_COLUMNS",
          "name": "text",
          "columns": [
            "text"
          ],
          "centroids": [
            0
          ],
          "tf_idf": [],
          "monitor_components": false
        }
      ]
    },
    "event_id_col": "text",
    "event_ts_col": "text",
    "event_ts_format": "text",
    "xai_params": {
      "custom_explain_methods": [
        "text"
      ],
      "default_explain_method": "text"
    },
    "artifact_files": [
      {
        "name": "text",
        "modified": "2024-09-16T10:26:05.102Z"
      }
    ],
    "is_binary_ranking_model": false
  }
}

Get details of a model

Details of a model for given model id

GEThttps://preprod.dev.fiddler.ai/v3/models/{model_id}

Path parameters

model_id*string (uuid)

model id path parameter

Response

200400404500

Model JSON response for provided model id

Body

application/json

api_versionenum

API version.

3.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataModelDetailResponse (all of)

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/models/{model_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "version": "v1",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "input_type": "text",
    "task": "binary_classification",
    "description": "text",
    "artifact_status": "no_model",
    "deleted_at": "2024-09-16T10:26:05.102Z",
    "algorithm": "text",
    "framework": "text",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    },
    "created_at": "2024-09-16T10:26:05.102Z",
    "updated_at": "2024-09-16T10:26:05.102Z",
    "task_params": {
      "binary_classification_threshold": 0,
      "target_class_order": [
        "text"
      ],
      "group_by": "text",
      "class_weights": [
        0
      ],
      "weighted_ref_histograms": false
    },
    "schema": {
      "columns": [
        {
          "id": "text",
          "name": "text",
          "data_type": "int",
          "min": 0,
          "max": 0,
          "categories": [
            "text"
          ],
          "bins": [
            0
          ],
          "replace_with_nulls": [
            "text"
          ]
        }
      ]
    },
    "spec": {
      "inputs": [
        "text"
      ],
      "outputs": [
        "text"
      ],
      "targets": [
        "text"
      ],
      "decisions": [
        "text"
      ],
      "metadata": [
        "text"
      ],
      "custom_features": [
        {
          "type": "FROM_COLUMNS",
          "name": "text",
          "columns": [
            "text"
          ],
          "centroids": [
            0
          ],
          "tf_idf": [],
          "monitor_components": false
        }
      ]
    },
    "event_id_col": "text",
    "event_ts_col": "text",
    "event_ts_format": "text",
    "xai_params": {
      "custom_explain_methods": [
        "text"
      ],
      "default_explain_method": "text"
    },
    "artifact_files": [
      {
        "name": "text",
        "modified": "2024-09-16T10:26:05.102Z"
      }
    ],
    "is_binary_ranking_model": false
  }
}

Delete a model

Delete a model

DELETEhttps://preprod.dev.fiddler.ai/v3/models/{model_id}

Path parameters

model_id*string (uuid)

model id path parameter

Response

202400404500

Details of a model delete job

Body

application/json

api_versionenum

API version.

3.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataDeleteModelResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/models/{model_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

202400404500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}

Update model fields

Update the fields of a model

PATCHhttps://preprod.dev.fiddler.ai/v3/models/{model_id}

Path parameters

model_id*string (uuid)

model id path parameter

Body

application/json

xai_paramsXaiParams (object)

XAI parameters set for a model

descriptionnullable string

display_namenullable string

Display name for the model

event_id_colnullable string

Event id column to be found in published data for the model

event_ts_colnullable string

Timestamp column to be found in published data for the model

event_ts_formatnullable string

Format of the timestamp like datetime, epoch time etc.

Response

200400404500

Updated model JSON response

Body

application/json

api_versionenum

API version.

3.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataModelDetailResponse (all of)

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/models/{model_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400404500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "version": "v1",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "input_type": "text",
    "task": "binary_classification",
    "description": "text",
    "artifact_status": "no_model",
    "deleted_at": "2024-09-16T10:26:05.102Z",
    "algorithm": "text",
    "framework": "text",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    },
    "created_at": "2024-09-16T10:26:05.102Z",
    "updated_at": "2024-09-16T10:26:05.102Z",
    "task_params": {
      "binary_classification_threshold": 0,
      "target_class_order": [
        "text"
      ],
      "group_by": "text",
      "class_weights": [
        0
      ],
      "weighted_ref_histograms": false
    },
    "schema": {
      "columns": [
        {
          "id": "text",
          "name": "text",
          "data_type": "int",
          "min": 0,
          "max": 0,
          "categories": [
            "text"
          ],
          "bins": [
            0
          ],
          "replace_with_nulls": [
            "text"
          ]
        }
      ]
    },
    "spec": {
      "inputs": [
        "text"
      ],
      "outputs": [
        "text"
      ],
      "targets": [
        "text"
      ],
      "decisions": [
        "text"
      ],
      "metadata": [
        "text"
      ],
      "custom_features": [
        {
          "type": "FROM_COLUMNS",
          "name": "text",
          "columns": [
            "text"
          ],
          "centroids": [
            0
          ],
          "tf_idf": [],
          "monitor_components": false
        }
      ]
    },
    "event_id_col": "text",
    "event_ts_col": "text",
    "event_ts_format": "text",
    "xai_params": {
      "custom_explain_methods": [
        "text"
      ],
      "default_explain_method": "text"
    },
    "artifact_files": [
      {
        "name": "text",
        "modified": "2024-09-16T10:26:05.102Z"
      }
    ],
    "is_binary_ranking_model": false
  }
}

Generate model from the given data sample

Generate model from the given data sample

POSThttps://preprod.dev.fiddler.ai/v3/model-factory

Body

application/json

file_id*string (uuid)

specModelSpecObject (object)

max_cardinalityinteger

sample_sizeinteger

Response

200400500

Generated model

Body

application/json

api_versionenum

API version.

3.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataModelFactoryResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/model-factory', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "file_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

200400500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "schema": {
      "columns": [
        {
          "id": "text",
          "name": "text",
          "data_type": "int",
          "min": 0,
          "max": 0,
          "categories": [
            "text"
          ],
          "bins": [
            0
          ],
          "replace_with_nulls": [
            "text"
          ]
        }
      ]
    },
    "spec": {
      "inputs": [
        "text"
      ],
      "outputs": [
        "text"
      ],
      "targets": [
        "text"
      ],
      "decisions": [
        "text"
      ],
      "metadata": [
        "text"
      ],
      "custom_features": [
        {
          "type": "FROM_COLUMNS",
          "name": "text",
          "columns": [
            "text"
          ],
          "centroids": [
            0
          ],
          "tf_idf": [],
          "monitor_components": false
        }
      ]
    }
  }
}

Update model artifacts

Update artifacts associated with the model

PUThttps://preprod.dev.fiddler.ai/v3/models/{model_id}/deploy-artifact

Path parameters

model_id*string (uuid)

model id path parameter

Query parameters

Response

200400404500

Updated Model Artifacts

Body

application/json

api_versionenum

API version.

3.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/models/{model_id}/deploy-artifact', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200400404500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}

Upload model artifacts

Upload artifacts associated with the model

POSThttps://preprod.dev.fiddler.ai/v3/models/{model_id}/deploy-artifact

Path parameters

model_id*string (uuid)

model id path parameter

Query parameters

Response

200400404500

Deployed Model Artifacts

Body

application/json

api_versionenum

API version.

3.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/models/{model_id}/deploy-artifact', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400404500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}

Update a surrogate model

Update a surrogate model

PUThttps://preprod.dev.fiddler.ai/v3/models/{model_id}/deploy-surrogate

Path parameters

model_id*string (uuid)

model id path parameter

Body

application/json

env_id*string (uuid)

Unique identifier of the environment associated to the model

deployment_params*_SurrogateDeploymentParams (all of)

Additoinal paramteres specified to deploy surrogate model

Response

202400404500

Surrogate model updating task with job id

Body

application/json

api_versionenum

API version.

3.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/models/{model_id}/deploy-surrogate', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "env_id": "123e4567-e89b-12d3-a456-426614174000",
      "deployment_params": {}
    }),
});
const data = await response.json();

Response

202400404500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}

Deploy a surrogate model

Deploy a surrogate model

POSThttps://preprod.dev.fiddler.ai/v3/models/{model_id}/deploy-surrogate

Path parameters

model_id*string (uuid)

model id path parameter

Body

application/json

env_id*string (uuid)

Unique identifier of the environment associated to the model

deployment_params*_SurrogateDeploymentParams (all of)

Additoinal paramteres specified to deploy surrogate model

Response

202400404500

Surrogate model generation task with job id

Body

application/json

api_versionenum

API version.

3.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/models/{model_id}/deploy-surrogate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "env_id": "123e4567-e89b-12d3-a456-426614174000",
      "deployment_params": {}
    }),
});
const data = await response.json();

Response

202400404500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}

Details of all columns

Details of all columns for a model

GEThttps://preprod.dev.fiddler.ai/v3/models/{model_id}/columns

Path parameters

model_id*string (uuid)

model id path parameter

Response

200400404500

Details of all columns for a model

Body

application/json

api_versionenum

API version of the response.

3.0

kindenum

Type of response, indicating a paginated response.

PAGINATED

dataobject

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/models/{model_id}/columns', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "text",
        "name": "text",
        "data_type": "int",
        "min": 0,
        "max": 0,
        "categories": [
          "text"
        ],
        "bins": [
          0
        ],
        "replace_with_nulls": [
          "text"
        ]
      }
    ]
  }
}

Details of a specific column

Details of a specific column for a model

GEThttps://preprod.dev.fiddler.ai/v3/models/{model_id}/columns/{column_id}

Path parameters

model_id*string (uuid)

model id path parameter

column_id*string

column_id path parameter

Response

200400404500

Details of a specific column for a model

Body

application/json

api_versionenum

API version.

3.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataModelSchemaColumnObject (object)

A model column representation

Request

JavaScriptCurlPython

const response = await fetch('https://preprod.dev.fiddler.ai/v3/models/{model_id}/columns/{column_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "text",
    "name": "text",
    "data_type": "int",
    "min": 0,
    "max": 0,
    "categories": [
      "text"
    ],
    "bins": [
      0
    ],
    "replace_with_nulls": [
      "text"
    ]
  }
}