Extract features from images

Start an asynchronous prediction job for extracting features such as text, asset tags or industrial objects from images. The response of the POST request contains a job ID, which can be used to make subsequent (GET) calls to check the status and retrieve the results of the job (see Retrieve results from a feature extraction job).

It is possible to have up to 20 concurrent jobs per CDF project.

The files referenced by items in the request body must fulfill the following requirements:

  • Must have file extension: .jpeg, .jpg or .png
  • Must have image/png or image/jpeg as mimeType

New feature extractors may be added in the future.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
header Parameters
cdf-version
string

cdf version header. Use this to specify the requested CDF release.

Example: alpha
Request Body schema: application/json
required

A request for running an extract job.

required
Array of objects or objects (FileReference) [ 1 .. 100 ]

List of image files to be analyzed by the feature extractors.

required
Array of TextDetection (string) or AssetTagDetection (string) or PeopleDetection (string) or IndustrialObjectDetection (string) or PersonalProtectiveEquipmentDetection (string) or DialGaugeDetection (string) or LevelGaugeDetection (string) or DigitalGaugeDetection (string) or ValveDetection (string) (VisionExtractFeature) [ 1 .. 3 ] unique

The type of detections to perform. New feature extractors may appear. You can use up to three feature extractors per request.

object (FeatureParameters)

Feature-specific parameters. New feature extractor parameters may appear.

Responses
200

Success

400

The response for a failed request.

post/context/vision/extract
Request samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "features": [
    • "TextDetection",
    • "AssetTagDetection",
    • "PeopleDetection"
    ],
  • "parameters": {
    • "textDetectionParameters": {
      },
    • "assetTagDetectionParameters": {
      },
    • "peopleDetectionParameters": {
      }
    }
}
Response samples
application/json
{
  • "status": "Queued",
  • "createdTime": 0,
  • "startTime": 0,
  • "statusTime": 0,
  • "errorMessage": null,
  • "jobId": 123,
  • "items": [
    • {
      }
    ],
  • "features": [
    • "TextDetection",
    • "AssetTagDetection",
    • "PeopleDetection"
    ],
  • "parameters": {
    • "textDetectionParameters": {
      },
    • "assetTagDetectionParameters": {
      },
    • "peopleDetectionParameters": {
      }
    }
}
➔ Next to Retrieve results from a feature extraction job on images