After signing in, you can create credentials that can be used to call the Platform APIs.
Download OpenAPI specification:Download
Sensei Machine Learning API provides a mechanism for data scientists to organize and manage ML services from algorithm onboarding through experimentation and to service deployment.
Related documentation:
Visualize API calls with Postman (a free, third-party software):
API paths:
Required headers:
Authorization
, x-gw-ims-org-id
, and x-api-key
. For more information on how to obtain these values, see the authentication tutorial.x-sandbox-name
whose value is the all-lowercase name of the sandbox the operation will take place in (for example, "prod"). See the sandboxes overview for more information.Content-Type
with a value of application/json
.API error handling:
Engines act as an umbrella entity holding all machine learning instances. This is tied to a Docker image, Java archive, or EGG file which contains machine learning logic to train and score a Model.
Lists all engines providing mechanisms for pagination, filtering, and sorting.
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "children": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "documentationUrl": "string",
- "type": "string",
- "iconUrl": "string",
- "gitRepo": "string",
- "algorithm": "string",
- "language": [
- "Python"
], - "mlLibrary": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
], - "_page": {
- "orderby": "string",
- "property": "string",
- "start": "string",
- "totalCount": 0,
- "count": 0,
- "next": "string"
}, - "_links": {
- "next": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "page": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createEngine": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
Creates a new Engine
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Unsupported media type
Unprocessable entity
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "id": "string",
- "name": "string",
- "description": "string",
- "documentationUrl": "string",
- "type": "string",
- "iconUrl": "string",
- "gitRepo": "string",
- "algorithm": "string",
- "language": [
- "Python"
], - "mlLibrary": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getEngine": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "listMLInstances": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "artifacts": {
- "default": {
- "image": {
- "location": "string",
- "reference": {
- "artifactId": "string",
- "version": "string"
}, - "name": "string",
- "executionType": "string",
- "packagingType": "docker",
- "metadata": {
- "property1": { },
- "property2": { }
}
}, - "defaultMLInstanceConfigs": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "downloadRequired": null,
- "refInput": { },
- "metadata": { }
}
], - "outputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "uploadRequired": null,
- "generatedURI": null,
- "metadata": { }
}
]
}
}
]
}, - "overrides": [
- {
- "id": "string",
- "name": "string",
- "artifact": {
- "location": "string",
- "reference": {
- "artifactId": "string",
- "version": "string"
}, - "name": "string",
- "executionType": "string",
- "packagingType": "docker",
- "metadata": {
- "property1": { },
- "property2": { }
}
}, - "defaultMLInstanceConfigs": {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "downloadRequired": null,
- "refInput": { },
- "metadata": { }
}
], - "outputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "uploadRequired": null,
- "generatedURI": null,
- "metadata": { }
}
]
}
}
}
]
}, - "tags": {
- "property1": "string",
- "property2": "string"
}
}
Get Docker registry information
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "host": "string",
- "username": "string",
- "password": "string"
}
Retrieves a specific Engine
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "id": "string",
- "name": "string",
- "description": "string",
- "documentationUrl": "string",
- "type": "string",
- "iconUrl": "string",
- "gitRepo": "string",
- "algorithm": "string",
- "language": [
- "Python"
], - "mlLibrary": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getEngine": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "listMLInstances": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "artifacts": {
- "default": {
- "image": {
- "location": "string",
- "reference": {
- "artifactId": "string",
- "version": "string"
}, - "name": "string",
- "executionType": "string",
- "packagingType": "docker",
- "metadata": {
- "property1": { },
- "property2": { }
}
}, - "defaultMLInstanceConfigs": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "downloadRequired": null,
- "refInput": { },
- "metadata": { }
}
], - "outputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "uploadRequired": null,
- "generatedURI": null,
- "metadata": { }
}
]
}
}
]
}, - "overrides": [
- {
- "id": "string",
- "name": "string",
- "artifact": {
- "location": "string",
- "reference": {
- "artifactId": "string",
- "version": "string"
}, - "name": "string",
- "executionType": "string",
- "packagingType": "docker",
- "metadata": {
- "property1": { },
- "property2": { }
}
}, - "defaultMLInstanceConfigs": {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "downloadRequired": null,
- "refInput": { },
- "metadata": { }
}
], - "outputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "uploadRequired": null,
- "generatedURI": null,
- "metadata": { }
}
]
}
}
}
]
}, - "tags": {
- "property1": "string",
- "property2": "string"
}
}
Updates a specific Engine
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
If-Match | string Optional header field with ETag value provided by client |
Content-Type required | string application/vnd.adobe.platform.sensei+json;profile=engine.v1.json |
Engine object to be updated
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "name": "string",
- "description": "string",
- "documentationUrl": "string",
- "type": "string",
- "iconUrl": "string",
- "gitRepo": "string",
- "algorithm": "string",
- "language": [
- "Python"
], - "mlLibrary": "string",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getEngine": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "listMLInstances": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "artifacts": {
- "default": {
- "image": {
- "location": "string",
- "reference": {
- "artifactId": "string",
- "version": "string"
}, - "name": "string",
- "executionType": "string",
- "packagingType": "docker"
}, - "defaultMLInstanceConfigs": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "downloadRequired": null,
- "refInput": { },
- "metadata": { }
}
], - "outputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "uploadRequired": null,
- "generatedURI": null,
- "metadata": { }
}
]
}
}
]
}, - "overrides": [
- {
- "id": "string",
- "name": "string",
- "artifact": {
- "location": "string",
- "reference": {
- "artifactId": "string",
- "version": "string"
}, - "name": "string",
- "executionType": "string",
- "packagingType": "docker"
}, - "defaultMLInstanceConfigs": {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "downloadRequired": null,
- "refInput": { },
- "metadata": { }
}
], - "outputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "uploadRequired": null,
- "generatedURI": null,
- "metadata": { }
}
]
}
}
}
]
}, - "tags": {
- "property1": "string",
- "property2": "string"
}
}
{- "id": "string",
- "name": "string",
- "description": "string",
- "documentationUrl": "string",
- "type": "string",
- "iconUrl": "string",
- "gitRepo": "string",
- "algorithm": "string",
- "language": [
- "Python"
], - "mlLibrary": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getEngine": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "listMLInstances": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "artifacts": {
- "default": {
- "image": {
- "location": "string",
- "reference": {
- "artifactId": "string",
- "version": "string"
}, - "name": "string",
- "executionType": "string",
- "packagingType": "docker",
- "metadata": {
- "property1": { },
- "property2": { }
}
}, - "defaultMLInstanceConfigs": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "downloadRequired": null,
- "refInput": { },
- "metadata": { }
}
], - "outputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "uploadRequired": null,
- "generatedURI": null,
- "metadata": { }
}
]
}
}
]
}, - "overrides": [
- {
- "id": "string",
- "name": "string",
- "artifact": {
- "location": "string",
- "reference": {
- "artifactId": "string",
- "version": "string"
}, - "name": "string",
- "executionType": "string",
- "packagingType": "docker",
- "metadata": {
- "property1": { },
- "property2": { }
}
}, - "defaultMLInstanceConfigs": {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "downloadRequired": null,
- "refInput": { },
- "metadata": { }
}
], - "outputs": [
- {
- "name": null,
- "id": null,
- "diskSizeInGB": null,
- "resType": null,
- "uploadRequired": null,
- "generatedURI": null,
- "metadata": { }
}
]
}
}
}
]
}, - "tags": {
- "property1": "string",
- "property2": "string"
}
}
Deletes a specific Engine
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "title": "Illegal Argument",
- "status": 400,
- "detail": "Model specification name must not be empty",
- "additionalDetails": {
- "property1": "string",
- "property2": "string"
}
}
MLInstances represent the combination of a specific Engine with particular set of configurations. An instance is often use-case specific for a customer or client.
MLInstances may be searched by name or tags.
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "children": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "engineId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
], - "_page": {
- "orderby": "string",
- "property": "string",
- "start": "string",
- "totalCount": 0,
- "count": 0,
- "next": "string"
}, - "_links": {
- "next": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "page": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
Creates a new MLInstance of an Engine
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Content-Type required | string application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json |
MLInstance object that needs to be added. Note that a valid engineId
has to be listed in the object.
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Unsupported media type
Unprocessable entity
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "name": "string",
- "description": "string",
- "engineId": "string",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "deleteMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getEngine": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "listExperiments": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createExperiment": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}, - "tasks": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "downloadRequired": true,
- "refInput": {
- "experimentRunId": "string",
- "taskName": "string",
- "outputName": "string"
}, - "metadata": {
- "property1": { },
- "property2": { }
}
}
], - "outputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "uploadRequired": true,
- "generatedURI": "string",
- "metadata": {
- "property1": { },
- "property2": { }
}
}
]
}
}
]
}
{- "id": "string",
- "name": "string",
- "description": "string",
- "engineId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "deleteMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getEngine": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "listExperiments": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createExperiment": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}, - "tasks": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "downloadRequired": true,
- "refInput": {
- "experimentRunId": "string",
- "taskName": "string",
- "outputName": "string"
}, - "metadata": {
- "property1": { },
- "property2": { }
}
}
], - "outputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "uploadRequired": true,
- "generatedURI": "string",
- "metadata": {
- "property1": { },
- "property2": { }
}
}
]
}
}
]
}
Deletes all MLinstances for provided engineId.
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Not found
Resource gone
Internal server error
Service unavailable
{- "title": "Illegal Argument",
- "status": 400,
- "detail": "Model specification name must not be empty",
- "additionalDetails": {
- "property1": "string",
- "property2": "string"
}
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "id": "string",
- "name": "string",
- "description": "string",
- "engineId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "deleteMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getEngine": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "listExperiments": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createExperiment": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}, - "tasks": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "downloadRequired": true,
- "refInput": {
- "experimentRunId": "string",
- "taskName": "string",
- "outputName": "string"
}, - "metadata": {
- "property1": { },
- "property2": { }
}
}
], - "outputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "uploadRequired": true,
- "generatedURI": "string",
- "metadata": {
- "property1": { },
- "property2": { }
}
}
]
}
}
]
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
If-Match | string Optional header field with ETag value provided by client |
Content-Type required | string application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json |
MLInstance object to be updated
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "name": "string",
- "description": "string",
- "engineId": "string",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "deleteMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getEngine": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "listExperiments": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createExperiment": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}, - "tasks": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "downloadRequired": true,
- "refInput": {
- "experimentRunId": "string",
- "taskName": "string",
- "outputName": "string"
}, - "metadata": {
- "property1": { },
- "property2": { }
}
}
], - "outputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "uploadRequired": true,
- "generatedURI": "string",
- "metadata": {
- "property1": { },
- "property2": { }
}
}
]
}
}
]
}
{- "id": "string",
- "name": "string",
- "description": "string",
- "engineId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "deleteMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getEngine": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "listExperiments": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createExperiment": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}, - "tasks": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "downloadRequired": true,
- "refInput": {
- "experimentRunId": "string",
- "taskName": "string",
- "outputName": "string"
}, - "metadata": {
- "property1": { },
- "property2": { }
}
}
], - "outputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "uploadRequired": true,
- "generatedURI": "string",
- "metadata": {
- "property1": { },
- "property2": { }
}
}
]
}
}
]
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "title": "Illegal Argument",
- "status": 400,
- "detail": "Model specification name must not be empty",
- "additionalDetails": {
- "property1": "string",
- "property2": "string"
}
}
An MLService is a published trained model that provides your organization with the ability to access and reuse previously developed models. A key feature of MLServices is the ability to automate training and scoring on a scheduled basis.
MLServices may be searched by name or tags.
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "children": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "mlInstanceId": "string",
- "trainingExperimentId": "string",
- "trainingExperimentRunId": "string",
- "trainingDataSetId": "string",
- "trainingTimeframe": 0,
- "scoringExperimentId": "string",
- "scoringDataSetId": "string",
- "scoringTimeframe": 0,
- "trainingSchedule": {
- "startTime": "string",
- "endTime": "string",
- "cron": "string"
}, - "scoringSchedule": {
- "startTime": "string",
- "endTime": "string",
- "cron": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
], - "_page": {
- "orderby": "string",
- "property": "string",
- "start": "string",
- "totalCount": 0,
- "count": 0,
- "next": "string"
}, - "_links": {
- "next": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "page": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
Creates a new MLService of an MLInstance
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
MLService object that needs to be added. Note that a valid mlInstanceId
has to be listed in the object.
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Unsupported media type
Unprocessable entity
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "name": "string",
- "description": "string",
- "mlInstanceId": "string",
- "trainingExperimentId": "string",
- "trainingExperimentRunId": "string",
- "trainingDataSetId": "string",
- "trainingTimeframe": 0,
- "scoringExperimentId": "string",
- "scoringDataSetId": "string",
- "scoringTimeframe": 0,
- "trainingSchedule": {
- "startTime": "string",
- "endTime": "string",
- "cron": "string"
}, - "scoringSchedule": {
- "startTime": "string",
- "endTime": "string",
- "cron": "string"
}, - "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getMLService": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "deleteMLService": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}
}
{- "id": "string",
- "name": "string",
- "description": "string",
- "mlInstanceId": "string",
- "trainingExperimentId": "string",
- "trainingExperimentRunId": "string",
- "trainingDataSetId": "string",
- "trainingTimeframe": 0,
- "scoringExperimentId": "string",
- "scoringDataSetId": "string",
- "scoringTimeframe": 0,
- "trainingSchedule": {
- "startTime": "string",
- "endTime": "string",
- "cron": "string"
}, - "scoringSchedule": {
- "startTime": "string",
- "endTime": "string",
- "cron": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getMLService": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "deleteMLService": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}
}
Deletes all MLServices for provided mlInstanceId
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Not found
Resource gone
Internal server error
Service unavailable
{- "title": "Illegal Argument",
- "status": 400,
- "detail": "Model specification name must not be empty",
- "additionalDetails": {
- "property1": "string",
- "property2": "string"
}
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
If-Match | string Optional header field with ETag value provided by client |
MLService object to be updated
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "name": "string",
- "description": "string",
- "mlInstanceId": "string",
- "trainingExperimentId": "string",
- "trainingExperimentRunId": "string",
- "trainingDataSetId": "string",
- "trainingTimeframe": 0,
- "scoringExperimentId": "string",
- "scoringDataSetId": "string",
- "scoringTimeframe": 0,
- "trainingSchedule": {
- "startTime": "string",
- "endTime": "string",
- "cron": "string"
}, - "scoringSchedule": {
- "startTime": "string",
- "endTime": "string",
- "cron": "string"
}, - "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getMLService": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "deleteMLService": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}
}
{- "id": "string",
- "name": "string",
- "description": "string",
- "mlInstanceId": "string",
- "trainingExperimentId": "string",
- "trainingExperimentRunId": "string",
- "trainingDataSetId": "string",
- "trainingTimeframe": 0,
- "scoringExperimentId": "string",
- "scoringDataSetId": "string",
- "scoringTimeframe": 0,
- "trainingSchedule": {
- "startTime": "string",
- "endTime": "string",
- "cron": "string"
}, - "scoringSchedule": {
- "startTime": "string",
- "endTime": "string",
- "cron": "string"
}, - "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getMLService": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "deleteMLService": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getMLInstance": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "title": "Illegal Argument",
- "status": 400,
- "detail": "Model specification name must not be empty",
- "additionalDetails": {
- "property1": "string",
- "property2": "string"
}
}
A data scientist conducts multiple experiments to arrive at a high-performing Model while training. This can include changing datasets, features, learning parameters, and hardware.
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "children": [
- {
- "id": "string",
- "name": "string",
- "mlInstanceId": "string",
- "mlInstanceQuery": "string",
- "description": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "createdByService": false,
- "workflowId": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
], - "_page": {
- "orderby": "string",
- "property": "string",
- "start": "string",
- "totalCount": 0,
- "count": 0,
- "next": "string"
}, - "_links": {
- "next": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "page": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createExperiment": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Content-Type required | string application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json |
Experiment object that needs to be created
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Unsupported media type
Unprocessable entity
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "name": "string",
- "mlInstanceId": "string",
- "mlInstanceQuery": "string",
- "description": "string",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "deleted": false,
- "createdByService": false,
- "workflowId": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getExperiment": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createExperimentRun": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "listExperimentRuns": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}, - "template": {
- "experimentRunId": "string",
- "tasks": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "downloadRequired": true,
- "refInput": {
- "experimentRunId": null,
- "taskName": null,
- "outputName": null
}, - "metadata": {
- "property1": { },
- "property2": { }
}
}
], - "outputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "uploadRequired": true,
- "generatedURI": "string",
- "metadata": {
- "property1": { },
- "property2": { }
}
}
]
}
}
], - "schedule": {
- "cron": "string",
- "startTime": "string",
- "endTime": "string"
}, - "notification": {
- "email": "string",
- "emailOnRetry": true,
- "emailOnFailure": true
}
}
}
{- "id": "string",
- "name": "string",
- "mlInstanceId": "string",
- "mlInstanceQuery": "string",
- "description": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "createdByService": false,
- "workflowId": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getExperiment": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createExperimentRun": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "listExperimentRuns": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}, - "template": {
- "experimentRunId": "string",
- "tasks": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "downloadRequired": true,
- "refInput": {
- "experimentRunId": null,
- "taskName": null,
- "outputName": null
}, - "metadata": {
- "property1": { },
- "property2": { }
}
}
], - "outputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "uploadRequired": true,
- "generatedURI": "string",
- "metadata": {
- "property1": { },
- "property2": { }
}
}
]
}
}
], - "schedule": {
- "cron": "string",
- "startTime": "string",
- "endTime": "string"
}, - "notification": {
- "email": "string",
- "emailOnRetry": true,
- "emailOnFailure": true
}
}
}
Deletes all experiments for the provided mlInstance.
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Not found
Resource gone
Internal server error
Service unavailable
{- "title": "Illegal Argument",
- "status": 400,
- "detail": "Model specification name must not be empty",
- "additionalDetails": {
- "property1": "string",
- "property2": "string"
}
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "id": "string",
- "name": "string",
- "mlInstanceId": "string",
- "mlInstanceQuery": "string",
- "description": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "createdByService": false,
- "workflowId": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getExperiment": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createExperimentRun": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "listExperimentRuns": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}, - "template": {
- "experimentRunId": "string",
- "tasks": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "downloadRequired": true,
- "refInput": {
- "experimentRunId": null,
- "taskName": null,
- "outputName": null
}, - "metadata": {
- "property1": { },
- "property2": { }
}
}
], - "outputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "uploadRequired": true,
- "generatedURI": "string",
- "metadata": {
- "property1": { },
- "property2": { }
}
}
]
}
}
], - "schedule": {
- "cron": "string",
- "startTime": "string",
- "endTime": "string"
}, - "notification": {
- "email": "string",
- "emailOnRetry": true,
- "emailOnFailure": true
}
}
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
If-Match | string Optional header field with ETag value provided by client |
Content-Type required | string application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json |
Experiment object to be updated
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "name": "string",
- "mlInstanceId": "string",
- "mlInstanceQuery": "string",
- "description": "string",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "deleted": false,
- "createdByService": false,
- "workflowId": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getExperiment": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createExperimentRun": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "listExperimentRuns": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}, - "template": {
- "experimentRunId": "string",
- "tasks": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "downloadRequired": true,
- "refInput": {
- "experimentRunId": null,
- "taskName": null,
- "outputName": null
}, - "metadata": {
- "property1": { },
- "property2": { }
}
}
], - "outputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "uploadRequired": true,
- "generatedURI": "string",
- "metadata": {
- "property1": { },
- "property2": { }
}
}
]
}
}
], - "schedule": {
- "cron": "string",
- "startTime": "string",
- "endTime": "string"
}, - "notification": {
- "email": "string",
- "emailOnRetry": true,
- "emailOnFailure": true
}
}
}
{- "id": "string",
- "name": "string",
- "mlInstanceId": "string",
- "mlInstanceQuery": "string",
- "description": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "createdByService": false,
- "workflowId": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getExperiment": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createExperimentRun": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "listExperimentRuns": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}, - "template": {
- "experimentRunId": "string",
- "tasks": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "downloadRequired": true,
- "refInput": {
- "experimentRunId": null,
- "taskName": null,
- "outputName": null
}, - "metadata": {
- "property1": { },
- "property2": { }
}
}
], - "outputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "uploadRequired": true,
- "generatedURI": "string",
- "metadata": {
- "property1": { },
- "property2": { }
}
}
]
}
}
], - "schedule": {
- "cron": "string",
- "startTime": "string",
- "endTime": "string"
}, - "notification": {
- "email": "string",
- "emailOnRetry": true,
- "emailOnFailure": true
}
}
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "title": "Illegal Argument",
- "status": 400,
- "detail": "Model specification name must not be empty",
- "additionalDetails": {
- "property1": "string",
- "property2": "string"
}
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "children": [
- {
- "id": "string",
- "mode": "string",
- "description": "string",
- "experimentId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
], - "_page": {
- "orderby": "string",
- "property": "string",
- "start": "string",
- "totalCount": 0,
- "count": 0,
- "next": "string"
}, - "_links": {
- "next": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "page": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createExperimentRun": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Content-Type required | string application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json |
Run object that needs to be added
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Unsupported media type
Unprocessable entity
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "id": "string",
- "mode": "string",
- "description": "string",
- "experimentId": "string",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tasks": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "downloadRequired": true,
- "refInput": {
- "experimentRunId": "string",
- "taskName": "string",
- "outputName": "string"
}, - "metadata": {
- "property1": { },
- "property2": { }
}
}
], - "outputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "uploadRequired": true,
- "generatedURI": "string",
- "metadata": {
- "property1": { },
- "property2": { }
}
}
]
}
}
], - "runChain": {
- "preprocessTaskId": "string",
- "trainTaskId": "string",
- "batchScoreTaskId": "string",
- "validateTaskId": "string",
- "evaluateTaskId": "string"
}
}
{- "id": "string",
- "mode": "string",
- "description": "string",
- "experimentId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tasks": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "downloadRequired": true,
- "refInput": {
- "experimentRunId": "string",
- "taskName": "string",
- "outputName": "string"
}, - "metadata": {
- "property1": { },
- "property2": { }
}
}
], - "outputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "uploadRequired": true,
- "generatedURI": "string",
- "metadata": {
- "property1": { },
- "property2": { }
}
}
]
}
}
], - "runChain": {
- "preprocessTaskId": "string",
- "trainTaskId": "string",
- "batchScoreTaskId": "string",
- "validateTaskId": "string",
- "evaluateTaskId": "string"
}
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "id": "string",
- "mode": "string",
- "description": "string",
- "experimentId": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tasks": [
- {
- "name": "string",
- "parameters": [
- {
- "key": "string",
- "value": "string",
- "secret": true
}
], - "specification": {
- "type": "ContainerTaskSpec"
}, - "datasets": {
- "inputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "downloadRequired": true,
- "refInput": {
- "experimentRunId": "string",
- "taskName": "string",
- "outputName": "string"
}, - "metadata": {
- "property1": { },
- "property2": { }
}
}
], - "outputs": [
- {
- "name": "string",
- "id": "string",
- "diskSizeInGB": 0,
- "resType": "dataset",
- "uploadRequired": true,
- "generatedURI": "string",
- "metadata": {
- "property1": { },
- "property2": { }
}
}
]
}
}
], - "runChain": {
- "preprocessTaskId": "string",
- "trainTaskId": "string",
- "batchScoreTaskId": "string",
- "validateTaskId": "string",
- "evaluateTaskId": "string"
}
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "id": "string",
- "name": "string",
- "experimentRunId": "string",
- "description": "string",
- "deleted": false,
- "status": {
- "tasks": [
- {
- "id": "string",
- "name": "string",
- "state": "PENDING",
- "logs": "string",
- "tasklogs": [
- {
- "name": "string",
- "url": "string"
}
], - "message": "string",
- "started": "string",
- "ended": "string"
}
]
}
}
Allows machine learning Model management and registration (Model artifact that is created by the training process).
List all Models providing mechanisms for pagination, filtering, and sorting.
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "children": [
- {
- "id": "string",
- "name": "string",
- "experimentId": "string",
- "experimentRunId": "string",
- "description": "string",
- "modelArtifactUri": "string",
- "state": [
- "trained"
], - "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
], - "_page": {
- "orderby": "string",
- "property": "string",
- "start": "string",
- "totalCount": 0,
- "count": 0,
- "next": "string"
}, - "_links": {
- "next": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "page": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createModel": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
Creates a Model for a particular Engine and MLinstance
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Unsupported media type
Unprocessable entity
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "id": "string",
- "name": "string",
- "experimentId": "string",
- "experimentRunId": "string",
- "description": "string",
- "modelArtifactUri": "string",
- "state": [
- "trained"
], - "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}
}
Retrieves a specific Model
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "id": "string",
- "name": "string",
- "experimentId": "string",
- "experimentRunId": "string",
- "description": "string",
- "modelArtifactUri": "string",
- "state": [
- "trained"
], - "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}
}
Update an existing Model
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
If-Match | string Optional header field with ETag value provided by client |
Content-Type required | string application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json |
Model object to be updated
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "id": "string",
- "name": "string",
- "experimentId": "string",
- "experimentRunId": "string",
- "description": "string",
- "modelArtifactUri": "string",
- "state": [
- "trained"
], - "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}
}
{- "id": "string",
- "name": "string",
- "experimentId": "string",
- "experimentRunId": "string",
- "description": "string",
- "modelArtifactUri": "string",
- "state": [
- "trained"
], - "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}, - "tags": {
- "property1": "string",
- "property2": "string"
}
}
Deletes a specific Model
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "title": "Illegal Argument",
- "status": 400,
- "detail": "Model specification name must not be empty",
- "additionalDetails": {
- "property1": "string",
- "property2": "string"
}
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "children": [
- {
- "id": "string",
- "modelId": "string",
- "targetFormat": "CoreML",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
], - "_page": {
- "orderby": "string",
- "property": "string",
- "start": "string",
- "totalCount": 0,
- "count": 0,
- "next": "string"
}, - "_links": {
- "next": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "page": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createService": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Content-Type required | string application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json |
Model transcoding to be created
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Unsupported media type
Unprocessable entity
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "id": "string",
- "modelId": "string",
- "targetFormat": "CoreML",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getModelTranscoding": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
{- "id": "string",
- "modelId": "string",
- "targetFormat": "CoreML",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getModelTranscoding": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "id": "string",
- "modelId": "string",
- "targetFormat": "CoreML",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": {
- "displayName": "string",
- "avatar": "string",
- "userId": "string"
}, - "updated": "2019-08-24T14:15:22Z",
- "deleted": false,
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "getModelTranscoding": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
Insights contain metrics which are used to empower a data scientist to evaluate and choose optimal ML Models by displaying relevant evaluation metrics.
Lists all insights for all experiment runs
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "children": [
- {
- "id": "string",
- "context": {
- "clientId": "string",
- "notebookId": "string",
- "experimentId": "string",
- "engineId": "string",
- "mlInstanceId": "string",
- "experimentRunId": "string",
- "modelId": "string",
- "dataSetId": "string"
}, - "events": {
- "name": "string",
- "eventValues": {
- "property1": "string",
- "property2": "string"
}
}, - "metrics": [
- {
- "name": "string",
- "value": "string",
- "valueType": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "updated": "2019-08-24T14:15:22Z",
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
], - "_page": {
- "orderby": "string",
- "property": "string",
- "start": "string",
- "totalCount": 0,
- "count": 0,
- "next": "string"
}, - "_links": {
- "next": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "page": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}, - "createService": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
Creates a new Model insight
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Content-Type required | string application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json |
Insight object that needs to be added
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Unsupported media type
Unprocessable entity
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "id": "string",
- "context": {
- "clientId": "string",
- "notebookId": "string",
- "experimentId": "string",
- "engineId": "string",
- "mlInstanceId": "string",
- "experimentRunId": "string",
- "modelId": "string",
- "dataSetId": "string"
}, - "events": {
- "name": "string",
- "eventValues": {
- "property1": "string",
- "property2": "string"
}
}, - "metrics": [
- {
- "name": "string",
- "value": "string",
- "valueType": "string"
}
], - "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
{- "id": "string",
- "context": {
- "clientId": "string",
- "notebookId": "string",
- "experimentId": "string",
- "engineId": "string",
- "mlInstanceId": "string",
- "experimentRunId": "string",
- "modelId": "string",
- "dataSetId": "string"
}, - "events": {
- "name": "string",
- "eventValues": {
- "property1": "string",
- "property2": "string"
}
}, - "metrics": [
- {
- "name": "string",
- "value": "string",
- "valueType": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "updated": "2019-08-24T14:15:22Z",
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
Retrieves a specific insight
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not found
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "id": "string",
- "context": {
- "clientId": "string",
- "notebookId": "string",
- "experimentId": "string",
- "engineId": "string",
- "mlInstanceId": "string",
- "experimentRunId": "string",
- "modelId": "string",
- "dataSetId": "string"
}, - "events": {
- "name": "string",
- "eventValues": {
- "property1": "string",
- "property2": "string"
}
}, - "metrics": [
- {
- "name": "string",
- "value": "string",
- "valueType": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "updated": "2019-08-24T14:15:22Z",
- "_links": {
- "self": {
- "href": "string",
- "templated": false,
- "type": "string",
- "method": "GET",
- "title": "string",
- "hrefLang": "string"
}
}
}
Lists all default metrics available for algorithms
Authorization required | string The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, |
x-api-key required | string The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-gw-ims-org-id required | string The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial. |
x-sandbox-name required | string The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information. |
Success
Bad request
Unauthorized
Forbidden
Not acceptable
Internal server error
Bad gateway
Service unavailable
Gateway timeout
{- "children": [
- {
- "algorithm": "string",
- "defaultMetrics": [
- "string"
]
}
]
}