Blueprints¶
This page outlines DataRobot's endpoints for blueprints, a graphical representation of the many steps involved in transforming input predictors and targets into a model.
GET /api/v2/customTasks/¶
Retrieve metadata for all custom tasks the user has access to.
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. |
| orderBy | query | string | false | Sort order which will be applied to custom task 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 tasks being returned in order of creation time descending. |
| searchFor | query | string | false | String to search for occurrence in custom task's description, language and name. Search is case insensitive. If not specified, all custom tasks will be returned. |
Enumerated Values¶
| Parameter | Value |
|---|---|
| orderBy | [created, -created, updated, -updated] |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of custom tasks.",
"items": {
"properties": {
"calibratePredictions": {
"description": "Determines whether or not predictions should be calibrated by DataRobot. Only applies to anomaly detection.",
"type": "boolean"
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"createdBy": {
"description": "The username of the custom task creator.",
"type": "string"
},
"customModelType": {
"description": "The type of custom task.",
"enum": [
"training",
"inference"
],
"type": "string",
"x-versiondeprecated": "v2.25"
},
"description": {
"description": "The description of the task.",
"type": "string"
},
"id": {
"description": "The ID of the custom task.",
"type": "string"
},
"language": {
"description": "The programming language used by the task.",
"type": "string"
},
"latestVersion": {
"description": "The latest version for the custom task (if this field is empty the task is not ready for use).",
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this task version.",
"type": [
"string",
"null"
]
},
"baseEnvironmentVersionId": {
"description": "The base environment version to use with this task version.",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"customModelId": {
"description": "an alias for customTaskId",
"type": "string",
"x-versiondeprecated": "v2.25"
},
"customTaskId": {
"description": "the ID of the custom task.",
"type": "string"
},
"dependencies": {
"description": "The parsed dependencies of the custom task version if the version has a valid requirements.txt file.",
"items": {
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"description": {
"description": "Description of a custom task version.",
"type": [
"string",
"null"
]
},
"id": {
"description": "the ID of the custom model version created.",
"type": "string"
},
"isFrozen": {
"description": "If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).",
"type": "boolean",
"x-versiondeprecated": "v2.34"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"label": {
"description": "A semantic version number of the major and minor version.",
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"versionMajor": {
"description": "The major version number, incremented on deployments or larger file changes.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number, incremented on general file changes.",
"type": "integer"
},
"warning": {
"description": "Warnings about the custom task version",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"created",
"customModelId",
"customTaskId",
"description",
"id",
"isFrozen",
"items",
"label",
"outboundNetworkPolicy",
"versionMajor",
"versionMinor"
],
"type": "object"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"name": {
"description": "The name of the task.",
"type": "string"
},
"targetType": {
"description": "The target type of the custom task.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"Anomaly",
"Transform",
"TextGeneration",
"GeoPoint"
],
"type": "string"
},
"updated": {
"description": "ISO-8601 timestamp of when task was last updated.",
"type": "string"
}
},
"required": [
"created",
"createdBy",
"customModelType",
"description",
"id",
"language",
"latestVersion",
"name",
"targetType",
"updated"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK. | CustomTaskListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/customTasks/¶
Creates a new custom task and returns the newly created metadata record for it.
A custom task may either be an estimator or a transform. Estimators must support a single target type (e.g. binaryClassification, regression). Regression and anomaly detection models are 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
}
Transforms are expected to return a dataframe or sparse matrix with the same number of rows as the input feature matrix. At this time, only numeric outputs are supported for custom transforms.
Body parameter¶
{
"properties": {
"calibratePredictions": {
"default": true,
"description": "Whether model predictions should be calibrated by DataRobot.Only applies to anomaly detection; we recommend this if you have not already included calibration in your model code.Calibration improves the probability estimates of a model, and modifies the predictions of non-probabilistic models to be interpretable as probabilities. This will facilitate comparison to DataRobot models, and give access to ROC curve insights on external data.",
"type": "boolean"
},
"description": {
"description": "The user-friendly description of the task.",
"maxLength": 10000,
"type": "string"
},
"language": {
"description": "Programming language name in which task is written.",
"maxLength": 500,
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"name": {
"description": "The user-friendly name for the task.",
"maxLength": 255,
"type": "string"
},
"targetType": {
"description": "The target type of the custom task",
"enum": [
"Binary",
"Regression",
"Multiclass",
"Anomaly",
"Transform",
"TextGeneration",
"GeoPoint"
],
"type": "string"
}
},
"required": [
"name",
"targetType"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CustomTaskCreate | false | none |
Example responses¶
201 Response
{
"properties": {
"calibratePredictions": {
"description": "Determines whether or not predictions should be calibrated by DataRobot. Only applies to anomaly detection.",
"type": "boolean"
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"createdBy": {
"description": "The username of the custom task creator.",
"type": "string"
},
"customModelType": {
"description": "The type of custom task.",
"enum": [
"training",
"inference"
],
"type": "string",
"x-versiondeprecated": "v2.25"
},
"description": {
"description": "The description of the task.",
"type": "string"
},
"id": {
"description": "The ID of the custom task.",
"type": "string"
},
"language": {
"description": "The programming language used by the task.",
"type": "string"
},
"latestVersion": {
"description": "The latest version for the custom task (if this field is empty the task is not ready for use).",
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this task version.",
"type": [
"string",
"null"
]
},
"baseEnvironmentVersionId": {
"description": "The base environment version to use with this task version.",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"customModelId": {
"description": "an alias for customTaskId",
"type": "string",
"x-versiondeprecated": "v2.25"
},
"customTaskId": {
"description": "the ID of the custom task.",
"type": "string"
},
"dependencies": {
"description": "The parsed dependencies of the custom task version if the version has a valid requirements.txt file.",
"items": {
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"description": {
"description": "Description of a custom task version.",
"type": [
"string",
"null"
]
},
"id": {
"description": "the ID of the custom model version created.",
"type": "string"
},
"isFrozen": {
"description": "If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).",
"type": "boolean",
"x-versiondeprecated": "v2.34"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"label": {
"description": "A semantic version number of the major and minor version.",
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"versionMajor": {
"description": "The major version number, incremented on deployments or larger file changes.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number, incremented on general file changes.",
"type": "integer"
},
"warning": {
"description": "Warnings about the custom task version",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"created",
"customModelId",
"customTaskId",
"description",
"id",
"isFrozen",
"items",
"label",
"outboundNetworkPolicy",
"versionMajor",
"versionMinor"
],
"type": "object"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"name": {
"description": "The name of the task.",
"type": "string"
},
"targetType": {
"description": "The target type of the custom task.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"Anomaly",
"Transform",
"TextGeneration",
"GeoPoint"
],
"type": "string"
},
"updated": {
"description": "ISO-8601 timestamp of when task was last updated.",
"type": "string"
}
},
"required": [
"created",
"createdBy",
"customModelType",
"description",
"id",
"language",
"latestVersion",
"name",
"targetType",
"updated"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Custom task successfully created. | CustomTaskResponse |
| 403 | Forbidden | Custom task creation is not enabled. | None |
| 422 | Unprocessable Entity | Input parameters invalid | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/customTasks/fromCustomTask/¶
Creates a copy of the provided custom task, including metadata, versions of that task, and uploaded files. Associates the new versions with files owned by the custom task.
Body parameter¶
{
"properties": {
"customTaskId": {
"description": "ID of the custom task to copy.",
"type": "string"
}
},
"required": [
"customTaskId"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CustomTaskCopy | false | none |
Example responses¶
201 Response
{
"properties": {
"calibratePredictions": {
"description": "Determines whether or not predictions should be calibrated by DataRobot. Only applies to anomaly detection.",
"type": "boolean"
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"createdBy": {
"description": "The username of the custom task creator.",
"type": "string"
},
"customModelType": {
"description": "The type of custom task.",
"enum": [
"training",
"inference"
],
"type": "string",
"x-versiondeprecated": "v2.25"
},
"description": {
"description": "The description of the task.",
"type": "string"
},
"id": {
"description": "The ID of the custom task.",
"type": "string"
},
"language": {
"description": "The programming language used by the task.",
"type": "string"
},
"latestVersion": {
"description": "The latest version for the custom task (if this field is empty the task is not ready for use).",
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this task version.",
"type": [
"string",
"null"
]
},
"baseEnvironmentVersionId": {
"description": "The base environment version to use with this task version.",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"customModelId": {
"description": "an alias for customTaskId",
"type": "string",
"x-versiondeprecated": "v2.25"
},
"customTaskId": {
"description": "the ID of the custom task.",
"type": "string"
},
"dependencies": {
"description": "The parsed dependencies of the custom task version if the version has a valid requirements.txt file.",
"items": {
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"description": {
"description": "Description of a custom task version.",
"type": [
"string",
"null"
]
},
"id": {
"description": "the ID of the custom model version created.",
"type": "string"
},
"isFrozen": {
"description": "If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).",
"type": "boolean",
"x-versiondeprecated": "v2.34"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"label": {
"description": "A semantic version number of the major and minor version.",
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"versionMajor": {
"description": "The major version number, incremented on deployments or larger file changes.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number, incremented on general file changes.",
"type": "integer"
},
"warning": {
"description": "Warnings about the custom task version",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"created",
"customModelId",
"customTaskId",
"description",
"id",
"isFrozen",
"items",
"label",
"outboundNetworkPolicy",
"versionMajor",
"versionMinor"
],
"type": "object"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"name": {
"description": "The name of the task.",
"type": "string"
},
"targetType": {
"description": "The target type of the custom task.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"Anomaly",
"Transform",
"TextGeneration",
"GeoPoint"
],
"type": "string"
},
"updated": {
"description": "ISO-8601 timestamp of when task was last updated.",
"type": "string"
}
},
"required": [
"created",
"createdBy",
"customModelType",
"description",
"id",
"language",
"latestVersion",
"name",
"targetType",
"updated"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Successfully created copy. | CustomTaskResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/customTasks/{customTaskId}/¶
Delete a custom task. Only users who have permission to edit custom task can delete it. Only custom tasks which are not currently deployed, used in a blueprint, or in the AIcatalog can be deleted. Relevant CustomTaskImage will be deleted also.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | The ID of the custom task. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Record deleted. | None |
| 409 | Conflict | This custom task is currently deployed, trained, or part of a user blueprint, and cannot be deleted. The response body will contain link where these conflicts can be retrieved. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/customTasks/{customTaskId}/¶
Retrieve metadata for a custom task
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | The ID of the custom task. |
Example responses¶
200 Response
{
"properties": {
"calibratePredictions": {
"description": "Determines whether or not predictions should be calibrated by DataRobot. Only applies to anomaly detection.",
"type": "boolean"
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"createdBy": {
"description": "The username of the custom task creator.",
"type": "string"
},
"customModelType": {
"description": "The type of custom task.",
"enum": [
"training",
"inference"
],
"type": "string",
"x-versiondeprecated": "v2.25"
},
"description": {
"description": "The description of the task.",
"type": "string"
},
"id": {
"description": "The ID of the custom task.",
"type": "string"
},
"language": {
"description": "The programming language used by the task.",
"type": "string"
},
"latestVersion": {
"description": "The latest version for the custom task (if this field is empty the task is not ready for use).",
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this task version.",
"type": [
"string",
"null"
]
},
"baseEnvironmentVersionId": {
"description": "The base environment version to use with this task version.",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"customModelId": {
"description": "an alias for customTaskId",
"type": "string",
"x-versiondeprecated": "v2.25"
},
"customTaskId": {
"description": "the ID of the custom task.",
"type": "string"
},
"dependencies": {
"description": "The parsed dependencies of the custom task version if the version has a valid requirements.txt file.",
"items": {
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"description": {
"description": "Description of a custom task version.",
"type": [
"string",
"null"
]
},
"id": {
"description": "the ID of the custom model version created.",
"type": "string"
},
"isFrozen": {
"description": "If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).",
"type": "boolean",
"x-versiondeprecated": "v2.34"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"label": {
"description": "A semantic version number of the major and minor version.",
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"versionMajor": {
"description": "The major version number, incremented on deployments or larger file changes.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number, incremented on general file changes.",
"type": "integer"
},
"warning": {
"description": "Warnings about the custom task version",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"created",
"customModelId",
"customTaskId",
"description",
"id",
"isFrozen",
"items",
"label",
"outboundNetworkPolicy",
"versionMajor",
"versionMinor"
],
"type": "object"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"name": {
"description": "The name of the task.",
"type": "string"
},
"targetType": {
"description": "The target type of the custom task.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"Anomaly",
"Transform",
"TextGeneration",
"GeoPoint"
],
"type": "string"
},
"updated": {
"description": "ISO-8601 timestamp of when task was last updated.",
"type": "string"
}
},
"required": [
"created",
"createdBy",
"customModelType",
"description",
"id",
"language",
"latestVersion",
"name",
"targetType",
"updated"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK. | CustomTaskResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/customTasks/{customTaskId}/¶
Updates metadata for an existing custom task.
All custom tasks must support one target type (e.g. binaryClassification, regression, transform).
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 task
has active deployments.
Body parameter¶
{
"properties": {
"description": {
"description": "The user-friendly description of the task.",
"maxLength": 10000,
"type": "string"
},
"language": {
"description": "Programming language name in which task is written.",
"maxLength": 500,
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"name": {
"description": "The user-friendly name for the task.",
"maxLength": 255,
"type": "string"
}
},
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | The ID of the custom task. |
| body | body | CustomTaskUpdate | false | none |
Example responses¶
201 Response
{
"properties": {
"calibratePredictions": {
"description": "Determines whether or not predictions should be calibrated by DataRobot. Only applies to anomaly detection.",
"type": "boolean"
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"createdBy": {
"description": "The username of the custom task creator.",
"type": "string"
},
"customModelType": {
"description": "The type of custom task.",
"enum": [
"training",
"inference"
],
"type": "string",
"x-versiondeprecated": "v2.25"
},
"description": {
"description": "The description of the task.",
"type": "string"
},
"id": {
"description": "The ID of the custom task.",
"type": "string"
},
"language": {
"description": "The programming language used by the task.",
"type": "string"
},
"latestVersion": {
"description": "The latest version for the custom task (if this field is empty the task is not ready for use).",
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this task version.",
"type": [
"string",
"null"
]
},
"baseEnvironmentVersionId": {
"description": "The base environment version to use with this task version.",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"customModelId": {
"description": "an alias for customTaskId",
"type": "string",
"x-versiondeprecated": "v2.25"
},
"customTaskId": {
"description": "the ID of the custom task.",
"type": "string"
},
"dependencies": {
"description": "The parsed dependencies of the custom task version if the version has a valid requirements.txt file.",
"items": {
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"description": {
"description": "Description of a custom task version.",
"type": [
"string",
"null"
]
},
"id": {
"description": "the ID of the custom model version created.",
"type": "string"
},
"isFrozen": {
"description": "If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).",
"type": "boolean",
"x-versiondeprecated": "v2.34"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"label": {
"description": "A semantic version number of the major and minor version.",
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"versionMajor": {
"description": "The major version number, incremented on deployments or larger file changes.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number, incremented on general file changes.",
"type": "integer"
},
"warning": {
"description": "Warnings about the custom task version",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"created",
"customModelId",
"customTaskId",
"description",
"id",
"isFrozen",
"items",
"label",
"outboundNetworkPolicy",
"versionMajor",
"versionMinor"
],
"type": "object"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"name": {
"description": "The name of the task.",
"type": "string"
},
"targetType": {
"description": "The target type of the custom task.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"Anomaly",
"Transform",
"TextGeneration",
"GeoPoint"
],
"type": "string"
},
"updated": {
"description": "ISO-8601 timestamp of when task was last updated.",
"type": "string"
}
},
"required": [
"created",
"createdBy",
"customModelType",
"description",
"id",
"language",
"latestVersion",
"name",
"targetType",
"updated"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created. | CustomTaskResponse |
| 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/customTasks/{customTaskId}/accessControl/¶
Get a list of users who have access to this custom task and their roles on it.
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. |
| customTaskId | path | string | true | The ID of the custom task. |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "Number of items in current page.",
"type": "integer"
},
"data": {
"description": "List of the requested custom task access control entries.",
"items": {
"properties": {
"canShare": {
"description": "Whether this user can share this custom task",
"type": "boolean"
},
"role": {
"description": "This users role.",
"type": "string"
},
"userId": {
"description": "This user's userId.",
"type": "string"
},
"username": {
"description": "The username for this user's entry.",
"type": "string"
}
},
"required": [
"canShare",
"role",
"userId",
"username"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page",
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"count",
"data",
"next",
"previous"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A list of users who have access to this custom task and their roles on it. | CustomTaskAccessControlListResponse |
| 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/customTasks/{customTaskId}/accessControl/¶
Grant access or update roles for users on this custom task and appropriate learning data. Up to 100 user roles may be set in a single request.
Body parameter¶
{
"properties": {
"data": {
"description": "List of sharing roles to update.",
"items": {
"properties": {
"canShare": {
"default": true,
"description": "Whether the org/group/user should be able to share with others.If true, the org/group/user will be able to grant any role up to and includingtheir own to other orgs/groups/user. If `role` is `NO_ROLE` `canShare` is ignored.",
"type": "boolean"
},
"role": {
"description": "The role to set on the entity. When it is None, the role of this user will be removedfrom this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of the user to update the access role for.",
"type": "string"
}
},
"required": [
"role",
"username"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | The ID of the custom task. |
| body | body | SharingUpdateOrRemoveWithGrant | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Roles updated successfully. | None |
| 409 | Conflict | The request would leave the custom task 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/customTasks/{customTaskId}/download/¶
Download the latest item bundle from a custom task as a zip compressed archive.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | The ID of the custom task. |
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- |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/customTasks/{customTaskId}/versions/¶
List custom task versions.
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. |
| customTaskId | path | string | true | The ID of the custom task. |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of custom task versions.",
"items": {
"description": "The latest version for the custom task (if this field is empty the task is not ready for use).",
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this task version.",
"type": [
"string",
"null"
]
},
"baseEnvironmentVersionId": {
"description": "The base environment version to use with this task version.",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"customModelId": {
"description": "an alias for customTaskId",
"type": "string",
"x-versiondeprecated": "v2.25"
},
"customTaskId": {
"description": "the ID of the custom task.",
"type": "string"
},
"dependencies": {
"description": "The parsed dependencies of the custom task version if the version has a valid requirements.txt file.",
"items": {
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"description": {
"description": "Description of a custom task version.",
"type": [
"string",
"null"
]
},
"id": {
"description": "the ID of the custom model version created.",
"type": "string"
},
"isFrozen": {
"description": "If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).",
"type": "boolean",
"x-versiondeprecated": "v2.34"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"label": {
"description": "A semantic version number of the major and minor version.",
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"versionMajor": {
"description": "The major version number, incremented on deployments or larger file changes.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number, incremented on general file changes.",
"type": "integer"
},
"warning": {
"description": "Warnings about the custom task version",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"created",
"customModelId",
"customTaskId",
"description",
"id",
"isFrozen",
"items",
"label",
"outboundNetworkPolicy",
"versionMajor",
"versionMinor"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK. | CustomTaskVersionListResponse |
| 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
PATCH /api/v2/customTasks/{customTaskId}/versions/¶
Create a new custom task version with files added, replaced or deleted. Files from the previous version of a custom task will be used as a basis.
Body parameter¶
properties:
baseEnvironmentId:
description: The base environment to use with this custom task version.
type: string
file:
description: 'A file with code for a custom task or a custom model. For each
file supplied as form data, you must have a corresponding `filePath`
supplied that shows the relative location of the file. For example, you
have two files: `/home/username/custom-task/main.py` and
`/home/username/custom-task/helpers/helper.py`. When uploading these
files, you would _also_ need to include two `filePath` fields of,
`"main.py"` and `"helpers/helper.py"`. If the supplied `file` already
exists at the supplied `filePath`, the old file is replaced by the new
file.'
format: binary
type: string
filePath:
description: The local path of the file being uploaded. See the `file` field
explanation for more details.
oneOf:
- type: string
- items:
type: string
maxItems: 1000
type: array
filesToDelete:
description: The IDs of the files to be deleted.
oneOf:
- type: string
- items:
type: string
maxItems: 100
type: array
isMajorUpdate:
default: "true"
description: If set to true, new major version will created, otherwise minor
version will be created.
enum:
- "false"
- "False"
- "true"
- "True"
type: string
maximumMemory:
description: DEPRECATED! The maximum memory that might be allocated by the
custom-model. If exceeded, the custom-model will be killed.
maximum: 15032385536
minimum: 134217728
type:
- integer
- "null"
x-versiondeprecated: 2.32.0
outboundNetworkPolicy:
description: What kind of outbound network calls are allowed. If ISOLATED, then
no outbound network calls are allowed. If PUBLIC, then network calls are
allowed to any public ip address.
enum:
- ISOLATED
- PUBLIC
type: string
x-versionadded: 2.32.0
requiredMetadata:
description: Additional parameters required by the execution environment. The
required keys are defined by the fieldNames in the base environment's
requiredMetadataKeys. Once set, they cannot be changed. If you to change
them, make a new version.
type: string
x-versionadded: v2.25
x-versiondeprecated: v2.26
requiredMetadataValues:
description: Additional parameters required by the execution environment. The
required fieldNames are defined by the fieldNames in the base
environment's requiredMetadataKeys.
type: string
x-versionadded: v2.26
required:
- baseEnvironmentId
- isMajorUpdate
type: object
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | The ID of the custom task. |
| body | body | CustomTaskVersionCreateFromLatest | false | none |
Example responses¶
201 Response
{
"description": "The latest version for the custom task (if this field is empty the task is not ready for use).",
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this task version.",
"type": [
"string",
"null"
]
},
"baseEnvironmentVersionId": {
"description": "The base environment version to use with this task version.",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"customModelId": {
"description": "an alias for customTaskId",
"type": "string",
"x-versiondeprecated": "v2.25"
},
"customTaskId": {
"description": "the ID of the custom task.",
"type": "string"
},
"dependencies": {
"description": "The parsed dependencies of the custom task version if the version has a valid requirements.txt file.",
"items": {
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"description": {
"description": "Description of a custom task version.",
"type": [
"string",
"null"
]
},
"id": {
"description": "the ID of the custom model version created.",
"type": "string"
},
"isFrozen": {
"description": "If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).",
"type": "boolean",
"x-versiondeprecated": "v2.34"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"label": {
"description": "A semantic version number of the major and minor version.",
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"versionMajor": {
"description": "The major version number, incremented on deployments or larger file changes.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number, incremented on general file changes.",
"type": "integer"
},
"warning": {
"description": "Warnings about the custom task version",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"created",
"customModelId",
"customTaskId",
"description",
"id",
"isFrozen",
"items",
"label",
"outboundNetworkPolicy",
"versionMajor",
"versionMinor"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Item successfully created. | CustomTaskVersionResponse |
| 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/customTasks/{customTaskId}/versions/¶
Create a new custom task version with attached files if supplied.
Body parameter¶
properties:
baseEnvironmentId:
description: The base environment to use with this custom task version.
type: string
file:
description: 'A file with code for a custom task or a custom model. For each
file supplied as form data, you must have a corresponding `filePath`
supplied that shows the relative location of the file. For example, you
have two files: `/home/username/custom-task/main.py` and
`/home/username/custom-task/helpers/helper.py`. When uploading these
files, you would _also_ need to include two `filePath` fields of,
`"main.py"` and `"helpers/helper.py"`. If the supplied `file` already
exists at the supplied `filePath`, the old file is replaced by the new
file.'
format: binary
type: string
filePath:
description: The local path of the file being uploaded. See the `file` field
explanation for more details.
oneOf:
- type: string
- items:
type: string
maxItems: 1000
type: array
isMajorUpdate:
default: "true"
description: If set to true, new major version will created, otherwise minor
version will be created.
enum:
- "false"
- "False"
- "true"
- "True"
type: string
maximumMemory:
description: DEPRECATED! The maximum memory that might be allocated by the
custom-model. If exceeded, the custom-model will be killed.
maximum: 15032385536
minimum: 134217728
type:
- integer
- "null"
x-versiondeprecated: 2.32.0
outboundNetworkPolicy:
description: What kind of outbound network calls are allowed. If ISOLATED, then
no outbound network calls are allowed. If PUBLIC, then network calls are
allowed to any public ip address.
enum:
- ISOLATED
- PUBLIC
type: string
x-versionadded: 2.32.0
requiredMetadata:
description: Additional parameters required by the execution environment. The
required keys are defined by the fieldNames in the base environment's
requiredMetadataKeys. Once set, they cannot be changed. If you to change
them, make a new version.
type: string
x-versionadded: v2.25
x-versiondeprecated: v2.26
requiredMetadataValues:
description: Additional parameters required by the execution environment. The
required fieldNames are defined by the fieldNames in the base
environment's requiredMetadataKeys.
type: string
x-versionadded: v2.26
required:
- baseEnvironmentId
- isMajorUpdate
type: object
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | The ID of the custom task. |
| body | body | CustomTaskVersionCreate | false | none |
Example responses¶
201 Response
{
"description": "The latest version for the custom task (if this field is empty the task is not ready for use).",
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this task version.",
"type": [
"string",
"null"
]
},
"baseEnvironmentVersionId": {
"description": "The base environment version to use with this task version.",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"customModelId": {
"description": "an alias for customTaskId",
"type": "string",
"x-versiondeprecated": "v2.25"
},
"customTaskId": {
"description": "the ID of the custom task.",
"type": "string"
},
"dependencies": {
"description": "The parsed dependencies of the custom task version if the version has a valid requirements.txt file.",
"items": {
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"description": {
"description": "Description of a custom task version.",
"type": [
"string",
"null"
]
},
"id": {
"description": "the ID of the custom model version created.",
"type": "string"
},
"isFrozen": {
"description": "If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).",
"type": "boolean",
"x-versiondeprecated": "v2.34"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"label": {
"description": "A semantic version number of the major and minor version.",
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"versionMajor": {
"description": "The major version number, incremented on deployments or larger file changes.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number, incremented on general file changes.",
"type": "integer"
},
"warning": {
"description": "Warnings about the custom task version",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"created",
"customModelId",
"customTaskId",
"description",
"id",
"isFrozen",
"items",
"label",
"outboundNetworkPolicy",
"versionMajor",
"versionMinor"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Item successfully created. | CustomTaskVersionResponse |
| 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/customTasks/{customTaskId}/versions/fromRepository/¶
Create a new custom task version with files added from a remote repository. Files from the previous version of a custom task will be used as a basis.
Body parameter¶
{
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this version.",
"type": "string",
"x-versionadded": "v2.22"
},
"isMajorUpdate": {
"default": true,
"description": "If set to true, new major version will created, otherwise minor version will be created.",
"type": "boolean"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"ref": {
"description": "Remote reference (branch, commit, etc). Latest, if not specified.",
"type": "string"
},
"repositoryId": {
"description": "The ID of remote repository used to pull sources. This ID can be found using the /api/v2/remoteRepositories/ endpoint.",
"type": "string"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"sourcePath": {
"description": "A remote repository file path to be pulled into a custom model or custom task.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
]
}
},
"required": [
"baseEnvironmentId",
"repositoryId"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | The ID of the custom task. |
| body | body | CustomTaskVersionCreateFromRepository | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Accepted: request placed to a queue for processing. | None |
| 422 | Unprocessable Entity | Input parameters are invalid. | 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/customTasks/{customTaskId}/versions/fromRepository/¶
Create a new custom task version with only files added from the specified remote repository.
Body parameter¶
{
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this version.",
"type": "string",
"x-versionadded": "v2.22"
},
"isMajorUpdate": {
"default": true,
"description": "If set to true, new major version will created, otherwise minor version will be created.",
"type": "boolean"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"ref": {
"description": "Remote reference (branch, commit, etc). Latest, if not specified.",
"type": "string"
},
"repositoryId": {
"description": "The ID of remote repository used to pull sources. This ID can be found using the /api/v2/remoteRepositories/ endpoint.",
"type": "string"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"sourcePath": {
"description": "A remote repository file path to be pulled into a custom model or custom task.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
]
}
},
"required": [
"baseEnvironmentId",
"repositoryId"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | The ID of the custom task. |
| body | body | CustomTaskVersionCreateFromRepository | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Accepted: request placed to a queue for processing. | None |
| 422 | Unprocessable Entity | Input parameters are invalid. | 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/customTasks/{customTaskId}/versions/{customTaskVersionId}/¶
Display a requested version of a custom task along with the files attached to it.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | ID of the custom task. |
| customTaskVersionId | path | string | true | ID of the custom task version. |
Example responses¶
200 Response
{
"description": "The latest version for the custom task (if this field is empty the task is not ready for use).",
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this task version.",
"type": [
"string",
"null"
]
},
"baseEnvironmentVersionId": {
"description": "The base environment version to use with this task version.",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"customModelId": {
"description": "an alias for customTaskId",
"type": "string",
"x-versiondeprecated": "v2.25"
},
"customTaskId": {
"description": "the ID of the custom task.",
"type": "string"
},
"dependencies": {
"description": "The parsed dependencies of the custom task version if the version has a valid requirements.txt file.",
"items": {
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"description": {
"description": "Description of a custom task version.",
"type": [
"string",
"null"
]
},
"id": {
"description": "the ID of the custom model version created.",
"type": "string"
},
"isFrozen": {
"description": "If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).",
"type": "boolean",
"x-versiondeprecated": "v2.34"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"label": {
"description": "A semantic version number of the major and minor version.",
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"versionMajor": {
"description": "The major version number, incremented on deployments or larger file changes.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number, incremented on general file changes.",
"type": "integer"
},
"warning": {
"description": "Warnings about the custom task version",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"created",
"customModelId",
"customTaskId",
"description",
"id",
"isFrozen",
"items",
"label",
"outboundNetworkPolicy",
"versionMajor",
"versionMinor"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK. | CustomTaskVersionResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/¶
Edit metadata of a specific task version.
Body parameter¶
{
"properties": {
"description": {
"description": "New description for the custom task or model.",
"maxLength": 10000,
"type": "string"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
}
},
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | ID of the custom task. |
| customTaskVersionId | path | string | true | ID of the custom task version. |
| body | body | CustomTaskVersionMetadataUpdate | false | none |
Example responses¶
200 Response
{
"description": "The latest version for the custom task (if this field is empty the task is not ready for use).",
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this task version.",
"type": [
"string",
"null"
]
},
"baseEnvironmentVersionId": {
"description": "The base environment version to use with this task version.",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"customModelId": {
"description": "an alias for customTaskId",
"type": "string",
"x-versiondeprecated": "v2.25"
},
"customTaskId": {
"description": "the ID of the custom task.",
"type": "string"
},
"dependencies": {
"description": "The parsed dependencies of the custom task version if the version has a valid requirements.txt file.",
"items": {
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"description": {
"description": "Description of a custom task version.",
"type": [
"string",
"null"
]
},
"id": {
"description": "the ID of the custom model version created.",
"type": "string"
},
"isFrozen": {
"description": "If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).",
"type": "boolean",
"x-versiondeprecated": "v2.34"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"label": {
"description": "A semantic version number of the major and minor version.",
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"versionMajor": {
"description": "The major version number, incremented on deployments or larger file changes.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number, incremented on general file changes.",
"type": "integer"
},
"warning": {
"description": "Warnings about the custom task version",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"created",
"customModelId",
"customTaskId",
"description",
"id",
"isFrozen",
"items",
"label",
"outboundNetworkPolicy",
"versionMajor",
"versionMinor"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The edit was successful. | CustomTaskVersionResponse |
| 404 | Not Found | Custom task not found or user does not have edit permissions. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuild/¶
Cancel the custom task version's dependency build.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | ID of the custom task. |
| customTaskVersionId | path | string | true | ID of the custom task version. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Custom task version's dependency build was cancelled. | None |
| 409 | Conflict | Custom task dependency build has reached a terminal state and cannot be cancelled. | None |
| 422 | Unprocessable Entity | No custom task 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/customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuild/¶
Retrieve the custom task version's dependency build status.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | ID of the custom task. |
| customTaskVersionId | path | string | true | ID of the custom task version. |
Example responses¶
200 Response
{
"properties": {
"buildEnd": {
"description": "The ISO-8601 encoded time when this build completed.",
"type": [
"string",
"null"
]
},
"buildLogLocation": {
"description": "The URL to download the build logs from this build.",
"format": "uri",
"type": [
"string",
"null"
]
},
"buildStart": {
"description": "The ISO-8601 encoded time when this build started.",
"type": "string"
},
"buildStatus": {
"description": "The current status of the dependency build.",
"enum": [
"submitted",
"processing",
"failed",
"success"
],
"type": "string"
},
"customTaskId": {
"description": "The ID of custom task.",
"type": "string"
},
"customTaskVersionId": {
"description": "The ID of custom task version.",
"type": "string"
}
},
"required": [
"buildEnd",
"buildLogLocation",
"buildStart",
"buildStatus",
"customTaskId",
"customTaskVersionId"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The metadata from the custom task version's dependency build. | CustomTaskVersionDependencyBuildMetadataResponse |
| 422 | Unprocessable Entity | Custom task 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/customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuild/¶
Start a custom task version's dependency build. This is required to test, deploy, or train custom tasks.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | ID of the custom task. |
| customTaskVersionId | path | string | true | ID of the custom task version. |
Example responses¶
202 Response
{
"properties": {
"buildEnd": {
"description": "The ISO-8601 encoded time when this build completed.",
"type": [
"string",
"null"
]
},
"buildLogLocation": {
"description": "The URL to download the build logs from this build.",
"format": "uri",
"type": [
"string",
"null"
]
},
"buildStart": {
"description": "The ISO-8601 encoded time when this build started.",
"type": "string"
},
"buildStatus": {
"description": "The current status of the dependency build.",
"enum": [
"submitted",
"processing",
"failed",
"success"
],
"type": "string"
},
"customTaskId": {
"description": "The ID of custom task.",
"type": "string"
},
"customTaskVersionId": {
"description": "The ID of custom task version.",
"type": "string"
}
},
"required": [
"buildEnd",
"buildLogLocation",
"buildStart",
"buildStatus",
"customTaskId",
"customTaskVersionId"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Custom task version's dependency build has started. | CustomTaskVersionDependencyBuildMetadataResponse |
| 422 | Unprocessable Entity | Custom task 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/customTasks/{customTaskId}/versions/{customTaskVersionId}/dependencyBuildLog/¶
Retrieve the custom task version's dependency build log.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | ID of the custom task. |
| customTaskVersionId | path | string | true | ID of the custom task version. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The log file generated during the custom task version's dependency build. | None |
| 404 | Not Found | Dependency build is in progress or could not be found. | None |
| 422 | Unprocessable Entity | Custom task 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/customTasks/{customTaskId}/versions/{customTaskVersionId}/download/¶
Download a specific item bundle from a custom task as a zip compressed archive.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customTaskId | path | string | true | ID of the custom task. |
| customTaskVersionId | path | string | true | ID of the custom task version. |
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- |
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.
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, False, true, True] |
| targetTypes | [Binary, Regression, Multiclass, Anomaly, Transform, TextGeneration, GeoPoint, Unstructured, VectorDatabase, AgenticWorkflow] |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of training model blueprints.",
"items": {
"properties": {
"createdAt": {
"description": "ISO-8601 timestamp of when the blueprint was created.",
"type": "string"
},
"customModel": {
"description": "Custom model associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model.",
"type": "string"
},
"name": {
"description": "User-friendly name of the model.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"customModelVersion": {
"description": "Custom model version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the model version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"executionEnvironment": {
"description": "Execution environment associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment.",
"type": "string"
},
"name": {
"description": "User-friendly name of the execution environment.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"executionEnvironmentVersion": {
"description": "Execution environment version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the execution environment version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"targetType": {
"description": "The target type of the training model.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"Anomaly",
"Transform",
"TextGeneration",
"GeoPoint",
"Unstructured",
"VectorDatabase",
"AgenticWorkflow"
],
"type": "string"
},
"trainingHistory": {
"description": "List of instances of this blueprint having been trained.",
"items": {
"properties": {
"creationDate": {
"description": "ISO-8601 timestamp of when the project the blueprint was trained on was created.",
"type": "string"
},
"lid": {
"description": "The leaderboard ID the blueprint was trained on.",
"type": "string"
},
"pid": {
"description": "The project ID the blueprint was trained on.",
"type": "string"
},
"projectModelsCount": {
"description": "Number of models in the project the blueprint was trained on.",
"type": "integer"
},
"projectName": {
"description": "The project name the blueprint was trained on.",
"type": "string"
},
"targetName": {
"description": "The target name of the project the blueprint was trained on.",
"type": "string"
}
},
"required": [
"creationDate",
"lid",
"pid",
"projectModelsCount",
"projectName",
"targetName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"userBlueprintId": {
"description": "User Blueprint ID that can be used to train the model.",
"type": "string"
}
},
"required": [
"createdAt",
"customModel",
"customModelVersion",
"executionEnvironment",
"executionEnvironmentVersion",
"targetType",
"trainingHistory",
"userBlueprintId"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
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.
Body parameter¶
{
"properties": {
"customModelVersionId": {
"description": "The ID of the specific model version from which to create a custom training blueprint.",
"type": "string"
}
},
"required": [
"customModelVersionId"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CustomTrainingBlueprintCreate | false | none |
Example responses¶
201 Response
{
"properties": {
"createdAt": {
"description": "ISO-8601 timestamp of when the blueprint was created.",
"type": "string"
},
"customModel": {
"description": "Custom model associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model.",
"type": "string"
},
"name": {
"description": "User-friendly name of the model.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"customModelVersion": {
"description": "Custom model version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the model version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"executionEnvironment": {
"description": "Execution environment associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment.",
"type": "string"
},
"name": {
"description": "User-friendly name of the execution environment.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"executionEnvironmentVersion": {
"description": "Execution environment version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the execution environment version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"targetType": {
"description": "The target type of the training model.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"Anomaly",
"Transform",
"TextGeneration",
"GeoPoint",
"Unstructured",
"VectorDatabase",
"AgenticWorkflow"
],
"type": "string"
},
"trainingHistory": {
"description": "List of instances of this blueprint having been trained.",
"items": {
"properties": {
"creationDate": {
"description": "ISO-8601 timestamp of when the project the blueprint was trained on was created.",
"type": "string"
},
"lid": {
"description": "The leaderboard ID the blueprint was trained on.",
"type": "string"
},
"pid": {
"description": "The project ID the blueprint was trained on.",
"type": "string"
},
"projectModelsCount": {
"description": "Number of models in the project the blueprint was trained on.",
"type": "integer"
},
"projectName": {
"description": "The project name the blueprint was trained on.",
"type": "string"
},
"targetName": {
"description": "The target name of the project the blueprint was trained on.",
"type": "string"
}
},
"required": [
"creationDate",
"lid",
"pid",
"projectModelsCount",
"projectName",
"targetName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"userBlueprintId": {
"description": "User Blueprint ID that can be used to train the model.",
"type": "string"
}
},
"required": [
"createdAt",
"customModel",
"customModelVersion",
"executionEnvironment",
"executionEnvironmentVersion",
"targetType",
"trainingHistory",
"userBlueprintId"
],
"type": "object"
}
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/imageAugmentationLists/¶
List of augmentation lists that match the specified query.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| projectId | query | string | true | Project ID to retrieve augmentation lists from |
| featureName | query | string | false | Name of the image feature that the augmentation list is associated with |
| offset | query | integer | true | This many results will be skipped |
| limit | query | integer | true | At most this many results are returned. To specify no limit, use 0. The default may change without notice. |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The content in the form of an augmentation lists",
"items": {
"properties": {
"featureName": {
"description": "The name of the image feature containing the data to be augmented",
"type": "string"
},
"id": {
"description": "Image Augmentation list ID",
"type": "string"
},
"inUse": {
"default": false,
"description": "This is set to true when the Augmentation List has been used to train a model",
"type": "boolean"
},
"initialList": {
"default": false,
"description": "Whether this list will be used during autopilot to perform image augmentation",
"type": "boolean"
},
"name": {
"description": "The name of the image augmentation list",
"type": "string"
},
"numberOfNewImages": {
"description": "Number of new rows to add for each existing row",
"minimum": 1,
"type": "integer"
},
"projectId": {
"description": "The project containing the image data to be augmented",
"type": "string"
},
"samplesId": {
"default": null,
"description": "Image Augmentation list samples ID",
"type": [
"string",
"null"
]
},
"transformationProbability": {
"description": "Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"transformations": {
"description": "List of Transformations to possibly apply to each image",
"items": {
"properties": {
"enabled": {
"default": false,
"description": "Whether this transformation is enabled by default",
"type": "boolean"
},
"name": {
"description": "Transformation name",
"type": "string"
},
"params": {
"description": "Config values for transformation",
"items": {
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"id",
"name",
"numberOfNewImages",
"projectId",
"transformationProbability",
"transformations"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Image Augmentation Lists | ImageAugmentationListsResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/imageAugmentationLists/¶
Creates a new augmentation list based on the posted payload data.
Body parameter¶
{
"properties": {
"featureName": {
"description": "The name of the image feature containing the data to be augmented",
"type": "string"
},
"inUse": {
"default": false,
"description": "This parameter was deprecated. You can still pass a value, but it will be ignored. DataRobot will takes care of the value itself.",
"type": "boolean",
"x-versiondeprecated": "2.30.0"
},
"initialList": {
"default": false,
"description": "Whether this list will be used during autopilot to perform image augmentation",
"type": "boolean"
},
"name": {
"description": "The name of the image augmentation list",
"type": "string"
},
"numberOfNewImages": {
"description": "Number of new rows to add for each existing row",
"minimum": 1,
"type": "integer"
},
"projectId": {
"description": "The project containing the image data to be augmented",
"type": "string"
},
"samplesId": {
"default": null,
"description": "Image Augmentation list samples ID",
"type": [
"string",
"null"
]
},
"transformationProbability": {
"description": "Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"transformations": {
"description": "List of Transformations to possibly apply to each image",
"items": {
"properties": {
"enabled": {
"default": false,
"description": "Whether this transformation is enabled by default",
"type": "boolean"
},
"name": {
"description": "Transformation name",
"type": "string"
},
"params": {
"description": "Config values for transformation",
"items": {
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name",
"numberOfNewImages",
"projectId",
"transformationProbability",
"transformations"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ImageAugmentationListsCreate | false | none |
Example responses¶
201 Response
{
"properties": {
"augmentationListId": {
"description": "\n Id of the newly created augmentation list which can be used to:\n - retrieve the full augmentation list details;\n - retrieve augmentation previews;\n - to set the list id of a model in advanced tuning;\n - to delete or rename the list.\n ",
"type": "string"
}
},
"required": [
"augmentationListId"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Augmentation list id | ImageAugmentationListCreateResponse |
| 422 | Unprocessable Entity | Unable to create image augmentation list with the given input | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/imageAugmentationLists/{augmentationId}/¶
Delete an existing augmentation lists by id
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| augmentationId | path | string | true | The id of the augmentation list to fetch |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | The successful response is empty | None |
| 400 | Bad Request | Cannot delete an augmentation list that is marked as in_use. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/imageAugmentationLists/{augmentationId}/¶
Returns a single augmentation list with the specified id.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| augmentationId | path | string | true | The id of the augmentation list to fetch |
Example responses¶
200 Response
{
"properties": {
"featureName": {
"description": "The name of the image feature containing the data to be augmented",
"type": "string"
},
"id": {
"description": "Image Augmentation list ID",
"type": "string"
},
"inUse": {
"default": false,
"description": "This is set to true when the Augmentation List has been used to train a model",
"type": "boolean"
},
"initialList": {
"default": false,
"description": "Whether this list will be used during autopilot to perform image augmentation",
"type": "boolean"
},
"name": {
"description": "The name of the image augmentation list",
"type": "string"
},
"numberOfNewImages": {
"description": "Number of new rows to add for each existing row",
"minimum": 1,
"type": "integer"
},
"projectId": {
"description": "The project containing the image data to be augmented",
"type": "string"
},
"samplesId": {
"default": null,
"description": "Image Augmentation list samples ID",
"type": [
"string",
"null"
]
},
"transformationProbability": {
"description": "Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"transformations": {
"description": "List of Transformations to possibly apply to each image",
"items": {
"properties": {
"enabled": {
"default": false,
"description": "Whether this transformation is enabled by default",
"type": "boolean"
},
"name": {
"description": "Transformation name",
"type": "string"
},
"params": {
"description": "Config values for transformation",
"items": {
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"id",
"name",
"numberOfNewImages",
"projectId",
"transformationProbability",
"transformations"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns an augmentation list object | ImageAugmentationListsRetrieve |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/imageAugmentationLists/{augmentationId}/¶
Update an existing augmentation list, with passed in values.
Body parameter¶
{
"properties": {
"featureName": {
"description": "The name of the image feature containing the data to be augmented",
"type": "string"
},
"inUse": {
"description": "This parameter was deprecated. You can still pass a value, but it will be ignored. DataRobot will takes care of the value itself.",
"type": "boolean",
"x-versiondeprecated": "2.30.0"
},
"initialList": {
"description": "Whether this list will be used during autopilot to perform image augmentation",
"type": "boolean"
},
"name": {
"description": "The name of the image augmentation list",
"type": "string"
},
"numberOfNewImages": {
"description": "Number of new rows to add for each existing row",
"minimum": 0,
"type": "integer"
},
"projectId": {
"description": "This parameter was deprecated. You can still pass a value, but it will be ignored. If you want to move an augmentation list to another project you can create a new list in the other project and delete the list in this project.",
"type": "string",
"x-versiondeprecated": "2.30.0"
},
"transformationProbability": {
"description": "Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"transformations": {
"description": "List of Transformations to possibly apply to each image",
"items": {
"properties": {
"enabled": {
"default": false,
"description": "Whether this transformation is enabled by default",
"type": "boolean"
},
"name": {
"description": "Transformation name",
"type": "string"
},
"params": {
"description": "Config values for transformation",
"items": {
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| augmentationId | path | string | true | The id of the augmentation list to fetch |
| body | body | ImageAugmentationListPatchParam | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | The successful response is empty | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/imageAugmentationLists/{augmentationId}/samples/¶
Retrieve latest Augmentation Samples generated for list
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. |
| augmentationId | path | string | true | The id of the augmentation list |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "Augmentation samples list",
"items": {
"properties": {
"height": {
"description": "Height of the image in pixels",
"type": "integer"
},
"imageId": {
"description": "Id of the image. The augmented image file can be retrieved with [GET /api/v2/projects/{projectId}/images/{imageId}/file/][get-apiv2projectsprojectidimagesimageidfile]",
"type": "string"
},
"originalImageId": {
"description": "Id of the original image that was transformed to produce the augmented image. If this is an original image (from the original training dataset) this value will be null. The id can be used to retrieve the original image file with: [GET /api/v2/projects/{projectId}/images/{imageId}/file/][get-apiv2projectsprojectidimagesimageidfile]",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "Project id",
"type": "string"
},
"width": {
"description": "Width of the image in pixels",
"type": "integer"
}
},
"required": [
"height",
"imageId",
"originalImageId",
"projectId",
"width"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ImageAugmentationListsRetrieveSamplesResponse |
| 404 | Not Found | Augmentation Samples not found | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/imageAugmentationLists/{augmentationId}/samples/¶
This endpoint will schedule a job to augment the specified images from a project's dataset and return a link to monitor the status of the job, as well as a link to retrieve the resulting augmented images.
Body parameter¶
{
"properties": {
"numberOfRows": {
"description": "Number of images from the original dataset to be augmented",
"minimum": 1,
"type": "integer"
}
},
"required": [
"numberOfRows"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| augmentationId | path | string | true | The id of the augmentation list |
| body | body | ImageAugmentationListsCreateSamples | false | none |
Example responses¶
202 Response
{
"properties": {
"statusId": {
"description": "Id of the newly created augmentation samples which can be used to retrieve the full set of sample images.",
"type": "string"
}
},
"required": [
"statusId"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Image Augmentation Samples generation has been successfully requested | ImageAugmentationSamplesResponse |
Response Headers¶
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 202 | Location | string | URL that can be polled to check the status of the operation. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/imageAugmentationOptions/{projectId}/¶
Augmentation list of all available transformations that are supported in the system.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| projectId | path | string | true | The project ID |
Example responses¶
200 Response
{
"properties": {
"currentNumberOfNewImages": {
"description": "Number of new images to be created for each original image during training",
"type": "integer"
},
"currentTransformationProbability": {
"description": "Probability that each transformation included in an augmentation list will be applied to an image, if `affectedByTransformationProbability` for that transformation is True",
"type": "number"
},
"featureName": {
"description": "Name of the image feature that the augmentation list is associated with",
"type": "string"
},
"id": {
"description": "Augmentation list id",
"type": "string"
},
"maxNumberOfNewImages": {
"description": "Maximum number of new images per original image to be generated during training",
"type": "integer"
},
"maxTransformationProbability": {
"description": "Maximum probability that each enabled augmentation will be applied to an image",
"maximum": 1,
"type": "number"
},
"minNumberOfNewImages": {
"description": "Minimum number of new images per original image to be generated during training",
"type": "integer"
},
"minTransformationProbability": {
"description": "Minimum probability that each enabled augmentation will be applied to an image",
"minimum": 0,
"type": "number"
},
"name": {
"description": "The name of the augmentation list",
"type": "string"
},
"projectId": {
"description": "The id of the project containing the image data to be augmented",
"type": "string"
},
"transformations": {
"description": "List of Transformations to possibly apply to each image",
"items": {
"properties": {
"affectedByTransformationProbability": {
"description": "If true, whenever this transformation is included in an augmentation list, this transformation will be applied to each image with probability set by the Transformation Probability. If false, whenever this transformation is included in an augmentation list, this transformation will be applied to each image with probability described in the Platform Documentation here: https://docs.datarobot.com/en/docs/modeling/special-workflows/visual-ai/tti-augment/ttia-lists.html#transformations",
"type": "boolean"
},
"enabledByDefault": {
"description": "Determines if the parameter should be default selected in the UI",
"type": "boolean"
},
"name": {
"description": "The name of the transformation",
"type": "string"
},
"params": {
"description": "The list of parameters that control the transformation",
"items": {
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
},
"translatedName": {
"description": "Translated name of the parameter",
"type": "string"
},
"type": {
"description": "The type of the parameter (int, float, etc...)",
"type": "string"
}
},
"required": [
"name",
"translatedName",
"type"
],
"type": "object"
},
"type": "array"
},
"translatedName": {
"description": "Translated name of the transformation",
"type": "string"
}
},
"required": [
"affectedByTransformationProbability",
"enabledByDefault",
"name",
"params",
"translatedName"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"currentNumberOfNewImages",
"currentTransformationProbability",
"id",
"maxNumberOfNewImages",
"maxTransformationProbability",
"minNumberOfNewImages",
"minTransformationProbability",
"name",
"projectId",
"transformations"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Augmentation list object | ImageAugmentationOptionsResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/imageAugmentationSamples/¶
(Deprecated in v2.28) This endpoint will schedule a job to augment the specified images from a project's dataset and return a link to monitor the status of the job, as well as a link to retrieve the resulting augmented images.
Body parameter¶
{
"properties": {
"featureName": {
"description": "The name of the image feature containing the data to be augmented",
"type": "string"
},
"id": {
"description": "Augmentation list id",
"type": "string"
},
"inUse": {
"default": false,
"description": "This is set to true when the Augmentation List has been used to train a model",
"type": "boolean"
},
"initialList": {
"default": false,
"description": "Whether this list will be used during autopilot to perform image augmentation",
"type": "boolean"
},
"name": {
"description": "The name of the image augmentation list",
"type": "string"
},
"numberOfNewImages": {
"description": "Number of new rows to add for each existing row",
"minimum": 1,
"type": "integer"
},
"numberOfRows": {
"description": "Number of images from the original dataset to be augmented",
"minimum": 1,
"type": "integer"
},
"projectId": {
"description": "The project containing the image data to be augmented",
"type": "string"
},
"samplesId": {
"default": null,
"description": "Image Augmentation list samples ID",
"type": [
"string",
"null"
]
},
"transformationProbability": {
"description": "Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"transformations": {
"description": "List of Transformations to possibly apply to each image",
"items": {
"properties": {
"enabled": {
"default": false,
"description": "Whether this transformation is enabled by default",
"type": "boolean"
},
"name": {
"description": "Transformation name",
"type": "string"
},
"params": {
"description": "Config values for transformation",
"items": {
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name",
"numberOfNewImages",
"numberOfRows",
"projectId",
"transformationProbability",
"transformations"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ImageAugmentationSamplesRequest | false | none |
Example responses¶
202 Response
{
"properties": {
"statusId": {
"description": "Id of the newly created augmentation samples which can be used to retrieve the full set of sample images.",
"type": "string"
}
},
"required": [
"statusId"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Image Augmentation Samples generation has been successfully requested | ImageAugmentationSamplesResponse |
Response Headers¶
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 202 | Location | string | URL that can be polled to check the status of the operation. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/imageAugmentationSamples/{samplesId}/¶
(Deprecated in v2.28) Retrieve previously generated Augmentation Samples. This route is being deprecated please use GET /imageAugmentationLists/<augmentationId>/samples route instead.
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. |
| samplesId | path | string | true | Id of the augmentation sample |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "Augmentation samples list",
"items": {
"properties": {
"height": {
"description": "Height of the image in pixels",
"type": "integer"
},
"imageId": {
"description": "Id of the image. The augmented image file can be retrieved with [GET /api/v2/projects/{projectId}/images/{imageId}/file/][get-apiv2projectsprojectidimagesimageidfile]",
"type": "string"
},
"originalImageId": {
"description": "Id of the original image that was transformed to produce the augmented image. If this is an original image (from the original training dataset) this value will be null. The id can be used to retrieve the original image file with: [GET /api/v2/projects/{projectId}/images/{imageId}/file/][get-apiv2projectsprojectidimagesimageidfile]",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "Project id",
"type": "string"
},
"width": {
"description": "Width of the image in pixels",
"type": "integer"
}
},
"required": [
"height",
"imageId",
"originalImageId",
"projectId",
"width"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ImageAugmentationRetrieveSamplesResponse |
| 404 | Not Found | Augmentation Samples 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}/blueprints/¶
List appropriate blueprints for the project.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| projectId | path | string | true | The project ID. |
Example responses¶
200 Response
{
"items": {
"properties": {
"blueprintCategory": {
"description": "describes the category of the blueprint and indicates the kind of model this blueprint produces. Will be either \"DataRobot\" or \"Scaleout DataRobot\".",
"type": "string",
"x-versionadded": "v2.6"
},
"id": {
"description": "the blueprint ID of this blueprint - note that this is not an ObjectId.",
"type": "string"
},
"isCustomModelBlueprint": {
"description": "Whether blueprint contains custom task.",
"type": "boolean"
},
"modelType": {
"description": "the model this blueprint will produce.",
"type": "string"
},
"monotonicDecreasingFeaturelistId": {
"description": "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.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.11"
},
"monotonicIncreasingFeaturelistId": {
"description": "null or str, 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.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.11"
},
"processes": {
"description": "a list of strings representing processes the blueprint uses.",
"items": {
"type": "string"
},
"type": "array"
},
"projectId": {
"description": "the project the blueprint belongs to.",
"type": "string"
},
"recommendedFeaturelistId": {
"description": "The ID of the feature list recommended for this blueprint. If this field is not present, then there is no recommended feature list.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.18"
},
"supportsComposableMl": {
"description": "indicates whether this blueprint is supported in Composable ML.",
"type": "boolean",
"x-versionadded": "v2.26"
},
"supportsIncrementalLearning": {
"description": "Whether blueprint supports incremental learning.",
"type": "boolean",
"x-versionadded": "v2.32"
},
"supportsMonotonicConstraints": {
"description": "whether this model supports enforcing monotonic constraints.",
"type": "boolean",
"x-versionadded": "v2.11"
}
},
"required": [
"blueprintCategory",
"id",
"isCustomModelBlueprint",
"modelType",
"monotonicDecreasingFeaturelistId",
"monotonicIncreasingFeaturelistId",
"processes",
"projectId",
"supportsComposableMl",
"supportsIncrementalLearning",
"supportsMonotonicConstraints"
],
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The list of blueprints | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [BlueprintResponse] | false | none | |
| » blueprintCategory | string | true | describes the category of the blueprint and indicates the kind of model this blueprint produces. Will be either "DataRobot" or "Scaleout DataRobot". | |
| » id | string | true | the blueprint ID of this blueprint - note that this is not an ObjectId. | |
| » isCustomModelBlueprint | boolean | true | Whether blueprint contains custom task. | |
| » modelType | string | true | the model this blueprint will produce. | |
| » monotonicDecreasingFeaturelistId | string,null | true | 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 | null or str, 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. | |
| » processes | [string] | true | a list of strings representing processes the blueprint uses. | |
| » projectId | string | true | the project the blueprint belongs to. | |
| » recommendedFeaturelistId | string,null | false | The ID of the feature list recommended for this blueprint. If this field is not present, then there is no recommended feature list. | |
| » supportsComposableMl | boolean | true | indicates whether this blueprint is supported in Composable ML. | |
| » supportsIncrementalLearning | boolean | true | Whether blueprint supports incremental learning. | |
| » supportsMonotonicConstraints | boolean | true | whether this model supports enforcing monotonic constraints. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/projects/{projectId}/blueprints/{blueprintId}/¶
Retrieve a blueprint by its ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| projectId | path | string | true | The project ID. |
| blueprintId | path | string | true | The blueprint ID. |
Example responses¶
200 Response
{
"properties": {
"blueprintCategory": {
"description": "describes the category of the blueprint and indicates the kind of model this blueprint produces. Will be either \"DataRobot\" or \"Scaleout DataRobot\".",
"type": "string",
"x-versionadded": "v2.6"
},
"id": {
"description": "the blueprint ID of this blueprint - note that this is not an ObjectId.",
"type": "string"
},
"isCustomModelBlueprint": {
"description": "Whether blueprint contains custom task.",
"type": "boolean"
},
"modelType": {
"description": "the model this blueprint will produce.",
"type": "string"
},
"monotonicDecreasingFeaturelistId": {
"description": "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.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.11"
},
"monotonicIncreasingFeaturelistId": {
"description": "null or str, 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.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.11"
},
"processes": {
"description": "a list of strings representing processes the blueprint uses.",
"items": {
"type": "string"
},
"type": "array"
},
"projectId": {
"description": "the project the blueprint belongs to.",
"type": "string"
},
"recommendedFeaturelistId": {
"description": "The ID of the feature list recommended for this blueprint. If this field is not present, then there is no recommended feature list.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.18"
},
"supportsComposableMl": {
"description": "indicates whether this blueprint is supported in Composable ML.",
"type": "boolean",
"x-versionadded": "v2.26"
},
"supportsIncrementalLearning": {
"description": "Whether blueprint supports incremental learning.",
"type": "boolean",
"x-versionadded": "v2.32"
},
"supportsMonotonicConstraints": {
"description": "whether this model supports enforcing monotonic constraints.",
"type": "boolean",
"x-versionadded": "v2.11"
}
},
"required": [
"blueprintCategory",
"id",
"isCustomModelBlueprint",
"modelType",
"monotonicDecreasingFeaturelistId",
"monotonicIncreasingFeaturelistId",
"processes",
"projectId",
"supportsComposableMl",
"supportsIncrementalLearning",
"supportsMonotonicConstraints"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A blueprint based on its blueprint ID. | BlueprintResponse |
| 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}/blueprints/{blueprintId}/blueprintChart/¶
Retrieve a blueprint chart by blueprint id.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| projectId | path | string | true | The project ID. |
| blueprintId | path | string | true | The blueprint ID. |
Example responses¶
200 Response
{
"properties": {
"edges": {
"description": "An array of chart edges - tuples of (start_id, end_id).",
"items": {
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"nodes": {
"description": "An array of node descriptions.",
"items": {
"properties": {
"id": {
"description": "The ID of the node.",
"type": "string"
},
"label": {
"description": "The label of the node.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"edges",
"nodes"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A blueprint chart based on the blueprint id. | BlueprintChartRetrieveResponse |
| 404 | Not Found | No blueprint data found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/projects/{projectId}/blueprints/{blueprintId}/blueprintDocs/¶
Retrieve blueprint tasks documentation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| projectId | path | string | true | The project ID. |
| blueprintId | path | string | true | The blueprint ID. |
Example responses¶
200 Response
{
"items": {
"properties": {
"description": {
"description": "The task description.",
"type": "string"
},
"links": {
"description": "A list of external documentation links.",
"items": {
"properties": {
"name": {
"description": "The name of the documentation at the link.",
"type": "string"
},
"url": {
"description": "The URL at which external documentation can be found.",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"type": "array"
},
"parameters": {
"description": "An array of task parameters.",
"items": {
"properties": {
"description": {
"description": "A description of what the parameter does.",
"type": "string"
},
"name": {
"description": "The name of the parameter.",
"type": "string"
},
"type": {
"description": "The type (and default value) of the parameter.",
"type": "string"
}
},
"required": [
"description",
"name",
"type"
],
"type": "object"
},
"type": "array"
},
"references": {
"description": "A list of reference links.",
"items": {
"properties": {
"name": {
"description": "The name of the reference.",
"type": "string"
},
"url": {
"description": "The URL at which the reference can be found.",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"type": "array"
},
"task": {
"description": "The task described in document.",
"type": "string"
},
"title": {
"description": "The document title.",
"type": "string"
}
},
"required": [
"description",
"links",
"parameters",
"references",
"task",
"title"
],
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The task documentation for a blueprint. | Inline |
| 404 | Not Found | Model document missing. | None |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [BlueprintListDocumentsResponse] | false | none | |
| » description | string | true | The task description. | |
| » links | [BlueprintDocLinks] | true | A list of external documentation links. | |
| »» name | string | true | The name of the documentation at the link. | |
| »» url | string,null | true | The URL at which external documentation can be found. | |
| » parameters | [BlueprintDocParameters] | true | An array of task parameters. | |
| »» description | string | true | A description of what the parameter does. | |
| »» name | string | true | The name of the parameter. | |
| »» type | string | true | The type (and default value) of the parameter. | |
| » references | [BlueprintDocReferences] | true | A list of reference links. | |
| »» name | string | true | The name of the reference. | |
| »» url | string,null | true | The URL at which the reference can be found. | |
| » task | string | true | The task described in document. | |
| » title | string | true | The document title. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/projects/{projectId}/blueprints/{blueprintId}/json/¶
Retrieve a blueprint json by its ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| projectId | path | string | true | The project ID. |
| blueprintId | path | string | true | The blueprint ID. |
Example responses¶
200 Response
{
"properties": {
"blueprint": {
"description": "JSON blueprint representation of the model.",
"example": "\n {\n \"1\": [[\"NUM\"], [\"PNI2\"], \"T\"],\n \"2\": [[\"1\"], [\"LASSO2\"], \"P\"],\n }\n ",
"type": "object",
"x-versionadded": "v2.31"
}
},
"required": [
"blueprint"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Blueprint json based on its blueprint ID. | BlueprintJsonResponse |
| 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}/blueprintChart/¶
Retrieve a reduced model blueprint chart by model id. The model blueprint charts are reduced from the full blueprint charts to show only those sections of the blueprint that were actually used in the model, given the selected featurelist.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| projectId | path | string | true | The project ID |
| modelId | path | string | true | The model ID |
Example responses¶
200 Response
{
"properties": {
"edges": {
"description": "An array of chart edges - tuples of (start_id, end_id).",
"items": {
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"nodes": {
"description": "An array of node descriptions.",
"items": {
"properties": {
"id": {
"description": "The ID of the node.",
"type": "string"
},
"label": {
"description": "The label of the node.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"edges",
"nodes"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A reduced model blueprint chart based on the model id. | BlueprintChartRetrieveResponse |
| 404 | Not Found | No model found for given projectId and modelId. | 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}/blueprintDocs/¶
Retrieve task documentation for a reduced model blueprint. The model blueprint is reduced from the full blueprint to show only those sections of the blueprint that were actually used in the model, given the selected featurelist.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| projectId | path | string | true | The project ID |
| modelId | path | string | true | The model ID |
Example responses¶
200 Response
{
"items": {
"properties": {
"description": {
"description": "The task description.",
"type": "string"
},
"links": {
"description": "A list of external documentation links.",
"items": {
"properties": {
"name": {
"description": "The name of the documentation at the link.",
"type": "string"
},
"url": {
"description": "The URL at which external documentation can be found.",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"type": "array"
},
"parameters": {
"description": "An array of task parameters.",
"items": {
"properties": {
"description": {
"description": "A description of what the parameter does.",
"type": "string"
},
"name": {
"description": "The name of the parameter.",
"type": "string"
},
"type": {
"description": "The type (and default value) of the parameter.",
"type": "string"
}
},
"required": [
"description",
"name",
"type"
],
"type": "object"
},
"type": "array"
},
"references": {
"description": "A list of reference links.",
"items": {
"properties": {
"name": {
"description": "The name of the reference.",
"type": "string"
},
"url": {
"description": "The URL at which the reference can be found.",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"type": "array"
},
"task": {
"description": "The task described in document.",
"type": "string"
},
"title": {
"description": "The document title.",
"type": "string"
}
},
"required": [
"description",
"links",
"parameters",
"references",
"task",
"title"
],
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The task documentation for a reduced model blueprint. | Inline |
| 404 | Not Found | No model found for given projectId and modelId. | None |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [BlueprintListDocumentsResponse] | false | none | |
| » description | string | true | The task description. | |
| » links | [BlueprintDocLinks] | true | A list of external documentation links. | |
| »» name | string | true | The name of the documentation at the link. | |
| »» url | string,null | true | The URL at which external documentation can be found. | |
| » parameters | [BlueprintDocParameters] | true | An array of task parameters. | |
| »» description | string | true | A description of what the parameter does. | |
| »» name | string | true | The name of the parameter. | |
| »» type | string | true | The type (and default value) of the parameter. | |
| » references | [BlueprintDocReferences] | true | A list of reference links. | |
| »» name | string | true | The name of the reference. | |
| »» url | string,null | true | The URL at which the reference can be found. | |
| » task | string | true | The task described in document. | |
| » title | string | true | The document title. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/userBlueprints/¶
Delete user blueprints, specified by userBlueprintIds.
Body parameter¶
{
"properties": {
"userBlueprintIds": {
"description": "A list of IDs of user blueprints to be deleted.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"required": [
"userBlueprintIds"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | UserBlueprintsBulkDelete | false | none |
Example responses¶
200 Response
{
"properties": {
"failedToDelete": {
"description": "List of IDs of User Blueprints which failed to be deleted.",
"items": {
"description": "An ID of a User Blueprint which failed to be deleted.",
"type": "string"
},
"type": "array"
},
"successfullyDeleted": {
"description": "List of IDs of User Blueprints successfully deleted.",
"items": {
"description": "An ID of a User Blueprint successfully deleted.",
"type": "string"
},
"type": "array"
}
},
"required": [
"failedToDelete",
"successfullyDeleted"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A list of user blueprints successfully and unsuccessfully deleted. | UserBlueprintsBulkDeleteResponse |
| 401 | Unauthorized | User is not authorized. | None |
| 403 | Forbidden | User does not have access to this functionality. | None |
| 422 | Unprocessable Entity | Unprocessable Entity | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/userBlueprints/¶
Fetch a list of the user blueprints the current user has access to
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | integer | true | The number of results to skip (for pagination). |
| limit | query | integer | true | The max number of results to return. |
| projectId | query | string | false | The id of the project, used to filter for original project_id. |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "Number of records on this page",
"type": "integer"
},
"data": {
"description": "List of user blueprints",
"items": {
"properties": {
"blender": {
"default": false,
"description": "Whether the blueprint is a blender.",
"type": "boolean"
},
"blueprintId": {
"description": "The deterministic id of the blueprint, based on its content.",
"type": "string"
},
"customTaskVersionMetadata": {
"description": "An association of custom entity ids and task ids.",
"items": {
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"decompressedFormat": {
"default": false,
"description": "Whether the blueprint is in the decompressed format.",
"type": "boolean"
},
"diagram": {
"description": "The diagram used by the UI to display the blueprint.",
"type": "string"
},
"features": {
"description": "A list of the names of tasks used in the blueprint.",
"items": {
"type": "string"
},
"type": "array"
},
"featuresText": {
"description": "A description of the blueprint via the names of tasks used.",
"type": "string"
},
"hexColumnNameLookup": {
"description": "A lookup between hex values and data column names used in the blueprint.",
"items": {
"properties": {
"colname": {
"description": "The name of the column.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"projectId": {
"description": "The id of the project from which the column name originates.",
"type": "string"
}
},
"required": [
"colname",
"hex"
],
"type": "object"
},
"type": "array"
},
"hiddenFromCatalog": {
"description": "If true, the blueprint will not show up in the catalog",
"type": "boolean"
},
"icons": {
"description": "The icon(s) associated with the blueprint.",
"items": {
"type": "integer"
},
"type": "array"
},
"insights": {
"description": "An indication of the insights generated by the blueprint.",
"type": "string"
},
"isTimeSeries": {
"default": false,
"description": "Whether the blueprint contains time-series tasks.",
"type": "boolean"
},
"linkedToProjectId": {
"description": "Whether the user blueprint is linked to a project.",
"type": "boolean"
},
"modelType": {
"description": "The generated or provided title of the blueprint.",
"type": "string"
},
"projectId": {
"description": "The id of the project the blueprint was originally created with, if applicable.",
"type": [
"string",
"null"
]
},
"referenceModel": {
"default": false,
"description": "Whether the blueprint is a reference model.",
"type": "boolean"
},
"shapSupport": {
"default": false,
"description": "Whether the blueprint supports shapley additive explanations.",
"type": "boolean"
},
"supportedTargetTypes": {
"description": "The list of supported targets of the current blueprint.",
"items": {
"enum": [
"binary",
"multiclass",
"multilabel",
"nonnegative",
"regression",
"unsupervised",
"unsupervisedClustering"
],
"type": "string"
},
"type": "array"
},
"supportsGpu": {
"default": false,
"description": "Whether the blueprint supports execution on the GPU.",
"type": "boolean"
},
"supportsNewSeries": {
"description": "Whether the blueprint supports new series.",
"type": "boolean"
},
"userBlueprintId": {
"description": "The unique id associated with the user blueprint.",
"type": "string"
},
"userId": {
"description": "The id of the user who owns the blueprint.",
"type": "string"
}
},
"required": [
"blender",
"blueprintId",
"decompressedFormat",
"diagram",
"features",
"featuresText",
"icons",
"insights",
"isTimeSeries",
"modelType",
"referenceModel",
"shapSupport",
"supportedTargetTypes",
"supportsGpu",
"userBlueprintId",
"userId"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "URL to the next page, or `null` if there is no such page",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL to the previous page, or `null` if there is no such page",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "Total number of records",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Fetched the list of the accessible user blueprints successfully | UserBlueprintsListResponse |
| 401 | Unauthorized | User is not authorized. | None |
| 403 | Forbidden | User does not have access to this functionality. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/userBlueprints/¶
Create a user blueprint
Body parameter¶
{
"properties": {
"blueprint": {
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"oneOf": [
{
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"items": {
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
},
"decompressedBlueprint": {
"default": false,
"description": "Whether to retrieve the blueprint in the decompressed format.",
"type": "boolean"
},
"description": {
"description": "The description to give to the blueprint.",
"type": "string"
},
"getDynamicLabels": {
"default": false,
"description": "Whether to add dynamic labels to a decompressed blueprint.",
"type": "boolean"
},
"isInplaceEditor": {
"default": false,
"description": "Whether the request is sent from the in place user BP editor.",
"type": "boolean"
},
"modelType": {
"description": "The title to give to the blueprint.",
"maxLength": 1000,
"type": "string"
},
"projectId": {
"description": "String representation of ObjectId for the currently active project. The user blueprint is created when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.",
"type": [
"string",
"null"
]
},
"saveToCatalog": {
"default": true,
"description": "Whether to save the blueprint to the catalog.",
"type": "boolean"
}
},
"required": [
"blueprint",
"decompressedBlueprint",
"isInplaceEditor",
"saveToCatalog"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | UserBlueprintCreate | false | none |
Example responses¶
200 Response
{
"properties": {
"blender": {
"default": false,
"description": "Whether the blueprint is a blender.",
"type": "boolean"
},
"blueprint": {
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"oneOf": [
{
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"items": {
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
},
"blueprintId": {
"description": "The deterministic id of the blueprint, based on its content.",
"type": "string"
},
"bpData": {
"description": "Additional blueprint metadata used to render the blueprint in the UI",
"oneOf": [
{
"properties": {
"children": {
"description": "A nested dictionary representation of the blueprint DAG.",
"items": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"type": "array"
},
"id": {
"description": "The type of the node (e.g. \"start\", \"input\", \"task\").",
"type": "string"
},
"inputs": {
"description": "The inputs to the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"output": {
"description": "Ids describing the destination of any outgoing edges.",
"oneOf": [
{
"description": "Ids describing the destination of any outgoing edges.",
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 0,
"type": "array"
}
]
},
"taskMap": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"taskParameters": {
"description": "A stringified JSON object describing the parameters and their values for a task.",
"type": "string"
},
"tasks": {
"description": "The task defining the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "A unique id to represent the current node.",
"type": "string"
}
},
"required": [
"id",
"taskMap",
"tasks",
"type"
],
"type": "object"
}
]
},
"customTaskVersionMetadata": {
"description": "An association of custom entity ids and task ids.",
"items": {
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"decompressedFormat": {
"default": false,
"description": "Whether the blueprint is in the decompressed format.",
"type": "boolean"
},
"diagram": {
"description": "The diagram used by the UI to display the blueprint.",
"type": "string"
},
"features": {
"description": "A list of the names of tasks used in the blueprint.",
"items": {
"type": "string"
},
"type": "array"
},
"featuresText": {
"description": "A description of the blueprint via the names of tasks used.",
"type": "string"
},
"hexColumnNameLookup": {
"description": "A lookup between hex values and data column names used in the blueprint.",
"items": {
"properties": {
"colname": {
"description": "The name of the column.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"projectId": {
"description": "The id of the project from which the column name originates.",
"type": "string"
}
},
"required": [
"colname",
"hex"
],
"type": "object"
},
"type": "array"
},
"hiddenFromCatalog": {
"description": "If true, the blueprint will not show up in the catalog",
"type": "boolean"
},
"icons": {
"description": "The icon(s) associated with the blueprint.",
"items": {
"type": "integer"
},
"type": "array"
},
"insights": {
"description": "An indication of the insights generated by the blueprint.",
"type": "string"
},
"isTimeSeries": {
"default": false,
"description": "Whether the blueprint contains time-series tasks.",
"type": "boolean"
},
"linkedToProjectId": {
"description": "Whether the user blueprint is linked to a project.",
"type": "boolean"
},
"modelType": {
"description": "The generated or provided title of the blueprint.",
"type": "string"
},
"projectId": {
"description": "The id of the project the blueprint was originally created with, if applicable.",
"type": [
"string",
"null"
]
},
"referenceModel": {
"default": false,
"description": "Whether the blueprint is a reference model.",
"type": "boolean"
},
"shapSupport": {
"default": false,
"description": "Whether the blueprint supports shapley additive explanations.",
"type": "boolean"
},
"supportedTargetTypes": {
"description": "The list of supported targets of the current blueprint.",
"items": {
"enum": [
"binary",
"multiclass",
"multilabel",
"nonnegative",
"regression",
"unsupervised",
"unsupervisedClustering"
],
"type": "string"
},
"type": "array"
},
"supportsGpu": {
"default": false,
"description": "Whether the blueprint supports execution on the GPU.",
"type": "boolean"
},
"supportsNewSeries": {
"description": "Whether the blueprint supports new series.",
"type": "boolean"
},
"userBlueprintId": {
"description": "The unique id associated with the user blueprint.",
"type": "string"
},
"userId": {
"description": "The id of the user who owns the blueprint.",
"type": "string"
},
"vertexContext": {
"description": "Info about, warnings about, and errors with a specific vertex in the blueprint.",
"items": {
"properties": {
"information": {
"description": "A specification of requirements of the inputs and expectations of the output of the vertex.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
]
},
"messages": {
"description": "Warnings about and errors with a specific vertex in the blueprint.",
"oneOf": [
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"taskId": {
"description": "The id associated with a specific vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"blender",
"blueprint",
"blueprintId",
"bpData",
"decompressedFormat",
"diagram",
"features",
"featuresText",
"icons",
"insights",
"isTimeSeries",
"modelType",
"referenceModel",
"shapSupport",
"supportedTargetTypes",
"supportsGpu",
"userBlueprintId",
"userId",
"vertexContext"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Created the user blueprint successfully | UserBlueprintsDetailedItem |
| 401 | Unauthorized | User is not authorized. | None |
| 403 | Forbidden | User does not have access to this functionality. | None |
| 404 | Not Found | Project not found. | None |
| 422 | Unprocessable Entity | Unprocessable Entity | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/userBlueprints/fromBlueprintId/¶
Clone a blueprint from a project.
Body parameter¶
{
"properties": {
"blueprintId": {
"description": "The id associated with the blueprint to create the user blueprint from.",
"type": "string"
},
"decompressedBlueprint": {
"default": false,
"description": "Whether to retrieve the blueprint in the decompressed format.",
"type": "boolean"
},
"description": {
"description": "The description to give to the blueprint.",
"type": "string"
},
"getDynamicLabels": {
"default": false,
"description": "Whether to add dynamic labels to a decompressed blueprint.",
"type": "boolean"
},
"isInplaceEditor": {
"default": false,
"description": "Whether the request is sent from the in place user BP editor.",
"type": "boolean"
},
"modelType": {
"description": "The title to give to the blueprint.",
"maxLength": 1000,
"type": "string"
},
"projectId": {
"description": "String representation of ObjectId for the currently active project. The user blueprint is created when this project is active.",
"type": "string"
},
"saveToCatalog": {
"default": true,
"description": "Whether to save the blueprint to the catalog.",
"type": "boolean"
}
},
"required": [
"blueprintId",
"decompressedBlueprint",
"isInplaceEditor",
"projectId",
"saveToCatalog"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | UserBlueprintCreateFromBlueprintId | false | none |
Example responses¶
200 Response
{
"properties": {
"blender": {
"default": false,
"description": "Whether the blueprint is a blender.",
"type": "boolean"
},
"blueprint": {
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"oneOf": [
{
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"items": {
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
},
"blueprintId": {
"description": "The deterministic id of the blueprint, based on its content.",
"type": "string"
},
"bpData": {
"description": "Additional blueprint metadata used to render the blueprint in the UI",
"oneOf": [
{
"properties": {
"children": {
"description": "A nested dictionary representation of the blueprint DAG.",
"items": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"type": "array"
},
"id": {
"description": "The type of the node (e.g. \"start\", \"input\", \"task\").",
"type": "string"
},
"inputs": {
"description": "The inputs to the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"output": {
"description": "Ids describing the destination of any outgoing edges.",
"oneOf": [
{
"description": "Ids describing the destination of any outgoing edges.",
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 0,
"type": "array"
}
]
},
"taskMap": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"taskParameters": {
"description": "A stringified JSON object describing the parameters and their values for a task.",
"type": "string"
},
"tasks": {
"description": "The task defining the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "A unique id to represent the current node.",
"type": "string"
}
},
"required": [
"id",
"taskMap",
"tasks",
"type"
],
"type": "object"
}
]
},
"customTaskVersionMetadata": {
"description": "An association of custom entity ids and task ids.",
"items": {
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"decompressedFormat": {
"default": false,
"description": "Whether the blueprint is in the decompressed format.",
"type": "boolean"
},
"diagram": {
"description": "The diagram used by the UI to display the blueprint.",
"type": "string"
},
"features": {
"description": "A list of the names of tasks used in the blueprint.",
"items": {
"type": "string"
},
"type": "array"
},
"featuresText": {
"description": "A description of the blueprint via the names of tasks used.",
"type": "string"
},
"hexColumnNameLookup": {
"description": "A lookup between hex values and data column names used in the blueprint.",
"items": {
"properties": {
"colname": {
"description": "The name of the column.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"projectId": {
"description": "The id of the project from which the column name originates.",
"type": "string"
}
},
"required": [
"colname",
"hex"
],
"type": "object"
},
"type": "array"
},
"hiddenFromCatalog": {
"description": "If true, the blueprint will not show up in the catalog",
"type": "boolean"
},
"icons": {
"description": "The icon(s) associated with the blueprint.",
"items": {
"type": "integer"
},
"type": "array"
},
"insights": {
"description": "An indication of the insights generated by the blueprint.",
"type": "string"
},
"isTimeSeries": {
"default": false,
"description": "Whether the blueprint contains time-series tasks.",
"type": "boolean"
},
"linkedToProjectId": {
"description": "Whether the user blueprint is linked to a project.",
"type": "boolean"
},
"modelType": {
"description": "The generated or provided title of the blueprint.",
"type": "string"
},
"projectId": {
"description": "The id of the project the blueprint was originally created with, if applicable.",
"type": [
"string",
"null"
]
},
"referenceModel": {
"default": false,
"description": "Whether the blueprint is a reference model.",
"type": "boolean"
},
"shapSupport": {
"default": false,
"description": "Whether the blueprint supports shapley additive explanations.",
"type": "boolean"
},
"supportedTargetTypes": {
"description": "The list of supported targets of the current blueprint.",
"items": {
"enum": [
"binary",
"multiclass",
"multilabel",
"nonnegative",
"regression",
"unsupervised",
"unsupervisedClustering"
],
"type": "string"
},
"type": "array"
},
"supportsGpu": {
"default": false,
"description": "Whether the blueprint supports execution on the GPU.",
"type": "boolean"
},
"supportsNewSeries": {
"description": "Whether the blueprint supports new series.",
"type": "boolean"
},
"userBlueprintId": {
"description": "The unique id associated with the user blueprint.",
"type": "string"
},
"userId": {
"description": "The id of the user who owns the blueprint.",
"type": "string"
},
"vertexContext": {
"description": "Info about, warnings about, and errors with a specific vertex in the blueprint.",
"items": {
"properties": {
"information": {
"description": "A specification of requirements of the inputs and expectations of the output of the vertex.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
]
},
"messages": {
"description": "Warnings about and errors with a specific vertex in the blueprint.",
"oneOf": [
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"taskId": {
"description": "The id associated with a specific vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"blender",
"blueprint",
"blueprintId",
"bpData",
"decompressedFormat",
"diagram",
"features",
"featuresText",
"icons",
"insights",
"isTimeSeries",
"modelType",
"referenceModel",
"shapSupport",
"supportedTargetTypes",
"supportsGpu",
"userBlueprintId",
"userId",
"vertexContext"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Created the user blueprint successfully | UserBlueprintsDetailedItem |
| 401 | Unauthorized | User is not authorized. | None |
| 403 | Forbidden | User does not have access to this functionality. | None |
| 404 | Not Found | Project or blueprint not found. | None |
| 422 | Unprocessable Entity | Unprocessable Entity | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/userBlueprints/fromCustomTaskVersionId/¶
Create a user blueprint from a single custom task.
Body parameter¶
{
"properties": {
"customTaskVersionId": {
"description": "The ID of a custom task version.",
"type": "string"
},
"decompressedBlueprint": {
"default": false,
"description": "Whether to retrieve the blueprint in the decompressed format.",
"type": "boolean"
},
"description": {
"description": "The description for the user blueprint that will be created from this CustomTaskVersion.",
"type": "string"
},
"saveToCatalog": {
"default": true,
"description": "Whether to save the blueprint to the catalog.",
"type": "boolean"
}
},
"required": [
"customTaskVersionId",
"decompressedBlueprint",
"saveToCatalog"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | UserBlueprintCreateFromCustomTaskVersionIdPayload | false | none |
Example responses¶
200 Response
{
"properties": {
"blender": {
"default": false,
"description": "Whether the blueprint is a blender.",
"type": "boolean"
},
"blueprint": {
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"oneOf": [
{
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"items": {
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
},
"blueprintId": {
"description": "The deterministic id of the blueprint, based on its content.",
"type": "string"
},
"bpData": {
"description": "Additional blueprint metadata used to render the blueprint in the UI",
"oneOf": [
{
"properties": {
"children": {
"description": "A nested dictionary representation of the blueprint DAG.",
"items": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"type": "array"
},
"id": {
"description": "The type of the node (e.g. \"start\", \"input\", \"task\").",
"type": "string"
},
"inputs": {
"description": "The inputs to the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"output": {
"description": "Ids describing the destination of any outgoing edges.",
"oneOf": [
{
"description": "Ids describing the destination of any outgoing edges.",
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 0,
"type": "array"
}
]
},
"taskMap": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"taskParameters": {
"description": "A stringified JSON object describing the parameters and their values for a task.",
"type": "string"
},
"tasks": {
"description": "The task defining the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "A unique id to represent the current node.",
"type": "string"
}
},
"required": [
"id",
"taskMap",
"tasks",
"type"
],
"type": "object"
}
]
},
"customTaskVersionMetadata": {
"description": "An association of custom entity ids and task ids.",
"items": {
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"decompressedFormat": {
"default": false,
"description": "Whether the blueprint is in the decompressed format.",
"type": "boolean"
},
"diagram": {
"description": "The diagram used by the UI to display the blueprint.",
"type": "string"
},
"features": {
"description": "A list of the names of tasks used in the blueprint.",
"items": {
"type": "string"
},
"type": "array"
},
"featuresText": {
"description": "A description of the blueprint via the names of tasks used.",
"type": "string"
},
"hexColumnNameLookup": {
"description": "A lookup between hex values and data column names used in the blueprint.",
"items": {
"properties": {
"colname": {
"description": "The name of the column.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"projectId": {
"description": "The id of the project from which the column name originates.",
"type": "string"
}
},
"required": [
"colname",
"hex"
],
"type": "object"
},
"type": "array"
},
"hiddenFromCatalog": {
"description": "If true, the blueprint will not show up in the catalog",
"type": "boolean"
},
"icons": {
"description": "The icon(s) associated with the blueprint.",
"items": {
"type": "integer"
},
"type": "array"
},
"insights": {
"description": "An indication of the insights generated by the blueprint.",
"type": "string"
},
"isTimeSeries": {
"default": false,
"description": "Whether the blueprint contains time-series tasks.",
"type": "boolean"
},
"linkedToProjectId": {
"description": "Whether the user blueprint is linked to a project.",
"type": "boolean"
},
"modelType": {
"description": "The generated or provided title of the blueprint.",
"type": "string"
},
"projectId": {
"description": "The id of the project the blueprint was originally created with, if applicable.",
"type": [
"string",
"null"
]
},
"referenceModel": {
"default": false,
"description": "Whether the blueprint is a reference model.",
"type": "boolean"
},
"shapSupport": {
"default": false,
"description": "Whether the blueprint supports shapley additive explanations.",
"type": "boolean"
},
"supportedTargetTypes": {
"description": "The list of supported targets of the current blueprint.",
"items": {
"enum": [
"binary",
"multiclass",
"multilabel",
"nonnegative",
"regression",
"unsupervised",
"unsupervisedClustering"
],
"type": "string"
},
"type": "array"
},
"supportsGpu": {
"default": false,
"description": "Whether the blueprint supports execution on the GPU.",
"type": "boolean"
},
"supportsNewSeries": {
"description": "Whether the blueprint supports new series.",
"type": "boolean"
},
"userBlueprintId": {
"description": "The unique id associated with the user blueprint.",
"type": "string"
},
"userId": {
"description": "The id of the user who owns the blueprint.",
"type": "string"
},
"vertexContext": {
"description": "Info about, warnings about, and errors with a specific vertex in the blueprint.",
"items": {
"properties": {
"information": {
"description": "A specification of requirements of the inputs and expectations of the output of the vertex.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
]
},
"messages": {
"description": "Warnings about and errors with a specific vertex in the blueprint.",
"oneOf": [
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"taskId": {
"description": "The id associated with a specific vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"blender",
"blueprint",
"blueprintId",
"bpData",
"decompressedFormat",
"diagram",
"features",
"featuresText",
"icons",
"insights",
"isTimeSeries",
"modelType",
"referenceModel",
"shapSupport",
"supportedTargetTypes",
"supportsGpu",
"userBlueprintId",
"userId",
"vertexContext"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Created the user blueprint successfully | UserBlueprintsDetailedItem |
| 401 | Unauthorized | User is not authorized. | None |
| 403 | Forbidden | User does not have access to this functionality. | None |
| 404 | Not Found | Custom task version or custom task not found. | None |
| 422 | Unprocessable Entity | Unprocessable Entity | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/userBlueprints/fromUserBlueprintId/¶
Clone a user blueprint.
Body parameter¶
{
"properties": {
"decompressedBlueprint": {
"default": false,
"description": "Whether to retrieve the blueprint in the decompressed format.",
"type": "boolean"
},
"description": {
"description": "The description to give to the blueprint.",
"type": "string"
},
"getDynamicLabels": {
"default": false,
"description": "Whether to add dynamic labels to a decompressed blueprint.",
"type": "boolean"
},
"isInplaceEditor": {
"default": false,
"description": "Whether the request is sent from the in place user BP editor.",
"type": "boolean"
},
"modelType": {
"description": "The title to give to the blueprint.",
"maxLength": 1000,
"type": "string"
},
"projectId": {
"description": "String representation of ObjectId for the currently active project. The user blueprint is created when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.",
"type": [
"string",
"null"
]
},
"saveToCatalog": {
"default": true,
"description": "Whether to save the blueprint to the catalog.",
"type": "boolean"
},
"userBlueprintId": {
"description": "The id of the existing user blueprint to copy.",
"type": "string"
}
},
"required": [
"decompressedBlueprint",
"isInplaceEditor",
"saveToCatalog",
"userBlueprintId"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | UserBlueprintCreateFromUserBlueprintId | false | none |
Example responses¶
200 Response
{
"properties": {
"blender": {
"default": false,
"description": "Whether the blueprint is a blender.",
"type": "boolean"
},
"blueprint": {
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"oneOf": [
{
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"items": {
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
},
"blueprintId": {
"description": "The deterministic id of the blueprint, based on its content.",
"type": "string"
},
"bpData": {
"description": "Additional blueprint metadata used to render the blueprint in the UI",
"oneOf": [
{
"properties": {
"children": {
"description": "A nested dictionary representation of the blueprint DAG.",
"items": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"type": "array"
},
"id": {
"description": "The type of the node (e.g. \"start\", \"input\", \"task\").",
"type": "string"
},
"inputs": {
"description": "The inputs to the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"output": {
"description": "Ids describing the destination of any outgoing edges.",
"oneOf": [
{
"description": "Ids describing the destination of any outgoing edges.",
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 0,
"type": "array"
}
]
},
"taskMap": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"taskParameters": {
"description": "A stringified JSON object describing the parameters and their values for a task.",
"type": "string"
},
"tasks": {
"description": "The task defining the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "A unique id to represent the current node.",
"type": "string"
}
},
"required": [
"id",
"taskMap",
"tasks",
"type"
],
"type": "object"
}
]
},
"customTaskVersionMetadata": {
"description": "An association of custom entity ids and task ids.",
"items": {
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"decompressedFormat": {
"default": false,
"description": "Whether the blueprint is in the decompressed format.",
"type": "boolean"
},
"diagram": {
"description": "The diagram used by the UI to display the blueprint.",
"type": "string"
},
"features": {
"description": "A list of the names of tasks used in the blueprint.",
"items": {
"type": "string"
},
"type": "array"
},
"featuresText": {
"description": "A description of the blueprint via the names of tasks used.",
"type": "string"
},
"hexColumnNameLookup": {
"description": "A lookup between hex values and data column names used in the blueprint.",
"items": {
"properties": {
"colname": {
"description": "The name of the column.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"projectId": {
"description": "The id of the project from which the column name originates.",
"type": "string"
}
},
"required": [
"colname",
"hex"
],
"type": "object"
},
"type": "array"
},
"hiddenFromCatalog": {
"description": "If true, the blueprint will not show up in the catalog",
"type": "boolean"
},
"icons": {
"description": "The icon(s) associated with the blueprint.",
"items": {
"type": "integer"
},
"type": "array"
},
"insights": {
"description": "An indication of the insights generated by the blueprint.",
"type": "string"
},
"isTimeSeries": {
"default": false,
"description": "Whether the blueprint contains time-series tasks.",
"type": "boolean"
},
"linkedToProjectId": {
"description": "Whether the user blueprint is linked to a project.",
"type": "boolean"
},
"modelType": {
"description": "The generated or provided title of the blueprint.",
"type": "string"
},
"projectId": {
"description": "The id of the project the blueprint was originally created with, if applicable.",
"type": [
"string",
"null"
]
},
"referenceModel": {
"default": false,
"description": "Whether the blueprint is a reference model.",
"type": "boolean"
},
"shapSupport": {
"default": false,
"description": "Whether the blueprint supports shapley additive explanations.",
"type": "boolean"
},
"supportedTargetTypes": {
"description": "The list of supported targets of the current blueprint.",
"items": {
"enum": [
"binary",
"multiclass",
"multilabel",
"nonnegative",
"regression",
"unsupervised",
"unsupervisedClustering"
],
"type": "string"
},
"type": "array"
},
"supportsGpu": {
"default": false,
"description": "Whether the blueprint supports execution on the GPU.",
"type": "boolean"
},
"supportsNewSeries": {
"description": "Whether the blueprint supports new series.",
"type": "boolean"
},
"userBlueprintId": {
"description": "The unique id associated with the user blueprint.",
"type": "string"
},
"userId": {
"description": "The id of the user who owns the blueprint.",
"type": "string"
},
"vertexContext": {
"description": "Info about, warnings about, and errors with a specific vertex in the blueprint.",
"items": {
"properties": {
"information": {
"description": "A specification of requirements of the inputs and expectations of the output of the vertex.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
]
},
"messages": {
"description": "Warnings about and errors with a specific vertex in the blueprint.",
"oneOf": [
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"taskId": {
"description": "The id associated with a specific vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"blender",
"blueprint",
"blueprintId",
"bpData",
"decompressedFormat",
"diagram",
"features",
"featuresText",
"icons",
"insights",
"isTimeSeries",
"modelType",
"referenceModel",
"shapSupport",
"supportedTargetTypes",
"supportsGpu",
"userBlueprintId",
"userId",
"vertexContext"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Created the user blueprint successfully | UserBlueprintsDetailedItem |
| 401 | Unauthorized | User is not authorized. | None |
| 403 | Forbidden | User does not have access to this functionality. | None |
| 404 | Not Found | User blueprint or project not found. | None |
| 422 | Unprocessable Entity | Unprocessable Entity | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/userBlueprints/{userBlueprintId}/¶
Delete a user blueprint, specified by the userBlueprintId.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| userBlueprintId | path | string | true | Used to identify a specific user-owned blueprint. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Successfully deleted the specified blueprint, if it existed. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/userBlueprints/{userBlueprintId}/¶
Retrieve a user blueprint
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| editMode | query | boolean | true | Whether to retrieve the extra blueprint metadata for editing. |
| decompressedBlueprint | query | boolean | true | Whether to retrieve the blueprint in the decompressed format. |
| projectId | query | string | false | String representation of ObjectId for the currently active project. The user blueprint is retrieved when this project is active. |
| isInplaceEditor | query | boolean | true | Whether the request is sent from the in place user BP editor. |
| getDynamicLabels | query | boolean | false | Whether to add dynamic labels to a decompressed blueprint. |
| userBlueprintId | path | string | true | Used to identify a specific user-owned blueprint. |
Example responses¶
200 Response
{
"properties": {
"blender": {
"default": false,
"description": "Whether the blueprint is a blender.",
"type": "boolean"
},
"blueprint": {
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"oneOf": [
{
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"items": {
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
},
"blueprintId": {
"description": "The deterministic id of the blueprint, based on its content.",
"type": "string"
},
"bpData": {
"description": "Additional blueprint metadata used to render the blueprint in the UI",
"oneOf": [
{
"properties": {
"children": {
"description": "A nested dictionary representation of the blueprint DAG.",
"items": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"type": "array"
},
"id": {
"description": "The type of the node (e.g. \"start\", \"input\", \"task\").",
"type": "string"
},
"inputs": {
"description": "The inputs to the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"output": {
"description": "Ids describing the destination of any outgoing edges.",
"oneOf": [
{
"description": "Ids describing the destination of any outgoing edges.",
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 0,
"type": "array"
}
]
},
"taskMap": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"taskParameters": {
"description": "A stringified JSON object describing the parameters and their values for a task.",
"type": "string"
},
"tasks": {
"description": "The task defining the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "A unique id to represent the current node.",
"type": "string"
}
},
"required": [
"id",
"taskMap",
"tasks",
"type"
],
"type": "object"
}
]
},
"customTaskVersionMetadata": {
"description": "An association of custom entity ids and task ids.",
"items": {
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"decompressedFormat": {
"default": false,
"description": "Whether the blueprint is in the decompressed format.",
"type": "boolean"
},
"diagram": {
"description": "The diagram used by the UI to display the blueprint.",
"type": "string"
},
"features": {
"description": "A list of the names of tasks used in the blueprint.",
"items": {
"type": "string"
},
"type": "array"
},
"featuresText": {
"description": "A description of the blueprint via the names of tasks used.",
"type": "string"
},
"hexColumnNameLookup": {
"description": "A lookup between hex values and data column names used in the blueprint.",
"items": {
"properties": {
"colname": {
"description": "The name of the column.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"projectId": {
"description": "The id of the project from which the column name originates.",
"type": "string"
}
},
"required": [
"colname",
"hex"
],
"type": "object"
},
"type": "array"
},
"hiddenFromCatalog": {
"description": "If true, the blueprint will not show up in the catalog",
"type": "boolean"
},
"icons": {
"description": "The icon(s) associated with the blueprint.",
"items": {
"type": "integer"
},
"type": "array"
},
"insights": {
"description": "An indication of the insights generated by the blueprint.",
"type": "string"
},
"isTimeSeries": {
"default": false,
"description": "Whether the blueprint contains time-series tasks.",
"type": "boolean"
},
"linkedToProjectId": {
"description": "Whether the user blueprint is linked to a project.",
"type": "boolean"
},
"modelType": {
"description": "The generated or provided title of the blueprint.",
"type": "string"
},
"projectId": {
"description": "The id of the project the blueprint was originally created with, if applicable.",
"type": [
"string",
"null"
]
},
"referenceModel": {
"default": false,
"description": "Whether the blueprint is a reference model.",
"type": "boolean"
},
"shapSupport": {
"default": false,
"description": "Whether the blueprint supports shapley additive explanations.",
"type": "boolean"
},
"supportedTargetTypes": {
"description": "The list of supported targets of the current blueprint.",
"items": {
"enum": [
"binary",
"multiclass",
"multilabel",
"nonnegative",
"regression",
"unsupervised",
"unsupervisedClustering"
],
"type": "string"
},
"type": "array"
},
"supportsGpu": {
"default": false,
"description": "Whether the blueprint supports execution on the GPU.",
"type": "boolean"
},
"supportsNewSeries": {
"description": "Whether the blueprint supports new series.",
"type": "boolean"
},
"userBlueprintId": {
"description": "The unique id associated with the user blueprint.",
"type": "string"
},
"userId": {
"description": "The id of the user who owns the blueprint.",
"type": "string"
},
"vertexContext": {
"description": "Info about, warnings about, and errors with a specific vertex in the blueprint.",
"items": {
"properties": {
"information": {
"description": "A specification of requirements of the inputs and expectations of the output of the vertex.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
]
},
"messages": {
"description": "Warnings about and errors with a specific vertex in the blueprint.",
"oneOf": [
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"taskId": {
"description": "The id associated with a specific vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"blender",
"blueprintId",
"decompressedFormat",
"diagram",
"features",
"featuresText",
"icons",
"insights",
"isTimeSeries",
"modelType",
"referenceModel",
"shapSupport",
"supportedTargetTypes",
"supportsGpu",
"userBlueprintId",
"userId"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Retrieved the user blueprint successfully | UserBlueprintsRetrieveResponse |
| 401 | Unauthorized | User is not authorized. | None |
| 403 | Forbidden | User does not have access to this functionality. | None |
| 404 | Not Found | Referenced project or user blueprint not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/userBlueprints/{userBlueprintId}/¶
Update a user blueprint
Body parameter¶
{
"properties": {
"blueprint": {
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"oneOf": [
{
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"items": {
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
},
"decompressedBlueprint": {
"default": false,
"description": "Whether to retrieve the blueprint in the decompressed format.",
"type": "boolean"
},
"description": {
"description": "The description to give to the blueprint.",
"type": "string"
},
"getDynamicLabels": {
"default": false,
"description": "Whether to add dynamic labels to a decompressed blueprint.",
"type": "boolean"
},
"isInplaceEditor": {
"default": false,
"description": "Whether the request is sent from the in place user BP editor.",
"type": "boolean"
},
"modelType": {
"description": "The title to give to the blueprint.",
"maxLength": 1000,
"type": "string"
},
"projectId": {
"description": "String representation of ObjectId for the currently active project. The user blueprint is created when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.",
"type": [
"string",
"null"
]
},
"saveToCatalog": {
"default": true,
"description": "Whether to save the blueprint to the catalog.",
"type": "boolean"
}
},
"required": [
"decompressedBlueprint",
"isInplaceEditor",
"saveToCatalog"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| userBlueprintId | path | string | true | Used to identify a specific user-owned blueprint. |
| body | body | UserBlueprintUpdate | false | none |
Example responses¶
200 Response
{
"properties": {
"blender": {
"default": false,
"description": "Whether the blueprint is a blender.",
"type": "boolean"
},
"blueprint": {
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"oneOf": [
{
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"items": {
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
},
"blueprintId": {
"description": "The deterministic id of the blueprint, based on its content.",
"type": "string"
},
"bpData": {
"description": "Additional blueprint metadata used to render the blueprint in the UI",
"oneOf": [
{
"properties": {
"children": {
"description": "A nested dictionary representation of the blueprint DAG.",
"items": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"type": "array"
},
"id": {
"description": "The type of the node (e.g. \"start\", \"input\", \"task\").",
"type": "string"
},
"inputs": {
"description": "The inputs to the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"output": {
"description": "Ids describing the destination of any outgoing edges.",
"oneOf": [
{
"description": "Ids describing the destination of any outgoing edges.",
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 0,
"type": "array"
}
]
},
"taskMap": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"taskParameters": {
"description": "A stringified JSON object describing the parameters and their values for a task.",
"type": "string"
},
"tasks": {
"description": "The task defining the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "A unique id to represent the current node.",
"type": "string"
}
},
"required": [
"id",
"taskMap",
"tasks",
"type"
],
"type": "object"
}
]
},
"customTaskVersionMetadata": {
"description": "An association of custom entity ids and task ids.",
"items": {
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"decompressedFormat": {
"default": false,
"description": "Whether the blueprint is in the decompressed format.",
"type": "boolean"
},
"diagram": {
"description": "The diagram used by the UI to display the blueprint.",
"type": "string"
},
"features": {
"description": "A list of the names of tasks used in the blueprint.",
"items": {
"type": "string"
},
"type": "array"
},
"featuresText": {
"description": "A description of the blueprint via the names of tasks used.",
"type": "string"
},
"hexColumnNameLookup": {
"description": "A lookup between hex values and data column names used in the blueprint.",
"items": {
"properties": {
"colname": {
"description": "The name of the column.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"projectId": {
"description": "The id of the project from which the column name originates.",
"type": "string"
}
},
"required": [
"colname",
"hex"
],
"type": "object"
},
"type": "array"
},
"hiddenFromCatalog": {
"description": "If true, the blueprint will not show up in the catalog",
"type": "boolean"
},
"icons": {
"description": "The icon(s) associated with the blueprint.",
"items": {
"type": "integer"
},
"type": "array"
},
"insights": {
"description": "An indication of the insights generated by the blueprint.",
"type": "string"
},
"isTimeSeries": {
"default": false,
"description": "Whether the blueprint contains time-series tasks.",
"type": "boolean"
},
"linkedToProjectId": {
"description": "Whether the user blueprint is linked to a project.",
"type": "boolean"
},
"modelType": {
"description": "The generated or provided title of the blueprint.",
"type": "string"
},
"projectId": {
"description": "The id of the project the blueprint was originally created with, if applicable.",
"type": [
"string",
"null"
]
},
"referenceModel": {
"default": false,
"description": "Whether the blueprint is a reference model.",
"type": "boolean"
},
"shapSupport": {
"default": false,
"description": "Whether the blueprint supports shapley additive explanations.",
"type": "boolean"
},
"supportedTargetTypes": {
"description": "The list of supported targets of the current blueprint.",
"items": {
"enum": [
"binary",
"multiclass",
"multilabel",
"nonnegative",
"regression",
"unsupervised",
"unsupervisedClustering"
],
"type": "string"
},
"type": "array"
},
"supportsGpu": {
"default": false,
"description": "Whether the blueprint supports execution on the GPU.",
"type": "boolean"
},
"supportsNewSeries": {
"description": "Whether the blueprint supports new series.",
"type": "boolean"
},
"userBlueprintId": {
"description": "The unique id associated with the user blueprint.",
"type": "string"
},
"userId": {
"description": "The id of the user who owns the blueprint.",
"type": "string"
},
"vertexContext": {
"description": "Info about, warnings about, and errors with a specific vertex in the blueprint.",
"items": {
"properties": {
"information": {
"description": "A specification of requirements of the inputs and expectations of the output of the vertex.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
]
},
"messages": {
"description": "Warnings about and errors with a specific vertex in the blueprint.",
"oneOf": [
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"taskId": {
"description": "The id associated with a specific vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"blender",
"blueprint",
"blueprintId",
"bpData",
"decompressedFormat",
"diagram",
"features",
"featuresText",
"icons",
"insights",
"isTimeSeries",
"modelType",
"referenceModel",
"shapSupport",
"supportedTargetTypes",
"supportsGpu",
"userBlueprintId",
"userId",
"vertexContext"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Updated the user blueprint successfully | UserBlueprintsDetailedItem |
| 401 | Unauthorized | User is not authorized. | None |
| 403 | Forbidden | User does not have access to this functionality. | None |
| 404 | Not Found | User blueprint not found. | None |
| 422 | Unprocessable Entity | Unprocessable Entity | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/userBlueprints/{userBlueprintId}/sharedRoles/¶
Get a list of users, groups and organizations that have an access to this user blueprint
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. |
| userBlueprintId | path | string | true | Used to identify a specific user-owned blueprint. |
Enumerated Values¶
| Parameter | Value |
|---|---|
| shareRecipientType | [user, group, organization] |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "A list of SharedRoles objects.",
"items": {
"properties": {
"id": {
"description": "The ID of the recipient organization, group or user.",
"type": "string"
},
"name": {
"description": "The name of the recipient organization, group or user.",
"type": "string"
},
"role": {
"description": "The role of the org/group/user on this dataset or \"NO_ROLE\" for removing access when used with route to modify access.",
"enum": [
"CONSUMER",
"EDITOR",
"OWNER"
],
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully retrieved roles. | UserBlueprintSharedRolesListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/userBlueprints/{userBlueprintId}/sharedRoles/¶
Share a user blueprint with a user, group, or organization
Body parameter¶
{
"properties": {
"operation": {
"description": "Name of the action being taken. The only operation is 'updateRoles'.",
"enum": [
"updateRoles"
],
"type": "string"
},
"roles": {
"description": "Array of GrantAccessControl objects., up to maximum 100 objects.",
"items": {
"oneOf": [
{
"properties": {
"role": {
"description": "The role of the recipient on this entity. One of OWNER, USER, OBSERVER.",
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
},
"username": {
"description": "Username of the user to update the access role for.",
"type": "string"
}
},
"required": [
"role",
"shareRecipientType",
"username"
],
"type": "object"
},
{
"properties": {
"id": {
"description": "The ID of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity. One of OWNER, USER, OBSERVER.",
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"role",
"shareRecipientType"
],
"type": "object"
}
]
},
"maxItems": 100,
"minItems": 1,
"type": "array"
}
},
"required": [
"operation",
"roles"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| userBlueprintId | path | string | true | Used to identify a specific user-owned blueprint. |
| body | body | SharedRolesUpdate | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Roles updated successfully | None |
| 400 | Bad Request | Bad Request | None |
| 403 | Forbidden | User can view entity but does not have permission to grant these roles on the entity. | None |
| 404 | Not Found | Either the entity does not exist or the user does not have permissions to view the entity. | None |
| 409 | Conflict | The request would leave the entity without an owner. | None |
| 422 | Unprocessable Entity | The request was formatted improperly. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/userBlueprintsBulkValidations/¶
Validate many user blueprints, optionally using a specific project. Any non-existent or inaccessible user blueprints will be ignored.
Body parameter¶
{
"properties": {
"projectId": {
"description": "String representation of ObjectId for the currently active project. The user blueprint is validated when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.",
"type": "string"
},
"userBlueprintIds": {
"description": "The ids of the user blueprints to validate in bulk.",
"items": {
"description": "An id of one user blueprint to validate.",
"type": "string"
},
"type": "array"
}
},
"required": [
"userBlueprintIds"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | UserBlueprintBulkValidationRequest | false | none |
Example responses¶
201 Response
{
"properties": {
"data": {
"description": "A list of validation responses with their associated User Blueprint ID.",
"items": {
"properties": {
"userBlueprintId": {
"description": "The unique id associated with the user blueprint.",
"type": "string"
},
"vertexContext": {
"description": "Info about, warnings about, and errors with a specific vertex in the blueprint.",
"items": {
"properties": {
"information": {
"description": "A specification of requirements of the inputs and expectations of the output of the vertex.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
]
},
"messages": {
"description": "Warnings about and errors with a specific vertex in the blueprint.",
"oneOf": [
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"taskId": {
"description": "The id associated with a specific vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"userBlueprintId",
"vertexContext"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Validated many user blueprints successfully | UserBlueprintsBulkValidationResponse |
| 401 | Unauthorized | User is not authorized. | None |
| 403 | Forbidden | User does not have access to this functionality. | None |
| 404 | Not Found | Referenced project was not found. | None |
| 422 | Unprocessable Entity | Unprocessable Entity | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/userBlueprintsInputTypes/¶
Retrieve the input types which can be used with User Blueprints.
Example responses¶
200 Response
{
"properties": {
"inputTypes": {
"description": "A list of associated pairs of an input types and their human-readable names.",
"items": {
"properties": {
"name": {
"description": "The human-readable name of an input type.",
"type": "string"
},
"type": {
"description": "The unique identifier of an input type.",
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputTypes"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully retrieved the input types. | UserBlueprintsInputTypesResponse |
| 401 | Unauthorized | User is not authorized. | None |
| 403 | Forbidden | User does not have access to this functionality. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/userBlueprintsProjectBlueprints/¶
Add a list of user blueprints, by id, to a specified (by id) project's repository.
Body parameter¶
{
"properties": {
"deleteAfter": {
"default": false,
"description": "Whether to delete the user blueprint(s) after adding it (them) to the project menu.",
"type": "boolean"
},
"describeFailures": {
"default": false,
"description": "Whether to include extra fields to describe why any blueprints were not added to the chosen project.",
"type": "boolean",
"x-versionadded": "v2.27"
},
"projectId": {
"description": "The projectId of the project for the repository to add the specified user blueprints to.",
"type": "string"
},
"userBlueprintIds": {
"description": "The ids of the user blueprints to add to the specified project's repository.",
"items": {
"description": "An id of one user blueprint to add to the specified project's repository.",
"type": "string"
},
"type": "array"
}
},
"required": [
"deleteAfter",
"describeFailures",
"projectId",
"userBlueprintIds"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | UserBlueprintAddToMenu | false | none |
Example responses¶
200 Response
{
"properties": {
"addedToMenu": {
"description": "The list of userBlueprintId and blueprintId pairs representing blueprints successfully added to the project repository.",
"items": {
"properties": {
"blueprintId": {
"description": "The blueprintId representing the blueprint which was added to the project repository.",
"type": "string"
},
"userBlueprintId": {
"description": "The userBlueprintId associated with the blueprintId added to the project repository.",
"type": "string"
}
},
"required": [
"blueprintId",
"userBlueprintId"
],
"type": "object"
},
"type": "array"
},
"message": {
"description": "A success message or a list of reasons why the list of blueprints could not be added to the project repository.",
"type": "string",
"x-versionadded": "2.27"
},
"notAddedToMenu": {
"description": "The list of userBlueprintId and error message representing blueprints which failed to be added to the project repository.",
"items": {
"properties": {
"error": {
"description": "The error message representing why the blueprint was not added to the project repository.",
"type": "string"
},
"userBlueprintId": {
"description": "The userBlueprintId associated with the blueprint which was not added to the project repository.",
"type": "string"
}
},
"required": [
"error",
"userBlueprintId"
],
"type": "object"
},
"type": "array",
"x-versionadded": "2.27"
}
},
"required": [
"addedToMenu"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully added the user blueprints to the project's repository. | UserBlueprintAddToMenuResponse |
| 401 | Unauthorized | User is not authorized. | None |
| 403 | Forbidden | User does not have access to this functionality. | None |
| 404 | Not Found | Referenced project not found. | None |
| 422 | Unprocessable Entity | Unprocessable Entity | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/userBlueprintsTaskParameters/¶
Validate that each value assigned to specified task parameters are valid.
Body parameter¶
{
"properties": {
"outputMethod": {
"description": "The method representing how the task will output data.",
"enum": [
"P",
"Pm",
"S",
"Sm",
"T",
"TS"
],
"type": "string"
},
"projectId": {
"description": "The projectId representing the project where this user blueprint is edited.",
"type": [
"string",
"null"
]
},
"taskCode": {
"description": "The task code representing the task to validate parameter values.",
"type": "string"
},
"taskParameters": {
"description": "A list of task parameters and proposed values to be validated.",
"items": {
"properties": {
"newValue": {
"description": "The proposed value for the task parameter.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"paramName": {
"description": "The name of the task parameter to be validated.",
"type": "string"
}
},
"required": [
"newValue",
"paramName"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"outputMethod",
"taskCode",
"taskParameters"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | UserBlueprintTaskParameterValidation | false | none |
Example responses¶
200 Response
{
"properties": {
"errors": {
"description": "A list of the task parameters, their proposed values, and messages describing why each is not valid.",
"items": {
"properties": {
"message": {
"description": "The description of the issue with the proposed task parameter value.",
"type": "string"
},
"paramName": {
"description": "The name of the validated task parameter.",
"type": "string"
},
"value": {
"description": "The invalid value proposed for the validated task parameter.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"message",
"paramName",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"errors"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Accepted validation parameters for a task in the context of User Blueprints. | UserBlueprintsValidateTaskParametersResponse |
| 401 | Unauthorized | User is not authorized. | None |
| 403 | Forbidden | User does not have access to this functionality. | None |
| 404 | Not Found | Custom task version not found | None |
| 422 | Unprocessable Entity | Unprocessable Entity | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/userBlueprintsTasks/¶
Retrieve the available tasks, organized into categories, which can be used to create or modify User Blueprints.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| projectId | query | string | false | The project id to use for task retrieval |
| blueprintId | query | string | false | The blueprint id to use for task retrieval |
| userBlueprintId | query | string | false | The user blueprint id to use for task retrieval |
Example responses¶
200 Response
{
"properties": {
"categories": {
"description": "A list of the available task categories, sub-categories, and tasks.",
"items": {
"properties": {
"name": {
"description": "The name of the category.",
"type": "string"
},
"subcategories": {
"description": "A list of the available task category items.",
"items": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"type": "array"
},
"taskCodes": {
"description": "A list of task codes representing the tasks in this category.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"taskCodes"
],
"type": "object"
},
"type": "array"
},
"tasks": {
"description": "A list of task codes and their task definitions.",
"items": {
"properties": {
"taskCode": {
"description": "The unique code which represents the task to be constructed and executed",
"type": "string"
},
"taskDefinition": {
"description": "A definition of a task in terms of label, arguments, description, and other metadata.",
"oneOf": [
{
"properties": {
"arguments": {
"description": "A list of definitions of each argument which can be set for the task.",
"items": {
"properties": {
"argument": {
"description": "The definition of a task argument, used to specify a certain aspect of the task.",
"oneOf": [
{
"properties": {
"default": {
"description": "The default value of the argument.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"name": {
"description": "The name of the argument.",
"type": "string"
},
"recommended": {
"description": "The recommended value, based on frequently used values.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"tunable": {
"description": "Whether the argument is tunable by the end-user.",
"type": "boolean"
},
"type": {
"description": "The type of the argument (e.g. \"int\", \"float\", \"select\", \"intgrid\", \"multi\", etc.)",
"type": "string"
},
"values": {
"description": "The possible values of the argument, which may be a range or list, or dictionary of ranges or lists keyed by type.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
}
},
"required": [
"name",
"type",
"values"
],
"type": "object"
}
]
},
"key": {
"description": "The unique key of the argument",
"type": "string"
}
},
"required": [
"argument",
"key"
],
"type": "object"
},
"type": "array"
},
"categories": {
"description": "The categories which the task is in.",
"items": {
"type": "string"
},
"type": "array"
},
"colnamesAndTypes": {
"description": "The column names, their types, and their hex representation, available in the specified project for the task.",
"items": {
"properties": {
"colname": {
"description": "The column name.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"type": {
"description": "The data type of the column.",
"type": "string"
}
},
"required": [
"colname",
"hex",
"type"
],
"type": "object"
},
"type": "array"
},
"customTaskId": {
"description": "The id of the custom task, if it is a custom task.",
"type": [
"string",
"null"
]
},
"customTaskVersions": {
"description": "Metadata for all of the custom task's versions.",
"items": {
"properties": {
"id": {
"description": "Id of the custom task version. The ID can be latest_<task_id> which implies to use the latest version of that custom task.",
"type": "string"
},
"label": {
"description": "The name of the custom task version.",
"type": "string"
},
"versionMajor": {
"description": "Major version of the custom task.",
"type": "integer"
},
"versionMinor": {
"description": "Minor version of the custom task.",
"type": "integer"
}
},
"required": [
"id",
"label",
"versionMajor",
"versionMinor"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "A description of the task.",
"type": "string"
},
"icon": {
"description": "The integer representing the id to be displayed when the blueprint is trained.",
"type": "integer"
},
"isCommonTask": {
"default": false,
"description": "Whether the task is a common task.",
"type": "boolean"
},
"isCustomTask": {
"description": "Whether the task is custom code written by the user.",
"type": "boolean"
},
"isVisibleInComposableMl": {
"default": true,
"description": "Whether the task is visible in the ComposableML menu",
"type": "boolean"
},
"label": {
"description": "The generic / default title or label for the task.",
"type": "string"
},
"outputMethods": {
"description": "The methods which the task can use to produce output.",
"items": {
"type": "string"
},
"type": "array"
},
"supportsScoringCode": {
"description": "Whether the task supports Scoring Code.",
"type": "boolean"
},
"taskCode": {
"description": "The unique code which represents the task to be constructed and executed",
"type": "string"
},
"timeSeriesOnly": {
"description": "Whether the task can only be used with time series projects.",
"type": "boolean"
},
"url": {
"description": "The URL of the documentation of the task.",
"oneOf": [
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
{
"type": "string"
}
]
},
"validInputs": {
"description": "The supported input types of the task.",
"items": {
"description": "A specific supported input type.",
"type": "string"
},
"type": "array"
}
},
"required": [
"arguments",
"categories",
"description",
"icon",
"label",
"outputMethods",
"supportsScoringCode",
"taskCode",
"timeSeriesOnly",
"url",
"validInputs"
],
"type": "object"
}
]
}
},
"required": [
"taskCode",
"taskDefinition"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"categories",
"tasks"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully retrieved the tasks. | UserBlueprintTasksResponse |
| 401 | Unauthorized | User is not authorized. | None |
| 403 | Forbidden | User does not have access to this functionality. | None |
| 404 | Not Found | Referenced project or user blueprint not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/userBlueprintsValidations/¶
Validate a user blueprint
Body parameter¶
{
"properties": {
"blueprint": {
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"oneOf": [
{
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"items": {
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
},
"isInplaceEditor": {
"default": false,
"description": "Whether the request is sent from the in place user BP editor.",
"type": "boolean"
},
"projectId": {
"description": "String representation of ObjectId for the currently active project. The user blueprint is validated when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.",
"type": [
"string",
"null"
]
}
},
"required": [
"blueprint",
"isInplaceEditor"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | UserBlueprintValidation | false | none |
Example responses¶
201 Response
{
"properties": {
"vertexContext": {
"description": "Info about, warnings about, and errors with a specific vertex in the blueprint.",
"items": {
"properties": {
"information": {
"description": "A specification of requirements of the inputs and expectations of the output of the vertex.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
]
},
"messages": {
"description": "Warnings about and errors with a specific vertex in the blueprint.",
"oneOf": [
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"taskId": {
"description": "The id associated with a specific vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"vertexContext"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Validated the user blueprint successfully | UserBlueprintsValidationResponse |
| 401 | Unauthorized | User is not authorized. | None |
| 403 | Forbidden | User does not have access to this functionality. | None |
| 404 | Not Found | Referenced project not found. | None |
| 422 | Unprocessable Entity | Unprocessable Entity | 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}/logs/¶
Retrieve an archive (tar.gz) of the logs produced and persisted by a model. Note that only blueprints with custom tasks create persistent logs - this will not work with any other type of model.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| projectId | path | string | true | The project ID |
| modelId | path | string | true | The model ID |
Example responses¶
200 Response
{
"properties": {
"data": {
"description": "An archive (tar.gz) of the logs produced and persisted by a model.",
"format": "binary",
"type": "string"
}
},
"required": [
"data"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | An archive (tar.gz) of the logs produced and persisted by a model. | PersistentLogsForModelWithCustomTasksRetrieveResponse |
| 403 | Forbidden | User does not have permissions to fetch model logs. | None |
| 404 | Not Found | Logs for this model could not be 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}/trainingArtifact/¶
Retrieve an archive (tar.gz) of the artifacts produced and persisted by a model. Note that only blueprints with custom tasks create these artifacts - this will not work with any other type of model.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| projectId | path | string | true | The project ID |
| modelId | path | string | true | The model ID |
Example responses¶
200 Response
{
"properties": {
"data": {
"description": "An archive (tar.gz) of the artifacts produced and persisted by a model.",
"format": "binary",
"type": "string"
}
},
"required": [
"data"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | An archive (tar.gz) of the artifacts produced by this model. | ArtifactsForModelWithCustomTasksRetrieveResponse |
| 403 | Forbidden | User does not have permissions to fetch this artifact. | None |
| 404 | Not Found | The model with this modelID does not have any artifacts. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas¶
AllowExtra
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
Parameters submitted by the user to the failed job
Properties¶
None
ArtifactsForModelWithCustomTasksRetrieveResponse
{
"properties": {
"data": {
"description": "An archive (tar.gz) of the artifacts produced and persisted by a model.",
"format": "binary",
"type": "string"
}
},
"required": [
"data"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | string(binary) | true | An archive (tar.gz) of the artifacts produced and persisted by a model. |
BlueprintChartRetrieveResponse
{
"properties": {
"edges": {
"description": "An array of chart edges - tuples of (start_id, end_id).",
"items": {
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"nodes": {
"description": "An array of node descriptions.",
"items": {
"properties": {
"id": {
"description": "The ID of the node.",
"type": "string"
},
"label": {
"description": "The label of the node.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"edges",
"nodes"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| edges | [array] | true | An array of chart edges - tuples of (start_id, end_id). | |
| nodes | [NodeDescription] | true | An array of node descriptions. |
BlueprintDocLinks
{
"properties": {
"name": {
"description": "The name of the documentation at the link.",
"type": "string"
},
"url": {
"description": "The URL at which external documentation can be found.",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | The name of the documentation at the link. | |
| url | string,null | true | The URL at which external documentation can be found. |
BlueprintDocParameters
{
"properties": {
"description": {
"description": "A description of what the parameter does.",
"type": "string"
},
"name": {
"description": "The name of the parameter.",
"type": "string"
},
"type": {
"description": "The type (and default value) of the parameter.",
"type": "string"
}
},
"required": [
"description",
"name",
"type"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | true | A description of what the parameter does. | |
| name | string | true | The name of the parameter. | |
| type | string | true | The type (and default value) of the parameter. |
BlueprintDocReferences
{
"properties": {
"name": {
"description": "The name of the reference.",
"type": "string"
},
"url": {
"description": "The URL at which the reference can be found.",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | The name of the reference. | |
| url | string,null | true | The URL at which the reference can be found. |
BlueprintJsonResponse
{
"properties": {
"blueprint": {
"description": "JSON blueprint representation of the model.",
"example": "\n {\n \"1\": [[\"NUM\"], [\"PNI2\"], \"T\"],\n \"2\": [[\"1\"], [\"LASSO2\"], \"P\"],\n }\n ",
"type": "object",
"x-versionadded": "v2.31"
}
},
"required": [
"blueprint"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| blueprint | object | true | JSON blueprint representation of the model. |
BlueprintListDocumentsResponse
{
"properties": {
"description": {
"description": "The task description.",
"type": "string"
},
"links": {
"description": "A list of external documentation links.",
"items": {
"properties": {
"name": {
"description": "The name of the documentation at the link.",
"type": "string"
},
"url": {
"description": "The URL at which external documentation can be found.",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"type": "array"
},
"parameters": {
"description": "An array of task parameters.",
"items": {
"properties": {
"description": {
"description": "A description of what the parameter does.",
"type": "string"
},
"name": {
"description": "The name of the parameter.",
"type": "string"
},
"type": {
"description": "The type (and default value) of the parameter.",
"type": "string"
}
},
"required": [
"description",
"name",
"type"
],
"type": "object"
},
"type": "array"
},
"references": {
"description": "A list of reference links.",
"items": {
"properties": {
"name": {
"description": "The name of the reference.",
"type": "string"
},
"url": {
"description": "The URL at which the reference can be found.",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"type": "array"
},
"task": {
"description": "The task described in document.",
"type": "string"
},
"title": {
"description": "The document title.",
"type": "string"
}
},
"required": [
"description",
"links",
"parameters",
"references",
"task",
"title"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | true | The task description. | |
| links | [BlueprintDocLinks] | true | A list of external documentation links. | |
| parameters | [BlueprintDocParameters] | true | An array of task parameters. | |
| references | [BlueprintDocReferences] | true | A list of reference links. | |
| task | string | true | The task described in document. | |
| title | string | true | The document title. |
BlueprintResponse
{
"properties": {
"blueprintCategory": {
"description": "describes the category of the blueprint and indicates the kind of model this blueprint produces. Will be either \"DataRobot\" or \"Scaleout DataRobot\".",
"type": "string",
"x-versionadded": "v2.6"
},
"id": {
"description": "the blueprint ID of this blueprint - note that this is not an ObjectId.",
"type": "string"
},
"isCustomModelBlueprint": {
"description": "Whether blueprint contains custom task.",
"type": "boolean"
},
"modelType": {
"description": "the model this blueprint will produce.",
"type": "string"
},
"monotonicDecreasingFeaturelistId": {
"description": "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.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.11"
},
"monotonicIncreasingFeaturelistId": {
"description": "null or str, 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.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.11"
},
"processes": {
"description": "a list of strings representing processes the blueprint uses.",
"items": {
"type": "string"
},
"type": "array"
},
"projectId": {
"description": "the project the blueprint belongs to.",
"type": "string"
},
"recommendedFeaturelistId": {
"description": "The ID of the feature list recommended for this blueprint. If this field is not present, then there is no recommended feature list.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.18"
},
"supportsComposableMl": {
"description": "indicates whether this blueprint is supported in Composable ML.",
"type": "boolean",
"x-versionadded": "v2.26"
},
"supportsIncrementalLearning": {
"description": "Whether blueprint supports incremental learning.",
"type": "boolean",
"x-versionadded": "v2.32"
},
"supportsMonotonicConstraints": {
"description": "whether this model supports enforcing monotonic constraints.",
"type": "boolean",
"x-versionadded": "v2.11"
}
},
"required": [
"blueprintCategory",
"id",
"isCustomModelBlueprint",
"modelType",
"monotonicDecreasingFeaturelistId",
"monotonicIncreasingFeaturelistId",
"processes",
"projectId",
"supportsComposableMl",
"supportsIncrementalLearning",
"supportsMonotonicConstraints"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| blueprintCategory | string | true | describes the category of the blueprint and indicates the kind of model this blueprint produces. Will be either "DataRobot" or "Scaleout DataRobot". | |
| id | string | true | the blueprint ID of this blueprint - note that this is not an ObjectId. | |
| isCustomModelBlueprint | boolean | true | Whether blueprint contains custom task. | |
| modelType | string | true | the model this blueprint will produce. | |
| monotonicDecreasingFeaturelistId | string,null | true | 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 | null or str, 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. | |
| processes | [string] | true | a list of strings representing processes the blueprint uses. | |
| projectId | string | true | the project the blueprint belongs to. | |
| recommendedFeaturelistId | string,null | false | The ID of the feature list recommended for this blueprint. If this field is not present, then there is no recommended feature list. | |
| supportsComposableMl | boolean | true | indicates whether this blueprint is supported in Composable ML. | |
| supportsIncrementalLearning | boolean | true | Whether blueprint supports incremental learning. | |
| supportsMonotonicConstraints | boolean | true | whether this model supports enforcing monotonic constraints. |
BpData
{
"properties": {
"children": {
"description": "A nested dictionary representation of the blueprint DAG.",
"items": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"type": "array"
},
"id": {
"description": "The type of the node (e.g. \"start\", \"input\", \"task\").",
"type": "string"
},
"inputs": {
"description": "The inputs to the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"output": {
"description": "Ids describing the destination of any outgoing edges.",
"oneOf": [
{
"description": "Ids describing the destination of any outgoing edges.",
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 0,
"type": "array"
}
]
},
"taskMap": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"taskParameters": {
"description": "A stringified JSON object describing the parameters and their values for a task.",
"type": "string"
},
"tasks": {
"description": "The task defining the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "A unique id to represent the current node.",
"type": "string"
}
},
"required": [
"id",
"taskMap",
"tasks",
"type"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| children | [AllowExtra] | false | A nested dictionary representation of the blueprint DAG. | |
| id | string | true | The type of the node (e.g. "start", "input", "task"). | |
| inputs | [string] | false | The inputs to the current node. | |
| output | any | false | Ids describing the destination of any outgoing edges. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | Ids describing the destination of any outgoing edges. |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| taskMap | AllowExtra | true | Parameters submitted by the user to the failed job | |
| taskParameters | string | false | A stringified JSON object describing the parameters and their values for a task. | |
| tasks | [string] | true | The task defining the current node. | |
| type | string | true | A unique id to represent the current node. |
ColnameAndType
{
"properties": {
"colname": {
"description": "The column name.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"type": {
"description": "The data type of the column.",
"type": "string"
}
},
"required": [
"colname",
"hex",
"type"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| colname | string | true | The column name. | |
| hex | string | true | A safe hex representation of the column name. | |
| type | string | true | The data type of the column. |
CustomModelShortResponse
{
"description": "Custom model associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model.",
"type": "string"
},
"name": {
"description": "User-friendly name of the model.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
Custom model associated with this deployment.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | The ID of the custom model. | |
| name | string | true | User-friendly name of the model. |
CustomModelVersionShortResponse
{
"description": "Custom model version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the model version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
}
Custom model version associated with this deployment.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | The ID of the custom model version. | |
| label | string | true | User-friendly name of the model version. |
CustomTaskAccessControlListResponse
{
"properties": {
"count": {
"description": "Number of items in current page.",
"type": "integer"
},
"data": {
"description": "List of the requested custom task access control entries.",
"items": {
"properties": {
"canShare": {
"description": "Whether this user can share this custom task",
"type": "boolean"
},
"role": {
"description": "This users role.",
"type": "string"
},
"userId": {
"description": "This user's userId.",
"type": "string"
},
"username": {
"description": "The username for this user's entry.",
"type": "string"
}
},
"required": [
"canShare",
"role",
"userId",
"username"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page",
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"count",
"data",
"next",
"previous"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | true | Number of items in current page. | |
| data | [CustomTaskAccessControlResponse] | true | maxItems: 1000 |
List of the requested custom task access control entries. |
| next | string,null(uri) | true | URL pointing to the next page (if null, there is no next page) | |
| previous | string,null(uri) | true | URL pointing to the previous page (if null, there is no previous page |
CustomTaskAccessControlResponse
{
"properties": {
"canShare": {
"description": "Whether this user can share this custom task",
"type": "boolean"
},
"role": {
"description": "This users role.",
"type": "string"
},
"userId": {
"description": "This user's userId.",
"type": "string"
},
"username": {
"description": "The username for this user's entry.",
"type": "string"
}
},
"required": [
"canShare",
"role",
"userId",
"username"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| canShare | boolean | true | Whether this user can share this custom task | |
| role | string | true | This users role. | |
| userId | string | true | This user's userId. | |
| username | string | true | The username for this user's entry. |
CustomTaskCopy
{
"properties": {
"customTaskId": {
"description": "ID of the custom task to copy.",
"type": "string"
}
},
"required": [
"customTaskId"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customTaskId | string | true | ID of the custom task to copy. |
CustomTaskCreate
{
"properties": {
"calibratePredictions": {
"default": true,
"description": "Whether model predictions should be calibrated by DataRobot.Only applies to anomaly detection; we recommend this if you have not already included calibration in your model code.Calibration improves the probability estimates of a model, and modifies the predictions of non-probabilistic models to be interpretable as probabilities. This will facilitate comparison to DataRobot models, and give access to ROC curve insights on external data.",
"type": "boolean"
},
"description": {
"description": "The user-friendly description of the task.",
"maxLength": 10000,
"type": "string"
},
"language": {
"description": "Programming language name in which task is written.",
"maxLength": 500,
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"name": {
"description": "The user-friendly name for the task.",
"maxLength": 255,
"type": "string"
},
"targetType": {
"description": "The target type of the custom task",
"enum": [
"Binary",
"Regression",
"Multiclass",
"Anomaly",
"Transform",
"TextGeneration",
"GeoPoint"
],
"type": "string"
}
},
"required": [
"name",
"targetType"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| calibratePredictions | boolean | false | Whether model predictions should be calibrated by DataRobot.Only applies to anomaly detection; we recommend this if you have not already included calibration in your model code.Calibration improves the probability estimates of a model, and modifies the predictions of non-probabilistic models to be interpretable as probabilities. This will facilitate comparison to DataRobot models, and give access to ROC curve insights on external data. | |
| description | string | false | maxLength: 10000 |
The user-friendly description of the task. |
| language | string | false | maxLength: 500 |
Programming language name in which task is written. |
| maximumMemory | integer,null | false | maximum: 15032385536 minimum: 134217728 |
DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed. |
| name | string | true | maxLength: 255 |
The user-friendly name for the task. |
| targetType | string | true | The target type of the custom task |
Enumerated Values¶
| Property | Value |
|---|---|
| targetType | [Binary, Regression, Multiclass, Anomaly, Transform, TextGeneration, GeoPoint] |
CustomTaskListResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of custom tasks.",
"items": {
"properties": {
"calibratePredictions": {
"description": "Determines whether or not predictions should be calibrated by DataRobot. Only applies to anomaly detection.",
"type": "boolean"
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"createdBy": {
"description": "The username of the custom task creator.",
"type": "string"
},
"customModelType": {
"description": "The type of custom task.",
"enum": [
"training",
"inference"
],
"type": "string",
"x-versiondeprecated": "v2.25"
},
"description": {
"description": "The description of the task.",
"type": "string"
},
"id": {
"description": "The ID of the custom task.",
"type": "string"
},
"language": {
"description": "The programming language used by the task.",
"type": "string"
},
"latestVersion": {
"description": "The latest version for the custom task (if this field is empty the task is not ready for use).",
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this task version.",
"type": [
"string",
"null"
]
},
"baseEnvironmentVersionId": {
"description": "The base environment version to use with this task version.",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"customModelId": {
"description": "an alias for customTaskId",
"type": "string",
"x-versiondeprecated": "v2.25"
},
"customTaskId": {
"description": "the ID of the custom task.",
"type": "string"
},
"dependencies": {
"description": "The parsed dependencies of the custom task version if the version has a valid requirements.txt file.",
"items": {
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"description": {
"description": "Description of a custom task version.",
"type": [
"string",
"null"
]
},
"id": {
"description": "the ID of the custom model version created.",
"type": "string"
},
"isFrozen": {
"description": "If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).",
"type": "boolean",
"x-versiondeprecated": "v2.34"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"label": {
"description": "A semantic version number of the major and minor version.",
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"versionMajor": {
"description": "The major version number, incremented on deployments or larger file changes.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number, incremented on general file changes.",
"type": "integer"
},
"warning": {
"description": "Warnings about the custom task version",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"created",
"customModelId",
"customTaskId",
"description",
"id",
"isFrozen",
"items",
"label",
"outboundNetworkPolicy",
"versionMajor",
"versionMinor"
],
"type": "object"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"name": {
"description": "The name of the task.",
"type": "string"
},
"targetType": {
"description": "The target type of the custom task.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"Anomaly",
"Transform",
"TextGeneration",
"GeoPoint"
],
"type": "string"
},
"updated": {
"description": "ISO-8601 timestamp of when task was last updated.",
"type": "string"
}
},
"required": [
"created",
"createdBy",
"customModelType",
"description",
"id",
"language",
"latestVersion",
"name",
"targetType",
"updated"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | Number of items returned on this page. | |
| data | [CustomTaskResponse] | true | maxItems: 1000 |
List of custom tasks. |
| next | string,null(uri) | true | URL pointing to the next page (if null, there is no next page). | |
| previous | string,null(uri) | true | URL pointing to the previous page (if null, there is no previous page). | |
| totalCount | integer | true | The total number of items across all pages. |
CustomTaskResponse
{
"properties": {
"calibratePredictions": {
"description": "Determines whether or not predictions should be calibrated by DataRobot. Only applies to anomaly detection.",
"type": "boolean"
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"createdBy": {
"description": "The username of the custom task creator.",
"type": "string"
},
"customModelType": {
"description": "The type of custom task.",
"enum": [
"training",
"inference"
],
"type": "string",
"x-versiondeprecated": "v2.25"
},
"description": {
"description": "The description of the task.",
"type": "string"
},
"id": {
"description": "The ID of the custom task.",
"type": "string"
},
"language": {
"description": "The programming language used by the task.",
"type": "string"
},
"latestVersion": {
"description": "The latest version for the custom task (if this field is empty the task is not ready for use).",
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this task version.",
"type": [
"string",
"null"
]
},
"baseEnvironmentVersionId": {
"description": "The base environment version to use with this task version.",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"customModelId": {
"description": "an alias for customTaskId",
"type": "string",
"x-versiondeprecated": "v2.25"
},
"customTaskId": {
"description": "the ID of the custom task.",
"type": "string"
},
"dependencies": {
"description": "The parsed dependencies of the custom task version if the version has a valid requirements.txt file.",
"items": {
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"description": {
"description": "Description of a custom task version.",
"type": [
"string",
"null"
]
},
"id": {
"description": "the ID of the custom model version created.",
"type": "string"
},
"isFrozen": {
"description": "If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).",
"type": "boolean",
"x-versiondeprecated": "v2.34"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"label": {
"description": "A semantic version number of the major and minor version.",
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"versionMajor": {
"description": "The major version number, incremented on deployments or larger file changes.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number, incremented on general file changes.",
"type": "integer"
},
"warning": {
"description": "Warnings about the custom task version",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"created",
"customModelId",
"customTaskId",
"description",
"id",
"isFrozen",
"items",
"label",
"outboundNetworkPolicy",
"versionMajor",
"versionMinor"
],
"type": "object"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"name": {
"description": "The name of the task.",
"type": "string"
},
"targetType": {
"description": "The target type of the custom task.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"Anomaly",
"Transform",
"TextGeneration",
"GeoPoint"
],
"type": "string"
},
"updated": {
"description": "ISO-8601 timestamp of when task was last updated.",
"type": "string"
}
},
"required": [
"created",
"createdBy",
"customModelType",
"description",
"id",
"language",
"latestVersion",
"name",
"targetType",
"updated"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| calibratePredictions | boolean | false | Determines whether or not predictions should be calibrated by DataRobot. Only applies to anomaly detection. | |
| created | string | true | ISO-8601 timestamp of when the task was created. | |
| createdBy | string | true | The username of the custom task creator. | |
| customModelType | string | true | The type of custom task. | |
| description | string | true | The description of the task. | |
| id | string | true | The ID of the custom task. | |
| language | string | true | The programming language used by the task. | |
| latestVersion | CustomTaskVersionResponse | true | The latest version for the custom task (if this field is empty the task is not ready for use). | |
| maximumMemory | integer,null | false | maximum: 15032385536 minimum: 134217728 |
DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed. |
| name | string | true | The name of the task. | |
| targetType | string | true | The target type of the custom task. | |
| updated | string | true | ISO-8601 timestamp of when task was last updated. |
Enumerated Values¶
| Property | Value |
|---|---|
| customModelType | [training, inference] |
| targetType | [Binary, Regression, Multiclass, Anomaly, Transform, TextGeneration, GeoPoint] |
CustomTaskUpdate
{
"properties": {
"description": {
"description": "The user-friendly description of the task.",
"maxLength": 10000,
"type": "string"
},
"language": {
"description": "Programming language name in which task is written.",
"maxLength": 500,
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"name": {
"description": "The user-friendly name for the task.",
"maxLength": 255,
"type": "string"
}
},
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | maxLength: 10000 |
The user-friendly description of the task. |
| language | string | false | maxLength: 500 |
Programming language name in which task is written. |
| maximumMemory | integer,null | false | maximum: 15032385536 minimum: 134217728 |
DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed. |
| name | string | false | maxLength: 255 |
The user-friendly name for the task. |
CustomTaskVersionCreate
{
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this custom task version.",
"type": "string"
},
"file": {
"description": "A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding `filePath` supplied that shows the relative location of the file. For example, you have two files: `/home/username/custom-task/main.py` and `/home/username/custom-task/helpers/helper.py`. When uploading these files, you would _also_ need to include two `filePath` fields of, `\"main.py\"` and `\"helpers/helper.py\"`. If the supplied `file` already exists at the supplied `filePath`, the old file is replaced by the new file.",
"format": "binary",
"type": "string"
},
"filePath": {
"description": "The local path of the file being uploaded. See the `file` field explanation for more details.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
}
]
},
"isMajorUpdate": {
"default": "true",
"description": "If set to true, new major version will created, otherwise minor version will be created.",
"enum": [
"false",
"False",
"true",
"True"
],
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you to change them, make a new version.",
"type": "string",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"type": "string",
"x-versionadded": "v2.26"
}
},
"required": [
"baseEnvironmentId",
"isMajorUpdate"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| baseEnvironmentId | string | true | The base environment to use with this custom task version. | |
| file | string(binary) | false | A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding filePath supplied that shows the relative location of the file. For example, you have two files: /home/username/custom-task/main.py and /home/username/custom-task/helpers/helper.py. When uploading these files, you would also need to include two filePath fields of, "main.py" and "helpers/helper.py". If the supplied file already exists at the supplied filePath, the old file is replaced by the new file. |
|
| filePath | any | false | The local path of the file being uploaded. See the file field explanation for more details. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | maxItems: 1000 |
none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isMajorUpdate | string | true | If set to true, new major version will created, otherwise minor version will be created. | |
| maximumMemory | integer,null | false | maximum: 15032385536 minimum: 134217728 |
DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed. |
| outboundNetworkPolicy | string | false | What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address. | |
| requiredMetadata | string | false | Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you to change them, make a new version. | |
| requiredMetadataValues | string | false | Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys. |
Enumerated Values¶
| Property | Value |
|---|---|
| isMajorUpdate | [false, False, true, True] |
| outboundNetworkPolicy | [ISOLATED, PUBLIC] |
CustomTaskVersionCreateFromLatest
{
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this custom task version.",
"type": "string"
},
"file": {
"description": "A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding `filePath` supplied that shows the relative location of the file. For example, you have two files: `/home/username/custom-task/main.py` and `/home/username/custom-task/helpers/helper.py`. When uploading these files, you would _also_ need to include two `filePath` fields of, `\"main.py\"` and `\"helpers/helper.py\"`. If the supplied `file` already exists at the supplied `filePath`, the old file is replaced by the new file.",
"format": "binary",
"type": "string"
},
"filePath": {
"description": "The local path of the file being uploaded. See the `file` field explanation for more details.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
}
]
},
"filesToDelete": {
"description": "The IDs of the files to be deleted.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
]
},
"isMajorUpdate": {
"default": "true",
"description": "If set to true, new major version will created, otherwise minor version will be created.",
"enum": [
"false",
"False",
"true",
"True"
],
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you to change them, make a new version.",
"type": "string",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"type": "string",
"x-versionadded": "v2.26"
}
},
"required": [
"baseEnvironmentId",
"isMajorUpdate"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| baseEnvironmentId | string | true | The base environment to use with this custom task version. | |
| file | string(binary) | false | A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding filePath supplied that shows the relative location of the file. For example, you have two files: /home/username/custom-task/main.py and /home/username/custom-task/helpers/helper.py. When uploading these files, you would also need to include two filePath fields of, "main.py" and "helpers/helper.py". If the supplied file already exists at the supplied filePath, the old file is replaced by the new file. |
|
| filePath | any | false | The local path of the file being uploaded. See the file field explanation for more details. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | maxItems: 1000 |
none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| filesToDelete | any | false | The IDs of the files to be deleted. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | maxItems: 100 |
none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isMajorUpdate | string | true | If set to true, new major version will created, otherwise minor version will be created. | |
| maximumMemory | integer,null | false | maximum: 15032385536 minimum: 134217728 |
DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed. |
| outboundNetworkPolicy | string | false | What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address. | |
| requiredMetadata | string | false | Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you to change them, make a new version. | |
| requiredMetadataValues | string | false | Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys. |
Enumerated Values¶
| Property | Value |
|---|---|
| isMajorUpdate | [false, False, true, True] |
| outboundNetworkPolicy | [ISOLATED, PUBLIC] |
CustomTaskVersionCreateFromRepository
{
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this version.",
"type": "string",
"x-versionadded": "v2.22"
},
"isMajorUpdate": {
"default": true,
"description": "If set to true, new major version will created, otherwise minor version will be created.",
"type": "boolean"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"ref": {
"description": "Remote reference (branch, commit, etc). Latest, if not specified.",
"type": "string"
},
"repositoryId": {
"description": "The ID of remote repository used to pull sources. This ID can be found using the /api/v2/remoteRepositories/ endpoint.",
"type": "string"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"sourcePath": {
"description": "A remote repository file path to be pulled into a custom model or custom task.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
]
}
},
"required": [
"baseEnvironmentId",
"repositoryId"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| baseEnvironmentId | string | true | The base environment to use with this version. | |
| isMajorUpdate | boolean | false | If set to true, new major version will created, otherwise minor version will be created. | |
| outboundNetworkPolicy | string | false | What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address. | |
| ref | string | false | Remote reference (branch, commit, etc). Latest, if not specified. | |
| repositoryId | string | true | The ID of remote repository used to pull sources. This ID can be found using the /api/v2/remoteRepositories/ endpoint. | |
| requiredMetadata | object | false | Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you to change them, make a new version. | |
| requiredMetadataValues | [RequiredMetadataValue] | false | maxItems: 100 |
Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys. |
| sourcePath | any | false | A remote repository file path to be pulled into a custom model or custom task. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | maxItems: 100 |
none |
Enumerated Values¶
| Property | Value |
|---|---|
| outboundNetworkPolicy | [ISOLATED, PUBLIC] |
CustomTaskVersionDependencyBuildMetadataResponse
{
"properties": {
"buildEnd": {
"description": "The ISO-8601 encoded time when this build completed.",
"type": [
"string",
"null"
]
},
"buildLogLocation": {
"description": "The URL to download the build logs from this build.",
"format": "uri",
"type": [
"string",
"null"
]
},
"buildStart": {
"description": "The ISO-8601 encoded time when this build started.",
"type": "string"
},
"buildStatus": {
"description": "The current status of the dependency build.",
"enum": [
"submitted",
"processing",
"failed",
"success"
],
"type": "string"
},
"customTaskId": {
"description": "The ID of custom task.",
"type": "string"
},
"customTaskVersionId": {
"description": "The ID of custom task version.",
"type": "string"
}
},
"required": [
"buildEnd",
"buildLogLocation",
"buildStart",
"buildStatus",
"customTaskId",
"customTaskVersionId"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| buildEnd | string,null | true | The ISO-8601 encoded time when this build completed. | |
| buildLogLocation | string,null(uri) | true | The URL to download the build logs from this build. | |
| buildStart | string | true | The ISO-8601 encoded time when this build started. | |
| buildStatus | string | true | The current status of the dependency build. | |
| customTaskId | string | true | The ID of custom task. | |
| customTaskVersionId | string | true | The ID of custom task version. |
Enumerated Values¶
| Property | Value |
|---|---|
| buildStatus | [submitted, processing, failed, success] |
CustomTaskVersionListResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of custom task versions.",
"items": {
"description": "The latest version for the custom task (if this field is empty the task is not ready for use).",
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this task version.",
"type": [
"string",
"null"
]
},
"baseEnvironmentVersionId": {
"description": "The base environment version to use with this task version.",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"customModelId": {
"description": "an alias for customTaskId",
"type": "string",
"x-versiondeprecated": "v2.25"
},
"customTaskId": {
"description": "the ID of the custom task.",
"type": "string"
},
"dependencies": {
"description": "The parsed dependencies of the custom task version if the version has a valid requirements.txt file.",
"items": {
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"description": {
"description": "Description of a custom task version.",
"type": [
"string",
"null"
]
},
"id": {
"description": "the ID of the custom model version created.",
"type": "string"
},
"isFrozen": {
"description": "If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).",
"type": "boolean",
"x-versiondeprecated": "v2.34"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"label": {
"description": "A semantic version number of the major and minor version.",
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"versionMajor": {
"description": "The major version number, incremented on deployments or larger file changes.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number, incremented on general file changes.",
"type": "integer"
},
"warning": {
"description": "Warnings about the custom task version",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"created",
"customModelId",
"customTaskId",
"description",
"id",
"isFrozen",
"items",
"label",
"outboundNetworkPolicy",
"versionMajor",
"versionMinor"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | Number of items returned on this page. | |
| data | [CustomTaskVersionResponse] | true | maxItems: 1000 |
List of custom task versions. |
| next | string,null(uri) | true | URL pointing to the next page (if null, there is no next page). | |
| previous | string,null(uri) | true | URL pointing to the previous page (if null, there is no previous page). | |
| totalCount | integer | true | The total number of items across all pages. |
CustomTaskVersionMetadataUpdate
{
"properties": {
"description": {
"description": "New description for the custom task or model.",
"maxLength": 10000,
"type": "string"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
}
},
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | maxLength: 10000 |
New description for the custom task or model. |
| requiredMetadata | object | false | Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. | |
| requiredMetadataValues | [RequiredMetadataValue] | false | maxItems: 100 |
Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys. |
CustomTaskVersionResponse
{
"description": "The latest version for the custom task (if this field is empty the task is not ready for use).",
"properties": {
"baseEnvironmentId": {
"description": "The base environment to use with this task version.",
"type": [
"string",
"null"
]
},
"baseEnvironmentVersionId": {
"description": "The base environment version to use with this task version.",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the task was created.",
"type": "string"
},
"customModelId": {
"description": "an alias for customTaskId",
"type": "string",
"x-versiondeprecated": "v2.25"
},
"customTaskId": {
"description": "the ID of the custom task.",
"type": "string"
},
"dependencies": {
"description": "The parsed dependencies of the custom task version if the version has a valid requirements.txt file.",
"items": {
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"description": {
"description": "Description of a custom task version.",
"type": [
"string",
"null"
]
},
"id": {
"description": "the ID of the custom model version created.",
"type": "string"
},
"isFrozen": {
"description": "If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded).",
"type": "boolean",
"x-versiondeprecated": "v2.34"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"label": {
"description": "A semantic version number of the major and minor version.",
"type": "string"
},
"maximumMemory": {
"description": "DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed.",
"maximum": 15032385536,
"minimum": 134217728,
"type": [
"integer",
"null"
],
"x-versiondeprecated": "2.32.0"
},
"outboundNetworkPolicy": {
"description": "What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address.",
"enum": [
"ISOLATED",
"PUBLIC"
],
"type": "string",
"x-versionadded": "2.32.0"
},
"requiredMetadata": {
"description": "Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version.",
"type": "object",
"x-versionadded": "v2.25",
"x-versiondeprecated": "v2.26"
},
"requiredMetadataValues": {
"description": "Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.26"
},
"versionMajor": {
"description": "The major version number, incremented on deployments or larger file changes.",
"type": "integer"
},
"versionMinor": {
"description": "The minor version number, incremented on general file changes.",
"type": "integer"
},
"warning": {
"description": "Warnings about the custom task version",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"created",
"customModelId",
"customTaskId",
"description",
"id",
"isFrozen",
"items",
"label",
"outboundNetworkPolicy",
"versionMajor",
"versionMinor"
],
"type": "object"
}
The latest version for the custom task (if this field is empty the task is not ready for use).
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| baseEnvironmentId | string,null | false | The base environment to use with this task version. | |
| baseEnvironmentVersionId | string,null | false | The base environment version to use with this task version. | |
| created | string | true | ISO-8601 timestamp of when the task was created. | |
| customModelId | string | true | an alias for customTaskId | |
| customTaskId | string | true | the ID of the custom task. | |
| dependencies | [DependencyResponse] | false | maxItems: 1000 |
The parsed dependencies of the custom task version if the version has a valid requirements.txt file. |
| description | string,null | true | Description of a custom task version. | |
| id | string | true | the ID of the custom model version created. | |
| isFrozen | boolean | true | If the version is frozen and immutable (i.e. it is either deployed or has been edited, causing a newer version to be yielded). | |
| items | [WorkspaceItemResponse] | true | maxItems: 100 |
List of file items. |
| label | string | true | A semantic version number of the major and minor version. | |
| maximumMemory | integer,null | false | maximum: 15032385536 minimum: 134217728 |
DEPRECATED! The maximum memory that might be allocated by the custom-model. If exceeded, the custom-model will be killed. |
| outboundNetworkPolicy | string | true | What kind of outbound network calls are allowed. If ISOLATED, then no outbound network calls are allowed. If PUBLIC, then network calls are allowed to any public ip address. | |
| requiredMetadata | object | false | Additional parameters required by the execution environment. The required keys are defined by the fieldNames in the base environment's requiredMetadataKeys. Once set, they cannot be changed. If you want to change them, make a new version. | |
| requiredMetadataValues | [RequiredMetadataValue] | false | maxItems: 100 |
Additional parameters required by the execution environment. The required fieldNames are defined by the fieldNames in the base environment's requiredMetadataKeys. |
| versionMajor | integer | true | The major version number, incremented on deployments or larger file changes. | |
| versionMinor | integer | true | The minor version number, incremented on general file changes. | |
| warning | [string] | false | maxItems: 100 |
Warnings about the custom task version |
Enumerated Values¶
| Property | Value |
|---|---|
| outboundNetworkPolicy | [ISOLATED, PUBLIC] |
CustomTrainingBlueprintCreate
{
"properties": {
"customModelVersionId": {
"description": "The ID of the specific model version from which to create a custom training blueprint.",
"type": "string"
}
},
"required": [
"customModelVersionId"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customModelVersionId | string | true | The ID of the specific model version from which to create a custom training blueprint. |
CustomTrainingBlueprintListResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of training model blueprints.",
"items": {
"properties": {
"createdAt": {
"description": "ISO-8601 timestamp of when the blueprint was created.",
"type": "string"
},
"customModel": {
"description": "Custom model associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model.",
"type": "string"
},
"name": {
"description": "User-friendly name of the model.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"customModelVersion": {
"description": "Custom model version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the model version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"executionEnvironment": {
"description": "Execution environment associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment.",
"type": "string"
},
"name": {
"description": "User-friendly name of the execution environment.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"executionEnvironmentVersion": {
"description": "Execution environment version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the execution environment version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"targetType": {
"description": "The target type of the training model.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"Anomaly",
"Transform",
"TextGeneration",
"GeoPoint",
"Unstructured",
"VectorDatabase",
"AgenticWorkflow"
],
"type": "string"
},
"trainingHistory": {
"description": "List of instances of this blueprint having been trained.",
"items": {
"properties": {
"creationDate": {
"description": "ISO-8601 timestamp of when the project the blueprint was trained on was created.",
"type": "string"
},
"lid": {
"description": "The leaderboard ID the blueprint was trained on.",
"type": "string"
},
"pid": {
"description": "The project ID the blueprint was trained on.",
"type": "string"
},
"projectModelsCount": {
"description": "Number of models in the project the blueprint was trained on.",
"type": "integer"
},
"projectName": {
"description": "The project name the blueprint was trained on.",
"type": "string"
},
"targetName": {
"description": "The target name of the project the blueprint was trained on.",
"type": "string"
}
},
"required": [
"creationDate",
"lid",
"pid",
"projectModelsCount",
"projectName",
"targetName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"userBlueprintId": {
"description": "User Blueprint ID that can be used to train the model.",
"type": "string"
}
},
"required": [
"createdAt",
"customModel",
"customModelVersion",
"executionEnvironment",
"executionEnvironmentVersion",
"targetType",
"trainingHistory",
"userBlueprintId"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | Number of items returned on this page. | |
| data | [CustomTrainingBlueprintResponse] | true | maxItems: 1000 |
List of training model blueprints. |
| next | string,null(uri) | true | URL pointing to the next page (if null, there is no next page). | |
| previous | string,null(uri) | true | URL pointing to the previous page (if null, there is no previous page). | |
| totalCount | integer | true | The total number of items across all pages. |
CustomTrainingBlueprintResponse
{
"properties": {
"createdAt": {
"description": "ISO-8601 timestamp of when the blueprint was created.",
"type": "string"
},
"customModel": {
"description": "Custom model associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model.",
"type": "string"
},
"name": {
"description": "User-friendly name of the model.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"customModelVersion": {
"description": "Custom model version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the custom model version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the model version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"executionEnvironment": {
"description": "Execution environment associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment.",
"type": "string"
},
"name": {
"description": "User-friendly name of the execution environment.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"executionEnvironmentVersion": {
"description": "Execution environment version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the execution environment version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
},
"targetType": {
"description": "The target type of the training model.",
"enum": [
"Binary",
"Regression",
"Multiclass",
"Anomaly",
"Transform",
"TextGeneration",
"GeoPoint",
"Unstructured",
"VectorDatabase",
"AgenticWorkflow"
],
"type": "string"
},
"trainingHistory": {
"description": "List of instances of this blueprint having been trained.",
"items": {
"properties": {
"creationDate": {
"description": "ISO-8601 timestamp of when the project the blueprint was trained on was created.",
"type": "string"
},
"lid": {
"description": "The leaderboard ID the blueprint was trained on.",
"type": "string"
},
"pid": {
"description": "The project ID the blueprint was trained on.",
"type": "string"
},
"projectModelsCount": {
"description": "Number of models in the project the blueprint was trained on.",
"type": "integer"
},
"projectName": {
"description": "The project name the blueprint was trained on.",
"type": "string"
},
"targetName": {
"description": "The target name of the project the blueprint was trained on.",
"type": "string"
}
},
"required": [
"creationDate",
"lid",
"pid",
"projectModelsCount",
"projectName",
"targetName"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"userBlueprintId": {
"description": "User Blueprint ID that can be used to train the model.",
"type": "string"
}
},
"required": [
"createdAt",
"customModel",
"customModelVersion",
"executionEnvironment",
"executionEnvironmentVersion",
"targetType",
"trainingHistory",
"userBlueprintId"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdAt | string | true | ISO-8601 timestamp of when the blueprint was created. | |
| customModel | CustomModelShortResponse | true | Custom model associated with this deployment. | |
| customModelVersion | CustomModelVersionShortResponse | true | Custom model version associated with this deployment. | |
| executionEnvironment | ExecutionEnvironmentShortResponse | true | Execution environment associated with this deployment. | |
| executionEnvironmentVersion | ExecutionEnvironmentVersionShortResponse | true | Execution environment version associated with this deployment. | |
| targetType | string | true | The target type of the training model. | |
| trainingHistory | [TrainingHistoryEntry] | true | maxItems: 1000 |
List of instances of this blueprint having been trained. |
| userBlueprintId | string | true | User Blueprint ID that can be used to train the model. |
Enumerated Values¶
| Property | Value |
|---|---|
| targetType | [Binary, Regression, Multiclass, Anomaly, Transform, TextGeneration, GeoPoint, Unstructured, VectorDatabase, AgenticWorkflow] |
DependencyConstraint
{
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| constraintType | string | true | The constraint type to apply to the version. | |
| version | string | true | The version label to use in the constraint. |
Enumerated Values¶
| Property | Value |
|---|---|
| constraintType | [<, <=, ==, >=, >] |
DependencyResponse
{
"properties": {
"constraints": {
"description": "Constraints that should be applied to the dependency when installed.",
"items": {
"properties": {
"constraintType": {
"description": "The constraint type to apply to the version.",
"enum": [
"<",
"<=",
"==",
">=",
">"
],
"type": "string"
},
"version": {
"description": "The version label to use in the constraint.",
"type": "string"
}
},
"required": [
"constraintType",
"version"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"extras": {
"description": "The dependency's package extras.",
"type": "string"
},
"line": {
"description": "The original line from the requirements.txt file.",
"type": "string"
},
"lineNumber": {
"description": "The line number the requirement was on in requirements.txt.",
"type": "integer"
},
"packageName": {
"description": "The dependency's package name.",
"type": "string"
}
},
"required": [
"constraints",
"line",
"lineNumber",
"packageName"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| constraints | [DependencyConstraint] | true | maxItems: 100 |
Constraints that should be applied to the dependency when installed. |
| extras | string | false | The dependency's package extras. | |
| line | string | true | The original line from the requirements.txt file. | |
| lineNumber | integer | true | The line number the requirement was on in requirements.txt. | |
| packageName | string | true | The dependency's package name. |
ExecutionEnvironmentShortResponse
{
"description": "Execution environment associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment.",
"type": "string"
},
"name": {
"description": "User-friendly name of the execution environment.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
Execution environment associated with this deployment.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | The ID of the execution environment. | |
| name | string | true | User-friendly name of the execution environment. |
ExecutionEnvironmentVersionShortResponse
{
"description": "Execution environment version associated with this deployment.",
"properties": {
"id": {
"description": "The ID of the execution environment version.",
"type": "string"
},
"label": {
"description": "User-friendly name of the execution environment version.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
}
Execution environment version associated with this deployment.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | The ID of the execution environment version. | |
| label | string | true | User-friendly name of the execution environment version. |
GrantAccessControlWithId
{
"properties": {
"id": {
"description": "The ID of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity. One of OWNER, USER, OBSERVER.",
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"role",
"shareRecipientType"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | The ID of the recipient. | |
| role | string | true | The role of the recipient on this entity. One of OWNER, USER, OBSERVER. | |
| shareRecipientType | string | true | Describes the recipient type, either user, group, or organization. |
Enumerated Values¶
| Property | Value |
|---|---|
| shareRecipientType | [user, group, organization] |
GrantAccessControlWithUsername
{
"properties": {
"role": {
"description": "The role of the recipient on this entity. One of OWNER, USER, OBSERVER.",
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
},
"username": {
"description": "Username of the user to update the access role for.",
"type": "string"
}
},
"required": [
"role",
"shareRecipientType",
"username"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| role | string | true | The role of the recipient on this entity. One of OWNER, USER, OBSERVER. | |
| shareRecipientType | string | true | Describes the recipient type, either user, group, or organization. | |
| username | string | true | Username of the user to update the access role for. |
Enumerated Values¶
| Property | Value |
|---|---|
| shareRecipientType | [user, group, organization] |
ImageAugmentationListCreateResponse
{
"properties": {
"augmentationListId": {
"description": "\n Id of the newly created augmentation list which can be used to:\n - retrieve the full augmentation list details;\n - retrieve augmentation previews;\n - to set the list id of a model in advanced tuning;\n - to delete or rename the list.\n ",
"type": "string"
}
},
"required": [
"augmentationListId"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| augmentationListId | string | true | Id of the newly created augmentation list which can be used to: - retrieve the full augmentation list details; - retrieve augmentation previews; - to set the list id of a model in advanced tuning; - to delete or rename the list. |
ImageAugmentationListPatchParam
{
"properties": {
"featureName": {
"description": "The name of the image feature containing the data to be augmented",
"type": "string"
},
"inUse": {
"description": "This parameter was deprecated. You can still pass a value, but it will be ignored. DataRobot will takes care of the value itself.",
"type": "boolean",
"x-versiondeprecated": "2.30.0"
},
"initialList": {
"description": "Whether this list will be used during autopilot to perform image augmentation",
"type": "boolean"
},
"name": {
"description": "The name of the image augmentation list",
"type": "string"
},
"numberOfNewImages": {
"description": "Number of new rows to add for each existing row",
"minimum": 0,
"type": "integer"
},
"projectId": {
"description": "This parameter was deprecated. You can still pass a value, but it will be ignored. If you want to move an augmentation list to another project you can create a new list in the other project and delete the list in this project.",
"type": "string",
"x-versiondeprecated": "2.30.0"
},
"transformationProbability": {
"description": "Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"transformations": {
"description": "List of Transformations to possibly apply to each image",
"items": {
"properties": {
"enabled": {
"default": false,
"description": "Whether this transformation is enabled by default",
"type": "boolean"
},
"name": {
"description": "Transformation name",
"type": "string"
},
"params": {
"description": "Config values for transformation",
"items": {
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| featureName | string | false | The name of the image feature containing the data to be augmented | |
| inUse | boolean | false | This parameter was deprecated. You can still pass a value, but it will be ignored. DataRobot will takes care of the value itself. | |
| initialList | boolean | false | Whether this list will be used during autopilot to perform image augmentation | |
| name | string | false | The name of the image augmentation list | |
| numberOfNewImages | integer | false | minimum: 0 |
Number of new rows to add for each existing row |
| projectId | string | false | This parameter was deprecated. You can still pass a value, but it will be ignored. If you want to move an augmentation list to another project you can create a new list in the other project and delete the list in this project. | |
| transformationProbability | number | false | maximum: 1 minimum: 0 |
Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always. |
| transformations | [Transformation] | false | List of Transformations to possibly apply to each image |
ImageAugmentationListsCreate
{
"properties": {
"featureName": {
"description": "The name of the image feature containing the data to be augmented",
"type": "string"
},
"inUse": {
"default": false,
"description": "This parameter was deprecated. You can still pass a value, but it will be ignored. DataRobot will takes care of the value itself.",
"type": "boolean",
"x-versiondeprecated": "2.30.0"
},
"initialList": {
"default": false,
"description": "Whether this list will be used during autopilot to perform image augmentation",
"type": "boolean"
},
"name": {
"description": "The name of the image augmentation list",
"type": "string"
},
"numberOfNewImages": {
"description": "Number of new rows to add for each existing row",
"minimum": 1,
"type": "integer"
},
"projectId": {
"description": "The project containing the image data to be augmented",
"type": "string"
},
"samplesId": {
"default": null,
"description": "Image Augmentation list samples ID",
"type": [
"string",
"null"
]
},
"transformationProbability": {
"description": "Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"transformations": {
"description": "List of Transformations to possibly apply to each image",
"items": {
"properties": {
"enabled": {
"default": false,
"description": "Whether this transformation is enabled by default",
"type": "boolean"
},
"name": {
"description": "Transformation name",
"type": "string"
},
"params": {
"description": "Config values for transformation",
"items": {
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name",
"numberOfNewImages",
"projectId",
"transformationProbability",
"transformations"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| featureName | string | false | The name of the image feature containing the data to be augmented | |
| inUse | boolean | false | This parameter was deprecated. You can still pass a value, but it will be ignored. DataRobot will takes care of the value itself. | |
| initialList | boolean | false | Whether this list will be used during autopilot to perform image augmentation | |
| name | string | true | The name of the image augmentation list | |
| numberOfNewImages | integer | true | minimum: 1 |
Number of new rows to add for each existing row |
| projectId | string | true | The project containing the image data to be augmented | |
| samplesId | string,null | false | Image Augmentation list samples ID | |
| transformationProbability | number | true | maximum: 1 minimum: 0 |
Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always. |
| transformations | [Transformation] | true | List of Transformations to possibly apply to each image |
ImageAugmentationListsCreateSamples
{
"properties": {
"numberOfRows": {
"description": "Number of images from the original dataset to be augmented",
"minimum": 1,
"type": "integer"
}
},
"required": [
"numberOfRows"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| numberOfRows | integer | true | minimum: 1 |
Number of images from the original dataset to be augmented |
ImageAugmentationListsResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "The content in the form of an augmentation lists",
"items": {
"properties": {
"featureName": {
"description": "The name of the image feature containing the data to be augmented",
"type": "string"
},
"id": {
"description": "Image Augmentation list ID",
"type": "string"
},
"inUse": {
"default": false,
"description": "This is set to true when the Augmentation List has been used to train a model",
"type": "boolean"
},
"initialList": {
"default": false,
"description": "Whether this list will be used during autopilot to perform image augmentation",
"type": "boolean"
},
"name": {
"description": "The name of the image augmentation list",
"type": "string"
},
"numberOfNewImages": {
"description": "Number of new rows to add for each existing row",
"minimum": 1,
"type": "integer"
},
"projectId": {
"description": "The project containing the image data to be augmented",
"type": "string"
},
"samplesId": {
"default": null,
"description": "Image Augmentation list samples ID",
"type": [
"string",
"null"
]
},
"transformationProbability": {
"description": "Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"transformations": {
"description": "List of Transformations to possibly apply to each image",
"items": {
"properties": {
"enabled": {
"default": false,
"description": "Whether this transformation is enabled by default",
"type": "boolean"
},
"name": {
"description": "Transformation name",
"type": "string"
},
"params": {
"description": "Config values for transformation",
"items": {
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"id",
"name",
"numberOfNewImages",
"projectId",
"transformationProbability",
"transformations"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | Number of items returned on this page. | |
| data | [ImageAugmentationListsRetrieve] | true | The content in the form of an augmentation lists | |
| next | string,null(uri) | true | URL pointing to the next page (if null, there is no next page). | |
| previous | string,null(uri) | true | URL pointing to the previous page (if null, there is no previous page). | |
| totalCount | integer | true | The total number of items across all pages. |
ImageAugmentationListsRetrieve
{
"properties": {
"featureName": {
"description": "The name of the image feature containing the data to be augmented",
"type": "string"
},
"id": {
"description": "Image Augmentation list ID",
"type": "string"
},
"inUse": {
"default": false,
"description": "This is set to true when the Augmentation List has been used to train a model",
"type": "boolean"
},
"initialList": {
"default": false,
"description": "Whether this list will be used during autopilot to perform image augmentation",
"type": "boolean"
},
"name": {
"description": "The name of the image augmentation list",
"type": "string"
},
"numberOfNewImages": {
"description": "Number of new rows to add for each existing row",
"minimum": 1,
"type": "integer"
},
"projectId": {
"description": "The project containing the image data to be augmented",
"type": "string"
},
"samplesId": {
"default": null,
"description": "Image Augmentation list samples ID",
"type": [
"string",
"null"
]
},
"transformationProbability": {
"description": "Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"transformations": {
"description": "List of Transformations to possibly apply to each image",
"items": {
"properties": {
"enabled": {
"default": false,
"description": "Whether this transformation is enabled by default",
"type": "boolean"
},
"name": {
"description": "Transformation name",
"type": "string"
},
"params": {
"description": "Config values for transformation",
"items": {
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"id",
"name",
"numberOfNewImages",
"projectId",
"transformationProbability",
"transformations"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| featureName | string | false | The name of the image feature containing the data to be augmented | |
| id | string | true | Image Augmentation list ID | |
| inUse | boolean | false | This is set to true when the Augmentation List has been used to train a model | |
| initialList | boolean | false | Whether this list will be used during autopilot to perform image augmentation | |
| name | string | true | The name of the image augmentation list | |
| numberOfNewImages | integer | true | minimum: 1 |
Number of new rows to add for each existing row |
| projectId | string | true | The project containing the image data to be augmented | |
| samplesId | string,null | false | Image Augmentation list samples ID | |
| transformationProbability | number | true | maximum: 1 minimum: 0 |
Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always. |
| transformations | [Transformation] | true | List of Transformations to possibly apply to each image |
ImageAugmentationListsRetrieveSamplesResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "Augmentation samples list",
"items": {
"properties": {
"height": {
"description": "Height of the image in pixels",
"type": "integer"
},
"imageId": {
"description": "Id of the image. The augmented image file can be retrieved with [GET /api/v2/projects/{projectId}/images/{imageId}/file/][get-apiv2projectsprojectidimagesimageidfile]",
"type": "string"
},
"originalImageId": {
"description": "Id of the original image that was transformed to produce the augmented image. If this is an original image (from the original training dataset) this value will be null. The id can be used to retrieve the original image file with: [GET /api/v2/projects/{projectId}/images/{imageId}/file/][get-apiv2projectsprojectidimagesimageidfile]",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "Project id",
"type": "string"
},
"width": {
"description": "Width of the image in pixels",
"type": "integer"
}
},
"required": [
"height",
"imageId",
"originalImageId",
"projectId",
"width"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | Number of items returned on this page. | |
| data | [ImageAugmentationRetrieveSamplesItem] | true | Augmentation samples list | |
| next | string,null(uri) | true | URL pointing to the next page (if null, there is no next page). | |
| previous | string,null(uri) | true | URL pointing to the previous page (if null, there is no previous page). | |
| totalCount | integer | true | The total number of items across all pages. |
ImageAugmentationOptionsResponse
{
"properties": {
"currentNumberOfNewImages": {
"description": "Number of new images to be created for each original image during training",
"type": "integer"
},
"currentTransformationProbability": {
"description": "Probability that each transformation included in an augmentation list will be applied to an image, if `affectedByTransformationProbability` for that transformation is True",
"type": "number"
},
"featureName": {
"description": "Name of the image feature that the augmentation list is associated with",
"type": "string"
},
"id": {
"description": "Augmentation list id",
"type": "string"
},
"maxNumberOfNewImages": {
"description": "Maximum number of new images per original image to be generated during training",
"type": "integer"
},
"maxTransformationProbability": {
"description": "Maximum probability that each enabled augmentation will be applied to an image",
"maximum": 1,
"type": "number"
},
"minNumberOfNewImages": {
"description": "Minimum number of new images per original image to be generated during training",
"type": "integer"
},
"minTransformationProbability": {
"description": "Minimum probability that each enabled augmentation will be applied to an image",
"minimum": 0,
"type": "number"
},
"name": {
"description": "The name of the augmentation list",
"type": "string"
},
"projectId": {
"description": "The id of the project containing the image data to be augmented",
"type": "string"
},
"transformations": {
"description": "List of Transformations to possibly apply to each image",
"items": {
"properties": {
"affectedByTransformationProbability": {
"description": "If true, whenever this transformation is included in an augmentation list, this transformation will be applied to each image with probability set by the Transformation Probability. If false, whenever this transformation is included in an augmentation list, this transformation will be applied to each image with probability described in the Platform Documentation here: https://docs.datarobot.com/en/docs/modeling/special-workflows/visual-ai/tti-augment/ttia-lists.html#transformations",
"type": "boolean"
},
"enabledByDefault": {
"description": "Determines if the parameter should be default selected in the UI",
"type": "boolean"
},
"name": {
"description": "The name of the transformation",
"type": "string"
},
"params": {
"description": "The list of parameters that control the transformation",
"items": {
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
},
"translatedName": {
"description": "Translated name of the parameter",
"type": "string"
},
"type": {
"description": "The type of the parameter (int, float, etc...)",
"type": "string"
}
},
"required": [
"name",
"translatedName",
"type"
],
"type": "object"
},
"type": "array"
},
"translatedName": {
"description": "Translated name of the transformation",
"type": "string"
}
},
"required": [
"affectedByTransformationProbability",
"enabledByDefault",
"name",
"params",
"translatedName"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"currentNumberOfNewImages",
"currentTransformationProbability",
"id",
"maxNumberOfNewImages",
"maxTransformationProbability",
"minNumberOfNewImages",
"minTransformationProbability",
"name",
"projectId",
"transformations"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| currentNumberOfNewImages | integer | true | Number of new images to be created for each original image during training | |
| currentTransformationProbability | number | true | Probability that each transformation included in an augmentation list will be applied to an image, if affectedByTransformationProbability for that transformation is True |
|
| featureName | string | false | Name of the image feature that the augmentation list is associated with | |
| id | string | true | Augmentation list id | |
| maxNumberOfNewImages | integer | true | Maximum number of new images per original image to be generated during training | |
| maxTransformationProbability | number | true | maximum: 1 |
Maximum probability that each enabled augmentation will be applied to an image |
| minNumberOfNewImages | integer | true | Minimum number of new images per original image to be generated during training | |
| minTransformationProbability | number | true | minimum: 0 |
Minimum probability that each enabled augmentation will be applied to an image |
| name | string | true | The name of the augmentation list | |
| projectId | string | true | The id of the project containing the image data to be augmented | |
| transformations | [ImageAugmentationOptionsTransformation] | true | List of Transformations to possibly apply to each image |
ImageAugmentationOptionsTransformation
{
"properties": {
"affectedByTransformationProbability": {
"description": "If true, whenever this transformation is included in an augmentation list, this transformation will be applied to each image with probability set by the Transformation Probability. If false, whenever this transformation is included in an augmentation list, this transformation will be applied to each image with probability described in the Platform Documentation here: https://docs.datarobot.com/en/docs/modeling/special-workflows/visual-ai/tti-augment/ttia-lists.html#transformations",
"type": "boolean"
},
"enabledByDefault": {
"description": "Determines if the parameter should be default selected in the UI",
"type": "boolean"
},
"name": {
"description": "The name of the transformation",
"type": "string"
},
"params": {
"description": "The list of parameters that control the transformation",
"items": {
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
},
"translatedName": {
"description": "Translated name of the parameter",
"type": "string"
},
"type": {
"description": "The type of the parameter (int, float, etc...)",
"type": "string"
}
},
"required": [
"name",
"translatedName",
"type"
],
"type": "object"
},
"type": "array"
},
"translatedName": {
"description": "Translated name of the transformation",
"type": "string"
}
},
"required": [
"affectedByTransformationProbability",
"enabledByDefault",
"name",
"params",
"translatedName"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| affectedByTransformationProbability | boolean | true | If true, whenever this transformation is included in an augmentation list, this transformation will be applied to each image with probability set by the Transformation Probability. If false, whenever this transformation is included in an augmentation list, this transformation will be applied to each image with probability described in the Platform Documentation here: https://docs.datarobot.com/en/docs/modeling/special-workflows/visual-ai/tti-augment/ttia-lists.html#transformations | |
| enabledByDefault | boolean | true | Determines if the parameter should be default selected in the UI | |
| name | string | true | The name of the transformation | |
| params | [ImageAugmentationOptionsTransformationParam] | true | The list of parameters that control the transformation | |
| translatedName | string | true | Translated name of the transformation |
ImageAugmentationOptionsTransformationParam
{
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
},
"translatedName": {
"description": "Translated name of the parameter",
"type": "string"
},
"type": {
"description": "The type of the parameter (int, float, etc...)",
"type": "string"
}
},
"required": [
"name",
"translatedName",
"type"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| currentValue | any | false | Current transformation value |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | number | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| maxValue | any | false | Max transformation value |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | number | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| minValue | any | false | Min transformation value |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | number | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | Transformation param name | |
| translatedName | string | true | Translated name of the parameter | |
| type | string | true | The type of the parameter (int, float, etc...) |
ImageAugmentationRetrieveSamplesItem
{
"properties": {
"height": {
"description": "Height of the image in pixels",
"type": "integer"
},
"imageId": {
"description": "Id of the image. The augmented image file can be retrieved with [GET /api/v2/projects/{projectId}/images/{imageId}/file/][get-apiv2projectsprojectidimagesimageidfile]",
"type": "string"
},
"originalImageId": {
"description": "Id of the original image that was transformed to produce the augmented image. If this is an original image (from the original training dataset) this value will be null. The id can be used to retrieve the original image file with: [GET /api/v2/projects/{projectId}/images/{imageId}/file/][get-apiv2projectsprojectidimagesimageidfile]",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "Project id",
"type": "string"
},
"width": {
"description": "Width of the image in pixels",
"type": "integer"
}
},
"required": [
"height",
"imageId",
"originalImageId",
"projectId",
"width"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| height | integer | true | Height of the image in pixels | |
| imageId | string | true | Id of the image. The augmented image file can be retrieved with GET /api/v2/projects/{projectId}/images/{imageId}/file/ | |
| originalImageId | string,null | true | Id of the original image that was transformed to produce the augmented image. If this is an original image (from the original training dataset) this value will be null. The id can be used to retrieve the original image file with: GET /api/v2/projects/{projectId}/images/{imageId}/file/ | |
| projectId | string | true | Project id | |
| width | integer | true | Width of the image in pixels |
ImageAugmentationRetrieveSamplesResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "Augmentation samples list",
"items": {
"properties": {
"height": {
"description": "Height of the image in pixels",
"type": "integer"
},
"imageId": {
"description": "Id of the image. The augmented image file can be retrieved with [GET /api/v2/projects/{projectId}/images/{imageId}/file/][get-apiv2projectsprojectidimagesimageidfile]",
"type": "string"
},
"originalImageId": {
"description": "Id of the original image that was transformed to produce the augmented image. If this is an original image (from the original training dataset) this value will be null. The id can be used to retrieve the original image file with: [GET /api/v2/projects/{projectId}/images/{imageId}/file/][get-apiv2projectsprojectidimagesimageidfile]",
"type": [
"string",
"null"
]
},
"projectId": {
"description": "Project id",
"type": "string"
},
"width": {
"description": "Width of the image in pixels",
"type": "integer"
}
},
"required": [
"height",
"imageId",
"originalImageId",
"projectId",
"width"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | Number of items returned on this page. | |
| data | [ImageAugmentationRetrieveSamplesItem] | true | Augmentation samples list | |
| next | string,null(uri) | true | URL pointing to the next page (if null, there is no next page). | |
| previous | string,null(uri) | true | URL pointing to the previous page (if null, there is no previous page). | |
| totalCount | integer | true | The total number of items across all pages. |
ImageAugmentationSamplesRequest
{
"properties": {
"featureName": {
"description": "The name of the image feature containing the data to be augmented",
"type": "string"
},
"id": {
"description": "Augmentation list id",
"type": "string"
},
"inUse": {
"default": false,
"description": "This is set to true when the Augmentation List has been used to train a model",
"type": "boolean"
},
"initialList": {
"default": false,
"description": "Whether this list will be used during autopilot to perform image augmentation",
"type": "boolean"
},
"name": {
"description": "The name of the image augmentation list",
"type": "string"
},
"numberOfNewImages": {
"description": "Number of new rows to add for each existing row",
"minimum": 1,
"type": "integer"
},
"numberOfRows": {
"description": "Number of images from the original dataset to be augmented",
"minimum": 1,
"type": "integer"
},
"projectId": {
"description": "The project containing the image data to be augmented",
"type": "string"
},
"samplesId": {
"default": null,
"description": "Image Augmentation list samples ID",
"type": [
"string",
"null"
]
},
"transformationProbability": {
"description": "Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"transformations": {
"description": "List of Transformations to possibly apply to each image",
"items": {
"properties": {
"enabled": {
"default": false,
"description": "Whether this transformation is enabled by default",
"type": "boolean"
},
"name": {
"description": "Transformation name",
"type": "string"
},
"params": {
"description": "Config values for transformation",
"items": {
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name",
"numberOfNewImages",
"numberOfRows",
"projectId",
"transformationProbability",
"transformations"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| featureName | string | false | The name of the image feature containing the data to be augmented | |
| id | string | false | Augmentation list id | |
| inUse | boolean | false | This is set to true when the Augmentation List has been used to train a model | |
| initialList | boolean | false | Whether this list will be used during autopilot to perform image augmentation | |
| name | string | true | The name of the image augmentation list | |
| numberOfNewImages | integer | true | minimum: 1 |
Number of new rows to add for each existing row |
| numberOfRows | integer | true | minimum: 1 |
Number of images from the original dataset to be augmented |
| projectId | string | true | The project containing the image data to be augmented | |
| samplesId | string,null | false | Image Augmentation list samples ID | |
| transformationProbability | number | true | maximum: 1 minimum: 0 |
Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always. |
| transformations | [Transformation] | true | List of Transformations to possibly apply to each image |
ImageAugmentationSamplesResponse
{
"properties": {
"statusId": {
"description": "Id of the newly created augmentation samples which can be used to retrieve the full set of sample images.",
"type": "string"
}
},
"required": [
"statusId"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| statusId | string | true | Id of the newly created augmentation samples which can be used to retrieve the full set of sample images. |
NodeDescription
{
"properties": {
"id": {
"description": "The ID of the node.",
"type": "string"
},
"label": {
"description": "The label of the node.",
"type": "string"
}
},
"required": [
"id",
"label"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | The ID of the node. | |
| label | string | true | The label of the node. |
ParamValuePair
{
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| param | string | true | The name of a field associated with the value. | |
| value | any | true | Any value. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | number | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [anyOf] | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | number | false | none |
PersistentLogsForModelWithCustomTasksRetrieveResponse
{
"properties": {
"data": {
"description": "An archive (tar.gz) of the logs produced and persisted by a model.",
"format": "binary",
"type": "string"
}
},
"required": [
"data"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | string(binary) | true | An archive (tar.gz) of the logs produced and persisted by a model. |
RequiredMetadataValue
{
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string"
},
"value": {
"description": "The value for the given field.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"fieldName",
"value"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fieldName | string | true | The required field name. This value will be added as an environment variable when running custom models. | |
| value | string | true | maxLength: 100 |
The value for the given field. |
SharedRolesUpdate
{
"properties": {
"operation": {
"description": "Name of the action being taken. The only operation is 'updateRoles'.",
"enum": [
"updateRoles"
],
"type": "string"
},
"roles": {
"description": "Array of GrantAccessControl objects., up to maximum 100 objects.",
"items": {
"oneOf": [
{
"properties": {
"role": {
"description": "The role of the recipient on this entity. One of OWNER, USER, OBSERVER.",
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
},
"username": {
"description": "Username of the user to update the access role for.",
"type": "string"
}
},
"required": [
"role",
"shareRecipientType",
"username"
],
"type": "object"
},
{
"properties": {
"id": {
"description": "The ID of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity. One of OWNER, USER, OBSERVER.",
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"role",
"shareRecipientType"
],
"type": "object"
}
]
},
"maxItems": 100,
"minItems": 1,
"type": "array"
}
},
"required": [
"operation",
"roles"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | string | true | Name of the action being taken. The only operation is 'updateRoles'. | |
| roles | [oneOf] | true | maxItems: 100 minItems: 1 |
Array of GrantAccessControl objects., up to maximum 100 objects. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | GrantAccessControlWithUsername | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | GrantAccessControlWithId | false | none |
Enumerated Values¶
| Property | Value |
|---|---|
| operation | updateRoles |
SharingUpdateOrRemoveWithGrant
{
"properties": {
"data": {
"description": "List of sharing roles to update.",
"items": {
"properties": {
"canShare": {
"default": true,
"description": "Whether the org/group/user should be able to share with others.If true, the org/group/user will be able to grant any role up to and includingtheir own to other orgs/groups/user. If `role` is `NO_ROLE` `canShare` is ignored.",
"type": "boolean"
},
"role": {
"description": "The role to set on the entity. When it is None, the role of this user will be removedfrom this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of the user to update the access role for.",
"type": "string"
}
},
"required": [
"role",
"username"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [UserRoleWithGrant] | true | maxItems: 100 |
List of sharing roles to update. |
TrainingHistoryEntry
{
"properties": {
"creationDate": {
"description": "ISO-8601 timestamp of when the project the blueprint was trained on was created.",
"type": "string"
},
"lid": {
"description": "The leaderboard ID the blueprint was trained on.",
"type": "string"
},
"pid": {
"description": "The project ID the blueprint was trained on.",
"type": "string"
},
"projectModelsCount": {
"description": "Number of models in the project the blueprint was trained on.",
"type": "integer"
},
"projectName": {
"description": "The project name the blueprint was trained on.",
"type": "string"
},
"targetName": {
"description": "The target name of the project the blueprint was trained on.",
"type": "string"
}
},
"required": [
"creationDate",
"lid",
"pid",
"projectModelsCount",
"projectName",
"targetName"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| creationDate | string | true | ISO-8601 timestamp of when the project the blueprint was trained on was created. | |
| lid | string | true | The leaderboard ID the blueprint was trained on. | |
| pid | string | true | The project ID the blueprint was trained on. | |
| projectModelsCount | integer | true | Number of models in the project the blueprint was trained on. | |
| projectName | string | true | The project name the blueprint was trained on. | |
| targetName | string | true | The target name of the project the blueprint was trained on. |
Transformation
{
"properties": {
"enabled": {
"default": false,
"description": "Whether this transformation is enabled by default",
"type": "boolean"
},
"name": {
"description": "Transformation name",
"type": "string"
},
"params": {
"description": "Config values for transformation",
"items": {
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| enabled | boolean | false | Whether this transformation is enabled by default | |
| name | string | true | Transformation name | |
| params | [TransformationParam] | false | Config values for transformation |
TransformationParam
{
"properties": {
"currentValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Current transformation value"
},
"maxValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Max transformation value"
},
"minValue": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"description": "Min transformation value"
},
"name": {
"description": "Transformation param name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| currentValue | any | false | Current transformation value |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | number | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| maxValue | any | false | Max transformation value |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | number | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| minValue | any | false | Min transformation value |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | number | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | Transformation param name |
UserBlueprintAddToMenu
{
"properties": {
"deleteAfter": {
"default": false,
"description": "Whether to delete the user blueprint(s) after adding it (them) to the project menu.",
"type": "boolean"
},
"describeFailures": {
"default": false,
"description": "Whether to include extra fields to describe why any blueprints were not added to the chosen project.",
"type": "boolean",
"x-versionadded": "v2.27"
},
"projectId": {
"description": "The projectId of the project for the repository to add the specified user blueprints to.",
"type": "string"
},
"userBlueprintIds": {
"description": "The ids of the user blueprints to add to the specified project's repository.",
"items": {
"description": "An id of one user blueprint to add to the specified project's repository.",
"type": "string"
},
"type": "array"
}
},
"required": [
"deleteAfter",
"describeFailures",
"projectId",
"userBlueprintIds"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| deleteAfter | boolean | true | Whether to delete the user blueprint(s) after adding it (them) to the project menu. | |
| describeFailures | boolean | true | Whether to include extra fields to describe why any blueprints were not added to the chosen project. | |
| projectId | string | true | The projectId of the project for the repository to add the specified user blueprints to. | |
| userBlueprintIds | [string] | true | The ids of the user blueprints to add to the specified project's repository. |
UserBlueprintAddToMenuResponse
{
"properties": {
"addedToMenu": {
"description": "The list of userBlueprintId and blueprintId pairs representing blueprints successfully added to the project repository.",
"items": {
"properties": {
"blueprintId": {
"description": "The blueprintId representing the blueprint which was added to the project repository.",
"type": "string"
},
"userBlueprintId": {
"description": "The userBlueprintId associated with the blueprintId added to the project repository.",
"type": "string"
}
},
"required": [
"blueprintId",
"userBlueprintId"
],
"type": "object"
},
"type": "array"
},
"message": {
"description": "A success message or a list of reasons why the list of blueprints could not be added to the project repository.",
"type": "string",
"x-versionadded": "2.27"
},
"notAddedToMenu": {
"description": "The list of userBlueprintId and error message representing blueprints which failed to be added to the project repository.",
"items": {
"properties": {
"error": {
"description": "The error message representing why the blueprint was not added to the project repository.",
"type": "string"
},
"userBlueprintId": {
"description": "The userBlueprintId associated with the blueprint which was not added to the project repository.",
"type": "string"
}
},
"required": [
"error",
"userBlueprintId"
],
"type": "object"
},
"type": "array",
"x-versionadded": "2.27"
}
},
"required": [
"addedToMenu"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| addedToMenu | [UserBlueprintAddedToMenuItem] | true | The list of userBlueprintId and blueprintId pairs representing blueprints successfully added to the project repository. | |
| message | string | false | A success message or a list of reasons why the list of blueprints could not be added to the project repository. | |
| notAddedToMenu | [UserBlueprintFailedToAddToMenuItem] | false | The list of userBlueprintId and error message representing blueprints which failed to be added to the project repository. |
UserBlueprintAddedToMenuItem
{
"properties": {
"blueprintId": {
"description": "The blueprintId representing the blueprint which was added to the project repository.",
"type": "string"
},
"userBlueprintId": {
"description": "The userBlueprintId associated with the blueprintId added to the project repository.",
"type": "string"
}
},
"required": [
"blueprintId",
"userBlueprintId"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| blueprintId | string | true | The blueprintId representing the blueprint which was added to the project repository. | |
| userBlueprintId | string | true | The userBlueprintId associated with the blueprintId added to the project repository. |
UserBlueprintBulkValidationRequest
{
"properties": {
"projectId": {
"description": "String representation of ObjectId for the currently active project. The user blueprint is validated when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.",
"type": "string"
},
"userBlueprintIds": {
"description": "The ids of the user blueprints to validate in bulk.",
"items": {
"description": "An id of one user blueprint to validate.",
"type": "string"
},
"type": "array"
}
},
"required": [
"userBlueprintIds"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| projectId | string | false | String representation of ObjectId for the currently active project. The user blueprint is validated when this project is active. Necessary in the event of project specific tasks, such as column selection tasks. | |
| userBlueprintIds | [string] | true | The ids of the user blueprints to validate in bulk. |
UserBlueprintCreate
{
"properties": {
"blueprint": {
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"oneOf": [
{
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"items": {
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
},
"decompressedBlueprint": {
"default": false,
"description": "Whether to retrieve the blueprint in the decompressed format.",
"type": "boolean"
},
"description": {
"description": "The description to give to the blueprint.",
"type": "string"
},
"getDynamicLabels": {
"default": false,
"description": "Whether to add dynamic labels to a decompressed blueprint.",
"type": "boolean"
},
"isInplaceEditor": {
"default": false,
"description": "Whether the request is sent from the in place user BP editor.",
"type": "boolean"
},
"modelType": {
"description": "The title to give to the blueprint.",
"maxLength": 1000,
"type": "string"
},
"projectId": {
"description": "String representation of ObjectId for the currently active project. The user blueprint is created when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.",
"type": [
"string",
"null"
]
},
"saveToCatalog": {
"default": true,
"description": "Whether to save the blueprint to the catalog.",
"type": "boolean"
}
},
"required": [
"blueprint",
"decompressedBlueprint",
"isInplaceEditor",
"saveToCatalog"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| blueprint | any | true | The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [UserBlueprintsBlueprintTask] | false | The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator. |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | AllowExtra | false | Parameters submitted by the user to the failed job |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| decompressedBlueprint | boolean | true | Whether to retrieve the blueprint in the decompressed format. | |
| description | string | false | The description to give to the blueprint. | |
| getDynamicLabels | boolean | false | Whether to add dynamic labels to a decompressed blueprint. | |
| isInplaceEditor | boolean | true | Whether the request is sent from the in place user BP editor. | |
| modelType | string | false | maxLength: 1000 |
The title to give to the blueprint. |
| projectId | string,null | false | String representation of ObjectId for the currently active project. The user blueprint is created when this project is active. Necessary in the event of project specific tasks, such as column selection tasks. | |
| saveToCatalog | boolean | true | Whether to save the blueprint to the catalog. |
UserBlueprintCreateFromBlueprintId
{
"properties": {
"blueprintId": {
"description": "The id associated with the blueprint to create the user blueprint from.",
"type": "string"
},
"decompressedBlueprint": {
"default": false,
"description": "Whether to retrieve the blueprint in the decompressed format.",
"type": "boolean"
},
"description": {
"description": "The description to give to the blueprint.",
"type": "string"
},
"getDynamicLabels": {
"default": false,
"description": "Whether to add dynamic labels to a decompressed blueprint.",
"type": "boolean"
},
"isInplaceEditor": {
"default": false,
"description": "Whether the request is sent from the in place user BP editor.",
"type": "boolean"
},
"modelType": {
"description": "The title to give to the blueprint.",
"maxLength": 1000,
"type": "string"
},
"projectId": {
"description": "String representation of ObjectId for the currently active project. The user blueprint is created when this project is active.",
"type": "string"
},
"saveToCatalog": {
"default": true,
"description": "Whether to save the blueprint to the catalog.",
"type": "boolean"
}
},
"required": [
"blueprintId",
"decompressedBlueprint",
"isInplaceEditor",
"projectId",
"saveToCatalog"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| blueprintId | string | true | The id associated with the blueprint to create the user blueprint from. | |
| decompressedBlueprint | boolean | true | Whether to retrieve the blueprint in the decompressed format. | |
| description | string | false | The description to give to the blueprint. | |
| getDynamicLabels | boolean | false | Whether to add dynamic labels to a decompressed blueprint. | |
| isInplaceEditor | boolean | true | Whether the request is sent from the in place user BP editor. | |
| modelType | string | false | maxLength: 1000 |
The title to give to the blueprint. |
| projectId | string | true | String representation of ObjectId for the currently active project. The user blueprint is created when this project is active. | |
| saveToCatalog | boolean | true | Whether to save the blueprint to the catalog. |
UserBlueprintCreateFromCustomTaskVersionIdPayload
{
"properties": {
"customTaskVersionId": {
"description": "The ID of a custom task version.",
"type": "string"
},
"decompressedBlueprint": {
"default": false,
"description": "Whether to retrieve the blueprint in the decompressed format.",
"type": "boolean"
},
"description": {
"description": "The description for the user blueprint that will be created from this CustomTaskVersion.",
"type": "string"
},
"saveToCatalog": {
"default": true,
"description": "Whether to save the blueprint to the catalog.",
"type": "boolean"
}
},
"required": [
"customTaskVersionId",
"decompressedBlueprint",
"saveToCatalog"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customTaskVersionId | string | true | The ID of a custom task version. | |
| decompressedBlueprint | boolean | true | Whether to retrieve the blueprint in the decompressed format. | |
| description | string | false | The description for the user blueprint that will be created from this CustomTaskVersion. | |
| saveToCatalog | boolean | true | Whether to save the blueprint to the catalog. |
UserBlueprintCreateFromUserBlueprintId
{
"properties": {
"decompressedBlueprint": {
"default": false,
"description": "Whether to retrieve the blueprint in the decompressed format.",
"type": "boolean"
},
"description": {
"description": "The description to give to the blueprint.",
"type": "string"
},
"getDynamicLabels": {
"default": false,
"description": "Whether to add dynamic labels to a decompressed blueprint.",
"type": "boolean"
},
"isInplaceEditor": {
"default": false,
"description": "Whether the request is sent from the in place user BP editor.",
"type": "boolean"
},
"modelType": {
"description": "The title to give to the blueprint.",
"maxLength": 1000,
"type": "string"
},
"projectId": {
"description": "String representation of ObjectId for the currently active project. The user blueprint is created when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.",
"type": [
"string",
"null"
]
},
"saveToCatalog": {
"default": true,
"description": "Whether to save the blueprint to the catalog.",
"type": "boolean"
},
"userBlueprintId": {
"description": "The id of the existing user blueprint to copy.",
"type": "string"
}
},
"required": [
"decompressedBlueprint",
"isInplaceEditor",
"saveToCatalog",
"userBlueprintId"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| decompressedBlueprint | boolean | true | Whether to retrieve the blueprint in the decompressed format. | |
| description | string | false | The description to give to the blueprint. | |
| getDynamicLabels | boolean | false | Whether to add dynamic labels to a decompressed blueprint. | |
| isInplaceEditor | boolean | true | Whether the request is sent from the in place user BP editor. | |
| modelType | string | false | maxLength: 1000 |
The title to give to the blueprint. |
| projectId | string,null | false | String representation of ObjectId for the currently active project. The user blueprint is created when this project is active. Necessary in the event of project specific tasks, such as column selection tasks. | |
| saveToCatalog | boolean | true | Whether to save the blueprint to the catalog. | |
| userBlueprintId | string | true | The id of the existing user blueprint to copy. |
UserBlueprintFailedToAddToMenuItem
{
"properties": {
"error": {
"description": "The error message representing why the blueprint was not added to the project repository.",
"type": "string"
},
"userBlueprintId": {
"description": "The userBlueprintId associated with the blueprint which was not added to the project repository.",
"type": "string"
}
},
"required": [
"error",
"userBlueprintId"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| error | string | true | The error message representing why the blueprint was not added to the project repository. | |
| userBlueprintId | string | true | The userBlueprintId associated with the blueprint which was not added to the project repository. |
UserBlueprintSharedRolesListResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "A list of SharedRoles objects.",
"items": {
"properties": {
"id": {
"description": "The ID of the recipient organization, group or user.",
"type": "string"
},
"name": {
"description": "The name of the recipient organization, group or user.",
"type": "string"
},
"role": {
"description": "The role of the org/group/user on this dataset or \"NO_ROLE\" for removing access when used with route to modify access.",
"enum": [
"CONSUMER",
"EDITOR",
"OWNER"
],
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | Number of items returned on this page. | |
| data | [UserBlueprintSharedRolesResponse] | true | A list of SharedRoles objects. | |
| next | string,null(uri) | true | URL pointing to the next page (if null, there is no next page). | |
| previous | string,null(uri) | true | URL pointing to the previous page (if null, there is no previous page). | |
| totalCount | integer | true | The total number of items across all pages. |
UserBlueprintSharedRolesResponse
{
"properties": {
"id": {
"description": "The ID of the recipient organization, group or user.",
"type": "string"
},
"name": {
"description": "The name of the recipient organization, group or user.",
"type": "string"
},
"role": {
"description": "The role of the org/group/user on this dataset or \"NO_ROLE\" for removing access when used with route to modify access.",
"enum": [
"CONSUMER",
"EDITOR",
"OWNER"
],
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | The ID of the recipient organization, group or user. | |
| name | string | true | The name of the recipient organization, group or user. | |
| role | string | true | The role of the org/group/user on this dataset or "NO_ROLE" for removing access when used with route to modify access. | |
| shareRecipientType | string | true | Describes the recipient type, either user, group, or organization. |
Enumerated Values¶
| Property | Value |
|---|---|
| role | [CONSUMER, EDITOR, OWNER] |
| shareRecipientType | [user, group, organization] |
UserBlueprintTask
{
"properties": {
"arguments": {
"description": "A list of definitions of each argument which can be set for the task.",
"items": {
"properties": {
"argument": {
"description": "The definition of a task argument, used to specify a certain aspect of the task.",
"oneOf": [
{
"properties": {
"default": {
"description": "The default value of the argument.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"name": {
"description": "The name of the argument.",
"type": "string"
},
"recommended": {
"description": "The recommended value, based on frequently used values.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"tunable": {
"description": "Whether the argument is tunable by the end-user.",
"type": "boolean"
},
"type": {
"description": "The type of the argument (e.g. \"int\", \"float\", \"select\", \"intgrid\", \"multi\", etc.)",
"type": "string"
},
"values": {
"description": "The possible values of the argument, which may be a range or list, or dictionary of ranges or lists keyed by type.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
}
},
"required": [
"name",
"type",
"values"
],
"type": "object"
}
]
},
"key": {
"description": "The unique key of the argument",
"type": "string"
}
},
"required": [
"argument",
"key"
],
"type": "object"
},
"type": "array"
},
"categories": {
"description": "The categories which the task is in.",
"items": {
"type": "string"
},
"type": "array"
},
"colnamesAndTypes": {
"description": "The column names, their types, and their hex representation, available in the specified project for the task.",
"items": {
"properties": {
"colname": {
"description": "The column name.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"type": {
"description": "The data type of the column.",
"type": "string"
}
},
"required": [
"colname",
"hex",
"type"
],
"type": "object"
},
"type": "array"
},
"customTaskId": {
"description": "The id of the custom task, if it is a custom task.",
"type": [
"string",
"null"
]
},
"customTaskVersions": {
"description": "Metadata for all of the custom task's versions.",
"items": {
"properties": {
"id": {
"description": "Id of the custom task version. The ID can be latest_<task_id> which implies to use the latest version of that custom task.",
"type": "string"
},
"label": {
"description": "The name of the custom task version.",
"type": "string"
},
"versionMajor": {
"description": "Major version of the custom task.",
"type": "integer"
},
"versionMinor": {
"description": "Minor version of the custom task.",
"type": "integer"
}
},
"required": [
"id",
"label",
"versionMajor",
"versionMinor"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "A description of the task.",
"type": "string"
},
"icon": {
"description": "The integer representing the id to be displayed when the blueprint is trained.",
"type": "integer"
},
"isCommonTask": {
"default": false,
"description": "Whether the task is a common task.",
"type": "boolean"
},
"isCustomTask": {
"description": "Whether the task is custom code written by the user.",
"type": "boolean"
},
"isVisibleInComposableMl": {
"default": true,
"description": "Whether the task is visible in the ComposableML menu",
"type": "boolean"
},
"label": {
"description": "The generic / default title or label for the task.",
"type": "string"
},
"outputMethods": {
"description": "The methods which the task can use to produce output.",
"items": {
"type": "string"
},
"type": "array"
},
"supportsScoringCode": {
"description": "Whether the task supports Scoring Code.",
"type": "boolean"
},
"taskCode": {
"description": "The unique code which represents the task to be constructed and executed",
"type": "string"
},
"timeSeriesOnly": {
"description": "Whether the task can only be used with time series projects.",
"type": "boolean"
},
"url": {
"description": "The URL of the documentation of the task.",
"oneOf": [
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
{
"type": "string"
}
]
},
"validInputs": {
"description": "The supported input types of the task.",
"items": {
"description": "A specific supported input type.",
"type": "string"
},
"type": "array"
}
},
"required": [
"arguments",
"categories",
"description",
"icon",
"label",
"outputMethods",
"supportsScoringCode",
"taskCode",
"timeSeriesOnly",
"url",
"validInputs"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| arguments | [UserBlueprintTaskArgument] | true | A list of definitions of each argument which can be set for the task. | |
| categories | [string] | true | The categories which the task is in. | |
| colnamesAndTypes | [ColnameAndType] | false | The column names, their types, and their hex representation, available in the specified project for the task. | |
| customTaskId | string,null | false | The id of the custom task, if it is a custom task. | |
| customTaskVersions | [UserBlueprintTaskCustomTaskMetadataWithArguments] | false | Metadata for all of the custom task's versions. | |
| description | string | true | A description of the task. | |
| icon | integer | true | The integer representing the id to be displayed when the blueprint is trained. | |
| isCommonTask | boolean | false | Whether the task is a common task. | |
| isCustomTask | boolean | false | Whether the task is custom code written by the user. | |
| isVisibleInComposableMl | boolean | false | Whether the task is visible in the ComposableML menu | |
| label | string | true | The generic / default title or label for the task. | |
| outputMethods | [string] | true | The methods which the task can use to produce output. | |
| supportsScoringCode | boolean | true | Whether the task supports Scoring Code. | |
| taskCode | string | true | The unique code which represents the task to be constructed and executed | |
| timeSeriesOnly | boolean | true | Whether the task can only be used with time series projects. | |
| url | any | true | The URL of the documentation of the task. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | AllowExtra | false | Parameters submitted by the user to the failed job |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| validInputs | [string] | true | The supported input types of the task. |
UserBlueprintTaskArgument
{
"properties": {
"argument": {
"description": "The definition of a task argument, used to specify a certain aspect of the task.",
"oneOf": [
{
"properties": {
"default": {
"description": "The default value of the argument.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"name": {
"description": "The name of the argument.",
"type": "string"
},
"recommended": {
"description": "The recommended value, based on frequently used values.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"tunable": {
"description": "Whether the argument is tunable by the end-user.",
"type": "boolean"
},
"type": {
"description": "The type of the argument (e.g. \"int\", \"float\", \"select\", \"intgrid\", \"multi\", etc.)",
"type": "string"
},
"values": {
"description": "The possible values of the argument, which may be a range or list, or dictionary of ranges or lists keyed by type.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
}
},
"required": [
"name",
"type",
"values"
],
"type": "object"
}
]
},
"key": {
"description": "The unique key of the argument",
"type": "string"
}
},
"required": [
"argument",
"key"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| argument | UserBlueprintTaskArgumentDefinition | true | The definition of a task argument, used to specify a certain aspect of the task. | |
| key | string | true | The unique key of the argument |
UserBlueprintTaskArgumentDefinition
{
"properties": {
"default": {
"description": "The default value of the argument.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"name": {
"description": "The name of the argument.",
"type": "string"
},
"recommended": {
"description": "The recommended value, based on frequently used values.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"tunable": {
"description": "Whether the argument is tunable by the end-user.",
"type": "boolean"
},
"type": {
"description": "The type of the argument (e.g. \"int\", \"float\", \"select\", \"intgrid\", \"multi\", etc.)",
"type": "string"
},
"values": {
"description": "The possible values of the argument, which may be a range or list, or dictionary of ranges or lists keyed by type.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
}
},
"required": [
"name",
"type",
"values"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| default | any | false | The default value of the argument. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | number | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [anyOf] | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | number | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | The name of the argument. | |
| recommended | any | false | The recommended value, based on frequently used values. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | number | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [anyOf] | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | number | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| tunable | boolean | false | Whether the argument is tunable by the end-user. | |
| type | string | true | The type of the argument (e.g. "int", "float", "select", "intgrid", "multi", etc.) | |
| values | any | true | The possible values of the argument, which may be a range or list, or dictionary of ranges or lists keyed by type. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | number | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [anyOf] | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | number | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | AllowExtra | false | Parameters submitted by the user to the failed job |
UserBlueprintTaskCategoryItem
{
"properties": {
"name": {
"description": "The name of the category.",
"type": "string"
},
"subcategories": {
"description": "A list of the available task category items.",
"items": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"type": "array"
},
"taskCodes": {
"description": "A list of task codes representing the tasks in this category.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"taskCodes"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | The name of the category. | |
| subcategories | [AllowExtra] | false | A list of the available task category items. | |
| taskCodes | [string] | true | A list of task codes representing the tasks in this category. |
UserBlueprintTaskCustomTaskMetadataWithArguments
{
"properties": {
"id": {
"description": "Id of the custom task version. The ID can be latest_<task_id> which implies to use the latest version of that custom task.",
"type": "string"
},
"label": {
"description": "The name of the custom task version.",
"type": "string"
},
"versionMajor": {
"description": "Major version of the custom task.",
"type": "integer"
},
"versionMinor": {
"description": "Minor version of the custom task.",
"type": "integer"
}
},
"required": [
"id",
"label",
"versionMajor",
"versionMinor"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | Id of the custom task version. The ID can be latest_ |
|
| label | string | true | The name of the custom task version. | |
| versionMajor | integer | true | Major version of the custom task. | |
| versionMinor | integer | true | Minor version of the custom task. |
UserBlueprintTaskLookupEntry
{
"properties": {
"taskCode": {
"description": "The unique code which represents the task to be constructed and executed",
"type": "string"
},
"taskDefinition": {
"description": "A definition of a task in terms of label, arguments, description, and other metadata.",
"oneOf": [
{
"properties": {
"arguments": {
"description": "A list of definitions of each argument which can be set for the task.",
"items": {
"properties": {
"argument": {
"description": "The definition of a task argument, used to specify a certain aspect of the task.",
"oneOf": [
{
"properties": {
"default": {
"description": "The default value of the argument.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"name": {
"description": "The name of the argument.",
"type": "string"
},
"recommended": {
"description": "The recommended value, based on frequently used values.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"tunable": {
"description": "Whether the argument is tunable by the end-user.",
"type": "boolean"
},
"type": {
"description": "The type of the argument (e.g. \"int\", \"float\", \"select\", \"intgrid\", \"multi\", etc.)",
"type": "string"
},
"values": {
"description": "The possible values of the argument, which may be a range or list, or dictionary of ranges or lists keyed by type.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
}
},
"required": [
"name",
"type",
"values"
],
"type": "object"
}
]
},
"key": {
"description": "The unique key of the argument",
"type": "string"
}
},
"required": [
"argument",
"key"
],
"type": "object"
},
"type": "array"
},
"categories": {
"description": "The categories which the task is in.",
"items": {
"type": "string"
},
"type": "array"
},
"colnamesAndTypes": {
"description": "The column names, their types, and their hex representation, available in the specified project for the task.",
"items": {
"properties": {
"colname": {
"description": "The column name.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"type": {
"description": "The data type of the column.",
"type": "string"
}
},
"required": [
"colname",
"hex",
"type"
],
"type": "object"
},
"type": "array"
},
"customTaskId": {
"description": "The id of the custom task, if it is a custom task.",
"type": [
"string",
"null"
]
},
"customTaskVersions": {
"description": "Metadata for all of the custom task's versions.",
"items": {
"properties": {
"id": {
"description": "Id of the custom task version. The ID can be latest_<task_id> which implies to use the latest version of that custom task.",
"type": "string"
},
"label": {
"description": "The name of the custom task version.",
"type": "string"
},
"versionMajor": {
"description": "Major version of the custom task.",
"type": "integer"
},
"versionMinor": {
"description": "Minor version of the custom task.",
"type": "integer"
}
},
"required": [
"id",
"label",
"versionMajor",
"versionMinor"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "A description of the task.",
"type": "string"
},
"icon": {
"description": "The integer representing the id to be displayed when the blueprint is trained.",
"type": "integer"
},
"isCommonTask": {
"default": false,
"description": "Whether the task is a common task.",
"type": "boolean"
},
"isCustomTask": {
"description": "Whether the task is custom code written by the user.",
"type": "boolean"
},
"isVisibleInComposableMl": {
"default": true,
"description": "Whether the task is visible in the ComposableML menu",
"type": "boolean"
},
"label": {
"description": "The generic / default title or label for the task.",
"type": "string"
},
"outputMethods": {
"description": "The methods which the task can use to produce output.",
"items": {
"type": "string"
},
"type": "array"
},
"supportsScoringCode": {
"description": "Whether the task supports Scoring Code.",
"type": "boolean"
},
"taskCode": {
"description": "The unique code which represents the task to be constructed and executed",
"type": "string"
},
"timeSeriesOnly": {
"description": "Whether the task can only be used with time series projects.",
"type": "boolean"
},
"url": {
"description": "The URL of the documentation of the task.",
"oneOf": [
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
{
"type": "string"
}
]
},
"validInputs": {
"description": "The supported input types of the task.",
"items": {
"description": "A specific supported input type.",
"type": "string"
},
"type": "array"
}
},
"required": [
"arguments",
"categories",
"description",
"icon",
"label",
"outputMethods",
"supportsScoringCode",
"taskCode",
"timeSeriesOnly",
"url",
"validInputs"
],
"type": "object"
}
]
}
},
"required": [
"taskCode",
"taskDefinition"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| taskCode | string | true | The unique code which represents the task to be constructed and executed | |
| taskDefinition | UserBlueprintTask | true | A definition of a task in terms of label, arguments, description, and other metadata. |
UserBlueprintTaskParameterValidation
{
"properties": {
"outputMethod": {
"description": "The method representing how the task will output data.",
"enum": [
"P",
"Pm",
"S",
"Sm",
"T",
"TS"
],
"type": "string"
},
"projectId": {
"description": "The projectId representing the project where this user blueprint is edited.",
"type": [
"string",
"null"
]
},
"taskCode": {
"description": "The task code representing the task to validate parameter values.",
"type": "string"
},
"taskParameters": {
"description": "A list of task parameters and proposed values to be validated.",
"items": {
"properties": {
"newValue": {
"description": "The proposed value for the task parameter.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"paramName": {
"description": "The name of the task parameter to be validated.",
"type": "string"
}
},
"required": [
"newValue",
"paramName"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"outputMethod",
"taskCode",
"taskParameters"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| outputMethod | string | true | The method representing how the task will output data. | |
| projectId | string,null | false | The projectId representing the project where this user blueprint is edited. | |
| taskCode | string | true | The task code representing the task to validate parameter values. | |
| taskParameters | [UserBlueprintTaskParameterValidationRequestParamItem] | true | A list of task parameters and proposed values to be validated. |
Enumerated Values¶
| Property | Value |
|---|---|
| outputMethod | [P, Pm, S, Sm, T, TS] |
UserBlueprintTaskParameterValidationRequestParamItem
{
"properties": {
"newValue": {
"description": "The proposed value for the task parameter.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"paramName": {
"description": "The name of the task parameter to be validated.",
"type": "string"
}
},
"required": [
"newValue",
"paramName"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| newValue | any | true | The proposed value for the task parameter. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | number | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [anyOf] | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | number | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| paramName | string | true | The name of the task parameter to be validated. |
UserBlueprintTasksResponse
{
"properties": {
"categories": {
"description": "A list of the available task categories, sub-categories, and tasks.",
"items": {
"properties": {
"name": {
"description": "The name of the category.",
"type": "string"
},
"subcategories": {
"description": "A list of the available task category items.",
"items": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"type": "array"
},
"taskCodes": {
"description": "A list of task codes representing the tasks in this category.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"taskCodes"
],
"type": "object"
},
"type": "array"
},
"tasks": {
"description": "A list of task codes and their task definitions.",
"items": {
"properties": {
"taskCode": {
"description": "The unique code which represents the task to be constructed and executed",
"type": "string"
},
"taskDefinition": {
"description": "A definition of a task in terms of label, arguments, description, and other metadata.",
"oneOf": [
{
"properties": {
"arguments": {
"description": "A list of definitions of each argument which can be set for the task.",
"items": {
"properties": {
"argument": {
"description": "The definition of a task argument, used to specify a certain aspect of the task.",
"oneOf": [
{
"properties": {
"default": {
"description": "The default value of the argument.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"name": {
"description": "The name of the argument.",
"type": "string"
},
"recommended": {
"description": "The recommended value, based on frequently used values.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
},
"tunable": {
"description": "Whether the argument is tunable by the end-user.",
"type": "boolean"
},
"type": {
"description": "The type of the argument (e.g. \"int\", \"float\", \"select\", \"intgrid\", \"multi\", etc.)",
"type": "string"
},
"values": {
"description": "The possible values of the argument, which may be a range or list, or dictionary of ranges or lists keyed by type.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
}
},
"required": [
"name",
"type",
"values"
],
"type": "object"
}
]
},
"key": {
"description": "The unique key of the argument",
"type": "string"
}
},
"required": [
"argument",
"key"
],
"type": "object"
},
"type": "array"
},
"categories": {
"description": "The categories which the task is in.",
"items": {
"type": "string"
},
"type": "array"
},
"colnamesAndTypes": {
"description": "The column names, their types, and their hex representation, available in the specified project for the task.",
"items": {
"properties": {
"colname": {
"description": "The column name.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"type": {
"description": "The data type of the column.",
"type": "string"
}
},
"required": [
"colname",
"hex",
"type"
],
"type": "object"
},
"type": "array"
},
"customTaskId": {
"description": "The id of the custom task, if it is a custom task.",
"type": [
"string",
"null"
]
},
"customTaskVersions": {
"description": "Metadata for all of the custom task's versions.",
"items": {
"properties": {
"id": {
"description": "Id of the custom task version. The ID can be latest_<task_id> which implies to use the latest version of that custom task.",
"type": "string"
},
"label": {
"description": "The name of the custom task version.",
"type": "string"
},
"versionMajor": {
"description": "Major version of the custom task.",
"type": "integer"
},
"versionMinor": {
"description": "Minor version of the custom task.",
"type": "integer"
}
},
"required": [
"id",
"label",
"versionMajor",
"versionMinor"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "A description of the task.",
"type": "string"
},
"icon": {
"description": "The integer representing the id to be displayed when the blueprint is trained.",
"type": "integer"
},
"isCommonTask": {
"default": false,
"description": "Whether the task is a common task.",
"type": "boolean"
},
"isCustomTask": {
"description": "Whether the task is custom code written by the user.",
"type": "boolean"
},
"isVisibleInComposableMl": {
"default": true,
"description": "Whether the task is visible in the ComposableML menu",
"type": "boolean"
},
"label": {
"description": "The generic / default title or label for the task.",
"type": "string"
},
"outputMethods": {
"description": "The methods which the task can use to produce output.",
"items": {
"type": "string"
},
"type": "array"
},
"supportsScoringCode": {
"description": "Whether the task supports Scoring Code.",
"type": "boolean"
},
"taskCode": {
"description": "The unique code which represents the task to be constructed and executed",
"type": "string"
},
"timeSeriesOnly": {
"description": "Whether the task can only be used with time series projects.",
"type": "boolean"
},
"url": {
"description": "The URL of the documentation of the task.",
"oneOf": [
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
{
"type": "string"
}
]
},
"validInputs": {
"description": "The supported input types of the task.",
"items": {
"description": "A specific supported input type.",
"type": "string"
},
"type": "array"
}
},
"required": [
"arguments",
"categories",
"description",
"icon",
"label",
"outputMethods",
"supportsScoringCode",
"taskCode",
"timeSeriesOnly",
"url",
"validInputs"
],
"type": "object"
}
]
}
},
"required": [
"taskCode",
"taskDefinition"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"categories",
"tasks"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| categories | [UserBlueprintTaskCategoryItem] | true | A list of the available task categories, sub-categories, and tasks. | |
| tasks | [UserBlueprintTaskLookupEntry] | true | A list of task codes and their task definitions. |
UserBlueprintUpdate
{
"properties": {
"blueprint": {
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"oneOf": [
{
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"items": {
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
},
"decompressedBlueprint": {
"default": false,
"description": "Whether to retrieve the blueprint in the decompressed format.",
"type": "boolean"
},
"description": {
"description": "The description to give to the blueprint.",
"type": "string"
},
"getDynamicLabels": {
"default": false,
"description": "Whether to add dynamic labels to a decompressed blueprint.",
"type": "boolean"
},
"isInplaceEditor": {
"default": false,
"description": "Whether the request is sent from the in place user BP editor.",
"type": "boolean"
},
"modelType": {
"description": "The title to give to the blueprint.",
"maxLength": 1000,
"type": "string"
},
"projectId": {
"description": "String representation of ObjectId for the currently active project. The user blueprint is created when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.",
"type": [
"string",
"null"
]
},
"saveToCatalog": {
"default": true,
"description": "Whether to save the blueprint to the catalog.",
"type": "boolean"
}
},
"required": [
"decompressedBlueprint",
"isInplaceEditor",
"saveToCatalog"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| blueprint | any | false | The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [UserBlueprintsBlueprintTask] | false | The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator. |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | AllowExtra | false | Parameters submitted by the user to the failed job |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| decompressedBlueprint | boolean | true | Whether to retrieve the blueprint in the decompressed format. | |
| description | string | false | The description to give to the blueprint. | |
| getDynamicLabels | boolean | false | Whether to add dynamic labels to a decompressed blueprint. | |
| isInplaceEditor | boolean | true | Whether the request is sent from the in place user BP editor. | |
| modelType | string | false | maxLength: 1000 |
The title to give to the blueprint. |
| projectId | string,null | false | String representation of ObjectId for the currently active project. The user blueprint is created when this project is active. Necessary in the event of project specific tasks, such as column selection tasks. | |
| saveToCatalog | boolean | true | Whether to save the blueprint to the catalog. |
UserBlueprintValidation
{
"properties": {
"blueprint": {
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"oneOf": [
{
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"items": {
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
},
"isInplaceEditor": {
"default": false,
"description": "Whether the request is sent from the in place user BP editor.",
"type": "boolean"
},
"projectId": {
"description": "String representation of ObjectId for the currently active project. The user blueprint is validated when this project is active. Necessary in the event of project specific tasks, such as column selection tasks.",
"type": [
"string",
"null"
]
}
},
"required": [
"blueprint",
"isInplaceEditor"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| blueprint | any | true | The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [UserBlueprintsBlueprintTask] | false | The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator. |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | AllowExtra | false | Parameters submitted by the user to the failed job |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isInplaceEditor | boolean | true | Whether the request is sent from the in place user BP editor. | |
| projectId | string,null | false | String representation of ObjectId for the currently active project. The user blueprint is validated when this project is active. Necessary in the event of project specific tasks, such as column selection tasks. |
UserBlueprintsBlueprintTask
{
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| taskData | UserBlueprintsBlueprintTaskData | true | The data defining the task / vertex in the blueprint. | |
| taskId | string | true | The identifier of a task / vertex in the blueprint. |
UserBlueprintsBlueprintTaskData
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| inputs | [string] | true | The ids or input data types which will be inputs to the task. | |
| outputMethod | string | true | The method which the task will use to produce output. | |
| outputMethodParameters | [ParamValuePair] | true | The parameters which further define how output will be produced. | |
| taskCode | string,null | true | The unique code representing the python class which will be instantiated and executed. | |
| taskParameters | [ParamValuePair] | true | The parameters which further define the behavior of the task. | |
| xTransformations | [ParamValuePair] | true | Transformations to apply to the input data before fitting or predicting. | |
| yTransformations | [ParamValuePair] | true | Transformations to apply to the input target before fitting or predicting. |
UserBlueprintsBulkDelete
{
"properties": {
"userBlueprintIds": {
"description": "A list of IDs of user blueprints to be deleted.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"required": [
"userBlueprintIds"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| userBlueprintIds | any | true | A list of IDs of user blueprints to be deleted. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | none |
UserBlueprintsBulkDeleteResponse
{
"properties": {
"failedToDelete": {
"description": "List of IDs of User Blueprints which failed to be deleted.",
"items": {
"description": "An ID of a User Blueprint which failed to be deleted.",
"type": "string"
},
"type": "array"
},
"successfullyDeleted": {
"description": "List of IDs of User Blueprints successfully deleted.",
"items": {
"description": "An ID of a User Blueprint successfully deleted.",
"type": "string"
},
"type": "array"
}
},
"required": [
"failedToDelete",
"successfullyDeleted"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| failedToDelete | [string] | true | List of IDs of User Blueprints which failed to be deleted. | |
| successfullyDeleted | [string] | true | List of IDs of User Blueprints successfully deleted. |
UserBlueprintsBulkValidationResponse
{
"properties": {
"data": {
"description": "A list of validation responses with their associated User Blueprint ID.",
"items": {
"properties": {
"userBlueprintId": {
"description": "The unique id associated with the user blueprint.",
"type": "string"
},
"vertexContext": {
"description": "Info about, warnings about, and errors with a specific vertex in the blueprint.",
"items": {
"properties": {
"information": {
"description": "A specification of requirements of the inputs and expectations of the output of the vertex.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
]
},
"messages": {
"description": "Warnings about and errors with a specific vertex in the blueprint.",
"oneOf": [
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"taskId": {
"description": "The id associated with a specific vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"userBlueprintId",
"vertexContext"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [UserBlueprintsBulkValidationResponseItem] | true | A list of validation responses with their associated User Blueprint ID. |
UserBlueprintsBulkValidationResponseItem
{
"properties": {
"userBlueprintId": {
"description": "The unique id associated with the user blueprint.",
"type": "string"
},
"vertexContext": {
"description": "Info about, warnings about, and errors with a specific vertex in the blueprint.",
"items": {
"properties": {
"information": {
"description": "A specification of requirements of the inputs and expectations of the output of the vertex.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
]
},
"messages": {
"description": "Warnings about and errors with a specific vertex in the blueprint.",
"oneOf": [
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"taskId": {
"description": "The id associated with a specific vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"userBlueprintId",
"vertexContext"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| userBlueprintId | string | true | The unique id associated with the user blueprint. | |
| vertexContext | [VertexContextItem] | true | Info about, warnings about, and errors with a specific vertex in the blueprint. |
UserBlueprintsDetailedItem
{
"properties": {
"blender": {
"default": false,
"description": "Whether the blueprint is a blender.",
"type": "boolean"
},
"blueprint": {
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"oneOf": [
{
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"items": {
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
},
"blueprintId": {
"description": "The deterministic id of the blueprint, based on its content.",
"type": "string"
},
"bpData": {
"description": "Additional blueprint metadata used to render the blueprint in the UI",
"oneOf": [
{
"properties": {
"children": {
"description": "A nested dictionary representation of the blueprint DAG.",
"items": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"type": "array"
},
"id": {
"description": "The type of the node (e.g. \"start\", \"input\", \"task\").",
"type": "string"
},
"inputs": {
"description": "The inputs to the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"output": {
"description": "Ids describing the destination of any outgoing edges.",
"oneOf": [
{
"description": "Ids describing the destination of any outgoing edges.",
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 0,
"type": "array"
}
]
},
"taskMap": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"taskParameters": {
"description": "A stringified JSON object describing the parameters and their values for a task.",
"type": "string"
},
"tasks": {
"description": "The task defining the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "A unique id to represent the current node.",
"type": "string"
}
},
"required": [
"id",
"taskMap",
"tasks",
"type"
],
"type": "object"
}
]
},
"customTaskVersionMetadata": {
"description": "An association of custom entity ids and task ids.",
"items": {
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"decompressedFormat": {
"default": false,
"description": "Whether the blueprint is in the decompressed format.",
"type": "boolean"
},
"diagram": {
"description": "The diagram used by the UI to display the blueprint.",
"type": "string"
},
"features": {
"description": "A list of the names of tasks used in the blueprint.",
"items": {
"type": "string"
},
"type": "array"
},
"featuresText": {
"description": "A description of the blueprint via the names of tasks used.",
"type": "string"
},
"hexColumnNameLookup": {
"description": "A lookup between hex values and data column names used in the blueprint.",
"items": {
"properties": {
"colname": {
"description": "The name of the column.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"projectId": {
"description": "The id of the project from which the column name originates.",
"type": "string"
}
},
"required": [
"colname",
"hex"
],
"type": "object"
},
"type": "array"
},
"hiddenFromCatalog": {
"description": "If true, the blueprint will not show up in the catalog",
"type": "boolean"
},
"icons": {
"description": "The icon(s) associated with the blueprint.",
"items": {
"type": "integer"
},
"type": "array"
},
"insights": {
"description": "An indication of the insights generated by the blueprint.",
"type": "string"
},
"isTimeSeries": {
"default": false,
"description": "Whether the blueprint contains time-series tasks.",
"type": "boolean"
},
"linkedToProjectId": {
"description": "Whether the user blueprint is linked to a project.",
"type": "boolean"
},
"modelType": {
"description": "The generated or provided title of the blueprint.",
"type": "string"
},
"projectId": {
"description": "The id of the project the blueprint was originally created with, if applicable.",
"type": [
"string",
"null"
]
},
"referenceModel": {
"default": false,
"description": "Whether the blueprint is a reference model.",
"type": "boolean"
},
"shapSupport": {
"default": false,
"description": "Whether the blueprint supports shapley additive explanations.",
"type": "boolean"
},
"supportedTargetTypes": {
"description": "The list of supported targets of the current blueprint.",
"items": {
"enum": [
"binary",
"multiclass",
"multilabel",
"nonnegative",
"regression",
"unsupervised",
"unsupervisedClustering"
],
"type": "string"
},
"type": "array"
},
"supportsGpu": {
"default": false,
"description": "Whether the blueprint supports execution on the GPU.",
"type": "boolean"
},
"supportsNewSeries": {
"description": "Whether the blueprint supports new series.",
"type": "boolean"
},
"userBlueprintId": {
"description": "The unique id associated with the user blueprint.",
"type": "string"
},
"userId": {
"description": "The id of the user who owns the blueprint.",
"type": "string"
},
"vertexContext": {
"description": "Info about, warnings about, and errors with a specific vertex in the blueprint.",
"items": {
"properties": {
"information": {
"description": "A specification of requirements of the inputs and expectations of the output of the vertex.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
]
},
"messages": {
"description": "Warnings about and errors with a specific vertex in the blueprint.",
"oneOf": [
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"taskId": {
"description": "The id associated with a specific vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"blender",
"blueprint",
"blueprintId",
"bpData",
"decompressedFormat",
"diagram",
"features",
"featuresText",
"icons",
"insights",
"isTimeSeries",
"modelType",
"referenceModel",
"shapSupport",
"supportedTargetTypes",
"supportsGpu",
"userBlueprintId",
"userId",
"vertexContext"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| blender | boolean | true | Whether the blueprint is a blender. | |
| blueprint | any | true | The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [UserBlueprintsBlueprintTask] | false | The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator. |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | AllowExtra | false | Parameters submitted by the user to the failed job |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| blueprintId | string | true | The deterministic id of the blueprint, based on its content. | |
| bpData | BpData | true | Additional blueprint metadata used to render the blueprint in the UI | |
| customTaskVersionMetadata | [array] | false | An association of custom entity ids and task ids. | |
| decompressedFormat | boolean | true | Whether the blueprint is in the decompressed format. | |
| diagram | string | true | The diagram used by the UI to display the blueprint. | |
| features | [string] | true | A list of the names of tasks used in the blueprint. | |
| featuresText | string | true | A description of the blueprint via the names of tasks used. | |
| hexColumnNameLookup | [UserBlueprintsHexColumnNameLookupEntry] | false | A lookup between hex values and data column names used in the blueprint. | |
| hiddenFromCatalog | boolean | false | If true, the blueprint will not show up in the catalog | |
| icons | [integer] | true | The icon(s) associated with the blueprint. | |
| insights | string | true | An indication of the insights generated by the blueprint. | |
| isTimeSeries | boolean | true | Whether the blueprint contains time-series tasks. | |
| linkedToProjectId | boolean | false | Whether the user blueprint is linked to a project. | |
| modelType | string | true | The generated or provided title of the blueprint. | |
| projectId | string,null | false | The id of the project the blueprint was originally created with, if applicable. | |
| referenceModel | boolean | true | Whether the blueprint is a reference model. | |
| shapSupport | boolean | true | Whether the blueprint supports shapley additive explanations. | |
| supportedTargetTypes | [string] | true | The list of supported targets of the current blueprint. | |
| supportsGpu | boolean | true | Whether the blueprint supports execution on the GPU. | |
| supportsNewSeries | boolean | false | Whether the blueprint supports new series. | |
| userBlueprintId | string | true | The unique id associated with the user blueprint. | |
| userId | string | true | The id of the user who owns the blueprint. | |
| vertexContext | [VertexContextItem] | true | Info about, warnings about, and errors with a specific vertex in the blueprint. |
UserBlueprintsHexColumnNameLookupEntry
{
"properties": {
"colname": {
"description": "The name of the column.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"projectId": {
"description": "The id of the project from which the column name originates.",
"type": "string"
}
},
"required": [
"colname",
"hex"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| colname | string | true | The name of the column. | |
| hex | string | true | A safe hex representation of the column name. | |
| projectId | string | false | The id of the project from which the column name originates. |
UserBlueprintsInputType
{
"properties": {
"name": {
"description": "The human-readable name of an input type.",
"type": "string"
},
"type": {
"description": "The unique identifier of an input type.",
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | The human-readable name of an input type. | |
| type | string | true | The unique identifier of an input type. |
UserBlueprintsInputTypesResponse
{
"properties": {
"inputTypes": {
"description": "A list of associated pairs of an input types and their human-readable names.",
"items": {
"properties": {
"name": {
"description": "The human-readable name of an input type.",
"type": "string"
},
"type": {
"description": "The unique identifier of an input type.",
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputTypes"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| inputTypes | [UserBlueprintsInputType] | true | A list of associated pairs of an input types and their human-readable names. |
UserBlueprintsListItem
{
"properties": {
"blender": {
"default": false,
"description": "Whether the blueprint is a blender.",
"type": "boolean"
},
"blueprintId": {
"description": "The deterministic id of the blueprint, based on its content.",
"type": "string"
},
"customTaskVersionMetadata": {
"description": "An association of custom entity ids and task ids.",
"items": {
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"decompressedFormat": {
"default": false,
"description": "Whether the blueprint is in the decompressed format.",
"type": "boolean"
},
"diagram": {
"description": "The diagram used by the UI to display the blueprint.",
"type": "string"
},
"features": {
"description": "A list of the names of tasks used in the blueprint.",
"items": {
"type": "string"
},
"type": "array"
},
"featuresText": {
"description": "A description of the blueprint via the names of tasks used.",
"type": "string"
},
"hexColumnNameLookup": {
"description": "A lookup between hex values and data column names used in the blueprint.",
"items": {
"properties": {
"colname": {
"description": "The name of the column.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"projectId": {
"description": "The id of the project from which the column name originates.",
"type": "string"
}
},
"required": [
"colname",
"hex"
],
"type": "object"
},
"type": "array"
},
"hiddenFromCatalog": {
"description": "If true, the blueprint will not show up in the catalog",
"type": "boolean"
},
"icons": {
"description": "The icon(s) associated with the blueprint.",
"items": {
"type": "integer"
},
"type": "array"
},
"insights": {
"description": "An indication of the insights generated by the blueprint.",
"type": "string"
},
"isTimeSeries": {
"default": false,
"description": "Whether the blueprint contains time-series tasks.",
"type": "boolean"
},
"linkedToProjectId": {
"description": "Whether the user blueprint is linked to a project.",
"type": "boolean"
},
"modelType": {
"description": "The generated or provided title of the blueprint.",
"type": "string"
},
"projectId": {
"description": "The id of the project the blueprint was originally created with, if applicable.",
"type": [
"string",
"null"
]
},
"referenceModel": {
"default": false,
"description": "Whether the blueprint is a reference model.",
"type": "boolean"
},
"shapSupport": {
"default": false,
"description": "Whether the blueprint supports shapley additive explanations.",
"type": "boolean"
},
"supportedTargetTypes": {
"description": "The list of supported targets of the current blueprint.",
"items": {
"enum": [
"binary",
"multiclass",
"multilabel",
"nonnegative",
"regression",
"unsupervised",
"unsupervisedClustering"
],
"type": "string"
},
"type": "array"
},
"supportsGpu": {
"default": false,
"description": "Whether the blueprint supports execution on the GPU.",
"type": "boolean"
},
"supportsNewSeries": {
"description": "Whether the blueprint supports new series.",
"type": "boolean"
},
"userBlueprintId": {
"description": "The unique id associated with the user blueprint.",
"type": "string"
},
"userId": {
"description": "The id of the user who owns the blueprint.",
"type": "string"
}
},
"required": [
"blender",
"blueprintId",
"decompressedFormat",
"diagram",
"features",
"featuresText",
"icons",
"insights",
"isTimeSeries",
"modelType",
"referenceModel",
"shapSupport",
"supportedTargetTypes",
"supportsGpu",
"userBlueprintId",
"userId"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| blender | boolean | true | Whether the blueprint is a blender. | |
| blueprintId | string | true | The deterministic id of the blueprint, based on its content. | |
| customTaskVersionMetadata | [array] | false | An association of custom entity ids and task ids. | |
| decompressedFormat | boolean | true | Whether the blueprint is in the decompressed format. | |
| diagram | string | true | The diagram used by the UI to display the blueprint. | |
| features | [string] | true | A list of the names of tasks used in the blueprint. | |
| featuresText | string | true | A description of the blueprint via the names of tasks used. | |
| hexColumnNameLookup | [UserBlueprintsHexColumnNameLookupEntry] | false | A lookup between hex values and data column names used in the blueprint. | |
| hiddenFromCatalog | boolean | false | If true, the blueprint will not show up in the catalog | |
| icons | [integer] | true | The icon(s) associated with the blueprint. | |
| insights | string | true | An indication of the insights generated by the blueprint. | |
| isTimeSeries | boolean | true | Whether the blueprint contains time-series tasks. | |
| linkedToProjectId | boolean | false | Whether the user blueprint is linked to a project. | |
| modelType | string | true | The generated or provided title of the blueprint. | |
| projectId | string,null | false | The id of the project the blueprint was originally created with, if applicable. | |
| referenceModel | boolean | true | Whether the blueprint is a reference model. | |
| shapSupport | boolean | true | Whether the blueprint supports shapley additive explanations. | |
| supportedTargetTypes | [string] | true | The list of supported targets of the current blueprint. | |
| supportsGpu | boolean | true | Whether the blueprint supports execution on the GPU. | |
| supportsNewSeries | boolean | false | Whether the blueprint supports new series. | |
| userBlueprintId | string | true | The unique id associated with the user blueprint. | |
| userId | string | true | The id of the user who owns the blueprint. |
UserBlueprintsListResponse
{
"properties": {
"count": {
"description": "Number of records on this page",
"type": "integer"
},
"data": {
"description": "List of user blueprints",
"items": {
"properties": {
"blender": {
"default": false,
"description": "Whether the blueprint is a blender.",
"type": "boolean"
},
"blueprintId": {
"description": "The deterministic id of the blueprint, based on its content.",
"type": "string"
},
"customTaskVersionMetadata": {
"description": "An association of custom entity ids and task ids.",
"items": {
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"decompressedFormat": {
"default": false,
"description": "Whether the blueprint is in the decompressed format.",
"type": "boolean"
},
"diagram": {
"description": "The diagram used by the UI to display the blueprint.",
"type": "string"
},
"features": {
"description": "A list of the names of tasks used in the blueprint.",
"items": {
"type": "string"
},
"type": "array"
},
"featuresText": {
"description": "A description of the blueprint via the names of tasks used.",
"type": "string"
},
"hexColumnNameLookup": {
"description": "A lookup between hex values and data column names used in the blueprint.",
"items": {
"properties": {
"colname": {
"description": "The name of the column.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"projectId": {
"description": "The id of the project from which the column name originates.",
"type": "string"
}
},
"required": [
"colname",
"hex"
],
"type": "object"
},
"type": "array"
},
"hiddenFromCatalog": {
"description": "If true, the blueprint will not show up in the catalog",
"type": "boolean"
},
"icons": {
"description": "The icon(s) associated with the blueprint.",
"items": {
"type": "integer"
},
"type": "array"
},
"insights": {
"description": "An indication of the insights generated by the blueprint.",
"type": "string"
},
"isTimeSeries": {
"default": false,
"description": "Whether the blueprint contains time-series tasks.",
"type": "boolean"
},
"linkedToProjectId": {
"description": "Whether the user blueprint is linked to a project.",
"type": "boolean"
},
"modelType": {
"description": "The generated or provided title of the blueprint.",
"type": "string"
},
"projectId": {
"description": "The id of the project the blueprint was originally created with, if applicable.",
"type": [
"string",
"null"
]
},
"referenceModel": {
"default": false,
"description": "Whether the blueprint is a reference model.",
"type": "boolean"
},
"shapSupport": {
"default": false,
"description": "Whether the blueprint supports shapley additive explanations.",
"type": "boolean"
},
"supportedTargetTypes": {
"description": "The list of supported targets of the current blueprint.",
"items": {
"enum": [
"binary",
"multiclass",
"multilabel",
"nonnegative",
"regression",
"unsupervised",
"unsupervisedClustering"
],
"type": "string"
},
"type": "array"
},
"supportsGpu": {
"default": false,
"description": "Whether the blueprint supports execution on the GPU.",
"type": "boolean"
},
"supportsNewSeries": {
"description": "Whether the blueprint supports new series.",
"type": "boolean"
},
"userBlueprintId": {
"description": "The unique id associated with the user blueprint.",
"type": "string"
},
"userId": {
"description": "The id of the user who owns the blueprint.",
"type": "string"
}
},
"required": [
"blender",
"blueprintId",
"decompressedFormat",
"diagram",
"features",
"featuresText",
"icons",
"insights",
"isTimeSeries",
"modelType",
"referenceModel",
"shapSupport",
"supportedTargetTypes",
"supportsGpu",
"userBlueprintId",
"userId"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "URL to the next page, or `null` if there is no such page",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL to the previous page, or `null` if there is no such page",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "Total number of records",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | true | Number of records on this page | |
| data | [UserBlueprintsListItem] | true | maxItems: 100 |
List of user blueprints |
| next | string,null | true | URL to the next page, or null if there is no such page |
|
| previous | string,null | true | URL to the previous page, or null if there is no such page |
|
| totalCount | integer | false | Total number of records |
UserBlueprintsRetrieveResponse
{
"properties": {
"blender": {
"default": false,
"description": "Whether the blueprint is a blender.",
"type": "boolean"
},
"blueprint": {
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"oneOf": [
{
"description": "The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator.",
"items": {
"properties": {
"taskData": {
"description": "The data defining the task / vertex in the blueprint.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "The ids or input data types which will be inputs to the task.",
"items": {
"description": "A specific input data type",
"type": "string"
},
"type": "array"
},
"outputMethod": {
"description": "The method which the task will use to produce output.",
"type": "string"
},
"outputMethodParameters": {
"default": [],
"description": "The parameters which further define how output will be produced.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"taskCode": {
"description": "The unique code representing the python class which will be instantiated and executed.",
"type": [
"string",
"null"
]
},
"taskParameters": {
"default": [],
"description": "The parameters which further define the behavior of the task.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"xTransformations": {
"default": [],
"description": "Transformations to apply to the input data before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
},
"yTransformations": {
"default": [],
"description": "Transformations to apply to the input target before fitting or predicting.",
"items": {
"properties": {
"param": {
"description": "The name of a field associated with the value.",
"type": "string"
},
"value": {
"description": "Any value.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"inputs",
"outputMethod",
"outputMethodParameters",
"taskCode",
"taskParameters",
"xTransformations",
"yTransformations"
],
"type": "object"
}
]
},
"taskId": {
"description": "The identifier of a task / vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskData",
"taskId"
],
"type": "object"
},
"type": "array"
},
{
"description": "Parameters submitted by the user to the failed job",
"type": "object"
}
]
},
"blueprintId": {
"description": "The deterministic id of the blueprint, based on its content.",
"type": "string"
},
"bpData": {
"description": "Additional blueprint metadata used to render the blueprint in the UI",
"oneOf": [
{
"properties": {
"children": {
"description": "A nested dictionary representation of the blueprint DAG.",
"items": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"type": "array"
},
"id": {
"description": "The type of the node (e.g. \"start\", \"input\", \"task\").",
"type": "string"
},
"inputs": {
"description": "The inputs to the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"output": {
"description": "Ids describing the destination of any outgoing edges.",
"oneOf": [
{
"description": "Ids describing the destination of any outgoing edges.",
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 0,
"type": "array"
}
]
},
"taskMap": {
"description": "Parameters submitted by the user to the failed job",
"type": "object"
},
"taskParameters": {
"description": "A stringified JSON object describing the parameters and their values for a task.",
"type": "string"
},
"tasks": {
"description": "The task defining the current node.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "A unique id to represent the current node.",
"type": "string"
}
},
"required": [
"id",
"taskMap",
"tasks",
"type"
],
"type": "object"
}
]
},
"customTaskVersionMetadata": {
"description": "An association of custom entity ids and task ids.",
"items": {
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"decompressedFormat": {
"default": false,
"description": "Whether the blueprint is in the decompressed format.",
"type": "boolean"
},
"diagram": {
"description": "The diagram used by the UI to display the blueprint.",
"type": "string"
},
"features": {
"description": "A list of the names of tasks used in the blueprint.",
"items": {
"type": "string"
},
"type": "array"
},
"featuresText": {
"description": "A description of the blueprint via the names of tasks used.",
"type": "string"
},
"hexColumnNameLookup": {
"description": "A lookup between hex values and data column names used in the blueprint.",
"items": {
"properties": {
"colname": {
"description": "The name of the column.",
"type": "string"
},
"hex": {
"description": "A safe hex representation of the column name.",
"type": "string"
},
"projectId": {
"description": "The id of the project from which the column name originates.",
"type": "string"
}
},
"required": [
"colname",
"hex"
],
"type": "object"
},
"type": "array"
},
"hiddenFromCatalog": {
"description": "If true, the blueprint will not show up in the catalog",
"type": "boolean"
},
"icons": {
"description": "The icon(s) associated with the blueprint.",
"items": {
"type": "integer"
},
"type": "array"
},
"insights": {
"description": "An indication of the insights generated by the blueprint.",
"type": "string"
},
"isTimeSeries": {
"default": false,
"description": "Whether the blueprint contains time-series tasks.",
"type": "boolean"
},
"linkedToProjectId": {
"description": "Whether the user blueprint is linked to a project.",
"type": "boolean"
},
"modelType": {
"description": "The generated or provided title of the blueprint.",
"type": "string"
},
"projectId": {
"description": "The id of the project the blueprint was originally created with, if applicable.",
"type": [
"string",
"null"
]
},
"referenceModel": {
"default": false,
"description": "Whether the blueprint is a reference model.",
"type": "boolean"
},
"shapSupport": {
"default": false,
"description": "Whether the blueprint supports shapley additive explanations.",
"type": "boolean"
},
"supportedTargetTypes": {
"description": "The list of supported targets of the current blueprint.",
"items": {
"enum": [
"binary",
"multiclass",
"multilabel",
"nonnegative",
"regression",
"unsupervised",
"unsupervisedClustering"
],
"type": "string"
},
"type": "array"
},
"supportsGpu": {
"default": false,
"description": "Whether the blueprint supports execution on the GPU.",
"type": "boolean"
},
"supportsNewSeries": {
"description": "Whether the blueprint supports new series.",
"type": "boolean"
},
"userBlueprintId": {
"description": "The unique id associated with the user blueprint.",
"type": "string"
},
"userId": {
"description": "The id of the user who owns the blueprint.",
"type": "string"
},
"vertexContext": {
"description": "Info about, warnings about, and errors with a specific vertex in the blueprint.",
"items": {
"properties": {
"information": {
"description": "A specification of requirements of the inputs and expectations of the output of the vertex.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
]
},
"messages": {
"description": "Warnings about and errors with a specific vertex in the blueprint.",
"oneOf": [
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"taskId": {
"description": "The id associated with a specific vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"blender",
"blueprintId",
"decompressedFormat",
"diagram",
"features",
"featuresText",
"icons",
"insights",
"isTimeSeries",
"modelType",
"referenceModel",
"shapSupport",
"supportedTargetTypes",
"supportsGpu",
"userBlueprintId",
"userId"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| blender | boolean | true | Whether the blueprint is a blender. | |
| blueprint | any | false | The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [UserBlueprintsBlueprintTask] | false | The representation of a directed acyclic graph defining a pipeline of data through tasks and a final estimator. |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | AllowExtra | false | Parameters submitted by the user to the failed job |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| blueprintId | string | true | The deterministic id of the blueprint, based on its content. | |
| bpData | BpData | false | Additional blueprint metadata used to render the blueprint in the UI | |
| customTaskVersionMetadata | [array] | false | An association of custom entity ids and task ids. | |
| decompressedFormat | boolean | true | Whether the blueprint is in the decompressed format. | |
| diagram | string | true | The diagram used by the UI to display the blueprint. | |
| features | [string] | true | A list of the names of tasks used in the blueprint. | |
| featuresText | string | true | A description of the blueprint via the names of tasks used. | |
| hexColumnNameLookup | [UserBlueprintsHexColumnNameLookupEntry] | false | A lookup between hex values and data column names used in the blueprint. | |
| hiddenFromCatalog | boolean | false | If true, the blueprint will not show up in the catalog | |
| icons | [integer] | true | The icon(s) associated with the blueprint. | |
| insights | string | true | An indication of the insights generated by the blueprint. | |
| isTimeSeries | boolean | true | Whether the blueprint contains time-series tasks. | |
| linkedToProjectId | boolean | false | Whether the user blueprint is linked to a project. | |
| modelType | string | true | The generated or provided title of the blueprint. | |
| projectId | string,null | false | The id of the project the blueprint was originally created with, if applicable. | |
| referenceModel | boolean | true | Whether the blueprint is a reference model. | |
| shapSupport | boolean | true | Whether the blueprint supports shapley additive explanations. | |
| supportedTargetTypes | [string] | true | The list of supported targets of the current blueprint. | |
| supportsGpu | boolean | true | Whether the blueprint supports execution on the GPU. | |
| supportsNewSeries | boolean | false | Whether the blueprint supports new series. | |
| userBlueprintId | string | true | The unique id associated with the user blueprint. | |
| userId | string | true | The id of the user who owns the blueprint. | |
| vertexContext | [VertexContextItem] | false | Info about, warnings about, and errors with a specific vertex in the blueprint. |
UserBlueprintsValidateTaskParameter
{
"properties": {
"message": {
"description": "The description of the issue with the proposed task parameter value.",
"type": "string"
},
"paramName": {
"description": "The name of the validated task parameter.",
"type": "string"
},
"value": {
"description": "The invalid value proposed for the validated task parameter.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"message",
"paramName",
"value"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| message | string | true | The description of the issue with the proposed task parameter value. | |
| paramName | string | true | The name of the validated task parameter. | |
| value | any | true | The invalid value proposed for the validated task parameter. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | number | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [anyOf] | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | number | false | none |
UserBlueprintsValidateTaskParametersResponse
{
"properties": {
"errors": {
"description": "A list of the task parameters, their proposed values, and messages describing why each is not valid.",
"items": {
"properties": {
"message": {
"description": "The description of the issue with the proposed task parameter value.",
"type": "string"
},
"paramName": {
"description": "The name of the validated task parameter.",
"type": "string"
},
"value": {
"description": "The invalid value proposed for the validated task parameter.",
"oneOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
},
"type": "array"
}
]
}
},
"required": [
"message",
"paramName",
"value"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"errors"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| errors | [UserBlueprintsValidateTaskParameter] | true | A list of the task parameters, their proposed values, and messages describing why each is not valid. |
UserBlueprintsValidationResponse
{
"properties": {
"vertexContext": {
"description": "Info about, warnings about, and errors with a specific vertex in the blueprint.",
"items": {
"properties": {
"information": {
"description": "A specification of requirements of the inputs and expectations of the output of the vertex.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
]
},
"messages": {
"description": "Warnings about and errors with a specific vertex in the blueprint.",
"oneOf": [
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"taskId": {
"description": "The id associated with a specific vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"vertexContext"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| vertexContext | [VertexContextItem] | true | Info about, warnings about, and errors with a specific vertex in the blueprint. |
UserRoleWithGrant
{
"properties": {
"canShare": {
"default": true,
"description": "Whether the org/group/user should be able to share with others.If true, the org/group/user will be able to grant any role up to and includingtheir own to other orgs/groups/user. If `role` is `NO_ROLE` `canShare` is ignored.",
"type": "boolean"
},
"role": {
"description": "The role to set on the entity. When it is None, the role of this user will be removedfrom this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of the user to update the access role for.",
"type": "string"
}
},
"required": [
"role",
"username"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| canShare | boolean | false | Whether the org/group/user should be able to share with others.If true, the org/group/user will be able to grant any role up to and includingtheir own to other orgs/groups/user. If role is NO_ROLE canShare is ignored. |
|
| role | string,null | true | The role to set on the entity. When it is None, the role of this user will be removedfrom this entity. | |
| username | string | true | Username of the user to update the access role for. |
Enumerated Values¶
| Property | Value |
|---|---|
| role | [ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER] |
VertexContextItem
{
"properties": {
"information": {
"description": "A specification of requirements of the inputs and expectations of the output of the vertex.",
"oneOf": [
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
]
},
"messages": {
"description": "Warnings about and errors with a specific vertex in the blueprint.",
"oneOf": [
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"taskId": {
"description": "The id associated with a specific vertex in the blueprint.",
"type": "string"
}
},
"required": [
"taskId"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| information | VertexContextItemInfo | false | A specification of requirements of the inputs and expectations of the output of the vertex. | |
| messages | VertexContextItemMessages | false | Warnings about and errors with a specific vertex in the blueprint. | |
| taskId | string | true | The id associated with a specific vertex in the blueprint. |
VertexContextItemInfo
{
"properties": {
"inputs": {
"description": "A specification of requirements of the inputs of the vertex.",
"items": {
"type": "string"
},
"type": "array"
},
"outputs": {
"description": "A specification of expectations of the output of the vertex.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inputs",
"outputs"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| inputs | [string] | true | A specification of requirements of the inputs of the vertex. | |
| outputs | [string] | true | A specification of expectations of the output of the vertex. |
VertexContextItemMessages
{
"properties": {
"errors": {
"description": "Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| errors | [string] | false | Errors with a specific vertex in the blueprint. Execution of the vertex is expected to fail. | |
| warnings | [string] | false | Warnings about a specific vertex in the blueprint. Execution of the vertex may fail or behave unexpectedly. |
WorkspaceItemResponse
{
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| commitSha | string,null | false | SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories). | |
| created | string | true | ISO-8601 timestamp of when the file item was created. | |
| fileName | string | true | Name of the file item. | |
| filePath | string | true | Path of the file item. | |
| fileSource | string | true | Source of the file item. | |
| id | string | true | ID of the file item. | |
| ref | string,null | false | Remote reference (branch, commit, tag). Branch "master", if not specified. | |
| repositoryFilePath | string,null | false | Full path to the file in the remote repository. | |
| repositoryLocation | string,null | false | URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name). | |
| repositoryName | string,null | false | Name of the repository from which the file was pulled. |