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
});{
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"jobId": 123,
"items": [
{
"fileId": 1234,
"predictions": {
"textPredictions": [
{
"confidence": 0.9,
"text": "string",
"textRegion": {
"xMin": 0.5,
"xMax": 0.9,
"yMin": 0.5,
"yMax": 0.9
}
}
],
"assetTagPredictions": [
{
"confidence": 0.9,
"assetRef": {
"id": 1233
},
"text": "string",
"textRegion": {
"xMin": 0.5,
"xMax": 0.9,
"yMin": 0.5,
"yMax": 0.9
}
}
],
"peoplePredictions": [
{
"label": "person",
"confidence": 0.8,
"boundingBox": {
"xMin": 0.5,
"xMax": 0.9,
"yMin": 0.5,
"yMax": 0.9
}
}
]
},
"fileExternalId": "1234"
}
],
"errorMessage": null,
"failedItems": [
{
"errorMessage": "<string>",
"items": [
{
"fileId": 1234,
"fileExternalId": "1234",
"fileInstanceId": {
"space": "space",
"externalId": "externalId"
}
}
]
}
],
"parameters": {
"textDetectionParameters": {
"threshold": 0.8
},
"assetTagDetectionParameters": {
"threshold": 0.8,
"partialMatch": true,
"assetSubtreeIds": [
1,
2
]
},
"peopleDetectionParameters": {
"threshold": 0.8
}
}
}Retrieve results from a feature extraction job on images
Required capabilities:
filesAcl:READ
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.
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
});{
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"jobId": 123,
"items": [
{
"fileId": 1234,
"predictions": {
"textPredictions": [
{
"confidence": 0.9,
"text": "string",
"textRegion": {
"xMin": 0.5,
"xMax": 0.9,
"yMin": 0.5,
"yMax": 0.9
}
}
],
"assetTagPredictions": [
{
"confidence": 0.9,
"assetRef": {
"id": 1233
},
"text": "string",
"textRegion": {
"xMin": 0.5,
"xMax": 0.9,
"yMin": 0.5,
"yMax": 0.9
}
}
],
"peoplePredictions": [
{
"label": "person",
"confidence": 0.8,
"boundingBox": {
"xMin": 0.5,
"xMax": 0.9,
"yMin": 0.5,
"yMax": 0.9
}
}
]
},
"fileExternalId": "1234"
}
],
"errorMessage": null,
"failedItems": [
{
"errorMessage": "<string>",
"items": [
{
"fileId": 1234,
"fileExternalId": "1234",
"fileInstanceId": {
"space": "space",
"externalId": "externalId"
}
}
]
}
],
"parameters": {
"textDetectionParameters": {
"threshold": 0.8
},
"assetTagDetectionParameters": {
"threshold": 0.8,
"partialMatch": true,
"assetSubtreeIds": [
1,
2
]
},
"peopleDetectionParameters": {
"threshold": 0.8
}
}
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Headers
cdf version header. Use this to specify the requested CDF release.
"alpha"
Path Parameters
Contextualization job ID.
123
Response
Success
The status of the job.
Queued, Running, Completed, Failed The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
Contextualization job ID.
123
List of file IDs and their corresponding predictions.
Show child attributes
Show child attributes
If the job failed, some more information about the error cause.
null
Show child attributes
Show child attributes
Feature-specific parameters. New feature extractor parameters may appear.
Show child attributes
Show child attributes
{
"textDetectionParameters": { "threshold": 0.8 },
"assetTagDetectionParameters": {
"threshold": 0.8,
"partialMatch": true,
"assetSubtreeIds": [1, 2]
},
"peopleDetectionParameters": { "threshold": 0.8 }
}Was this page helpful?