Skip to content

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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 ImageAugmentationCreateList 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 http://10.97.111.38/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 http://10.97.111.38/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 ImageAugmentationRetrieveList

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

BearerAuth

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

Update and existing augmentation list, with passed in values.

Code samples

# You can also use wget
curl -X PATCH http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 http://10.97.111.38/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 none A 2D matrix of values (row-major) representing the activation strengths for particular image regions.
actualTargetValue any true none Actual target value of the dataset row.

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous integer false none none

continued

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

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous integer false none none

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

Properties

Name Type Required Restrictions Description
downloadOriginalImage string(uri) true none URL of the original image
downloadOverlayImage string(uri) true none 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 none The job ID.
isBlocked boolean true none True if the job is waiting for its dependencies to be resolved first.
jobType string true none the type of the job
message string true none Error message in case of failure.
modelId string true none the model ID of the target model
projectId string true none The project the job belongs to.
status string true none The job status.
url string true none 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 none Number of items returned on this page.
data [ImageInsightsMetadataElement] true none List of Image Activation Maps
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page).
totalCount integer true none 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 none The height of each activation map (the number of rows in each activationValues matrix).
activationMapWidth integer¦null true none The width of each activation map (the number of items in each row of each activationValues matrix).
activationMaps [ActivationMap] true none List of activation map objects
targetBins [TargetBin]¦null true none List of bin objects for regression or null
targetValues [string]¦null true none List of target values for classification or null

DuplicateImageItem

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

Properties

Name Type Required Restrictions Description
imageId string true none Id of the image. The actual image file can be retrieved with GET /api/v2/projects/{projectId}/images/{imageId}/file/
rowCount integer true none 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 none Number of items returned on this page.
data [DuplicateImageItem] true none List of image metadata
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page).
totalCount integer true none 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 none Number of items returned on this page.
data [ImageInsightsMetadataElement] true none List of Image Embeddings
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page).
totalCount integer true none 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 none List of Image Embedding objects
targetBins [TargetBin]¦null true none List of bin objects for regression or null
targetValues [string]¦null true none List of target values for classification or null

ImageAugmentationCreateList

{
  "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 none The name of the image feature containing the data to be augmented
inUse boolean false none This is set to true when the Augmentation List has been used to train a model
initialList boolean false none Whether this list will be used during autopilot to perform image augmentation
name string true none The name of the image augmentation list
numberOfNewImages integer true none Number of new rows to add for each existing row
projectId string true none The project containing the image data to be augmented
samplesId string¦null false none Image Augmentation list samples ID
transformationProbability number true none 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 none List of Transformations to possibly apply to each image

ImageAugmentationListCreateResponse

{
  "augmentationListId": "string"
}

Properties

Name Type Required Restrictions Description
augmentationListId string true none 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 none The name of the image feature containing the data to be augmented
inUse boolean false none This is set to true when the Augmentation List has been used to train a model
initialList boolean false none Whether this list will be used during autopilot to perform image augmentation
name string false none The name of the image augmentation list
numberOfNewImages integer false none Number of new rows to add for each existing row
projectId string false none The project containing the image data to be augmented
transformationProbability number false none 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 none List of Transformations to possibly apply to each image

ImageAugmentationListsCreateSamples

{
  "numberOfRows": 1
}

Properties

Name Type Required Restrictions Description
numberOfRows integer true none 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 none Number of items returned on this page.
data [ImageAugmentationRetrieveList] true none The content in the form of an augmentation lists
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page).
totalCount integer true none The total number of items across all pages.

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 none Number of items returned on this page.
data [ImageAugmentationRetrieveSamplesItem] true none Augmentation samples list
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page).
totalCount integer true none 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 none Number of new images to be created for each original image during training
currentTransformationProbability number true none 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 none Name of the image feature that the augmentation list is associated with
id string true none Augmentation list id
maxNumberOfNewImages integer true none Maximum number of new images per original image to be generated during training
maxTransformationProbability number true none Maximum probability that each enabled augmentation will be applied to an image
minNumberOfNewImages integer true none Minimum number of new images per original image to be generated during training
minTransformationProbability number true none Minimum probability that each enabled augmentation will be applied to an image
name string true none The name of the augmentation list
projectId string true none The id of the project containing the image data to be augmented
transformations [ImageAugmentationOptionsTransformation] true none 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 none 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://app.datarobot.com/docs/modeling/special-workflows/visual-ai/tti-augment/ttia-lists.html#transformations
enabledByDefault boolean true none Determines if the parameter should be default selected in the UI
name string true none The name of the transformation
params [ImageAugmentationOptionsTransformationParam] true none The list of parameters that control the transformation
translatedName string true none 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 none Current transformation value

anyOf

Name Type Required Restrictions Description
» anonymous integer false none none

or

Name Type Required Restrictions Description
» anonymous number false none none

