GET /predict-api/api/extraction/{objectId}

Owned by Technische Redaktion
Dec 01, 2022
4 min read
As of Versionproduct version 2022 Winter
Request MethodGET
Response FormatJSON
Description

Retrieves a metadata extraction prediction for the binary content file of a single object identified by its objectId.

The property IDs will be returned according to the inference schema along with their probability in percentage (level of confidence) in the properties section of the JSON response body. The properties page and boundingBox (coordinates on the page) describe the location within the binary content file where the decisive information was identified.

The response JSON further contains the predictionId that should be used for giving feedback to the PREDICT-API on the quality of received predictions, as well as the system:objectId that was specified in the request URL.

Request Header

Content-Type: application/json

X-ID-TENANT-NAME: tenant_name

Request Example
/predict-api/api/extraction/da20c2fb-8071-45e9-b4bf-2af376cdf9b6
Result Example
{
    "predictions": [{
        "properties": {
            "appAIInvoice:aiiCompanyName": [
                {
                    "value": "Lufthansa",
                    "probability": 99.24,
                    "boundingBox": [
                        403,
                        729,
                        61,
                        14
                    ],
                    "page": 0
                },
                {
                    "value": "AKG Thermotechnik International GmbH & Co.KG",
                    "probability": 93.24,
                    "boundingBox": [
                        413,
                        224,
                        93,
                        14
                    ],
                    "page": 1
                }
            ],
            "appAIInvoice:aiiIssueDateTime": [
                {
                    "value": "2018-01-26T15:21:170Z",
                    "probability": 85.12,
                    "boundingBox": [
                        213,
                        234,
                        76,
                        14
                    ],
                    "page": 1
                }
            ]
        },
        "system:objectId": "da20c2fb-8071-45e9-b4bf-2af376cdf9b6",
        "predictionId": 188
    }]
}