Retrieve results from a feature extraction job on images

Retrieve results from a feature extraction job on images.

Note that since files are split up into batches and processed independently of each other, the items in successfully completed batches will be returned even if files in other batches are still being processed. The job status will be Running until all batches have been processed. If one of the items in a batch fails, the results from items in other completed batches will still be returned. The corresponding items and error message(s) of failed batches will be populated in failedItems. Additionally, the status of the job is set to Completed if at least one batch is successfully completed, otherwise the status is set to Failed.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
jobId
required
integer <int64> (JobId)

Contextualization job ID.

Example: 123
header Parameters
cdf-version
string

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

Example: alpha
Responses
200

Success

400

The response for a failed request.

get/context/vision/extract/{jobId}
Request samples 
const { items } = await client.vision.getExtractJob(12345678, true); // get an existing job, wait for it to complete, and get the results
items.forEach((item) => {
 const predictions = item.predictions // do something with the predictions
});
Response samples
application/json
{
  • "status": "Queued",
  • "createdTime": 0,
  • "startTime": 0,
  • "statusTime": 0,
  • "errorMessage": null,
  • "jobId": 123,
  • "items": [
    • {
      }
    ],
  • "failedItems": [
    • {
      }
    ],
  • "parameters": {
    • "textDetectionParameters": {
      },
    • "assetTagDetectionParameters": {
      },
    • "peopleDetectionParameters": {
      }
    }
}
➔ Next to Documents / Documents