continued

Name Type Required Restrictions Description
maxValue any false none Max transformation value

anyOf

Name Type Required Restrictions Description
» anonymous integer false none none

or

Name Type Required Restrictions Description
» anonymous number false none none

continued

Name Type Required Restrictions Description
minValue any false none Min transformation value

anyOf

Name Type Required Restrictions Description
» anonymous integer false none none

or

Name Type Required Restrictions Description
» anonymous number false none none

continued

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

ImageAugmentationRetrieveList

{
  "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 none The name of the image feature containing the data to be augmented
id string true none Image Augmentation list ID
inUse boolean false none This is set to true when the Augmentation List has been used to train a model
initialList boolean false none Whether this list will be used during autopilot to perform image augmentation
name string true none The name of the image augmentation list
numberOfNewImages integer true none Number of new rows to add for each existing row
projectId string true none The project containing the image data to be augmented
samplesId string¦null false none Image Augmentation list samples ID
transformationProbability number true none 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 none List of Transformations to possibly apply to each image

ImageAugmentationRetrieveSamplesItem

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

Properties

Name Type Required Restrictions Description
height integer true none Height of the image in pixels
imageId string true none Id of the image. The augmented image file can be retrieved with GET /api/v2/projects/{projectId}/images/{imageId}/file/
originalImageId string¦null true none 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 none Project id
width integer true none 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 none Number of items returned on this page.
data [ImageAugmentationRetrieveSamplesItem] true none Augmentation samples list
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page).
totalCount integer true none 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 none The name of the image feature containing the data to be augmented
id string false none Augmentation list id
inUse boolean false none This is set to true when the Augmentation List has been used to train a model
initialList boolean false none Whether this list will be used during autopilot to perform image augmentation
name string true none The name of the image augmentation list
numberOfNewImages integer true none Number of new rows to add for each existing row
numberOfRows integer true none Number of images from the original dataset to be augmented
projectId string true none The project containing the image data to be augmented
samplesId string¦null false none Image Augmentation list samples ID
transformationProbability number true none 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 none List of Transformations to possibly apply to each image

ImageAugmentationSamplesResponse

{
  "statusId": "string"
}

Properties

Name Type Required Restrictions Description
statusId string true none 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 none Number of items returned on this page.
data [ImageMetadataWithBins] true none List of image metadata, as described below
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page).
totalCount integer true none 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 none Actual target value of the dataset row.

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous integer false none none

xor

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

continued

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

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 none The job ID.
isBlocked boolean true none True if the job is waiting for its dependencies to be resolved first.
jobType string true none the type of the job
message string true none Error message in case of failure.
modelId string true none the model ID of the target model
projectId string true none The project the job belongs to.
status string true none The job status.
url string true none 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 none Name of feature
modelId string true none 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 none Number of items returned on this page.
data [ImageMetadataResponse] true none List of image metadata elements
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page).
totalCount integer true none 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 none Height of the image in pixels
imageId string true none Id of the image. The actual image file can be retrieved with GET /api/v2/projects/{projectId}/images/{imageId}/file/
targetValue number false none Target value
width integer true none 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 none Height of the image in pixels
imageId string true none Id of the image. The actual image file can be retrieved with GET /api/v2/projects/{projectId}/images/{imageId}/file/
targetBinEnd integer¦null false none Target value for bin end for regression, null for classification
targetBinRowCount integer true none Number of rows in this target bin
targetBinStart integer¦null false none Target value for bin start for regression, null for classification
targetValue number false none Target value
width integer true none 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 none Number of items returned on this page.
data [string] true none The content in the form of lines of the images data quality log
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page).
totalCount integer true none The total number of items across all pages.

InsightsPredictionField

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

Properties

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

oneOf

Name Type Required Restrictions Description
» anonymous number false none none

xor

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

TargetBin

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

Properties

Name Type Required Restrictions Description
targetBinEnd number true none End value for the target bin
targetBinStart number true none 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 none Whether this transformation is enabled by default
name string true none Transformation name
params [TransformationParam] false none Config values for transformation

TransformationParam

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

Properties

Name Type Required Restrictions Description
currentValue any false none Current transformation value

anyOf

Name Type Required Restrictions Description
» anonymous integer false none none

or

Name Type Required Restrictions Description
» anonymous number false none none

continued

Name Type Required Restrictions Description
maxValue any false none Max transformation value

anyOf

Name Type Required Restrictions Description
» anonymous integer false none none

or

Name Type Required Restrictions Description
» anonymous number false none none

continued

Name Type Required Restrictions Description
minValue any false none Min transformation value

anyOf

Name Type Required Restrictions Description
» anonymous integer false none none

or

Name Type Required Restrictions Description
» anonymous number false none none

continued

Name Type Required Restrictions Description
name string true none Transformation param name

Updated December 7, 2022
Back to top