Skip to content

On-premise users: click in-app to access the full platform documentation for your version of DataRobot.

Images

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

GET /api/v2/datasets/{datasetId}/imagesDataQualityLog/

Retrieve the images data quality log content and log length as JSON

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/datasets/{datasetId}/imagesDataQualityLog/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
datasetId path string true The ID of the dataset

Example responses

200 Response

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

Responses

Status Meaning Description Schema
200 OK Paginated list of lines of the image data quality log ImagesDataQualityLogLinesResponse

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

BearerAuth

GET /api/v2/datasets/{datasetId}/imagesDataQualityLog/file/

Retrieve a text file containing the images data quality log.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/datasets/{datasetId}/imagesDataQualityLog/file/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
datasetId path string true The ID of the dataset

Responses

Status Meaning Description Schema
200 OK The response will contain a text file with the contents of the images data quality log. None

Response Headers

Status Header Type Format Description
200 Content-Disposition string attachment;filename=<filename>.txt The suggested filename is dynamically generated
200 Content-Type string MIME type of the returned data

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

BearerAuth

GET /api/v2/imageAugmentationLists/

List of augmentation lists that match the specified query.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/imageAugmentationLists/?projectId=string&offset=0&limit=100 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId query string true Project ID to retrieve augmentation lists from
featureName query string false Name of the image feature that the augmentation list is associated with
offset query integer true This many results will be skipped
limit query integer true At most this many results are returned. To specify no limit, use 0. The default may change without notice.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "featureName": "string",
      "id": "string",
      "inUse": false,
      "initialList": false,
      "name": "string",
      "numberOfNewImages": 1,
      "projectId": "string",
      "samplesId": null,
      "transformationProbability": 1,
      "transformations": [
        {
          "enabled": false,
          "name": "string",
          "params": [
            {
              "currentValue": 0,
              "maxValue": 0,
              "minValue": 0,
              "name": "string"
            }
          ]
        }
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Image Augmentation Lists ImageAugmentationListsResponse

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

BearerAuth

POST /api/v2/imageAugmentationLists/

Creates a new augmentation list based on the posted payload data.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/imageAugmentationLists/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

{
  "featureName": "string",
  "inUse": false,
  "initialList": false,
  "name": "string",
  "numberOfNewImages": 1,
  "projectId": "string",
  "samplesId": null,
  "transformationProbability": 1,
  "transformations": [
    {
      "enabled": false,
      "name": "string",
      "params": [
        {
          "currentValue": 0,
          "maxValue": 0,
          "minValue": 0,
          "name": "string"
        }
      ]
    }
  ]
}

Parameters

Name In Type Required Description
body body ImageAugmentationListsCreate false none

Example responses

201 Response

{
  "augmentationListId": "string"
}

Responses

Status Meaning Description Schema
201 Created Augmentation list id ImageAugmentationListCreateResponse
422 Unprocessable Entity Unable to create image augmentation list with the given input None

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

BearerAuth

DELETE /api/v2/imageAugmentationLists/{augmentationId}/

Delete an existing augmentation lists by id

Code samples

# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/imageAugmentationLists/{augmentationId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
augmentationId path string true The id of the augmentation list to fetch

Responses

Status Meaning Description Schema
204 No Content The successful response is empty None
400 Bad Request Cannot delete an augmentation list that is marked as in_use. None

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

BearerAuth

GET /api/v2/imageAugmentationLists/{augmentationId}/

Returns a single augmentation list with the specified id.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/imageAugmentationLists/{augmentationId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
augmentationId path string true The id of the augmentation list to fetch

Example responses

200 Response

{
  "featureName": "string",
  "id": "string",
  "inUse": false,
  "initialList": false,
  "name": "string",
  "numberOfNewImages": 1,
  "projectId": "string",
  "samplesId": null,
  "transformationProbability": 1,
  "transformations": [
    {
      "enabled": false,
      "name": "string",
      "params": [
        {
          "currentValue": 0,
          "maxValue": 0,
          "minValue": 0,
          "name": "string"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Returns an augmentation list object ImageAugmentationListsRetrieve

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

BearerAuth

PATCH /api/v2/imageAugmentationLists/{augmentationId}/

Update an existing augmentation list, with passed in values.

Code samples

# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/imageAugmentationLists/{augmentationId}/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

{
  "featureName": "string",
  "inUse": true,
  "initialList": true,
  "name": "string",
  "numberOfNewImages": 0,
  "projectId": "string",
  "transformationProbability": 1,
  "transformations": [
    {
      "enabled": false,
      "name": "string",
      "params": [
        {
          "currentValue": 0,
          "maxValue": 0,
          "minValue": 0,
          "name": "string"
        }
      ]
    }
  ]
}

Parameters

Name In Type Required Description
augmentationId path string true The id of the augmentation list to fetch
body body ImageAugmentationListPatchParam false none

Responses

Status Meaning Description Schema
204 No Content The successful response is empty None

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

BearerAuth

GET /api/v2/imageAugmentationLists/{augmentationId}/samples/

Retrieve latest Augmentation Samples generated for list

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/imageAugmentationLists/{augmentationId}/samples/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
augmentationId path string true The id of the augmentation list

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "height": 0,
      "imageId": "string",
      "originalImageId": "string",
      "projectId": "string",
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none ImageAugmentationListsRetrieveSamplesResponse
404 Not Found Augmentation Samples not found None

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

BearerAuth

POST /api/v2/imageAugmentationLists/{augmentationId}/samples/

This endpoint will schedule a job to augment the specified images from a project's dataset and return a link to monitor the status of the job, as well as a link to retrieve the resulting augmented images.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/imageAugmentationLists/{augmentationId}/samples/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

{
  "numberOfRows": 1
}

Parameters

Name In Type Required Description
augmentationId path string true The id of the augmentation list
body body ImageAugmentationListsCreateSamples false none

Example responses

202 Response

{
  "statusId": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Image Augmentation Samples generation has been successfully requested ImageAugmentationSamplesResponse

Response Headers

Status Header Type Format Description
202 Location string URL that can be polled to check the status of the operation.

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

BearerAuth

GET /api/v2/imageAugmentationOptions/{projectId}/

Augmentation list of all available transformations that are supported in the system.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/imageAugmentationOptions/{projectId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

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

Example responses

200 Response

{
  "currentNumberOfNewImages": 0,
  "currentTransformationProbability": 0,
  "featureName": "string",
  "id": "string",
  "maxNumberOfNewImages": 0,
  "maxTransformationProbability": 1,
  "minNumberOfNewImages": 0,
  "minTransformationProbability": 0,
  "name": "string",
  "projectId": "string",
  "transformations": [
    {
      "affectedByTransformationProbability": true,
      "enabledByDefault": true,
      "name": "string",
      "params": [
        {
          "currentValue": 0,
          "maxValue": 0,
          "minValue": 0,
          "name": "string",
          "translatedName": "string",
          "type": "string"
        }
      ],
      "translatedName": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Augmentation list object ImageAugmentationOptionsResponse

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

BearerAuth

POST /api/v2/imageAugmentationSamples/

(Deprecated in v2.28) This endpoint will schedule a job to augment the specified images from a project's dataset and return a link to monitor the status of the job, as well as a link to retrieve the resulting augmented images.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/imageAugmentationSamples/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

{
  "featureName": "string",
  "id": "string",
  "inUse": false,
  "initialList": false,
  "name": "string",
  "numberOfNewImages": 1,
  "numberOfRows": 1,
  "projectId": "string",
  "samplesId": null,
  "transformationProbability": 1,
  "transformations": [
    {
      "enabled": false,
      "name": "string",
      "params": [
        {
          "currentValue": 0,
          "maxValue": 0,
          "minValue": 0,
          "name": "string"
        }
      ]
    }
  ]
}

Parameters

Name In Type Required Description
body body ImageAugmentationSamplesRequest false none

Example responses

202 Response

{
  "statusId": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Image Augmentation Samples generation has been successfully requested ImageAugmentationSamplesResponse

Response Headers

Status Header Type Format Description
202 Location string URL that can be polled to check the status of the operation.

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

BearerAuth

GET /api/v2/imageAugmentationSamples/{samplesId}/

(Deprecated in v2.28) Retrieve previously generated Augmentation Samples. This route is being deprecated please use GET /imageAugmentationLists/<augmentationId>/samples route instead.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/imageAugmentationSamples/{samplesId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
samplesId path string true Id of the augmentation sample

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "height": 0,
      "imageId": "string",
      "originalImageId": "string",
      "projectId": "string",
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none ImageAugmentationRetrieveSamplesResponse
404 Not Found Augmentation Samples not found None

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

BearerAuth

GET /api/v2/projects/{projectId}/duplicateImages/{column}/

Get a list of duplicate images containing the number of occurrences of each image

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/duplicateImages/{column}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
projectId path string true The project ID
column path string true Column parameter to filter the list of duplicate images returned

Example responses

200 Response

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

Responses

Status Meaning Description Schema
200 OK List of image metadata DuplicateImageTableResponse

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

BearerAuth

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

List all Image Activation Maps for the project.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/imageActivationMaps/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false The number of items to skip over.
limit query integer false The number of items to return.
projectId path string true The project ID

Example responses

200 Response

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

Responses

Status Meaning Description Schema
200 OK Image Activation Maps ActivationMapsListResponse

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

BearerAuth

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

List image bins and covers for every target value or range.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/imageBins/?featureName=string \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
featureName query string true Name of the image feature
projectId path string true The project ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "height": 0,
      "imageId": "string",
      "targetBinEnd": 0,
      "targetBinRowCount": 0,
      "targetBinStart": 0,
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Returns a list of image metadata ImageBinsListResponse
422 Unprocessable Entity The request cannot be processed None

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

BearerAuth

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

List all Image Embeddings for the project.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/imageEmbeddings/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false The number of items to skip over.
limit query integer false The number of items to return.
projectId path string true The project ID

Example responses

200 Response

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

Responses

Status Meaning Description Schema
200 OK Image Embeddings EmbeddingsListResponse

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

BearerAuth

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

List all metadata for images in the EDA sample

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/imageSamples/?featureName=string \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
featureName query string true Name of the image feature
projectId path string true The project ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "height": 0,
      "imageId": "string",
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Paginated list of image metadata ImageMetadataListResponse
422 Unprocessable Entity The request cannot be processed None

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

BearerAuth

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

Returns a list of image metadata elements.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/images/?offset=0&limit=100 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
column query string false Name of the column to query
targetValue query any false For classification projects - when specified, only images corresponding to this target value will be returned. Mutually exclusive with targetBinStart/targetBinEnd.
targetBinStart query any false For regression projects - when specified, only images corresponding to the target values above this will be returned. Mutually exclusive with targetValue. Must be specified with targetBinEnd.
targetBinEnd query any false For regression projects - when specified, only images corresponding to the target values below this will be returned. Mutually exclusive with targetValue. Must be specified with targetBinStart.
offset query integer true This many results will be skipped
limit query integer true At most this many results are returned
projectId path string true The project ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "height": 0,
      "imageId": "string",
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Returns a list of image metadata elements. ImageMetadataListResponse
422 Unprocessable Entity The request cannot be processed. Possible reasons include: - Cannot supply value for both TargetValue and TargetBin. - Must supply both TargetBinStart and TargetBinEnd. - TargetBin parameters are only valid for regression projects. - TargetValue parameter is only valid for classification projects. None

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

BearerAuth

GET /api/v2/projects/{projectId}/images/{imageId}/

Returns a single image metadata.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/images/{imageId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID
imageId path string true Id of the image

Example responses

200 Response

{
  "height": 0,
  "imageId": "string",
  "targetValue": 0,
  "width": 0
}

Responses

Status Meaning Description Schema
200 OK Metadata for a single image ImageMetadataResponse
404 Not Found Image not found None

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

BearerAuth

GET /api/v2/projects/{projectId}/images/{imageId}/file/

Returns a file for a single image

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/images/{imageId}/file/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
projectId path string true The project ID
imageId path string true Id of the image

Responses

Status Meaning Description Schema
200 OK The response is an image file (not JSON) that can be saved or displayed. None
404 Not Found Image not found None

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

BearerAuth

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

Retrieve the images data quality log content and log length as JSON

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/imagesDataQualityLog/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

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

Example responses

200 Response

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

Responses

Status Meaning Description Schema
200 OK Paginated list of lines of the image data quality log ImagesDataQualityLogLinesResponse
422 Unprocessable Entity Not a data quality enabled project None

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

BearerAuth

GET /api/v2/projects/{projectId}/imagesDataQualityLog/file/

Retrieve a text file containing the images data quality log

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/imagesDataQualityLog/file/ \
  -H "Authorization: Bearer {access-token}"

Parameters

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

Responses

Status Meaning Description Schema
200 OK The response will contain a text file with the contents of the images data quality log. None

Response Headers

Status Header Type Format Description
200 Content-Disposition string attachment;filename=<filename>.txt The suggested filename is dynamically generated
200 Content-Type string MIME type of the returned data

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

BearerAuth

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

Retrieve Image Activation Maps for a feature of a model. Image Activation maps are a technique to get the discriminative image regions used by a CNN to identify a specific class in the image. In other words, an image activation map lets us see which regions in the image were relevant to this class. The higher the value in the activation map the greater the effect the region had on the prediction.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/models/{modelId}/imageActivationMaps/?featureName=string \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
featureName query string true Name of the feature to query
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "activationMapHeight": 0,
  "activationMapWidth": 0,
  "activationMaps": [
    {
      "activationValues": [
        [
          255
        ]
      ],
      "actualTargetValue": "string",
      "featureName": "string",
      "imageHeight": 0,
      "imageId": "string",
      "imageWidth": 0,
      "links": {
        "downloadOriginalImage": "http://example.com",
        "downloadOverlayImage": "http://example.com"
      },
      "overlayImageId": "string",
      "predictedTargetValue": "string"
    }
  ],
  "targetBins": [
    {
      "targetBinEnd": 0,
      "targetBinStart": 0
    }
  ],
  "targetValues": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK Image Activation Maps ActivationMapsRetrieveResponse
422 Unprocessable Entity Unable to process request. None

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

BearerAuth

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

Request the computation of image activation maps for the specified model.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/projects/{projectId}/models/{modelId}/imageActivationMaps/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

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

Example responses

202 Response

{
  "id": "string",
  "isBlocked": true,
  "jobType": "compute_image_activation_maps",
  "message": "string",
  "modelId": "string",
  "projectId": "string",
  "status": "queue",
  "url": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Image activation map computation has been successfully requested ActivationMapsComputeResponse
422 Unprocessable Entity Cannot compute image activation maps: if image activation maps were already computed for the model or there was another issue creating this job None

Response Headers

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

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

BearerAuth

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

Retrieve ImageEmbeddings for a feature of a model.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/models/{modelId}/imageEmbeddings/?featureName=string \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
featureName query string true Name of the feature to query
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "embeddings": [
    {
      "actualTargetValue": "string",
      "imageId": "string",
      "positionX": 0,
      "positionY": 0,
      "prediction": {
        "labels": [
          "string"
        ],
        "values": [
          0
        ]
      }
    }
  ],
  "targetBins": [
    {
      "targetBinEnd": 0,
      "targetBinStart": 0
    }
  ],
  "targetValues": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK Image Embeddings EmbeddingsRetrieveResponse
422 Unprocessable Entity Unable to process request. None

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

BearerAuth

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

Request the computation of image embeddings for the specified model.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/projects/{projectId}/models/{modelId}/imageEmbeddings/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

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

Example responses

202 Response

{
  "id": "string",
  "isBlocked": true,
  "jobType": "compute_image_embeddings",
  "message": "string",
  "modelId": "string",
  "projectId": "string",
  "status": "queue",
  "url": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Image embedding computation has been successfully requested ImageEmbeddingsComputeResponse
422 Unprocessable Entity Cannot compute image embeddings: if image embeddings were already computed for the model or there was another issue creating this job None

Response Headers

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

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

BearerAuth

Schemas

ActivationMap

{
  "activationValues": [
    [
      255
    ]
  ],
  "actualTargetValue": "string",
  "featureName": "string",
  "imageHeight": 0,
  "imageId": "string",
  "imageWidth": 0,
  "links": {
    "downloadOriginalImage": "http://example.com",
    "downloadOverlayImage": "http://example.com"
  },
  "overlayImageId": "string",
  "predictedTargetValue": "string"
}

Properties

Name Type Required Restrictions Description
activationValues [array] true A 2D matrix of values (row-major) representing the activation strengths for particular image regions.
actualTargetValue any true Actual target value of the dataset row

oneOf

Name Type Required Restrictions Description
» anonymous string false none

xor

Name Type Required Restrictions Description
» anonymous number false none

xor

Name Type Required Restrictions Description
» anonymous [string] false none

continued

Name Type Required Restrictions Description
featureName string true The name of the column containing the image value the activation map is based upon.
imageHeight integer true The height of the original image (in pixels) this activation map has been computed for.
imageId string true ID of the original image this activation map has been computed for.
imageWidth integer true The width of the original image (in pixels) this activation map has been computed for.
links ActivationMapLinks true Download URLs
overlayImageId string true ID of the image containing the original image overlaid by the activation heatmap.
predictedTargetValue any true predicted target value of the dataset row containing this image.

oneOf

Name Type Required Restrictions Description
» anonymous string false none

xor

Name Type Required Restrictions Description
» anonymous number false none

xor

Name Type Required Restrictions Description
» anonymous [string] false none

{
  "downloadOriginalImage": "http://example.com",
  "downloadOverlayImage": "http://example.com"
}

Properties

Name Type Required Restrictions Description
downloadOriginalImage string(uri) true URL of the original image
downloadOverlayImage string(uri) true URL of the original image overlaid by the activation heatmap

ActivationMapsComputeResponse

{
  "id": "string",
  "isBlocked": true,
  "jobType": "compute_image_activation_maps",
  "message": "string",
  "modelId": "string",
  "projectId": "string",
  "status": "queue",
  "url": "string"
}

Properties

Name Type Required Restrictions Description
id string true The job ID.
isBlocked boolean true True if the job is waiting for its dependencies to be resolved first.
jobType string true the type of the job
message string true Error message in case of failure.
modelId string true the model ID of the target model
projectId string true The project the job belongs to.
status string true The job status.
url string true A URL that can be used to request details about the job.

Enumerated Values

Property Value
jobType compute_image_activation_maps
status queue
status inprogress
status error
status ABORTED
status COMPLETED

ActivationMapsListResponse

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

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ImageInsightsMetadataElement] true List of Image Activation Maps
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

ActivationMapsRetrieveResponse

{
  "activationMapHeight": 0,
  "activationMapWidth": 0,
  "activationMaps": [
    {
      "activationValues": [
        [
          255
        ]
      ],
      "actualTargetValue": "string",
      "featureName": "string",
      "imageHeight": 0,
      "imageId": "string",
      "imageWidth": 0,
      "links": {
        "downloadOriginalImage": "http://example.com",
        "downloadOverlayImage": "http://example.com"
      },
      "overlayImageId": "string",
      "predictedTargetValue": "string"
    }
  ],
  "targetBins": [
    {
      "targetBinEnd": 0,
      "targetBinStart": 0
    }
  ],
  "targetValues": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
activationMapHeight integer¦null true The height of each activation map (the number of rows in each activationValues matrix).
activationMapWidth integer¦null true The width of each activation map (the number of items in each row of each activationValues matrix).
activationMaps [ActivationMap] true List of activation map objects
targetBins [TargetBin]¦null true List of bin objects for regression or null
targetValues [string]¦null true List of target values for classification or null

DuplicateImageItem

{
  "imageId": "string",
  "rowCount": 0
}

Properties

Name Type Required Restrictions Description
imageId string true Id of the image. The actual image file can be retrieved with GET /api/v2/projects/{projectId}/images/{imageId}/file/
rowCount integer true The count of duplicate images i.e. number of times this image is used in column

DuplicateImageTableResponse

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

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [DuplicateImageItem] true List of image metadata
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

EmbeddingsListResponse

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

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ImageInsightsMetadataElement] true List of Image Embeddings
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

EmbeddingsRetrieveResponse

{
  "embeddings": [
    {
      "actualTargetValue": "string",
      "imageId": "string",
      "positionX": 0,
      "positionY": 0,
      "prediction": {
        "labels": [
          "string"
        ],
        "values": [
          0
        ]
      }
    }
  ],
  "targetBins": [
    {
      "targetBinEnd": 0,
      "targetBinStart": 0
    }
  ],
  "targetValues": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
embeddings [ImageEmbedding] true List of Image Embedding objects
targetBins [TargetBin]¦null true List of bin objects for regression or null
targetValues [string]¦null true List of target values for classification or null

ImageAugmentationListCreateResponse

{
  "augmentationListId": "string"
}

Properties

Name Type Required Restrictions Description
augmentationListId string true Id of the newly created augmentation list which can be used to:
- retrieve the full augmentation list details;
- retrieve augmentation previews;
- to set the list id of a model in advanced tuning;
- to delete or rename the list.

ImageAugmentationListPatchParam

{
  "featureName": "string",
  "inUse": true,
  "initialList": true,
  "name": "string",
  "numberOfNewImages": 0,
  "projectId": "string",
  "transformationProbability": 1,
  "transformations": [
    {
      "enabled": false,
      "name": "string",
      "params": [
        {
          "currentValue": 0,
          "maxValue": 0,
          "minValue": 0,
          "name": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
featureName string false The name of the image feature containing the data to be augmented
inUse boolean false This parameter was deprecated. You can still pass a value, but it will be ignored. DataRobot will takes care of the value itself.
initialList boolean false Whether this list will be used during autopilot to perform image augmentation
name string false The name of the image augmentation list
numberOfNewImages integer false minimum: 0
Number of new rows to add for each existing row
projectId string false This parameter was deprecated. You can still pass a value, but it will be ignored. If you want to move an augmentation list to another project you can create a new list in the other project and delete the list in this project.
transformationProbability number false maximum: 1
minimum: 0

Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always.
transformations [Transformation] false List of Transformations to possibly apply to each image

ImageAugmentationListsCreate

{
  "featureName": "string",
  "inUse": false,
  "initialList": false,
  "name": "string",
  "numberOfNewImages": 1,
  "projectId": "string",
  "samplesId": null,
  "transformationProbability": 1,
  "transformations": [
    {
      "enabled": false,
      "name": "string",
      "params": [
        {
          "currentValue": 0,
          "maxValue": 0,
          "minValue": 0,
          "name": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
featureName string false The name of the image feature containing the data to be augmented
inUse boolean false This parameter was deprecated. You can still pass a value, but it will be ignored. DataRobot will takes care of the value itself.
initialList boolean false Whether this list will be used during autopilot to perform image augmentation
name string true The name of the image augmentation list
numberOfNewImages integer true minimum: 1
Number of new rows to add for each existing row
projectId string true The project containing the image data to be augmented
samplesId string¦null false Image Augmentation list samples ID
transformationProbability number true maximum: 1
minimum: 0
Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always.
transformations [Transformation] true List of Transformations to possibly apply to each image

ImageAugmentationListsCreateSamples

{
  "numberOfRows": 1
}

Properties

Name Type Required Restrictions Description
numberOfRows integer true minimum: 1
Number of images from the original dataset to be augmented

ImageAugmentationListsResponse

{
  "count": 0,
  "data": [
    {
      "featureName": "string",
      "id": "string",
      "inUse": false,
      "initialList": false,
      "name": "string",
      "numberOfNewImages": 1,
      "projectId": "string",
      "samplesId": null,
      "transformationProbability": 1,
      "transformations": [
        {
          "enabled": false,
          "name": "string",
          "params": [
            {
              "currentValue": 0,
              "maxValue": 0,
              "minValue": 0,
              "name": "string"
            }
          ]
        }
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ImageAugmentationListsRetrieve] true The content in the form of an augmentation lists
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

ImageAugmentationListsRetrieve

{
  "featureName": "string",
  "id": "string",
  "inUse": false,
  "initialList": false,
  "name": "string",
  "numberOfNewImages": 1,
  "projectId": "string",
  "samplesId": null,
  "transformationProbability": 1,
  "transformations": [
    {
      "enabled": false,
      "name": "string",
      "params": [
        {
          "currentValue": 0,
          "maxValue": 0,
          "minValue": 0,
          "name": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
featureName string false The name of the image feature containing the data to be augmented
id string true Image Augmentation list ID
inUse boolean false This is set to true when the Augmentation List has been used to train a model
initialList boolean false Whether this list will be used during autopilot to perform image augmentation
name string true The name of the image augmentation list
numberOfNewImages integer true minimum: 1
Number of new rows to add for each existing row
projectId string true The project containing the image data to be augmented
samplesId string¦null false Image Augmentation list samples ID
transformationProbability number true maximum: 1
minimum: 0
Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always.
transformations [Transformation] true List of Transformations to possibly apply to each image

ImageAugmentationListsRetrieveSamplesResponse

{
  "count": 0,
  "data": [
    {
      "height": 0,
      "imageId": "string",
      "originalImageId": "string",
      "projectId": "string",
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ImageAugmentationRetrieveSamplesItem] true Augmentation samples list
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

ImageAugmentationOptionsResponse

{
  "currentNumberOfNewImages": 0,
  "currentTransformationProbability": 0,
  "featureName": "string",
  "id": "string",
  "maxNumberOfNewImages": 0,
  "maxTransformationProbability": 1,
  "minNumberOfNewImages": 0,
  "minTransformationProbability": 0,
  "name": "string",
  "projectId": "string",
  "transformations": [
    {
      "affectedByTransformationProbability": true,
      "enabledByDefault": true,
      "name": "string",
      "params": [
        {
          "currentValue": 0,
          "maxValue": 0,
          "minValue": 0,
          "name": "string",
          "translatedName": "string",
          "type": "string"
        }
      ],
      "translatedName": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
currentNumberOfNewImages integer true Number of new images to be created for each original image during training
currentTransformationProbability number true Probability that each transformation included in an augmentation list will be applied to an image, if affectedByTransformationProbability for that transformation is True
featureName string false Name of the image feature that the augmentation list is associated with
id string true Augmentation list id
maxNumberOfNewImages integer true Maximum number of new images per original image to be generated during training
maxTransformationProbability number true maximum: 1
Maximum probability that each enabled augmentation will be applied to an image
minNumberOfNewImages integer true Minimum number of new images per original image to be generated during training
minTransformationProbability number true minimum: 0
Minimum probability that each enabled augmentation will be applied to an image
name string true The name of the augmentation list
projectId string true The id of the project containing the image data to be augmented
transformations [ImageAugmentationOptionsTransformation] true List of Transformations to possibly apply to each image

ImageAugmentationOptionsTransformation

{
  "affectedByTransformationProbability": true,
  "enabledByDefault": true,
  "name": "string",
  "params": [
    {
      "currentValue": 0,
      "maxValue": 0,
      "minValue": 0,
      "name": "string",
      "translatedName": "string",
      "type": "string"
    }
  ],
  "translatedName": "string"
}

Properties

Name Type Required Restrictions Description
affectedByTransformationProbability boolean true If true, whenever this transformation is included in an augmentation list, this transformation will be applied to each image with probability set by the Transformation Probability. If false, whenever this transformation is included in an augmentation list, this transformation will be applied to each image with probability described in the Platform Documentation here: https://docs.datarobot.com/en/docs/modeling/special-workflows/visual-ai/tti-augment/ttia-lists.html#transformations
enabledByDefault boolean true Determines if the parameter should be default selected in the UI
name string true The name of the transformation
params [ImageAugmentationOptionsTransformationParam] true The list of parameters that control the transformation
translatedName string true Translated name of the transformation

ImageAugmentationOptionsTransformationParam

{
  "currentValue": 0,
  "maxValue": 0,
  "minValue": 0,
  "name": "string",
  "translatedName": "string",
  "type": "string"
}

Properties

Name Type Required Restrictions Description
currentValue any false Current transformation value

anyOf

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous number false none

continued

Name Type Required Restrictions Description
maxValue any false Max transformation value

anyOf

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous number false none

continued

Name Type Required Restrictions Description
minValue any false Min transformation value

anyOf

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous number false none

continued

Name Type Required Restrictions Description
name string true Transformation param name
translatedName string true Translated name of the parameter
type string true The type of the parameter (int, float, etc...)

ImageAugmentationRetrieveSamplesItem

{
  "height": 0,
  "imageId": "string",
  "originalImageId": "string",
  "projectId": "string",
  "width": 0
}

Properties

Name Type Required Restrictions Description
height integer true Height of the image in pixels
imageId string true Id of the image. The augmented image file can be retrieved with GET /api/v2/projects/{projectId}/images/{imageId}/file/
originalImageId string¦null true Id of the original image that was transformed to produce the augmented image. If this is an original image (from the original training dataset) this value will be null. The id can be used to retrieve the original image file with: GET /api/v2/projects/{projectId}/images/{imageId}/file/
projectId string true Project id
width integer true Width of the image in pixels

ImageAugmentationRetrieveSamplesResponse

{
  "count": 0,
  "data": [
    {
      "height": 0,
      "imageId": "string",
      "originalImageId": "string",
      "projectId": "string",
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ImageAugmentationRetrieveSamplesItem] true Augmentation samples list
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

ImageAugmentationSamplesRequest

{
  "featureName": "string",
  "id": "string",
  "inUse": false,
  "initialList": false,
  "name": "string",
  "numberOfNewImages": 1,
  "numberOfRows": 1,
  "projectId": "string",
  "samplesId": null,
  "transformationProbability": 1,
  "transformations": [
    {
      "enabled": false,
      "name": "string",
      "params": [
        {
          "currentValue": 0,
          "maxValue": 0,
          "minValue": 0,
          "name": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
featureName string false The name of the image feature containing the data to be augmented
id string false Augmentation list id
inUse boolean false This is set to true when the Augmentation List has been used to train a model
initialList boolean false Whether this list will be used during autopilot to perform image augmentation
name string true The name of the image augmentation list
numberOfNewImages integer true minimum: 1
Number of new rows to add for each existing row
numberOfRows integer true minimum: 1
Number of images from the original dataset to be augmented
projectId string true The project containing the image data to be augmented
samplesId string¦null false Image Augmentation list samples ID
transformationProbability number true maximum: 1
minimum: 0
Probability that each enabled transformation will be applied to an image. This does not apply to Horizontal or Vertical Flip, which are set to 50% always.
transformations [Transformation] true List of Transformations to possibly apply to each image

ImageAugmentationSamplesResponse

{
  "statusId": "string"
}

Properties

Name Type Required Restrictions Description
statusId string true Id of the newly created augmentation samples which can be used to retrieve the full set of sample images.

ImageBinsListResponse

{
  "count": 0,
  "data": [
    {
      "height": 0,
      "imageId": "string",
      "targetBinEnd": 0,
      "targetBinRowCount": 0,
      "targetBinStart": 0,
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ImageMetadataWithBins] true List of image metadata, as described below
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

ImageEmbedding

{
  "actualTargetValue": "string",
  "imageId": "string",
  "positionX": 0,
  "positionY": 0,
  "prediction": {
    "labels": [
      "string"
    ],
    "values": [
      0
    ]
  }
}

Properties

Name Type Required Restrictions Description
actualTargetValue any true Actual target value of the dataset row

oneOf

Name Type Required Restrictions Description
» anonymous string false none

xor

Name Type Required Restrictions Description
» anonymous number false none

xor

Name Type Required Restrictions Description
» anonymous [string] false none

continued

Name Type Required Restrictions Description
imageId string true Id of the image. The actual image file can be retrieved with GET /api/v2/projects/{projectId}/images/{imageId}/file/.
positionX number true x coordinate of the image in the embedding space.
positionY number true y coordinate of the image in the embedding space.
prediction InsightsPredictionField true Object that describes prediction value of the dataset row.

ImageEmbeddingsComputeResponse

{
  "id": "string",
  "isBlocked": true,
  "jobType": "compute_image_embeddings",
  "message": "string",
  "modelId": "string",
  "projectId": "string",
  "status": "queue",
  "url": "string"
}

Properties

Name Type Required Restrictions Description
id string true The job ID.
isBlocked boolean true True if the job is waiting for its dependencies to be resolved first.
jobType string true the type of the job
message string true Error message in case of failure.
modelId string true the model ID of the target model
projectId string true The project the job belongs to.
status string true The job status.
url string true A URL that can be used to request details about the job.

Enumerated Values

Property Value
jobType compute_image_embeddings
status queue
status inprogress
status error
status ABORTED
status COMPLETED

ImageInsightsMetadataElement

{
  "featureName": "string",
  "modelId": "string"
}

Properties

Name Type Required Restrictions Description
featureName string true Name of feature
modelId string true Model ID of the target model

ImageMetadataListResponse

{
  "count": 0,
  "data": [
    {
      "height": 0,
      "imageId": "string",
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ImageMetadataResponse] true List of image metadata elements
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

ImageMetadataResponse

{
  "height": 0,
  "imageId": "string",
  "targetValue": 0,
  "width": 0
}

Properties

Name Type Required Restrictions Description
height integer true Height of the image in pixels
imageId string true Id of the image. The actual image file can be retrieved with GET /api/v2/projects/{projectId}/images/{imageId}/file/
targetValue number false Target value
width integer true Width of the image in pixels

ImageMetadataWithBins

{
  "height": 0,
  "imageId": "string",
  "targetBinEnd": 0,
  "targetBinRowCount": 0,
  "targetBinStart": 0,
  "targetValue": 0,
  "width": 0
}

Properties

Name Type Required Restrictions Description
height integer true Height of the image in pixels
imageId string true Id of the image. The actual image file can be retrieved with GET /api/v2/projects/{projectId}/images/{imageId}/file/
targetBinEnd integer¦null false Target value for bin end for regression, null for classification
targetBinRowCount integer true Number of rows in this target bin
targetBinStart integer¦null false Target value for bin start for regression, null for classification
targetValue number false Target value
width integer true Width of the image in pixels

ImagesDataQualityLogLinesResponse

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

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [string] true The content in the form of lines of the images data quality log
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

InsightsPredictionField

{
  "labels": [
    "string"
  ],
  "values": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
labels [string]¦null true List of predicted label names corresponding to values.
values [oneOf] true Predicted value or probability of the class identified by the label.

oneOf

Name Type Required Restrictions Description
» anonymous number false none

xor

Name Type Required Restrictions Description
» anonymous [number] false none

TargetBin

{
  "targetBinEnd": 0,
  "targetBinStart": 0
}

Properties

Name Type Required Restrictions Description
targetBinEnd number true End value for the target bin
targetBinStart number true Start value for the target bin

Transformation

{
  "enabled": false,
  "name": "string",
  "params": [
    {
      "currentValue": 0,
      "maxValue": 0,
      "minValue": 0,
      "name": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
enabled boolean false Whether this transformation is enabled by default
name string true Transformation name
params [TransformationParam] false Config values for transformation

TransformationParam

{
  "currentValue": 0,
  "maxValue": 0,
  "minValue": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
currentValue any false Current transformation value

anyOf

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous number false none

continued

Name Type Required Restrictions Description
maxValue any false Max transformation value

anyOf

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous number false none

continued

Name Type Required Restrictions Description
minValue any false Min transformation value

anyOf

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous number false none

continued

Name Type Required Restrictions Description
name string true Transformation param name

Updated February 28, 2024